About
Support
Developer Guide
Version 19.1.20
Preparing search index...
The search index is not available
OpenFin Workspace Platform API
OpenFin Workspace Platform API
Workspace
Interface Workspace
Hierarchy
Workspace
Index
Properties
metadata?
snapshot
title
workspace
Id
Properties
Optional
metadata
metadata
?:
WorkspaceMetadata
snapshot
snapshot
:
BrowserSnapshot
title
title
:
string
While not required, it is suggested that Workspace titles be unique.
workspace
Id
workspace
Id
:
string
Settings
Theme
OS
Light
Dark
On This Page
metadata
snapshot
title
workspace
Id
Open
Fin
Workspace
Platform API
App
Manifest
Type
Browser
Button
Type
Color
Scheme
Option
Type
Custom
Action
Caller
Type
Global
Context
Menu
Option
Type
Page
Change
Event
Type
Page
Tab
Context
Menu
Option
Type
Panel
Position
Save
Button
Context
Menu
Option
Type
View
Tab
Menu
Option
Type
Window
Type
Analytics
Config
App
App
Intent
Appearance
Context
Menu
Item
Data
Apply
Snapshot
Options
Apply
Workspace
Options
Base
Theme
Options
Browser
Create
View
Payload
Browser
Create
View
Request
Browser
Create
Window
Request
Browser
Init
Config
Browser
Snapshot
Browser
View
State
Browser
Window
Factory
Browser
Window
Module
Browser
Workspace
Platform
View
Options
Browser
Workspace
Platform
Window
Options
Context
Menu
Item
Data
Copy
Page
Payload
Create
Saved
Page
Request
Create
Saved
Workspace
Request
Custom
Action
Specifier
Custom
Actions
Map
Custom
Browser
Button
Config
Custom
Button
Action
Payload
Custom
Button
Config
Custom
Dropdown
Item
Action
Payload
Custom
Palette
Set
Custom
Theme
Options
Custom
Theme
Options
With
Scheme
Global
Context
Menu
Item
Data
Global
Context
Menu
Option
Action
Payload
Handle
Page
Changes
Payload
Handle
Save
Modal
On
Page
Close
Payload
Image
Launch
App
Request
Modified
Page
State
Notification
Indicator
Colors
Set
Notification
Indicator
Colors
Set
Dark
Scheme
Notification
Indicator
Colors
Set
Light
Scheme
Open
Global
Context
Menu
Request
Open
Page
Tab
Context
Menu
Request
Open
Save
Button
Context
Menu
Request
Open
Save
Context
Menu
Option
Action
Payload
Open
View
Tab
Context
Menu
Request
Page
Page
Context
Added
Details
Page
Context
Removed
Details
Page
Layout
Details
Page
Tab
Context
Menu
Item
Data
Page
Tab
Context
Menu
Item
Template
Page
Tab
Context
Menu
Option
Action
Payload
Panel
Config
Horizontal
Panel
Config
Vertical
Pre
Defined
Button
Config
Reorder
Pages
Request
Reparent
Page
Request
Save
Button
Context
Menu
Item
Data
Save
Button
Context
Menu
Item
Template
Save
Modal
On
Page
Close
Result
Set
Active
Page
For
Window
Payload
Should
Page
Close
Payload
Should
Page
Close
Result
Store
Custom
Button
Action
Payload
Theme
Api
Theme
Extension
Toolbar
Options
Update
Attached
Page
Request
Update
Saved
Page
Request
Update
Saved
Workspace
Request
Url
Change
Details
View
Added
Details
View
Removed
Details
View
Tab
Custom
Action
Payload
View
Tab
Menu
Data
Views
Preventing
Unload
Payload
Window
State
Button
Options
Workflow
Integration
Workspace
Workspace
Context
Menu
Item
Data
Workspace
Platform
Init
Config
Workspace
Platform
Module
Workspace
Platform
Provider
Workspace
Platform
Storage
Workspace
Theme
Set
Analytics
Event
Apply
Workspace
Payload
Attached
Page
Browser
Override
Callback
Browser
Snapshot
Window
Custom
Action
Payload
Custom
Themes
Extended
Panel
Config
Global
Context
Menu
Item
Template
Locale
Lock
Unlock
Page
Config
Notification
Indicator
Colors
With
Scheme
Open
Global
Context
Menu
Payload
Open
Page
Tab
Context
Menu
Payload
Open
Save
Button
Context
Menu
Payload
Open
View
Tab
Context
Menu
Payload
Page
Change
Event
Details
Page
Layout
Page
With
Updatable
Runtime
Attribs
Panel
Config
Show
Hide
Tabs
Config
Taskbar
Icon
Toolbar
Button
View
Tab
Context
Menu
Template
Window
State
Button
Window
Title
Workspace
Platform
Override
Callback
SUPPORTED_
LANGUAGES
get
Current
Sync
init
wrap
Sync
While not required, it is suggested that Workspace titles be unique.