com.ibm.mobilefirstplatform.serversdk.java.push

Class APNs.Builder

java.lang.Object

com.ibm.mobilefirstplatform.serversdk.java.push.APNs.Builder

Enclosing class:

APNs

public static class APNs.Builder
extends Object

Builder for APNs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APNs.Builder.APNSNotificationType The available notification types of the APNs notification message.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
APNs.Builder	apnsCollapseId(String apnsCollapseId)
APNs.Builder	attachmentUrl(String attachmentUrl)
APNs.Builder	badge(Integer badge)
APNs	build()
APNs.Builder	interactiveCategory(String interactiveCategory)
APNs.Builder	iosActionKey(String iosActionKey)
APNs.Builder	launchImage(String launchImage)
APNs.Builder	locArgs(String[] locArgs)
APNs.Builder	locKey(String locKey)
APNs.Builder	payload(org.json.JSONObject payload)
APNs.Builder	sound(String sound)
APNs.Builder	subtitle(String subtitle)
APNs.Builder	title(String title)
APNs.Builder	titleLocArgs(String[] titleLocArgs)
APNs.Builder	titleLocKey(String titleLocKey)
APNs.Builder	type(APNs.Builder.APNSNotificationType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

badge

public final APNs.Builder badge(Integer badge)

Parameters:

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

Returns:

The Builder object for calls to be linked.

sound

public final APNs.Builder sound(String sound)

Parameters:

sound - The name of the sound file in the application bundle. The sound of this file is played as an alert.

Returns:

The Builder object for calls to be linked.

iosActionKey

public final APNs.Builder iosActionKey(String iosActionKey)

Parameters:

iosActionKey - The title for the Action key.

Returns:

The Builder object for calls to be linked.

payload

public final APNs.Builder payload(org.json.JSONObject payload)

Parameters:

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

Returns:

The Builder object for calls to be linked.

interactiveCategory

public final APNs.Builder interactiveCategory(String interactiveCategory)

Parameters:

interactiveCategory - The category identifier to be used for the interactive push notifications.

Returns:

The Builder object for calls to be linked.

type

public final APNs.Builder type(APNs.Builder.APNSNotificationType type)

Parameters:

type - {'DEFAULT', 'MIXED', 'SILENT'}

Returns:

The Builder object for calls to be linked.

titleLocKey

public final APNs.Builder titleLocKey(String titleLocKey)

Parameters:

titleLocKey - The key to a title string in the Localizable.strings file for the current localization. The key string can be formatted with %@ and %n$@ specifiers to take the variables specified in the titleLocArgs array.

Returns:

The Builder object for calls to be linked.

locKey

public final APNs.Builder locKey(String locKey)

Parameters:

locKey - A key to an alert-message string in a Localizable.strings file for the current localization (which is set by the user�s language preference). The key string can be formatted with %@ and %n$@ specifiers to take the variables specified in the locArgs array.

Returns:

The Builder object for calls to be linked.

launchImage

public final APNs.Builder launchImage(String launchImage)

Parameters:

launchImage - The filename of an image file in the app bundle, with or without the filename extension. The image is used as the launch image when users tap the action button or move the action slider.

Returns:

The Builder object for calls to be linked.

titleLocArgs

public final APNs.Builder titleLocArgs(String[] titleLocArgs)

Parameters:

titleLocArgs - Variable string values to appear in place of the format specifiers in title-loc-key.

Returns:

The Builder object for calls to be linked.

locArgs

public final APNs.Builder locArgs(String[] locArgs)

Parameters:

locArgs - Variable string values to appear in place of the format specifiers in locKey.

Returns:

The Builder object for calls to be linked.

subtitle

public final APNs.Builder subtitle(String subtitle)

Parameters:

subtitle - The subtitle of the Rich Notifications. (Supported on iOS 10 or later).

Returns:

The Builder object for calls to be linked.

title

public final APNs.Builder title(String title)

Parameters:

title - title - The title of Rich Push notifications (Supported on iOS 10 or later).

Returns:

The Builder object for calls to be linked.

attachmentUrl

public final APNs.Builder attachmentUrl(String attachmentUrl)

Parameters:

attachmentUrl - The link to the iOS notifications media (video, audio, GIF, images - Supported only on iOS 10 and above).

Returns:

The Builder object for calls to be linked.

apnsCollapseId

public final APNs.Builder apnsCollapseId(String apnsCollapseId)

Parameters:

apnsCollapseId - Multiple notifications with the same collapse identifier are displayed to the user as a single notification

Returns:

The Builder object for calls to be linked.

build

public APNs build()

Returns:

the APNs object.