Scripting API / core/DisplayApi / External
External
Classes
DisplayNotifyOptions
Properties
| Property |
Type |
Default value |
Description |
delay? |
number |
3000 |
The time in ms that the message will persist. This is overriden by the permenant field |
permanent? |
boolean |
false |
Whether the message will require user interaction to be dismissed. This overrides the delay field |
severity? |
"error" | "success" | "info" | "warn" |
undefined |
The level of importance of the message. When set to 'success', the message is green. When set to 'warn', the message is yellow. When set to 'error', the message is red. When set to 'info', the message is the default background color. |
text? |
string |
undefined |
The body of the message |
title? |
string |
undefined |
The header of the message |
Type Aliases
PromptButton = object
Properties
| Property |
Type |
Description |
return |
string | boolean | number |
The value to return when the button is clicked. |
text |
string |
The text to display on the button. |
type |
"blue" | "white" | "orange" |
The color of the button to display. It is recommended to use 'blue' for the default action, 'orange' for destructive actions, and 'white' for all other actions. |