AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

Inheritance Hierarchy

System.Object
  Amazon.Pinpoint.Model.Message

Namespace: Amazon.Pinpoint.Model
Assembly: AWSSDK.Pinpoint.dll
Version: 3.x.y.z

Syntax

C#
public class Message

The Message type exposes the following members

Constructors

NameDescription
Public Method Message()

Properties

NameTypeDescription
Public Property Action Amazon.Pinpoint.Action

Gets and sets the property Action.

The action to occur if a recipient taps the push notification. 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 iOS and Android.

  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Public Property Body System.String

Gets and sets the property Body.

The body of the notification message. The maximum number of characters is 200.

Public Property ImageIconUrl System.String

Gets and sets the property ImageIconUrl.

The URL of the image to display as the push-notification icon, such as the icon for the app.

Public Property ImageSmallIconUrl System.String

Gets and sets the property ImageSmallIconUrl.

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

Public Property ImageUrl System.String

Gets and sets the property ImageUrl.

The URL of an image to display in the push notification.

Public Property JsonBody System.String

Gets and sets the property JsonBody.

The JSON payload to use for a silent push notification.

Public Property MediaUrl System.String

Gets and sets the property MediaUrl.

The URL of the image or video to display in the push notification.

Public Property RawContent System.String

Gets and sets the property RawContent.

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

Public Property SilentPush System.Boolean

Gets and sets the property SilentPush.

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

Public Property TimeToLive System.Int32

Gets and sets the property TimeToLive.

The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

Public Property Title System.String

Gets and sets the property Title.

The title to display above the notification message on a recipient's device.

Public Property Url System.String

Gets and sets the property Url.

The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5