Interface CfnPushTemplate.IAndroidPushNotificationTemplateProperty

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.

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IAndroidPushNotificationTemplateProperty

Syntax (vb)

Public Interface IAndroidPushNotificationTemplateProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.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 androidPushNotificationTemplateProperty = new AndroidPushNotificationTemplateProperty {
    Action = "action",
    Body = "body",
    ImageIconUrl = "imageIconUrl",
    ImageUrl = "imageUrl",
    SmallImageIconUrl = "smallImageIconUrl",
    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 a push notification that's based on the message template.
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.
ImageUrl	The URL of an image to display in a push notification that's based on the message template.
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.
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 a push notification that's 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-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-action

Body

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

virtual string Body { get; }

Property Value

System.String

Remarks

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

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.

virtual string ImageIconUrl { get; }

Property Value

System.String

Remarks

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

ImageUrl

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

virtual string ImageUrl { get; }

Property Value

System.String

Remarks

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

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.

virtual string SmallImageIconUrl { get; }

Property Value

System.String

Remarks

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

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

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

Title

The title to use in a push notification that's 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.

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

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

Remarks

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