Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ScrollSyncSession

A class representing a scroll sync session.

Hierarchy

Index

Properties

Accessors

Methods

Properties

documentId

documentId: string

The document ID of the session

leader

leader: User

The "leader" of the session

id

id: string

position

position: ScrollSyncPosition

The current scroll position of the session

__type

__type: keyof EntityStateMetadata

Accessors

isActive

  • get isActive(): boolean

  • True if this session is the currently active session

    Returns boolean

Methods

exit

  • exit(): Promise<boolean>

  • Exits the current session. If the current user is the leader of the session, the session will be ended for everyone connected.

    Returns Promise<boolean>

join

  • join(): Promise<void>

  • Connects the current user to the session. Throws if the session cannot be joined

    Returns Promise<void>

Generated using TypeDoc