Interface DialogScope

API to open, close and communicate with dialogs.

since: 13.2

Hierarchy

DialogScope

Index

Methods

Methods

cancel

cancel(): Promise<void>

- Defined in api.ts:431
Closes an open dialog, rejecting the promise returned by open.

since

13.2

Returns Promise<void>

close

close(value: any): Promise<void>

- Defined in api.ts:439
Closes an open dialog, resolving the promise returned by open with a value.

since

13.2

Parameters
- value: any
  
  The value selected in the dialog. The value should be compatible with the structured clone algorithm.
Returns Promise<void>

open

open(options: DialogProperties): Promise<void>

- Defined in api.ts:445
Opens a dialog.

since

13.2

Parameters
- options: DialogProperties
Returns Promise<void>

options

options(): Promise<DialogProperties>

- Defined in api.ts:451
since

13.2

Returns Promise<DialogProperties>

A Promise that resolves with DialogProperties of the current dialog.