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.

APNS Message.

Inheritance Hierarchy

System.Object
  Amazon.Pinpoint.Model.APNSMessage

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

Syntax

C#
public class APNSMessage

The APNSMessage type exposes the following members

Constructors

NameDescription
Public Method APNSMessage()

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 Badge System.Int32

Gets and sets the property Badge. Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.

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 Category System.String

Gets and sets the property Category. Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.

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 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 MediaUrl System.String

Gets and sets the property MediaUrl. The URL that points to a video used in the push notification.

Public Property PreferredAuthenticationMethod System.String

Gets and sets the property PreferredAuthenticationMethod. The preferred authentication method, either "CERTIFICATE" or "TOKEN"

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 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 Sound System.String

Gets and sets the property Sound. Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.

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 ThreadId System.String

Gets and sets the property ThreadId. Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

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