1

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>
2

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
3

enableSingleEditorMode

Enables the single editor mode with an optional configuration.

Signature:

enableSingleEditorMode(config?: SingleEditorConfig): void

Params:

config?: SingleEditorConfig

Returns:

void
4

disableSingleEditorMode

Disables the single editor mode.

Signature:

disableSingleEditorMode(): void

Params:

none

Returns:

void
5

isUserEditor

Checks if the current user is an editor. Returns an observable.

Signature:

isUserEditor(): Observable<UserEditorAccess | null>

Params:

none

Returns:

Observable<UserEditorAccess | null>
6

getEditor

Retrieves the current editor information.

Signature:

getEditor(): Observable<User | null>

Params:

none

Returns:

Observable<User | null>
7

setUserAsEditor

Sets the current user as an editor.

Signature:

setUserAsEditor(): void

Params:

none

Returns:

void
8

resetUserAccess

Resets the user access.

Signature:

resetUserAccess(): void

Params:

none

Returns:

void
9

singleEditorModeContainerIds

Disables elements inside specific elements only when single editor mode is on.

Signature:

singleEditorModeContainerIds(elementIds: string[]): void

Params:

elementIds: string[]

Returns:

void
10

enableAutoSyncState

Enables the autosync state feature.

Signature:

enableAutoSyncState(): void

Params:

none

Returns:

void
11

disableAutoSyncState

Disables the autosync state feature.

Signature:

disableAutoSyncState(): void

Params:

none

Returns:

void
12

requestEditorAccess

Initiates a request for editor access.

Signature:

requestEditorAccess(): Observable<boolean | null>

Params:

none

Returns:

Observable<boolean | null>
13

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>
14

acceptEditorAccessRequest

AccessRequest

Accepts an editor access request.

Signature:

acceptEditorAccessRequest(): void

Params:

none

Returns:

void
15

rejectEditorAccessRequest

Rejects an editor access request.

Signature:

rejectEditorAccessRequest(): void

Params:

none

Returns:

void
16

cancelEditorAccessRequest

Cancels an editor access request.

Signature:

cancelEditorAccessRequest(): void

Params:

none

Returns:

void
17

editCurrentTab

Edits the current tab.

Signature:

editCurrentTab(): void

Params:

none

Returns:

void
18

setEditorAccessTimeout

Sets a timeout for editor access. (in milliseconds)

Signature:

setEditorAccessTimeout(timeout: number): void

Params:

timeout: number

Returns:

void
19

enableEditorAccessTransferOnTimeOut

Enables the transfer of editor access on timeout.

Signature:

enableEditorAccessTransferOnTimeOut(): void

Params:

none

Returns:

void
20

disableEditorAccessTransferOnTimeOut

Disables the transfer of editor access on timeout.

Signature:

disableEditorAccessTransferOnTimeOut(): void

Params:

none

Returns:

void
21

enableDefaultSingleEditorUI

Enables the default UI for single editor mode.

Signature:

enableDefaultSingleEditorUI(): void

Params:

none

Returns:

void
22

disableDefaultSingleEditorUI

Disables the default UI for single editor mode.

Signature:

disableDefaultSingleEditorUI(): void

Params:

none

Returns:

void