Skip to main content

Describes the result returned from showing a dialog.

Properties (3)

Property Type Default Required Description
action⚓︎ "clicked" | "closed" | "expired" x

If the user clicks a button in the dialog, this will be set to "clicked". If the dialog was closed using its "Close" button, this will be set to "closed". If the dialog has a timer and it expires before any user interaction occurs, this will be set to "expired".

button⚓︎ "negative" | "affirmative" | "cancel" x x

Specifies which button the user has clicked.

value⚓︎ string x x

The string value from the user input of a SingleInputDialog dialog. This value will be available only when the value of the button property is "affirmative". If the input filed is empty when the user clicks the affirmative button, this will be an empty string.