Apns object that specifies the iOS platform settings.
Methods
apnsCollapseId(apnsCollapseId)
Parameters:
| Name | Type | Description |
|---|---|---|
apnsCollapseId |
string | 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.
apnsGroupSummaryArg(apnsGroupSummaryArg)
Parameters:
| Name | Type | Description |
|---|---|---|
apnsGroupSummaryArg |
string | The string the notification adds to the category’s summary format string. |
Returns:
The Builder object for calls to be linked.
apnsGroupSummaryArgCount(apnsGroupSummaryArgCount)
Parameters:
| Name | Type | Description |
|---|---|---|
apnsGroupSummaryArgCount |
number | The number of items the notification adds to the category’s summary format string. |
Returns:
The Builder object for calls to be linked.
apnsThreadId(apnsThreadId)
Parameters:
| Name | Type | Description |
|---|---|---|
apnsThreadId |
string | An app-specific identifier for grouping related notifications. This value corresponds to the threadIdentifier property in the UNNotificationContent object. |
Returns:
The Builder object for calls to be linked.
attachmentUrl(attachmentUrl)
Parameters:
| Name | Type | Description |
|---|---|---|
attachmentUrl |
string | 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.
badge(badge)
Set badge for the payload
Parameters:
| Name | Type | Description |
|---|---|---|
badge |
number | The number to display as the badge of the application icon. |
Returns:
The Builder object for calls to be linked.
build()
Builds Apns values.
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.
iosActionKey(iosActionKey)
Parameters:
| Name | Type | Description |
|---|---|---|
iosActionKey |
string | The title for the Action key. |
Returns:
The Builder object for calls to be linked.
launchImage(launchImage)
Parameters:
| Name | Type | Description |
|---|---|---|
launchImage |
string | 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.
locArgs(locArgs)
Parameters:
| Name | Type | Description |
|---|---|---|
locArgs |
Array.<string> | Variable string values to appear in place of the format specifiers in locKey. |
Returns:
The Builder object for calls to be linked.
locKey(locKey)
Parameters:
| Name | Type | Description |
|---|---|---|
locKey |
string | 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.
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.
sound(sound)
Parameters:
| Name | Type | Description |
|---|---|---|
sound |
string | 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.
subtitle(subtitle)
Parameters:
| Name | Type | Description |
|---|---|---|
subtitle |
string | The subtitle of the Rich Notifications. (Supported on iOS 10 or later). |
Returns:
The Builder object for calls to be linked.
title(title)
Parameters:
| Name | Type | Description |
|---|---|---|
title |
string | The title of Rich Push notifications (Supported on iOS 10 or later). |
Returns:
The Builder object for calls to be linked.
titleLocArgs(titleLocArgs)
Parameters:
| Name | Type | Description |
|---|---|---|
titleLocArgs |
Array.<string> | Variable string values to appear in place of the format specifiers in title-loc-key. |
Returns:
The Builder object for calls to be linked.
titleLocKey(titleLocKey)
Parameters:
| Name | Type | Description |
|---|---|---|
titleLocKey |
string | 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.
type(type)
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | ['DEFAULT', 'MIXED', 'SILENT']. |
Returns:
The Builder object for calls to be linked.