getAllPages

Executes a command com.censhare.api.workspace.GetAllPages.

Usage: getAllPages()

Parameters: none

Returns: A promise resolved with an array of workspace pages.

getPage

Executes a command com.censhare.api.workspace.GetPage.

Usage: getPage(id: string, vars: any)

Parameters:

  • id {string} - the page ID
  • vars {any} - additional page parameters

Returns: A promise resolved with workspace page data.

getUserPreferences

Executes a command com.censhare.api.workspace.ReadPreferences.

Usage: getUserPreferences()

Parameters: none

Returns: A promise resolved with user workspace preferences map.

liveQueryOpen

Executes a command com.censhare.api.workspace.OpenWorkspace. This command sets up a live query to track workspace changes.

Usage: liveQueryOpen()

Parameters: none

Returns: A command instance.

reset

Executes a command com.censhare.api.workspace.ResetWorkspace. This command resets the workspace to its default state.

Usage: reset()

Parameters: none

Returns: A promise resolved when the command succeeds.

resetPage

Executes a command com.censhare.api.workspace.ResetPage. This command resets a page to its default configuration.

Usage: resetPage(pageId: string)

Parameters:

  • pageId {string} - a page ID

Returns: A promise resolved when the operation succeeds.

resetUserPreferences

Executes a command com.censhare.api.workspace.ResetPreferences.

Usage: resetUserPreferences()

Parameters: none

Returns: A promise with the method execution result.

savePageEvents

Executes a command com.censhare.api.workspace.ReceiveEvents.

Usage: savePageEvents(id: string, events: any)

Parameters:

  • id {string} - a page ID
  • events {any} - events to be saved

Returns: A promise with the method execution result.

saveUserPreferences

Executes a command com.censhare.api.workspace.SavePreferences.

Usage: saveUserPreferences(userPreferences: any)

Parameters:

  • userPreferences {any} - preferences map to be saved

Returns: A promise with the method execution result.