Interface CfnPushTemplate.IDefaultPushNotificationTemplateProperty

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDefaultPushNotificationTemplateProperty

Syntax (vb)

Public Interface IDefaultPushNotificationTemplateProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var defaultPushNotificationTemplateProperty = new DefaultPushNotificationTemplateProperty {
    Action = "action",
    Body = "body",
    Sound = "sound",
    Title = "title",
    Url = "url"
};

Synopsis

Properties

Action	The action to occur if a recipient taps a push notification that's based on the message template.
Body	The message body to use in push notifications that are based on the message template.
Sound	The sound to play when a recipient receives a push notification that's based on the message template.
Title	The title to use in push notifications that are based on the message template.
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 `Action` property is `URL` .

Properties

Action

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

virtual string Action { get; }

Property Value

System.String

Remarks

Valid values are:

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

Body

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

virtual string Body { get; }

Property Value

System.String

Remarks

Sound

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

virtual string Sound { get; }

Property Value

System.String

Remarks

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

For an iOS platform, this value is the key for 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.

Title

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

virtual string Title { get; }

Property Value

System.String

Remarks

This title appears above the notification message on a recipient's device.

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 Action property is URL .

virtual string Url { get; }

Property Value

System.String