Class DocumentSession

constructor

• new DocumentSession(options: DocumentSessionOptions): DocumentSession

  Parameters

  • options: DocumentSessionOptions

  Returns DocumentSession

ReadonlydocumentId

applyDurableMetadata

• applyDurableMetadata(
      metadata: DocumentMetadata | undefined,
      persistedAt: number,
  ): void

  Refresh the session's local-only metadata cache after the client has durably committed metadata. This intentionally emits no document/access event and does not touch the transport or CRDT state.

  Parameters

  • metadata: DocumentMetadata | undefined
  • persistedAt: number

  Returns void

approveForkResolution

• approveForkResolution(chosenControlId: string): Promise<ForkResolutionApproval>

  Sign the deterministic currently-frozen fork-resolution proposal.

  Parameters

  • chosenControlId: string

  Returns Promise<ForkResolutionApproval>

archive

• archive(): Promise<void>

  Returns Promise<void>

close

• close(): Promise<void>

  Returns Promise<void>

deleteForGroup

• deleteForGroup(): Promise<void>

  Returns Promise<void>

editText

• editText(nextText: string): Promise<void>

  Parameters

  • nextText: string

  Returns Promise<void>

flush

• flush(): Promise<void>

  Returns Promise<void>

getAccessState

• getAccessState(): DocumentAccessState

  Returns DocumentAccessState

getStatus

• getStatus(): SessionStatus

  Returns SessionStatus

getSyncMode

• getSyncMode(): SyncMode

  Returns SyncMode

getView

• getView(): DocumentView

  Returns DocumentView

inviteParticipant

• inviteParticipant(phoneNumber: string, role: DocumentRole): Promise<void>

  Parameters

  • phoneNumber: string
  • role: DocumentRole

  Returns Promise<void>

open

• open(): Promise<void>

  Returns Promise<void>

publishSnapshot

• publishSnapshot(): Promise<void>

  Persist and attempt delivery of a complete mergeable CRDT checkpoint.

  Returns Promise<void>

removeParticipant

• removeParticipant(participantId: string): Promise<void>

  Parameters

  • participantId: string

  Returns Promise<void>

resolveFork

• resolveFork(
      chosenControlId: string,
      approvals: readonly ForkResolutionApproval[],
  ): Promise<void>

  Publish a resolution only when the complete pre-fork admin quorum approved it.

  Parameters

  • chosenControlId: string
  • approvals: readonly ForkResolutionApproval[]

  Returns Promise<void>

setParticipantRole

• setParticipantRole(participantId: string, role: DocumentRole): Promise<void>

  Parameters

  • participantId: string
  • role: DocumentRole

  Returns Promise<void>

setSyncMode

• setSyncMode(mode: SyncMode): void

  Parameters

  • mode: SyncMode

  Returns void

spliceText

• spliceText(edit: TextEdit): Promise<void>

  Parameters

  • edit: TextEdit

  Returns Promise<void>

subscribe

• subscribe(listener: (event: DocumentSessionEvent) => void): () => void

  Parameters

  • listener: (event: DocumentSessionEvent) => void

  Returns () => void

unarchive

• unarchive(): Promise<void>

  Returns Promise<void>