Package com.mongodb.stitch.core.services.fcm

Class FcmSendMessageRequest

java.lang.Object

com.mongodb.stitch.core.services.fcm.FcmSendMessageRequest

public final class FcmSendMessageRequest
extends Object

An FcmSendMessageRequest encapsulates the details of an FCM send message request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FcmSendMessageRequest.Builder	A builder that can build FcmSendMessageRequests.

Method Summary

Modifier and Type	Method	Description
String	getCollapseKey()	Returns the group of messages that can be collapsed.
Boolean	getContentAvailable()	Returns whether or not to indicate to the client that content is available in order to wake the device.
Document	getData()	Returns the custom data to send in the payload.
Boolean	getMutableContent()	Returns whether or not the content in the message can be mutated.
FcmSendMessageNotification	getNotification()	Returns the predefined, user-visible key-value pairs of the notification payload.
FcmSendMessagePriority	getPriority()	Returns the priority of the message.
Long	getTimeToLive()	Returns how long (in seconds) the message should be kept in FCM storage if the device is offline.

Methods inherited from class java.lang.Object

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

Method Detail

getPriority

@Nonnull
public FcmSendMessagePriority getPriority()

Returns the priority of the message.

Returns:

the priority of the message.

getCollapseKey

@Nullable
public String getCollapseKey()

Returns the group of messages that can be collapsed.

Returns:

the group of messages that can be collapsed.

getContentAvailable

@Nullable
public Boolean getContentAvailable()

Returns whether or not to indicate to the client that content is available in order to wake the device. Note: for messages to iOS devices only.

Returns:

whether or not to indicate to the client that content is available in order to wake the device.

getMutableContent

@Nullable
public Boolean getMutableContent()

Returns whether or not the content in the message can be mutated. Note: for messages to iOS devices only.

Returns:

whether or not the content in the message can be mutated.

getTimeToLive

@Nullable
public Long getTimeToLive()

Returns how long (in seconds) the message should be kept in FCM storage if the device is offline.

Returns:

how long (in seconds) the message should be kept in FCM storage if the device is offline.

getData

@Nullable
public Document getData()

Returns the custom data to send in the payload.

Returns:

the custom data to send in the payload.

getNotification

@Nullable
public FcmSendMessageNotification getNotification()

Returns the predefined, user-visible key-value pairs of the notification payload.

Returns:

the predefined, user-visible key-value pairs of the notification payload.