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.

GCM Message.

Inheritance Hierarchy

System.Object
  Amazon.Pinpoint.Model.GCMMessage

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

Syntax

C#
public class GCMMessage

The GCMMessage type exposes the following members

Constructors

NameDescription
Public Method GCMMessage()

Properties

NameTypeDescription
Public Property Action Amazon.Pinpoint.Action

Gets and sets the property Action. The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

Public Property Body System.String

Gets and sets the property Body. The message body of the notification, the email body or the text message.

Public Property CollapseKey System.String

Gets and sets the property CollapseKey. This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.

Public Property Data System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Data. The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

Public Property IconReference System.String

Gets and sets the property IconReference. The icon image name of the asset saved in your application.

Public Property ImageIconUrl System.String

Gets and sets the property ImageIconUrl. The URL that points to an image used as the large icon to the notification content view.

Public Property ImageUrl System.String

Gets and sets the property ImageUrl. The URL that points to an image used in the push notification.

Public Property JsonData System.String

Gets and sets the property JsonData. The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

Public Property RawContent System.String

Gets and sets the property RawContent. The Raw JSON formatted string to be used as the payload. This value overrides the message.

Public Property RestrictedPackageName System.String

Gets and sets the property RestrictedPackageName. This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.

Public Property SilentPush System.Boolean

Gets and sets the property SilentPush. Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

Public Property SmallImageIconUrl System.String

Gets and sets the property SmallImageIconUrl. The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view

Public Property Sound System.String

Gets and sets the property Sound. Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/

Public Property Substitutions System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property Substitutions. Default message substitutions. Can be overridden by individual address substitutions.

Public Property Title System.String

Gets and sets the property Title. The message title that displays above the message on the user's device.

Public Property Url System.String

Gets and sets the property Url. The URL to open in the user's mobile browser. Used if the value for Action is URL.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms