/AWS1/CL_PPTADMMESSAGE¶
Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_action TYPE /AWS1/PPTACTION /AWS1/PPTACTION¶
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
iv_body TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The body of the notification message.
iv_consolidationkey TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
it_data TYPE /AWS1/CL_PPTMAPOF__STRING_W=>TT_MAPOF__STRING TT_MAPOF__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.
iv_expiresafter TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
iv_iconreference TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The icon image name of the asset saved in your app.
iv_imageiconurl TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The URL of the large icon image to display in the content view of the push notification.
iv_imageurl TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The URL of an image to display in the push notification.
iv_md5 TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
iv_rawcontent TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
iv_silentpush TYPE /AWS1/PPT__BOOLEAN /AWS1/PPT__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.
iv_smallimageiconurl TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The URL of the small icon image to display in the status bar and the content view of the push notification.
iv_sound TYPE /AWS1/PPT__STRING /AWS1/PPT__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/.
it_substitutions TYPE /AWS1/CL_PPTLISTOF__STRING_W=>TT_MAPOFLISTOF__STRING TT_MAPOFLISTOF__STRING¶
The default message variables to use in the notification message. You can override the default variables with individual address variables.
iv_title TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING¶
The title to display above the notification message on the recipient's device.
iv_url TYPE /AWS1/PPT__STRING /AWS1/PPT__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.
Queryable Attributes¶
Action¶
The action to occur if the recipient taps the push notification. Valid values are:
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACTION() |
Getter for ACTION, with configurable default |
ASK_ACTION() |
Getter for ACTION w/ exceptions if field has no value |
HAS_ACTION() |
Determine if ACTION has a value |
Body¶
The body of the notification message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BODY() |
Getter for BODY, with configurable default |
ASK_BODY() |
Getter for BODY w/ exceptions if field has no value |
HAS_BODY() |
Determine if BODY has a value |
ConsolidationKey¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONSOLIDATIONKEY() |
Getter for CONSOLIDATIONKEY, with configurable default |
ASK_CONSOLIDATIONKEY() |
Getter for CONSOLIDATIONKEY w/ exceptions if field has no va |
HAS_CONSOLIDATIONKEY() |
Determine if CONSOLIDATIONKEY has a value |
Data¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATA() |
Getter for DATA, with configurable default |
ASK_DATA() |
Getter for DATA w/ exceptions if field has no value |
HAS_DATA() |
Determine if DATA has a value |
ExpiresAfter¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRESAFTER() |
Getter for EXPIRESAFTER, with configurable default |
ASK_EXPIRESAFTER() |
Getter for EXPIRESAFTER w/ exceptions if field has no value |
HAS_EXPIRESAFTER() |
Determine if EXPIRESAFTER has a value |
IconReference¶
The icon image name of the asset saved in your app.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ICONREFERENCE() |
Getter for ICONREFERENCE, with configurable default |
ASK_ICONREFERENCE() |
Getter for ICONREFERENCE w/ exceptions if field has no value |
HAS_ICONREFERENCE() |
Determine if ICONREFERENCE has a value |
ImageIconUrl¶
The URL of the large icon image to display in the content view of the push notification.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGEICONURL() |
Getter for IMAGEICONURL, with configurable default |
ASK_IMAGEICONURL() |
Getter for IMAGEICONURL w/ exceptions if field has no value |
HAS_IMAGEICONURL() |
Determine if IMAGEICONURL has a value |
ImageUrl¶
The URL of an image to display in the push notification.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGEURL() |
Getter for IMAGEURL, with configurable default |
ASK_IMAGEURL() |
Getter for IMAGEURL w/ exceptions if field has no value |
HAS_IMAGEURL() |
Determine if IMAGEURL has a value |
MD5¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MD5() |
Getter for MD5, with configurable default |
ASK_MD5() |
Getter for MD5 w/ exceptions if field has no value |
HAS_MD5() |
Determine if MD5 has a value |
RawContent¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RAWCONTENT() |
Getter for RAWCONTENT, with configurable default |
ASK_RAWCONTENT() |
Getter for RAWCONTENT w/ exceptions if field has no value |
HAS_RAWCONTENT() |
Determine if RAWCONTENT has a value |
SilentPush¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SILENTPUSH() |
Getter for SILENTPUSH, with configurable default |
ASK_SILENTPUSH() |
Getter for SILENTPUSH w/ exceptions if field has no value |
HAS_SILENTPUSH() |
Determine if SILENTPUSH has a value |
SmallImageIconUrl¶
The URL of the small icon image to display in the status bar and the content view of the push notification.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SMALLIMAGEICONURL() |
Getter for SMALLIMAGEICONURL, with configurable default |
ASK_SMALLIMAGEICONURL() |
Getter for SMALLIMAGEICONURL w/ exceptions if field has no v |
HAS_SMALLIMAGEICONURL() |
Determine if SMALLIMAGEICONURL has a value |
Sound¶
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/.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOUND() |
Getter for SOUND, with configurable default |
ASK_SOUND() |
Getter for SOUND w/ exceptions if field has no value |
HAS_SOUND() |
Determine if SOUND has a value |
Substitutions¶
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBSTITUTIONS() |
Getter for SUBSTITUTIONS, with configurable default |
ASK_SUBSTITUTIONS() |
Getter for SUBSTITUTIONS w/ exceptions if field has no value |
HAS_SUBSTITUTIONS() |
Determine if SUBSTITUTIONS has a value |
Title¶
The title to display above the notification message on the recipient's device.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TITLE() |
Getter for TITLE, with configurable default |
ASK_TITLE() |
Getter for TITLE w/ exceptions if field has no value |
HAS_TITLE() |
Determine if TITLE has a value |
Url¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_URL() |
Getter for URL, with configurable default |
ASK_URL() |
Getter for URL w/ exceptions if field has no value |
HAS_URL() |
Determine if URL has a value |