ApnsMessage

Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The action to occur if the recipient taps the push notification. Valid values are:

Link copied to clipboard

The type of push notification to send. Valid values are:

Link copied to clipboard
val badge: Int?

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

Link copied to clipboard
val body: String?

The body of the notification message.

Link copied to clipboard

The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

Link copied to clipboard

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Link copied to clipboard

The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

Link copied to clipboard

The URL of an image or video to display in the push notification.

Link copied to clipboard

The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

Link copied to clipboard

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

Link copied to clipboard

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

Link copied to clipboard

Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

Link copied to clipboard

The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

Link copied to clipboard

The default message variables to use in the notification message. You can override these default variables with individual address variables.

Link copied to clipboard

The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

Link copied to clipboard

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

Link copied to clipboard

The title to display above the notification message on the recipient's device.

Link copied to clipboard
val url: String?

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Functions

Link copied to clipboard
inline fun copy(block: ApnsMessage.Builder.() -> Unit = {}): ApnsMessage
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String