mobile.clearNotifications

Drops notifications displayed on the mobile device.

Syntax

ui.Interface.frontCall("mobile", "clearNotifications",
   [options], [status] )
  1. options - Is a record defined with the following members:
    • id_list - A dynamic array of integers containing the list of notification ids to be removed.
    • channel_name - The name of a group of notifications to be removed.
  2. status - Holds the status of the front call execution.

Usage

The "clearNotifications" front call deletes all notifications identified by the ids provided in the options record, or all notifications related to a notification channel.

Notifications cleared with this front call will not appear in the next call to getLastNotificationInteractions.

When passing NULL as option parameter, all notifications (remote and local) will be deleted.

Example

DEFINE ret STRING
DEFINE options RECORD 
    id_list DYNAMIC ARRAY OF INTEGER,
    channel_name STRING
END RECORD
LET options.id_list[1] = 1768
LET options.id_list[2] = 2234
LET options.id_list[3] = 3239
LET options.channel_name = "Shipping"
CALL ui.Interface.frontCall("mobile","clearNotifications",[options],[ret])