getSyncStatus

What does this API do?

Reads current collaboration connection and synchronization state.

API for Pro features: Real-time collaboration (existing Pro grade retained)

Exact input and result types

getSyncStatus(): Promise<GridSyncStatus>

The return type is Promise<GridSyncStatus>.

Usage flow

After registering and initializing the Grid element, call grid.getSyncStatus(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

Read related types

• GridSyncStatus

Feature explanations and examples

• Real-time collaboration

  Collaboration shares edits, cursors, and presence among users in the same room. A room name alone does not automatically connect devices over the internet.