PushADMMessageTemplateContent
The content of the push message template that applies to ADM (Amazon Device Messaging) notification service.
Contents
- action
-
The action to occur if a recipient taps a push notification that is based on the message template. 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.
Type: String
Valid Values:
OPEN_APP | DEEP_LINK | URLRequired: No
-
- body
-
The message body to use in a push notification that is based on the message template.
Type: MessageTemplateBodyContentProvider object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- imageIconUrl
-
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- imageUrl
-
The URL of an image to display in a push notification that's based on the message template.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- rawContent
-
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.
Type: MessageTemplateBodyContentProvider object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- smallImageIconUrl
-
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.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- sound
-
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/.Type: String
Length Constraints: Minimum length of 1.
Required: No
- title
-
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.
Type: String
Length Constraints: Minimum length of 1.
Required: No
- url
-
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
actionproperty isURL.Type: String
Length Constraints: Minimum length of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: