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

Class: Aws::Pinpoint::Types::Message

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

Overview

Note:

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

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  body: "__string",
  image_icon_url: "__string",
  image_small_icon_url: "__string",
  image_url: "__string",
  json_body: "__string",
  media_url: "__string",
  raw_content: "__string",
  silent_push: false,
  title: "__string",
  url: "__string",
}

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:

  • 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. Can include up to 140 characters.

Returns:

  • (String)

    The message body.

#image_icon_urlString

The URL that points to the icon image for the push notification icon, for example, the app icon.

Returns:

  • (String)

    The URL that points to the icon image for the push notification icon, for example, the app icon.

#image_small_icon_urlString

The URL that points to the small icon image for the push notification icon, for example, the app icon.

Returns:

  • (String)

    The URL that points to the small icon image for the push notification icon, for example, the app icon.

#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_bodyString

The JSON payload used for a silent push.

Returns:

  • (String)

    The JSON payload used for a silent push.

#media_urlString

The URL that points to the media resource, for example a .mp4 or .gif file.

Returns:

  • (String)

    The URL that points to the media resource, for example a .mp4 or .gif file.

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

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