API REFERENCE
GridSyncStatus
Fields, allowed values, and APIs that use GridSyncStatus.
Type definition
A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.
export type GridSyncStatus = 'offline' | 'connecting' | 'synced';APIs using this type
- connectCollabRoom
Starts the configured collaboration room connection and returns synchronization state.
- getSyncStatus
Reads current collaboration connection and synchronization state.
- syncStatusChanged
Emitted when collaboration synchronization changes. Distinguish connection state from completed persistent server saving.