pinpoint/aws.sdk.kotlin.services.pinpoint.model/GcmMessage/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.

collapseKey

var collapseKey: String?

An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

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.

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.

preferredAuthenticationMethod

var preferredAuthenticationMethod: String?

The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the DefaultAuthenticationMethod is used.

priority

var priority: String?

para>normal – The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

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.

restrictedPackageName

var restrictedPackageName: String?

The package name of the application where registration tokens must match in order for the recipient to receive 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.

timeToLive

var timeToLive: Int?

The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

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.