For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sending a Notification

User Guide: Launcher Tab

Sending A Notification

The Notifications screen lets an administrator send a test notification to devices. Messages are delivered over an MQTT topic, and the device displays the notification based on the JSON message submitted

Use the following steps to send a notification to the devices:

  1. Navigate to Enterprise Launcher and select Notifications.

  2. Enter a destination for the notification. This is the MQTT topic (device, store, role, or group) that determines which devices receive the message.

  3. Edit the contents of the JSON message. See Notification Body for the field descriptions and a sample notification body.

  4. Click SEND to send the notification.

Notification Body

Field
Description

notificationId

number indicates the Notification Id. Should be unique per notification. Can use the same Id to replace an existing message being displayed

contentTitle

string Title of the message to display

contentText

string Text of the message body

expandedTitle

string Expanded Text of the Message body

expandedText

array Array of string to display in the expanded message

packageName

string Represents the package to invoke if the message display is press by the user

intentAction

string Represents the ACTION to invoke if the message display is pressed by the user

intentExtras

array Array of Intent Objects to insert within the intent posted when if the message display is pressed by the user

autoCancel

boolean true/false, allow the user to dismiss the message

onGoing

boolean true/false,

useSound

boolean true/false,

useHeadsUp

boolean true/false

soundName

string Optional parameter to specify a custom audio file on the device for notifications if useSound=true AND useHeadsUp=true. Example strings: If using local file path: "/sdcard/Download/ems/MyRingTone", where the file /sdcard/Download/ems/MyRingTone.mp3 exists on the device (note to not include the file extension in the field value). If using assets: "soundName": "assets:message_tone", where an asset exists in the launcher.json such as "message_tone": "https://example-file-hosting-site.com/MyRingTone.mp3".

Example Notification Body

Last updated