FCM object that specifies the settings specific to the Android platform.
Methods
androidTitle(androidTitle)
Parameters:
| Name | Type | Description |
|---|---|---|
androidTitle |
string | The androidTitle of Android Push notifications |
Returns:
The Builder object for calls to be linked.
build()
Builds FCM values.
collapseKey(collapseKey)
Parameters:
| Name | Type | Description |
|---|---|---|
collapseKey |
string | This parameter identifies a group of messages. |
Returns:
The Builder object for calls to be linked.
delayWhileIdle(delayWhileIdle)
Parameters:
| Name | Type | Description |
|---|---|---|
delayWhileIdle |
boolean | 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.
groupId(groupId)
Parameters:
| Name | Type | Description |
|---|---|---|
groupId |
string | Set this notification to be part of a group of notifications sharing the same key. Grouped notifications may display in a cluster or stack on devices which support such rendering. |
Returns:
The Builder object for calls to be linked.
icon(icon)
Parameters:
| Name | Type | Description |
|---|---|---|
icon |
string | 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.
interactiveCategory(interactiveCategory)
Parameters:
| Name | Type | Description |
|---|---|---|
interactiveCategory |
string | The category identifier to be used for the interactive push notifications. |
Returns:
The Builder object for calls to be linked.
lights(lights)
Parameters:
| Name | Type | Description |
|---|---|---|
lights |
Object | Allows setting the notification LED color on receiving push notification. |
Returns:
The Builder object for calls to be linked.
payload(payload)
Parameters:
| Name | Type | Description |
|---|---|---|
payload |
Object | Custom JSON payload that will be sent as part of the notification message. |
Returns:
The Builder object for calls to be linked.
priority(priority)
Parameters:
| Name | Type | Description |
|---|---|---|
priority |
string | 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'. |
Returns:
The Builder object for calls to be linked.
sound(sound)
Parameters:
| Name | Type | Description |
|---|---|---|
sound |
string | 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(style)
Parameters:
| Name | Type | Description |
|---|---|---|
style |
Object | 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.
sync(sync)
Parameters:
| Name | Type | Description |
|---|---|---|
sync |
boolean | 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.
timeToLive(timeToLive)
Parameters:
| Name | Type | Description |
|---|---|---|
timeToLive |
number | 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.
type(type)
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | ['DEFAULT', 'SILENT']. |
Returns:
The Builder object for calls to be linked.
visibility(visibility)
Parameters:
| Name | Type | Description |
|---|---|---|
visibility |
string | 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.