PresenceTransport | @sheetwrite/core

Host transport contract for ephemeral presence messages.

Package: @sheetwrite/core
Source: packages/core/src/collaboration.ts#L22

Members 2

publish

publish(message: PresenceMessageinterface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}Ephemeral collaborator selection and activity update.API reference →, signal?: AbortSignal): void | Promise<void>;

subscribe

subscribe( listener: (message: PresenceMessageinterface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}Ephemeral collaborator selection and activity update.API reference →) => void, signal?: AbortSignal, ): undefined | (() => void);

Declaration

View full TypeScript declaration

export interface PresenceTransport {
  publish(
    message: PresenceMessageinterface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}Ephemeral collaborator selection and activity update.API reference →,
    signal?: AbortSignal,
  ): void | Promise<void>;
  subscribe(
    listener: (message: PresenceMessageinterface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}interface PresenceMessage {
  actor: PresenceActor;
  activeSheet: string;
  selections: readonly Range[];
  sentAt: number;
}Ephemeral collaborator selection and activity update.API reference →) => void,
    signal?: AbortSignal,
  ): undefined | (() => void);
}