pinpoint/aws.sdk.kotlin.services.pinpoint.model/AdmMessage/Builder

Builder

class Builder

Properties

action

var action: Action?

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

body

var body: String?

The body of the notification message.

consolidationKey

var consolidationKey: String?

An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

data

var data: Map<String, String>?

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

expiresAfter

var expiresAfter: String?

The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

iconReference

var iconReference: String?

The icon image name of the asset saved in your app.

imageIconUrl

var imageIconUrl: String?

The URL of the large icon image to display in the content view of the push notification.

imageUrl

var imageUrl: String?

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

md5

var md5: String?

The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

rawContent

var rawContent: String?

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.

silentPush

var silentPush: Boolean?

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

smallImageIconUrl

var smallImageIconUrl: String?

The URL of the small icon image to display in the status bar and the content view of the push notification.

sound

var sound: String?

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

substitutions

var substitutions: Map<String, List<String>>?

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

title

var title: String?

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

url

var 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.