You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::ADMMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ADMMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  body: "__string",
  consolidation_key: "__string",
  data: {
    "__string" => "__string",
  },
  expires_after: "__string",
  icon_reference: "__string",
  image_icon_url: "__string",
  image_url: "__string",
  json_data: "__string",
  md5: "__string",
  raw_content: "__string",
  silent_push: false,
  small_image_icon_url: "__string",
  sound: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  title: "__string",
  url: "__string",
}

ADM Message.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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

Possible values:

  • OPEN_APP
  • DEEP_LINK
  • URL

Returns:

  • (String)

    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.

#bodyString

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

Returns:

  • (String)

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

#consolidation_keyString

Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.

Returns:

  • (String)

    Optional.

#dataHash<String,String>

Returns:

  • (Hash<String,String>)

#expires_afterString

Optional. Number of seconds ADM should retain the message if the device is offline

Returns:

  • (String)

    Optional.

#icon_referenceString

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

Returns:

  • (String)

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

#image_icon_urlString

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

Returns:

  • (String)

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

#image_urlString

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

Returns:

  • (String)

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

#json_dataString

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

Returns:

  • (String)

    The data payload used for a silent push.

#md5String

Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity

Returns:

  • (String)

    Optional.

#raw_contentString

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

Returns:

  • (String)

    The Raw JSON formatted string to be used as the payload.

#silent_pushBoolean

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

Returns:

  • (Boolean)

    Indicates if the message should display on the users device.

#small_image_icon_urlString

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

Returns:

  • (String)

    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.

#soundString

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/

Returns:

  • (String)

    Indicates a sound to play when the device receives the notification.

#substitutionsHash<String,Array<String>>

Returns:

  • (Hash<String,Array<String>>)

#titleString

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

Returns:

  • (String)

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

#urlString

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

Returns:

  • (String)

    The URL to open in the user\'s mobile browser.