PresenceCoordinatorOptions | @sheetwrite/core

Identity, privacy, and timing options for presence coordination.

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

Members 7

actor

actor: PresenceActorinterface PresenceActor {
  id: string;
  displayName?: string;
  color?: string;
}interface PresenceActor {
  id: string;
  displayName?: string;
  color?: string;
}interface PresenceActor {
  id: string;
  displayName?: string;
  color?: string;
}Public collaborator identity attached to presence updates.API reference →;

privacy

privacy?: PresencePrivacyOptionsinterface PresencePrivacyOptions {
  shareDisplayName?: boolean;
  shareSelection?: boolean;
  receivePresence?: boolean;
  allowActor?: (actor: Readonly<PresenceActor>) => boolean;
}interface PresencePrivacyOptions {
  shareDisplayName?: boolean;
  shareSelection?: boolean;
  receivePresence?: boolean;
  allowActor?: (actor: Readonly<PresenceActor>) => boolean;
}interface PresencePrivacyOptions {
  shareDisplayName?: boolean;
  shareSelection?: boolean;
  receivePresence?: boolean;
  allowActor?: (
    actor: Readonly<PresenceActor>,
  ) => boolean;
}Controls which ephemeral collaborator details may be transmitted.API reference →;

heartbeatMs Publish/prune interval in milliseconds; defaults to 15,000.

heartbeatMs?: number;

Publish/prune interval in milliseconds; defaults to 15,000. Use 0 to disable the timer.

timeoutMs Idle receipt time before a remote actor expires; defaults to 45,000 milliseconds.

timeoutMs?: number;

maxActors Remote actors retained at once; defaults to 32 and is clamped to at least 1.

maxActors?: number;

maxRangesPerActor Selection ranges sent or accepted per actor; defaults to 8 and is clamped to at least 1.

maxRangesPerActor?: number;

now

now?: () => number;

Declaration

View full TypeScript declaration

export interface PresenceCoordinatorOptions {
  actor: PresenceActorinterface PresenceActor {
  id: string;
  displayName?: string;
  color?: string;
}interface PresenceActor {
  id: string;
  displayName?: string;
  color?: string;
}interface PresenceActor {
  id: string;
  displayName?: string;
  color?: string;
}Public collaborator identity attached to presence updates.API reference →;
  privacy?: PresencePrivacyOptionsinterface PresencePrivacyOptions {
  shareDisplayName?: boolean;
  shareSelection?: boolean;
  receivePresence?: boolean;
  allowActor?: (actor: Readonly<PresenceActor>) => boolean;
}interface PresencePrivacyOptions {
  shareDisplayName?: boolean;
  shareSelection?: boolean;
  receivePresence?: boolean;
  allowActor?: (actor: Readonly<PresenceActor>) => boolean;
}interface PresencePrivacyOptions {
  shareDisplayName?: boolean;
  shareSelection?: boolean;
  receivePresence?: boolean;
  allowActor?: (
    actor: Readonly<PresenceActor>,
  ) => boolean;
}Controls which ephemeral collaborator details may be transmitted.API reference →;
  heartbeatMs?: number;
  timeoutMs?: number;
  maxActors?: number;
  maxRangesPerActor?: number;
  now?: () => number;
}