Package software.amazon.awscdk.services.pinpoint

Interface CfnPushTemplate.APNSPushNotificationTemplateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPushTemplate.APNSPushNotificationTemplateProperty.Jsii$Proxy

Enclosing class:

CfnPushTemplate

@Stability(Stable)
public static interface CfnPushTemplate.APNSPushNotificationTemplateProperty
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 APNs (Apple Push Notification service) 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.*;
 APNSPushNotificationTemplateProperty aPNSPushNotificationTemplateProperty = APNSPushNotificationTemplateProperty.builder()
         .action("action")
         .body("body")
         .mediaUrl("mediaUrl")
         .sound("sound")
         .title("title")
         .url("url")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPushTemplate.APNSPushNotificationTemplateProperty.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 push notifications that are based on the message template.
default String	getMediaUrl()	The URL of an image or video to display in push notifications that are based on the message template.
default String	getSound()	The key for the sound to play when the recipient receives a push notification that's based on the message template.
default String	getTitle()	The title to use in push notifications that are based on the message template.
default String	getUrl()	The URL to open in the 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 setting uses the deep-linking features of the iOS 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-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-action

getBody

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

The message body to use in push notifications that are based on the message template.

See Also:

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

getMediaUrl

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

The URL of an image or video to display in push notifications that are based on the message template.

See Also:

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

getSound

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

The key for the sound to play when the recipient receives a push notification that's based on the message template.

The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

See Also:

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

getTitle

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

The title to use in push notifications that are 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-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-title

getUrl

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

The URL to open in the 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-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-url

builder

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

Returns:

a CfnPushTemplate.APNSPushNotificationTemplateProperty.Builder of CfnPushTemplate.APNSPushNotificationTemplateProperty