AWSPinpointTargetingADMMessage

Objective-C

@interface AWSPinpointTargetingADMMessage

Swift

class AWSPinpointTargetingADMMessage

Specifies the settings for a one-time message that’s sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.

  • 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 indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

    Declaration

    Objective-C

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

    Swift

    var consolidationKey: 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 amount of time, in seconds, that ADM should store the message if the recipient’s device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

    Declaration

    Objective-C

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

    Swift

    var expiresAfter: 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 }
  • MD5

    The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

    Declaration

    Objective-C

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

    Swift

    var md5: 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 }

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