com.ibm.mobilefirstplatform.serversdk.java.push

Class NotificationBuilder

java.lang.Object

com.ibm.mobilefirstplatform.serversdk.java.push.NotificationBuilder

public class NotificationBuilder
extends Object

The NotificationBuilder is used to create a new push notification that is going to be sent using the Push Notification service in IBM® Bluemix. The push notification's message that is passed in the constructor is required. All other parameters are optional. Set them as needed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationBuilder.APNSNotificationType
static class	NotificationBuilder.GCMPriority
static class	NotificationBuilder.PushNotificationsPlatform

Field Summary

Fields

Modifier and Type	Field and Description
protected org.json.JSONObject	notification

Constructor Summary

Constructors

Constructor and Description
NotificationBuilder(String alert) Create a new NotificationBuilder to help create a new push notification.

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	build() Build the push notification as configured.
NotificationBuilder	setAPNSSettings(Integer badge, String category, String iosActionKey, org.json.JSONObject payload, String soundFile, NotificationBuilder.APNSNotificationType type) Configure specific Apple Push Notification Service (APNS) settings for iOS devices.
NotificationBuilder	setGCMSettings(String collapseKey, Boolean delayWhileIdle, org.json.JSONObject payload, NotificationBuilder.GCMPriority priority, String soundFile, Integer secondsToLive) Configure specific Google Cloud Messaging (GCM) settings.
NotificationBuilder	setMessageURL(String url) Set an optional URL to be included with the push notification.
NotificationBuilder	setTarget(String[] deviceIds, String[] userIds, NotificationBuilder.PushNotificationsPlatform[] platforms, String[] tagNames) Specify the targets that will receive the push notification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

notification

protected org.json.JSONObject notification

Constructor Detail

NotificationBuilder

public NotificationBuilder(String alert)

Create a new NotificationBuilder to help create a new push notification. This NotificationBuilder can be used to configure the push notification before it is sent, by configuring optional parameters.

Parameters:

alert - the message to be sent in the push notification

Method Detail

setMessageURL

public NotificationBuilder setMessageURL(String url)

Set an optional URL to be included with the push notification.

Parameters:

url - the URL to be included

Returns:

the NotificationBuilder object so that calls can be chained

setTarget

public NotificationBuilder setTarget(String[] deviceIds,
                                     String[] userIds,
                                     NotificationBuilder.PushNotificationsPlatform[] platforms,
                                     String[] tagNames)

Specify the targets that will receive the push notification.

Parameters:

deviceIds - an optional array of device ids specified as strings that the push notification will be sent to

userIds - an optional array of user ids specified as strings for whose devices the push notification will be sent to

platforms - an optional array of NotificationBuilder.PushNotificationsPlatform enums used to specify which platforms to send to

tagNames - an optional string array with the list of tags that will receive the notification

Returns:

the NotificationBuilder object so that calls can be chained

setAPNSSettings

public NotificationBuilder setAPNSSettings(Integer badge,
                                           String category,
                                           String iosActionKey,
                                           org.json.JSONObject payload,
                                           String soundFile,
                                           NotificationBuilder.APNSNotificationType type)

Configure specific Apple Push Notification Service (APNS) settings for iOS devices.

Parameters:

badge - the number to display as the badge of the application icon

category - the category identifier to be used for intereactive push notifications

iosActionKey - the title for the Action key

payload - custom JSON payload that will be sent as part of the notification message

soundFile - the name of the sound file in the application bundle; the sound of this file is played as an alert

type - determines whether an alert is shown or the message is placed in the notification center; specified with the NotificationBuilder.APNSNotificationType enum

Returns:

the NotificationBuilder object so that calls can be chained

setGCMSettings

public NotificationBuilder setGCMSettings(String collapseKey,
                                          Boolean delayWhileIdle,
                                          org.json.JSONObject payload,
                                          NotificationBuilder.GCMPriority priority,
                                          String soundFile,
                                          Integer secondsToLive)

Configure specific Google Cloud Messaging (GCM) settings.

Parameters:

collapseKey - key that identifies a group of push notifications that can be replaced with the latest one

delayWhileIdle - indicates whether the message should not be sent until the device becomes active

payload - custom JSON payload that will be sent as part of the notification message

priority - the priority of the message, specified using the NotificationBuilder.GCMPriority enum

soundFile - the sound file (on device) that will be attempted to play when the notification arrives on the device

secondsToLive - specifies how long (in seconds) the message should be kept in GCM storage if the device is offline

Returns:

the NotificationBuilder object so that calls can be chained

build

public org.json.JSONObject build()

Build the push notification as configured. The result of this method is to be passed to PushNotifications.send(JSONObject, PushNotificationsResponseListener) as a parameter.

Returns:

the push notification built as specified, ready to be sent