Skip to main content
Version: v10.15

Notification Action

Notification Action is an action to show UI notifications in the app in the form of a toaster, alert or a confirmation box. It provides message capabilities, a way for the app to notify the end users. Based on the operation selected app can notify the user through an Alert/Confirm dialog or a simple toaster message. This action can be useful in cases like error handling, confirm user action, etc.

Action Creation​

  1. There are two ways of creating a Notification Action:

    • Select the Action option from Variables on the Workspace Toolbar

    • and click New Action from the Actions dialog.

    • or, as a New Action event on any widget

  2. In both the cases, a New Action wizard will open.

Steps in Action Window​

Choose Notification Type. It can be from the following.

Alert​

For alert, you can further specify:

  1. Text: Message to be displayed
  2. Title: for the alert pop-up
  3. OK button text: message on the button to dismiss the alert pop-up
  4. Alert Type: to be set to error, information, success or warning.

Confirm​

For confirm, you can further specify:

  1. Text: Message to be displayed
  2. Title: for the alert pop-up
  3. OK button text: message on the button to dismiss the alert pop-up
  4. Cancel button text: message on the button to dismiss the alert pop-up.

Toast​

For toast, you can further specify:

  1. Content: Message to be displayed can be inline or from a partial page
  2. Text/Page: Message to be displayed/Partial page containing the message to be displayed
  3. Duration: number of milliseconds for which the toaster should be displayed
  4. Class: type of toast message in case of inline content, can be success, error, warning or info
  5. Toaster position: where the message should be displayed – a combination of top, center, bottom, left, right.

Name​

Set by default which can be modified.

Owner​

The scope of the Action being created. By default it is set to Page, you can change it to Application if you want this action to be available across the app.

Click Done to complete the action creation process

  1. You will be directed to the Actions dialog, with the new action listed. As you can see:
    1. a Notification Action is created,
    2. With the selected target,
    3. The properties tab with action properties
    4. The events tab containing the events that can be customised (know more)

Properties​

PropertyDescription
OperationThe type of notification to be performed through the Action. Options are: - alert - a dialog with a message and button; - confirm - a dialog with a message and two buttons (for positive and negative confirmations); - toast - a toaster box with a message Based upon the operation selected following properties are available:
Alert operation
TextThe text message to be shown in the dialog. It can be a static text or can be bound to a component for dynamic behavior.
TitleDialog’s header title
Ok button textText to be displayed on the OK button of the dialog
Alert typeDisplay type of the dialog. Available options are information, success, error and warning
Confirm operation
TextThe text message to be shown in the dialog. It can be a static text or can be bound to a component for dynamic behavior.
TitleDialog’s header title
Ok button textText to be displayed on the OK button of the dialog. This button is to receive the positive response from the end user. E.g. “YES”, “YES, I AGREE”, “CONTINUE”, etc.
Cancel button textText to be displayed on the CANCEL button of the dialog. This button is to receive the negative response from the end user. E.g. “NO”, “NO, I DON’T AGREE”, “GO BACK”, etc.
Toast operation
ContentType of content to be displayed in the toaster. It can be: - inline – plain text can be provided or bound for dynamic text; - page – a partial page can be loaded into the toaster area. This is for more customized display.
TextAvailable if “Content” property is selected as inline. Text to be displayed in the toaster
PageAvailable if “Content” property is selected as the page. Partial page to be loaded into the toaster area.
DurationThe time period (in milliseconds) after which the toaster should fade away once it is shown. Select 0 if the toaster should stay.
ClassDetermines the display type of toaster. Available options are success, error, warning, info.
Toaster PositionDetermines where to display the toaster in the app. Available options are a combination of top, center, bottom, left, center, right.

Events​

Notification Action Events​

Based on the operation different events are available for a Notification Action.

Alert​

  1. OnOk: The event is fired on click of the OK button of the alert dialog. The event receives action and data as params. This data can be useful in some validation where the dialog is opened from various places. Click here for an example of passing data through invoke method and receiving it in the onOk event of the action.

Confirm​

  1. OnOk: The event is fired on click of the OK button of the confirm dialog. Please note, this event takes the positive response from the user.
  2. OnCancel: The event is fired on click of the CANCEL button of the confirm dialog. Please note, this event takes the negative response from the user.
  3. OnClose: The event is fired on the close of the confirm dialog.

Toaster​

  1. OnClick: The event is fired on click of the toaster box.
  2. OnHide: The event is fired on the hide of the toaster box.

Methods​

invoke

invoke(options)​

This method invokes the notification action

Parameters:

  • options(object): This object can have optional fields like:
    • data: some data can be passed from here, which will be received in events like onOk, onCancel, onClose, onHide

Options specific toaster type action include

  • message - text to be displayed in the toaster.
  • position - where to display the toaster. Possible values:
    • "top left"
    • "top center"
    • "top right"
    • "center left"
    • "center center"
    • "center right"
    • "bottom left"
    • "bottom center"
    • "bottom right"
  • class - type of toaster. Possible values:
    • ‘success’
    • ‘error’
    • ‘Info’
    • ‘warning’

Return Value: None

Example:

// Example 1: Notify with default set properties
Page.Actions.notificationAction1.invoke();

// Example 2: Notify with dynamic properties
Page.Actions.notificationAction1.invoke({
    "class": "info",
    "message": "My custom message",
    "position": "bottom right"
});

// Example 3: Passing data through alert type notification action
Page.Actions.notificationAction1.invoke({
    "data": {“mode”: “edit}
});

// the data will be passed to the action events onOk, onCancel, onClose, onHide
Page.notificationAction1onOk = function(variable, data) {
    console.log('data: ', data)
    // Output:
    data: {“mode”: “edit}
};