Interface WorkspacePlatformProvider

Hierarchy

PlatformProvider
- WorkspacePlatformProvider

Methods

applyWorkspace

applyWorkspace(payload): Promise<boolean>
Applies a workspace to the user's desktop. Makes that workspace the active workspace.
Parameters
- payload: ApplyWorkspacePayload
Returns Promise<boolean>
true if the workspace was applied, false if the workspace was not applied.

createSavedPage

createSavedPage(req): Promise<void>
Implementation for creating a saved page in persistent storage.
Parameters
- req: CreateSavedPageRequest
  
  the create saved page request.
Returns Promise<void>

createSavedWorkspace

createSavedWorkspace(req): Promise<void>
Implementation for creating a saved workspace in persistent storage.
Parameters
- req: CreateSavedWorkspaceRequest
  
  the create saved workspace request.
Returns Promise<void>

deleteSavedPage

deleteSavedPage(id): 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>

deleteSavedWorkspace

deleteSavedWorkspace(id): 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>

getDockProviderConfig

getDockProviderConfig(id): Promise<DockProviderConfigWithIdentity>
Implementation for getting the dock provider from persistent storage.
Parameters
- id: string
  
  The id of the dock provider to get.
Returns Promise<DockProviderConfigWithIdentity>

getSavedPage

getSavedPage(id): Promise<Page>
Implementation for getting a single page in persistent storage.
Parameters
- id: string
Returns Promise<Page>

getSavedPages

getSavedPages(query?): Promise<Page[]>
Implementation for getting a list of saved pages from persistent storage.
Parameters
- Optional query: string
  
  an optional query.
Returns Promise<Page[]>

getSavedWorkspace

getSavedWorkspace(id): Promise<Workspace>
Implementation for getting a single workspace in persistent storage.
Parameters
- id: string
Returns Promise<Workspace>

getSavedWorkspaces

getSavedWorkspaces(query?): Promise<Workspace[]>
Implementation for getting a list of saved workspaces from persistent storage.
Parameters
- Optional query: string
  
  an optional query.
Returns Promise<Workspace[]>

getSelectedScheme

getSelectedScheme(): ColorSchemeOptionType
Implementation for getting selected theme scheme.

Returns ColorSchemeOptionType

handleAnalytics

handleAnalytics(req): Promise<void>
Implementation for handling Workspace analytics events
Parameters
- req: AnalyticsEvent[]
  
  the payload received by the provider
Returns Promise<void>

openGlobalContextMenu

openGlobalContextMenu(req, callerIdentity): 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>

openPageTabContextMenu

openPageTabContextMenu(req, callerIdentity): 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>

openSaveButtonContextMenu

openSaveButtonContextMenu(req, callerIdentity): 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>

openViewTabContextMenu

openViewTabContextMenu(req, callerIdentity): 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>

saveDockProviderConfig

saveDockProviderConfig(config): 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>

setSelectedScheme

setSelectedScheme(schemeType): Promise<void>
Implementation for setting selected theme scheme.
Parameters
- schemeType: ColorSchemeOptionType
  
  scheme to be set
Returns Promise<void>

updateSavedPage

updateSavedPage(req): Promise<void>
Implementation for updating a saved page in persistent storage.
Parameters
- req: UpdateSavedPageRequest
  
  the update saved page request.
Returns Promise<void>

updateSavedWorkspace

updateSavedWorkspace(req): Promise<void>
Implementation for updating a saved workspace in persistent storage.
Parameters
- req: UpdateSavedWorkspaceRequest
  
  the update saved workspace request.
Returns Promise<void>

Interface WorkspacePlatformProvider

Hierarchy

Index

Methods

Methods

applyWorkspace

Parameters

payload: ApplyWorkspacePayload

Returns Promise<boolean>

createSavedPage

Parameters

req: CreateSavedPageRequest

Returns Promise<void>

createSavedWorkspace

Parameters

req: CreateSavedWorkspaceRequest

Returns Promise<void>

deleteSavedPage

Parameters

id: string

Returns Promise<void>

deleteSavedWorkspace

Parameters

id: string

Returns Promise<void>

getDockProviderConfig

Parameters

id: string

Returns Promise<DockProviderConfigWithIdentity>

getSavedPage

Parameters

id: string

Returns Promise<Page>

getSavedPages

Parameters

Optional query: string

Returns Promise<Page[]>

getSavedWorkspace

Parameters

id: string

Returns Promise<Workspace>

getSavedWorkspaces

Parameters

Optional query: string

Returns Promise<Workspace[]>

getSelectedScheme

Returns ColorSchemeOptionType

handleAnalytics

Parameters

req: AnalyticsEvent[]

Returns Promise<void>

openGlobalContextMenu

Parameters

req: OpenGlobalContextMenuPayload

callerIdentity: Identity

Returns Promise<void>

openPageTabContextMenu

Parameters

req: OpenPageTabContextMenuPayload

callerIdentity: Identity

Returns Promise<void>

openSaveButtonContextMenu

Parameters

req: OpenSaveButtonContextMenuPayload

callerIdentity: Identity

Returns Promise<void>

openViewTabContextMenu

Parameters

req: OpenViewTabContextMenuPayload

callerIdentity: Identity

Returns Promise<void>

saveDockProviderConfig

Parameters

config: DockProviderConfigWithIdentity

Returns Promise<void>

setSelectedScheme

Parameters

schemeType: ColorSchemeOptionType

Returns Promise<void>

updateSavedPage

`Optional` query: string

`Optional` query: string