getBadgeNumber (iOS)

Returns the current badge number associated to the app.

Syntax

ui.Interface.frontCall("ios", "getBadgeNumber",
  [],[value])
  • value - Holds the current badge number.

Usage

The iOS "getBadgeNumber" front call returns the current badge number associated to the app.

Important: This front call is only available for an application running on an iOS device.

The badge number appears on the app icon and is typically used for Push notifications.

Important: In order to query or set the badge number, the app program must have executed a registerForRemoteNotifications front call before (in the current or prior execution instance). This registration is required in order to set the appropriate app permissions to access badge number data.

Example

DEFINE value INTEGER
CALL ui.interface.frontcall("ios","getBadgeNumber",[],[value])