- Overview of Sending Push Notifications
- Sending push notifications
- About Notification Payloads
- Troubleshooting common errors
Overview of Sending Push Notifications
Dashboard let you send push notifications to your Android and iOS application users. Mobile Backend Services acts the push provider on behalf of your application; that is, it communicates with the Google Cloud Messaging (GCM) or the Firebase Cloud Messaging (FCM) for Android service or Apple Push Notification Service (APNS). Firebase Cloud Messaging (FCM) is the new version of GCM.
Before you can send a push notification from Dashboard, the following must be done first:
- In Dashboard, configure Mobile Backend Services to communicate with either FCM or GCM for Android service or APNS.
- Your application needs to do the following:
- Obtain a device token from APNS or from FCM or GCM, respectively.
- Subscribe the user to at least one push notification channel. Channels provide a publish-subscribe model for push notifications. There are two ways an application can subscribe a user to receive push notifications: session-based subscriptions and token-based subscriptions.
How your application subscribes its users (session- or token-base subscriptions) determine, to a degree, your options for delivering notifications. In short, if you need to send notifications to specific API Builder users, use session-based subscriptions. For instance, a mobile banking app would want to notify individual account holders. If you don't need to target specific users, token-based subscriptions are a good approach, as it doesn't require the additional step of setting up an API Builder account.
Sending push notifications
To send a push notification, you provide Dashboard with the following information:
- Notification recipients and channel – If your application users were subscribed using session-based subscriptions, you can send a notification to specific API Builder users subscribed to a particular channel. For token-based subscriptions, you can send notifications to all users subscribed to a particular channel, or all users regardless of their channel subscriptions.
- Notification schedule – You can send a notification immediately, or schedule it to be sent at a future date and time. Scheduled notifications can be one-time or recurring.
- Notification payload – The content of the notification, which consists minimally of an alert string to display, and optionally a sound to play or badge display. See About Notification Payloads.
To send a notification to users located in a geographic area, the application must have first provided their current location to API Builder. For details, see Updating Subscriptions with Device Location.
Appcelerator Dashboard provides two views for sending notifications, Standard and Advanced. The Standard view provides an easy way to send notifications without having to understand the payload structure. In the Advanced view, you manually create the JSON payload. The advanced form provides additional flexibility, such as including custom payload fields.
To send a push notification from Dashboard:
- In Dashboard, select your application from the Apps menu.
- From the left-side navigation, select Cloud > Push Notifications.
- Click Send Push Notification to open the Send Push Notification form.
- Select either the Standard or Advanced tab.
- Select Recipients and (optionally) the notification Channel Name:
- To send a notification to all users regardless of their channel subscriptions, select All Users and leave the Channel Name field blank.
- To send a notification to all users subscribed to a particular channel, select All Users and enter the channel name in the Channel Name field.
- To send a notification to specific users who are subscribed to a particular channel, select Specific Users, then:
- Click the add (+) button in the To Users field.
- Select the desired recipients from the list of users. To locate a particular user, enter their username in the search field.
- In the Channel Name field enter the name of the target channel subscription. Note: You must specify a channel when sending a notification to specific users.
- To send a notification to all users located within a geographic selection, select Geographic Selection, then:
- Click the add (+) button in the Place field and select an existing Place. This defines the center points of the geographic selection. The selected Place must have a defined latitude and longitude.
In the Radius field, enter the distance (in Miles or Meters) from the selected Place to define the size of the geographic selection.
- To specify when to deliver the notification, in the Send When field, select one of the following options:
- To send the notification immediately, select Send Now.
- To schedule a one-time notification, select One-Time and then select the delivery date and time (All times are in UTC.)
- To schedule a recurring notification, select Recurring, select the start date and time, the end date, and the recurrence interval: Daily, Weekly, or Monthly. (All times are in UTC.)
- To define the notification payload using the Standard view:
- In the Alert field, enter the notification message to display on the device.
In the Badge field, enter a badge value. See Notification Badges for details.
In the Sound field, select None, Default, or Custom. See Notification Sounds for details.
For iOS devices:
In the Content-Available field, check the box to indicate that new content is available. This is used to support Newsstand apps and background content downloads.
In the Category field, enter the name of the category to use for interactive notifications. See iOS Interactive Notifications.
- For Android devices:
- in the Vibrate field, select No or Yes to have the device vibrate or not upon receipt of the notification.
- In the Title field (Android, only), select the title to display in the Alert message. See Notification Titles for details.
- In the Icon field (Android, only), specify the name of the image file to display as the notification icon. See Notification Icons for details.
- To define the notification payload using the Advanced view:
- In the Custom JSON field, enter a valid JSON string (see Custom JSON Payloads for details).
- In the Custom JSON field, enter a valid JSON string (see Custom JSON Payloads for details).
- Click Send Now.
About Notification Payloads
The content, or payload, of a push notification, is a JSON-encoded object whose fields contain the payload values. The JSON object typically contains one of the "standard" notification fields. Standard fields are supported by both iOS and Android devices. Some fields are platform-specific, such as
title, that are only used by Android, or
content-available, that are only used by iOS 8 devices and later.
Standard fields include the following:
alert– The notification message displayed to the user.
badge– A number to display with the notification. See Notification badges.
sound– The name of an audio file to play when the notification arrives, minus its extension. See Notification sounds.
Android devices support the following additional fields:
icon– The name of the image file to display as the icon, minus its extension.
title– Title displayed above the alert text. Defaults to the application name.
vibrate– A boolean that the device to vibrate momentarily upon receipt.
See Android-specific notification fields for more information about specifying these fields.
iOS 8 devices and later support the following additional fields:
category– The name of the category to use for interactive notifications. See iOS Interactive Notifications for more information.
content-available– If set to 1, indicates that new content is available. This is used to support Newsstand apps and background content downloads.
The payload can also include custom fields that your application can read and use as desired. See Custom JSON Payloads for an example of using custom fields.
Custom JSON payloads
Appcelerator Dashboard provides two forms, Standard and Advanced, for you to compose the payload. In the Standard form, you use common form controls to compose the payload, without having to write JSON code. In the Advanced form, you manually enter the JSON-encoded string that's sent in the notification. The JSON object can contain any of the standard fields discussed in About Notification Payloads, or custom fields specific to your application. For example, the following payload contains
sound fields, as well as a custom field named
Below is a more advanced custom JSON payload:
When the device receives this payload, it will do the following:
- Display the "Sample alert" message.
- Increment the current badge value by two.
- Play the "door_bell" audio file.
- On Android devices:
- The notification title will be set to "Example"
- The device will vibrate
- The "little_star" icon will be displayed in the notification area.
- On iOS 8 devices and later:
- The user notification actions associated with the "sampleCategory" user notification category.
About JSON Payloads Delivered to Devices
The notification payload that Mobile Backend Services delivers to either FCM or GCM or APNS is slightly modified from the original JSON payload you provide to Dashboard. Also, the payloads are slightly different for Android and iOS devices.
For Android, all Android-specific fields are contained in an
android dictionary, while all other iOS-only and custom fields are top-level keys of the payload. For example, the payload shown in Custom JSON payloads will be delivered to an Android application as follows:
For iOS devices, all iOS-specific fields are contained in an aps dictionary, while all Android-specific and custom fields are top-level keys of the payload. For example, For example, the payload shown in Custom JSON payloads will be delivered to an iOS application as follows:
Interactive Notifications (iOS 8 and later)
As of Titanium SDK v3.4.0, you can create interactive notifications, which users running iOS 8 or later can respond to without launching the application to the foreground.
Your Titanium application defines one or more a notification categories, each of which consists of one or more notification actions. When you create a push notification in Dashboard, the Category form field lets you specify the category of interactive notification to display when the push notification arrives.
To create an interactive notification:
- In your Titanium application:
- Create and configure notification actions.
- Create notification categories and assign notification actions to them.
Register the application for the desired notification categories, and to receive push notifications.
- Register an event listener for the
remotenotificationactionevent, to respond to user actions when they interact with the notification.
- In Dashboard, send a new push notification and set the Category field to the desired notification category to use.
When the notification arrives, the device displays the set of actions defined by the category. The remotenotificationaction event fires when the user interacts with the notification.
Silent Push Notifications (iOS 7 and later)
The Content-Available form field lets you silently notify a Titanium or native iOS/Android application, without alerting the user at all. A silent push is often used to alert the application that new content is available to download. Once the download (or another task) initiated by the silent push is complete, the application can display a notification to the user that new content is available.
For detailed steps on enabling silent push notifications in your Titanium application, see Silent Push in the Titanium SDK guides.
A badge is a number displayed on the application icon (on iOS), or in the notification area (on Android). You can specify a specific badge value to display (2 or 10, for example), or a number prefixed by plus (+) or minus (-) symbol (+3 or -6, for example). When prefixed, the currently displayed badge number is incremented or decremented by the specified amount, respectively. To remove an application badge on iOS, specify a badge value of 0 (zero).
sound field in a notification payload specifies the name (minus the extension) of a local sound file resource to play the notification arrives. When a push notification arrives, you can specify a custom sound to play, the default system sound, or no sound.
- For Android applications built with Titanium, place the file in the
- For iOS applications built with Titanium, place the file in the
- For native Android applications, place the file in the
- For native iOS applications, place the file in the main bundle.
Android-specific payload fields
In addition to the standard notification fields
(alert, badge, and
sound) Android devices support the following fields:
Titanium application may also specify any of the properties in Titanium.Android.Notification, except for
deleteIntent. For instance, you can add a
tickerText field to the notification payload that scrolls the specified text across the notification area.
Title – A string to display above the alert message in the notification area. If not specified in the payload, the application's name is displayed, as specified by the <name> element in your project's tiapp.xml file.
icon payload field specifies an image to display with the notification on Android devices. (For image specifications, see Icons and Splash Screens: Notification Icons.) It's value is the name of a local image file, minus the extension of the icon to display. The file must be placed your project's /res/drawable folder for native Android applications, or the /Resources folder Titanium applications. By default, the application's icon is displayed with the notification.
A boolean that specifies whether the device should vibrate when the notification arrives.
Troubleshooting common errors
This section lists errors that may occur when sending push notifications.
'Subscription not found' error
In general, this error indicates that the recipients you selected are not subscribed to the specified channel. If you're sending a notification to specific API Builder users, make sure that those users are subscribed to the specified channel. Or, if you're sending a token-based notification (not addressed to specific users) make sure that channel name you specified has at least one subscriber. See Viewing subscribed devices for more information.
When sending a geo-based push notification, this error can also indicate that no devices were found in the selected geographic area. Try the following:
- Make sure your application is sending its current location to API Builder. See Updating Subscriptions with Device Location. Devices must report their location to API Builder to enable geo-based push.
- Try using a larger Radius value to encompass a larger geographic area.