AboutSupportDeveloper GuideVersion 14.0.18

Interface WorkspacePlatformProvider

Hierarchy

  • PlatformProvider
    • WorkspacePlatformProvider

Methods

  • Applies a workspace to the user's desktop. Makes that workspace the active workspace.

    Parameters

    Returns Promise<boolean>

    true if the workspace was applied, false if the workspace was not applied.

  • Implementation for creating a saved page in persistent storage.

    Parameters

    Returns Promise<void>

  • Implementation for creating a saved workspace in persistent storage.

    Parameters

    Returns Promise<void>

  • Implementation for deleting a saved page in persistent storage.

    Parameters

    • id: string

      of the id of the page to delete.

    Returns Promise<void>

  • Implementation for deleting a saved workspace in persistent storage.

    Parameters

    • id: string

      of the id of the workspace to delete.

    Returns Promise<void>

  • Implementation for getting the dock provider from persistent storage.

    Parameters

    • id: string

      The id of the dock provider to get.

    Returns Promise<DockProviderConfigWithIdentity>

  • Implementation for getting a single page in persistent storage.

    Parameters

    • id: string

    Returns Promise<Page>

  • Implementation for getting a list of saved pages from persistent storage.

    Parameters

    • Optional query: string

      an optional query.

    Returns Promise<Page[]>

  • Implementation for getting a single workspace in persistent storage.

    Parameters

    • id: string

    Returns Promise<Workspace>

  • Implementation for getting a list of saved workspaces from persistent storage.

    Parameters

    • Optional query: string

      an optional query.

    Returns Promise<Workspace[]>

  • Implementation for handling Workspace analytics events

    Parameters

    Returns Promise<void>

  • Implementation for showing a global context menu given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.

    Parameters

    • req: OpenGlobalContextMenuPayload

      the payload received by the provider call

    • callerIdentity: Identity

      OF identity of the entity from which the request originated

    Returns Promise<void>

  • Implementation for showing a page tab context menu given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.

    Parameters

    • req: OpenPageTabContextMenuPayload

      the payload received by the provider call

    • callerIdentity: Identity

      OF identity of the entity from which the request originated

    Returns Promise<void>

  • Implementation for showing a context menu for save button given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.

    Parameters

    • req: OpenSaveButtonContextMenuPayload

      the payload received by the provider call

    • callerIdentity: Identity

      OF identity of the entity from which the request originated

    Returns Promise<void>

  • Implementation for showing a view tab context menu given a menu template, handler callback, and screen coordinates. For an example of overriding, see WorkspacePlatformOverrideCallback.

    Parameters

    • req: OpenViewTabContextMenuPayload

      the payload received by the provider call

    • callerIdentity: Identity

      OF identity of the entity from which the request originated

    Returns Promise<void>

  • Implementation for saving a dock provider config to persistent storage.

    Parameters

    • config: DockProviderConfigWithIdentity

      The new dock config to save to persistent storage.

    Returns Promise<void>

  • Implementation for setting selected theme scheme.

    Parameters

    Returns Promise<void>

  • Implementation for updating a saved page in persistent storage.

    Parameters

    Returns Promise<void>

  • Implementation for updating a saved workspace in persistent storage.

    Parameters

    Returns Promise<void>