Live state sync
getLiveStateData()
Retrieves live state data as an observable based on the provided ID.
- Signature:
getLiveStateData(liveStateDataId?: string): Observable<any> - Params:
liveStateDataId?: string - Returns:
Observable<any>
setLiveStateData()
Sets live state data for the provided ID and data.
- Signature:
setLiveStateData(liveStateDataId: string, liveStateData: any): any - Params:
liveStateDataId: string , liveStateData: any - Returns:
any
enableSingleEditorMode()
Enables the single editor mode with an optional configuration.
- Signature:
enableSingleEditorMode(config?: SingleEditorConfig): void - Params:
config?: SingleEditorConfig - Returns:
void
disableSingleEditorMode()
Disables the single editor mode.
- Signature:
disableSingleEditorMode(): void - Params: none
- Returns:
void
isUserEditor()
Checks if the current user is an editor. Returns an observable.
- Signature:
isUserEditor(): Observable<UserEditorAccess | null> - Params: none
- Returns:
Observable<UserEditorAccess | null>
getEditor()
Retrieves the current editor information.
- Signature:
getEditor(): Observable<User | null> - Params: none
- Returns:
Observable<User | null>
setUserAsEditor()
Sets the current user as an editor.
- Signature:
setUserAsEditor(): void - Params: none
- Returns:
void
resetUserAccess()
Resets the user access.
- Signature:
resetUserAccess(): void - Params: none
- Returns:
void
singleEditorModeContainerIds()
Disables elements inside specific elements only when single editor mode is on.
- Signature:
singleEditorModeContainerIds(elementIds: string[]): void - Params:
elementIds: string[] - Returns:
void
enableAutoSyncState()
Enables the autosync state feature.
- Signature:
enableAutoSyncState(): void - Params: none
- Returns:
void
disableAutoSyncState()
Disables the autosync state feature.
- Signature:
disableAutoSyncState(): void - Params: none
- Returns:
void
requestEditorAccess()
Initiates a request for editor access.
- Signature:
requestEditorAccess(): Observable<boolean | null> - Params: none
- Returns:
Observable<boolean | null>
isEditorAccessRequested()
Checks if editor access has been requested.
- Signature:
isEditorAccessRequested(): Observable<{ requestStatus: string, requestedBy: User } | null> - Params: none
- Returns:
Observable<{ requestStatus: string, requestedBy: User } | null>
acceptEditorAccessRequest()
Accepts an editor access request.
- Signature:
acceptEditorAccessRequest(): void - Params: none
- Returns:
void
rejectEditorAccessRequest()
Rejects an editor access request.
- Signature:
rejectEditorAccessRequest(): void - Params: none
- Returns:
void
cancelEditorAccessRequest()
Cancels an editor access request.
- Signature:
cancelEditorAccessRequest(): void - Params: none
- Returns:
void
editCurrentTab()
Edits the current tab.
- Signature:
editCurrentTab(): void - Params: none
- Returns:
void
setEditorAccessTimeout()
Sets a timeout for editor access. (in milliseconds)
- Signature:
setEditorAccessTimeout(timeout: number): void - Params:
timeout: number - Returns:
void
enableEditorAccessTransferOnTimeOut()
Enables the transfer of editor access on timeout.
- Signature:
enableEditorAccessTransferOnTimeOut(): void - Params: none
- Returns:
void
disableEditorAccessTransferOnTimeOut()
Disables the transfer of editor access on timeout.
- Signature:
disableEditorAccessTransferOnTimeOut(): void - Params: none
- Returns:
void
enableDefaultSingleEditorUI()
Enables the default UI for single editor mode.
- Signature:
enableDefaultSingleEditorUI(): void - Params: none
- Returns:
void
disableDefaultSingleEditorUI()
Disables the default UI for single editor mode.
- Signature:
disableDefaultSingleEditorUI(): void - Params: none
- Returns:
void