Class ScrollSyncManager

A class that manages scroll synchronization between multiple users

Can be accessed via CollabClient.ScrollSyncManager - not to be constructed manually

Hierarchy

BoundClass
- ScrollSyncManager

Index

Properties

Accessors

Properties

availableSessions

availableSessions: ScrollSyncSession[] = []

An array of ScrollSyncSession that can be joined.

This properly is updated in real time. Subscribe to the "scrollSyncSessionsChanged" event on EventManager to know when this property is updated.

unbind

unbind: () => void

Type declaration

- (): void
- Returns void

Accessors

canCreateSession

get canCreateSession(): boolean

Returns true if a session can be created

Returns boolean

canJoinSession

get canJoinSession(): boolean

Returns true if a scroll sync session can be joined

Returns boolean

activeSession

get activeSession(): ScrollSyncSession

Gets the currently active scroll sync session

Returns ScrollSyncSession

Generated using TypeDoc