Messages

Table of contents

• Global Functions
  • message(text)
  • log(text)
  • dialog()
  • notification()
• Dialog Object
  • title(text)
  • text(text)
  • view(uiObject)
  • positiveButton(text, callback)
  • negativeButton(text, callback)
  • neutralButton(text, callback)
  • autoDismiss(boolean)
  • show()
• Notification Object
  • id(value)
  • title(text)
  • text(content)
  • bigText(content)
  • smallIcon(icon)
  • largeIcon(icon)
  • alertOnce()
  • show()

Global Functions

message(text)

Displays a brief notification message to the user.

Parameters

Parameter	Type	Description
text	string	The text content of the notification to display

Example

message("Operation completed successfully");

log(text)

Writes a line to the script’s log file.

Parameters

Parameter	Type	Description
text	string	The text to write to the log file

Example

log("Starting data processing...");

dialog()

Creates a dialog builder for constructing and displaying modal dialogs.

Returns

Returns a Dialog object that can be used to configure and display the dialog.

Example

const myDialog = dialog()
    .title("Confirm Action")
    .text("Are you sure you want to proceed?")
    .positiveButton("Yes", () => {
        log("User confirmed action");
        return true;
    })
    .negativeButton("No", () => {
        log("User cancelled action");
        return true;
    })
    .show();

notification()

Creates a notification builder for constructing and displaying system notifications.

Returns

Returns a Notification object that can be used to configure and display the notification.

Example

notification()
    .id(1)
    .title("New Message")
    .text("You have received a new message")
    .bigText("Long message content here...")
    .show();
log("Notification displayed");

Dialog Object

A builder object for creating and customizing dialog windows.

title(text)

Sets the title of the dialog.

Parameters

Parameter	Type	Description
text	string	The title text to display

text(text)

Sets the main content text of the dialog.

Parameters

Parameter	Type	Description
text	string	The main message text

view(uiObject)

Sets a custom view for the dialog.

Parameters

Parameter	Type	Description
uiObject	UI Object	A custom UI object to display in the dialog

positiveButton(text, callback)

Adds a positive action button to the dialog.

Parameters

Parameter	Type	Description
text	string	The button text
callback	function	Function to execute when button is clicked

negativeButton(text, callback)

Adds a negative action button to the dialog.

Parameters

Parameter	Type	Description
text	string	The button text
callback	function	Function to execute when button is clicked

neutralButton(text, callback)

Adds a neutral action button to the dialog.

Parameters

Parameter	Type	Description
text	string	The button text
callback	function	Function to execute when button is clicked

autoDismiss(boolean)

Controls whether the dialog automatically closes after button click.

Parameters

Parameter	Type	Description
boolean	boolean	If false, dialog only closes when callback returns true

show()

Displays the configured dialog.

Notification Object

A builder object for creating and customizing system notifications.

id(value)

Sets the unique identifier for the notification.

Parameters

Parameter	Type	Description
value	integer	Unique ID for the notification

title(text)

Sets the notification title.

Parameters

Parameter	Type	Description
text	string	The title text

text(content)

Sets the notification content text.

Parameters

Parameter	Type	Description
content	string	The main notification text

bigText(content)

Sets the expanded notification text.

Parameters

Parameter	Type	Description
content	string	The expanded text content

smallIcon(icon)

Sets the small notification icon.

Parameters

Parameter	Type	Description
icon	iconCode	The icon code to use

largeIcon(icon)

Sets the large notification icon.

Parameters

Parameter	Type	Description
icon	iconCode/URL	Icon code or image URL

alertOnce()

Configures the notification to alert only once.

show()

Displays the configured notification.