AWSPinpointTargetingGCMMessage

Objective-C

@interface AWSPinpointTargetingGCMMessage

Swift

class AWSPinpointTargetingGCMMessage

Specifies the settings for a one-time message that’s sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

  • The action to occur if the 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 action uses the deep-linking features of the Android platform.

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

    Declaration

    Objective-C

    @property (nonatomic) AWSPinpointTargetingAction action;

    Swift

    var action: AWSPinpointTargetingAction { get set }

  • The body of the notification message.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable body;

    Swift

    var body: String? { get set }

  • An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient’s device comes online again or becomes active.

    Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable collapseKey;

    Swift

    var collapseKey: String? { get set }

  • The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    Declaration

    Objective-C

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

    Swift

    var data: [String : String]? { get set }

  • The icon image name of the asset saved in your app.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable iconReference;

    Swift

    var iconReference: String? { get set }

  • The URL of the large icon image to display in the content view of the push notification.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable imageIconUrl;

    Swift

    var imageIconUrl: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable imageUrl;

    Swift

    var imageUrl: String? { get set }

  • The preferred authentication method, with valid values “KEY” or “TOKEN”. If a value isn’t provided then the DefaultAuthenticationMethod is used.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable preferredAuthenticationMethod;

    Swift

    var preferredAuthenticationMethod: String? { get set }

  • para>normal – The notification might be delayed. Delivery is optimized for battery usage on the recipient’s device. Use this value unless immediate delivery is required.

    /listitem>

  • high – The notification is sent immediately and might wake a sleeping device.

    • /para>

    Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

    The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable priority;

    Swift

    var priority: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable rawContent;

    Swift

    var rawContent: String? { get set }

  • The package name of the application where registration tokens must match in order for the recipient to receive the message.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable restrictedPackageName;

    Swift

    var restrictedPackageName: String? { get set }

  • 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 or supporting phone home functionality.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable silentPush;

    Swift

    var silentPush: NSNumber? { get set }

  • The URL of the small icon image to display in the status bar and the content view of the push notification.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable smallImageIconUrl;

    Swift

    var smallImageIconUrl: String? { get set }

  • The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that’s bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable sound;

    Swift

    var sound: String? { get set }

  • The default message variables to use in the notification message. You can override the default variables with individual address variables.

    Declaration

    Objective-C

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

    Swift

    var substitutions: [String : [String]]? { get set }

  • The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don’t specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

    Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable timeToLive;

    Swift

    var timeToLive: NSNumber? { get set }

  • The title to display above the notification message on the recipient’s device.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable title;

    Swift

    var title: String? { get set }
  • url

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable url;

    Swift

    var url: String? { get set }