AWSPinpointTargetingAPNSMessage Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSPinpointTargetingModel.h
AWSPinpointTargetingModel.m

Overview

APNS Message.

  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

@property (nonatomic, assign) AWSPinpointTargetingAction action

Declared In

AWSPinpointTargetingModel.h

  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.

@property (nonatomic, strong) NSNumber *badge

Declared In

AWSPinpointTargetingModel.h

  body

The message body of the notification, the email body or the text message.

@property (nonatomic, strong) NSString *body

Declared In

AWSPinpointTargetingModel.h

  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.

@property (nonatomic, strong) NSString *category

Declared In

AWSPinpointTargetingModel.h

  data

The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object

@property (nonatomic, strong) NSDictionary<NSString*NSString*> *data

Declared In

AWSPinpointTargetingModel.h

  mediaUrl

The URL that points to a video used in the push notification.

@property (nonatomic, strong) NSString *mediaUrl

Declared In

AWSPinpointTargetingModel.h

  rawContent

The Raw JSON formatted string to be used as the payload. This value overrides the message.

@property (nonatomic, strong) NSString *rawContent

Declared In

AWSPinpointTargetingModel.h

  silentPush

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

@property (nonatomic, strong) NSNumber *silentPush

Declared In

AWSPinpointTargetingModel.h

  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.

@property (nonatomic, strong) NSString *sound

Declared In

AWSPinpointTargetingModel.h

  substitutions

Default message substitutions. Can be overridden by individual address substitutions.

@property (nonatomic, strong) NSDictionary<NSString*NSArray<NSString*> *> *substitutions

Declared In

AWSPinpointTargetingModel.h

  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.

@property (nonatomic, strong) NSString *threadId

Declared In

AWSPinpointTargetingModel.h

  title

The message title that displays above the message on the user’s device.

@property (nonatomic, strong) NSString *title

Declared In

AWSPinpointTargetingModel.h

  url

The URL to open in the user’s mobile browser. Used if the value for Action is URL.

@property (nonatomic, strong) NSString *url

Declared In

AWSPinpointTargetingModel.h