Data Models
LiveStateData
LiveStateData
Class
Property | Type | Optional | Description |
---|---|---|---|
`id | string | No | A unique identifier likely used for quick reference and indexing. It’s an MD5 hash of liveStateDataId . |
liveStateDataId | string | No | A unique identifier for the state data being synced. |
data | string | number | boolean | JSON | No | The actual data you want to synchronize across clients. |
lastUpdated | any | No | A timestamp or similar data indicating the last time the state data was updated. |
updatedBy | User | No | The user who last updated the state data. |
tabId | string | null | Yes | An identifier that could be used to associate the state data with a specific tab or instance. |
SingleEditorLiveStateData
Class
Property | Type | Optional | Description |
---|---|---|---|
editor | User | null | Yes | The user who is currently editing, if any. |
requestEditorAccess | Object | null | Yes | Details about a request for editor access. |
tabId | string | null | Yes | The identifier of the tab, if applicable. |
requestEditorAccess
Class:
Property | Type | Optional | Description |
---|---|---|---|
user | User | No | The user requesting editor access. |
requestedAt | any | No | The timestamp when the access was requested. |
status | ‘pending’ | ‘accepted’ | ‘rejected’ | ‘cancelled’ | No | The status of the access request. |
editorAccessTimeout | number | No | Timeout duration for the editor access. |
tabId | string | null | Yes | The identifier of the tab related to the access request. |
SingleEditorConfig
Class
Property | Type | Optional | Description |
---|---|---|---|
customMode | boolean | Yes | Enables/disables custom mode. In custom mode, input elements are not disabled for the viewer. |
singleTabEditor | boolean | No | Enables/disables editor mode on a single tab only. |
UserEditorAccess
Class
Property | Type | Optional | Description |
---|---|---|---|
isEditor | boolean | Yes | Indicates whether the user has editor privileges. |
isEditorOnCurrentTab | boolean | Yes | Indicates whether the user is an editor on the current tab. |
Was this page helpful?