# GridSyncStatus

Fields, allowed values, and APIs that use GridSyncStatus.

Canonical: https://grid.syidax.com/docs/types/GridSyncStatus/

<a id="definition"></a>

## 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.

```typescript
export type GridSyncStatus = 'offline' | 'connecting' | 'synced';
```

<a id="used-by"></a>

## APIs using this type

- [connectCollabRoom](https://grid.syidax.com/docs/methods/connectCollabRoom.md) — Starts the configured collaboration room connection and returns synchronization state.
- [getSyncStatus](https://grid.syidax.com/docs/methods/getSyncStatus.md) — Reads current collaboration connection and synchronization state.
- [syncStatusChanged](https://grid.syidax.com/docs/events/syncStatusChanged.md) — Emitted when collaboration synchronization changes. Distinguish connection state from completed persistent server saving.

<a id="parents"></a>

## Contracts containing this type

- [SyGridEventMap](https://grid.syidax.com/docs/types/SyGridEventMap.md)
- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)