pinpoint/aws.sdk.kotlin.services.pinpoint.model/AndroidPushNotificationTemplate

AndroidPushNotificationTemplate

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

Types

Builder

class Builder

Companion

object Companion

Properties

action

val action: Action?

The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

body

val body: String?

The message body to use in a push notification that's based on the message template.

imageIconUrl

val imageIconUrl: String?

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

imageUrl

val imageUrl: String?

The URL of an image to display in a push notification that's based on the message template.

rawContent

val rawContent: String?

The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

smallImageIconUrl

val smallImageIconUrl: String?

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

sound

val sound: String?

The sound to play when a recipient receives a push notification that's based on the message template. 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/.

title

val title: String?

The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

url

val url: String?

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

Functions

copy

inline fun copy(block: AndroidPushNotificationTemplate.Builder.() -> Unit = {}): AndroidPushNotificationTemplate

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String