Tag-based notifications in Hybrid applications
OverviewTag notifications are notification messages that are targeted to all the devices that are subscribed to a particular tag. Tags represent topics of interest to the user and provide the ability to receive notifications according to the chosen interest.
Setting up tagsTags are defined in the
API methods for tag-based notification
Client-side API methods:
WL.Client.Push.subscribeTag(tagName,options)- Subscribes the device to the specified tag name.
WL.Client.Push.unsubscribeTag(tagName,options)- Unsubscribes the device from the specified tag name.
trueif push notifications are supported by the platform, or
WL.Client.Push.isTagSubscribed(tagName)- Returns whether the device is subscribed to a specified tag name.
Common API methods for tag-based and broadcast notifications
WLNotificationListenerDefines the callback method to be notified when the notification arrives.
client.getPush().setWLNotificationListener(listener)This method sets the implementation class of the
client.getPush().setOnReadyToSubscribeListener(listener)This method registers a listener to be used for push notifications. This listener must implement the
WLNotificationListeneris called when a push notification is received by the device.
- props - A JSON block that contains the notification properties of the platform.
- payload - A JSON block that contains other data that is sent from MobileFirst Server. The JSON block also contains the tag name for tag-based or broadcast notification. The tag name appears in the "tag" element. For broadcast notification, the default tag name is
WL.Server.sendMessage(applicationId,notificationOptions)applicationId - (mandatory) The name of the MobileFirst application. notificationOptions - (mandatory) A JSON block containing message properties. Submits a notification based on the specified target parameters.
For more information about tag-based notification, see the "tag-based notification" topic in the user documentation.
Sample applicationClick to download the Studio project. The provided sample application demonstrates how to send a broadcast notification to the default autosubscribed
push.ALLtag. The sample also demonstrates how to send notifications to two predefined tags, sample-tag1 and sample-tag2, to which the user can subscribe in the application.
Last modified on November 09, 2016