Package software.amazon.awscdk.services.pinpoint

Interface CfnPushTemplate.AndroidPushNotificationTemplateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPushTemplate.AndroidPushNotificationTemplateProperty.Jsii$Proxy

Enclosing class:

CfnPushTemplate

@Stability(Stable)
public static interface CfnPushTemplate.AndroidPushNotificationTemplateProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 AndroidPushNotificationTemplateProperty androidPushNotificationTemplateProperty = AndroidPushNotificationTemplateProperty.builder()
         .action("action")
         .body("body")
         .imageIconUrl("imageIconUrl")
         .imageUrl("imageUrl")
         .smallImageIconUrl("smallImageIconUrl")
         .sound("sound")
         .title("title")
         .url("url")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPushTemplate.AndroidPushNotificationTemplateProperty.Builder	A builder for CfnPushTemplate.AndroidPushNotificationTemplateProperty
static final class	CfnPushTemplate.AndroidPushNotificationTemplateProperty.Jsii$Proxy	An implementation for CfnPushTemplate.AndroidPushNotificationTemplateProperty

Method Summary

Modifier and Type	Method	Description
static CfnPushTemplate.AndroidPushNotificationTemplateProperty.Builder	builder()
default String	getAction()	The action to occur if a recipient taps a push notification that's based on the message template.
default String	getBody()	The message body to use in a push notification that's based on the message template.
default String	getImageIconUrl()	The URL of the large icon image to display in the content view of a push notification that's based on the message template.
default String	getImageUrl()	The URL of an image to display in a push notification that's based on the message template.
default String	getSmallImageIconUrl()	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.
default String	getSound()	The sound to play when a recipient receives a push notification that's based on the message template.
default String	getTitle()	The title to use in a push notification that's based on the message template.
default String	getUrl()	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 .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@Nullable
default String getAction()

The action to occur if a recipient taps a push notification that's 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-action

getBody

@Stability(Stable)
@Nullable
default String getBody()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-body

getImageIconUrl

@Stability(Stable)
@Nullable
default String getImageIconUrl()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageiconurl

getImageUrl

@Stability(Stable)
@Nullable
default String getImageUrl()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageurl

getSmallImageIconUrl

@Stability(Stable)
@Nullable
default String getSmallImageIconUrl()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-smallimageiconurl

getSound

@Stability(Stable)
@Nullable
default String getSound()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-sound

getTitle

@Stability(Stable)
@Nullable
default String getTitle()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-title

getUrl

@Stability(Stable)
@Nullable
default String getUrl()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-url

builder

@Stability(Stable)
static CfnPushTemplate.AndroidPushNotificationTemplateProperty.Builder builder()

Returns:

a CfnPushTemplate.AndroidPushNotificationTemplateProperty.Builder of CfnPushTemplate.AndroidPushNotificationTemplateProperty