DialogAPI interface
An interface representing dialog related APIs
Methods
| close(Close |
Closes dialogs |
| open(Open |
Opens a dialog that loads the workload app |
| open(Open |
Opens a message box |
Method Details
close(CloseUIConfig)
Closes dialogs
function close(config?: CloseUIConfig): Promise<CloseUIResult>Parameters
- config
- CloseUIConfig
The configuration for closing dialogs, including whether to close all dialogs or just the top dialog, etc.
Returns
Promise<CloseUIResult>
A promise which resolves when dialogs are closed
open(OpenDialogConfig)
Opens a dialog that loads the workload app
function open(config: OpenDialogConfig): Promise<OpenUIResult>Parameters
- config
- OpenDialogConfig
The configuration of the dialog, including the name of the workload app providing the dialog UI, the route to locate the dialog UI in the workload app, the dialog size, etc.
Returns
Promise<OpenUIResult>
A promise which resolves when the dialog is opened
open(OpenMessageBoxConfig)
Opens a message box
function open(config: OpenMessageBoxConfig): Promise<OpenMessageBoxResult>Parameters
- config
- OpenMessageBoxConfig
The configuration of the message box, including the title, body, buttons (up to three), etc.
Returns
Promise<OpenMessageBoxResult>
A promise which resolves when the message box is opened