com.ibm.mobilefirstplatform.serversdk.java.push

Class FCM.Builder

java.lang.Object

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

Enclosing class:

FCM

public static class FCM.Builder
extends Object

Builder for FCM.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FCM.Builder.FCMNotificationType The available notification types of the FCM notification message.
static class	FCM.Builder.FCMPriority Determines the priority of the notification.
static class	FCM.Builder.Visibility Determines visibility of the notification.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FCM	build()
FCM.Builder	collapseKey(String collapseKey)
FCM.Builder	delayWhileIdle(Boolean delayWhileIdle)
FCM.Builder	icon(String icon)
FCM.Builder	interactiveCategory(String interactiveCategory)
FCM.Builder	lights(FCM.FCMLights lights)
FCM.Builder	payload(org.json.JSONObject payload)
FCM.Builder	priority(FCM.Builder.FCMPriority priority)
FCM.Builder	sound(String sound)
FCM.Builder	style(FCM.FCMStyle style)
FCM.Builder	sync(Boolean sync)
FCM.Builder	timeToLive(Integer timeToLive)
FCM.Builder	type(FCM.Builder.FCMNotificationType type)
FCM.Builder	visibility(FCM.Builder.Visibility visibility)

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

delayWhileIdle

public final FCM.Builder delayWhileIdle(Boolean delayWhileIdle)

Parameters:

delayWhileIdle - When this parameter is set to true, it indicates that the message should not be sent until the device becomes active.

Returns:

The Builder object for calls to be linked.

timeToLive

public final FCM.Builder timeToLive(Integer timeToLive)

Parameters:

timeToLive - This parameter specifies the duration (in seconds) for which the message should be kept in FCM, if the device is offline.

Returns:

The Builder object for calls to be linked.

collapseKey

public final FCM.Builder collapseKey(String collapseKey)

Parameters:

collapseKey - The parameter identifies a group of messages.

Returns:

The Builder object for calls to be linked.

payload

public final FCM.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.

sync

public final FCM.Builder sync(Boolean sync)

Parameters:

sync - Device group messaging makes it possible for every app instance in a group to reflect the latest messaging state.

Returns:

The Builder object for calls to be linked.

sound

public final FCM.Builder sound(String sound)

Parameters:

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

Returns:

The Builder object for calls to be linked.

interactiveCategory

public final FCM.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.

priority

public final FCM.Builder priority(FCM.Builder.FCMPriority priority)

Parameters:

priority - A string value that indicates the priority of this notification. Allowed values are 'max', 'high', 'default', 'low' and 'min'. High/Max priority notifications along with 'sound' field may be used for Heads up notification in Android 5.0 or higher.sampleval='low' , sound (string, optional): The sound file (on device) that will be attempted to play when the notification arrives on the device.

Returns:

The Builder object for calls to be linked.

style

public final FCM.Builder style(FCM.FCMStyle style)

Parameters:

style - Options to specify for Android expandable notifications. The types of expandable notifications are picture_notification, bigtext_notification, inbox_notification.

Returns:

The Builder object for calls to be linked.

visibility

public final FCM.Builder visibility(FCM.Builder.Visibility visibility)

Parameters:

visibility - private/public - Visibility of this notification, which affects how and when the notifications are revealed on a secure locked screen.

Returns:

The Builder object for calls to be linked.

icon

public final FCM.Builder icon(String icon)

Parameters:

icon - Specify the name of the icon to be displayed for the notification. Make sure the icon is already packaged with the client application.

Returns:

The Builder object for calls to be linked.

lights

public final FCM.Builder lights(FCM.FCMLights lights)

Parameters:

lights - Allows setting the notification LED color on receiving push notification.

Returns:

The Builder object for calls to be linked.

type

public final FCM.Builder type(FCM.Builder.FCMNotificationType type)

Parameters:

type - {'DEFAULT', 'SILENT'}

Returns:

The Builder object for calls to be linked.

build

public FCM build()

Returns:

the FCM object.