LocalNotifications external object

Official Content
This documentation is valid for:

The LocalNotifications external object enables you to alert users of scheduled events or alarms in the background, with no servers required.

LocalNotificationsexternalobject-Location_png LocalNotifications external object - Structure

Properties

It does not have any.

Methods

CreateAlerts method

Creates a set of local notifications (or alerts) by indicating when each of them will be triggered and the text which will be displayed. It returns 0 if the operation ends successfully.

Return value  Numeric(5.0)
Parameters alerts:LocalNotificationsInfo


ListAlerts method

Lists every local notification (or alert) previously created.

Return value  LocalNotificationsInfo
Parameters None


RemoveAlerts method

Removes a set of local notifications (or alerts), each of them identified by its triggered timestamp and its text. It returns 0 if the operation ends successfully.

Return value  Numeric(5.0)
Parameters alerts:LocalNotificationsInfo


RemoveAllAlerts method

Removes every local notification (or alerts) from the device.  It returns 0 if the operation ends successfully.

Return value  Numeric(5.0)
Parameters None
 

Events

It does not have any

Structured Data Types

LocalNotificationsInfo

Information about a local notification. It is a collection of the following pairs:

  • DateTime:DateTime
    When the local notification will be triggered. If you do not set this field (leave it empty), the notification will be triggered instantly.
     
  • Text:VarChar(128)
    The text displayed on the local notification.

Scope

Platforms  Smart Devices (iOS, Android)

See also





Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.