AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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,
  time_to_live: 1,
  title: "__string",
  url: "__string",
}

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action to occur if a 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 setting uses the deep-linking features of iOS and Android.

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

    Possible values:

    • OPEN_APP
    • DEEP_LINK
    • URL

Returns:

  • (String)

    The action to occur if a recipient taps the push notification.

#bodyString

The body of the notification message. The maximum number of characters is 200.

Returns:

  • (String)

    The body of the notification message.

#image_icon_urlString

The URL of the image to display as the push-notification icon, such as the icon for the app.

Returns:

  • (String)

    The URL of the image to display as the push-notification icon, such as the icon for the app.

#image_small_icon_urlString

The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

Returns:

  • (String)

    The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

#image_urlString

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

Returns:

  • (String)

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

#json_bodyString

The JSON payload to use for a silent push notification.

Returns:

  • (String)

    The JSON payload to use for a silent push notification.

#media_urlString

The URL of the image or video to display in the push notification.

Returns:

  • (String)

    The URL of the image or video to display in the push notification.

#raw_contentString

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.

Returns:

  • (String)

    The raw, JSON-formatted string to use as the payload for the notification message.

#silent_pushBoolean

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, displaying messages in an in-app message center, or supporting phone home functionality.

Returns:

  • (Boolean)

    Specifies whether the notification is a silent push notification, which is a push notification that doesn\'t display on a recipient\'s device.

#time_to_liveInteger

The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it\'s sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn\'t store or try to deliver the notification again.

This value doesn\'t apply to messages that are sent through the Amazon Device Messaging (ADM) service.

Returns:

  • (Integer)

    The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time.

#titleString

The title to display above the notification message on a recipient\'s device.

Returns:

  • (String)

    The title to display above the notification message on a recipient\'s device.

#urlString

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

Returns:

  • (String)

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