AWSPinpointTargetingGCMMessage Class Reference

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

Overview

GCM 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

  body

The message body of the notification.

@property (nonatomic, strong) NSString *body

Declared In

AWSPinpointTargetingModel.h

  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.

@property (nonatomic, strong) NSString *collapseKey

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

  iconReference

The icon image name of the asset saved in your application.

@property (nonatomic, strong) NSString *iconReference

Declared In

AWSPinpointTargetingModel.h

  imageIconUrl

The URL that points to an image used as the large icon to the notification content view.

@property (nonatomic, strong) NSString *imageIconUrl

Declared In

AWSPinpointTargetingModel.h

  imageUrl

The URL that points to an image used in the push notification.

@property (nonatomic, strong) NSString *imageUrl

Declared In

AWSPinpointTargetingModel.h

  priority

The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values:“Normal” - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required.“High” - Messages are sent immediately and might wake a sleeping device.The equivalent values for APNs messages are “5” and “10”. Amazon Pinpoint accepts these values here and converts them.For more information, see About FCM Messages in the Firebase documentation.

@property (nonatomic, strong) NSString *priority

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

  restrictedPackageName

This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.

@property (nonatomic, strong) NSString *restrictedPackageName

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

  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

@property (nonatomic, strong) NSString *smallImageIconUrl

Declared In

AWSPinpointTargetingModel.h

  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/

@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

  timeToLive

The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.

@property (nonatomic, strong) NSNumber *timeToLive

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