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::GCMMessage

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

Overview

Note:

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

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  body: "__string",
  collapse_key: "__string",
  data: {
    "__string" => "__string",
  },
  icon_reference: "__string",
  image_icon_url: "__string",
  image_url: "__string",
  priority: "__string",
  raw_content: "__string",
  restricted_package_name: "__string",
  silent_push: false,
  small_image_icon_url: "__string",
  sound: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  time_to_live: 1,
  title: "__string",
  url: "__string",
}

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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.

    Possible values:

    • OPEN_APP
    • DEEP_LINK
    • URL

Returns:

  • (String)

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

#bodyString

The body of the notification message.

Returns:

  • (String)

    The body of the notification message.

#collapse_keyString

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.

Returns:

  • (String)

    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.

#dataHash<String,String>

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.

Returns:

  • (Hash<String,String>)

    The JSON data payload to use for the push notification, if the notification is a silent push notification.

#icon_referenceString

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

Returns:

  • (String)

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

#image_icon_urlString

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

Returns:

  • (String)

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

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

#priorityString

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

Returns:

  • (String)

    para>normal - The notification might be delayed.

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

#restricted_package_nameString

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

Returns:

  • (String)

    The package name of the application where registration tokens must match in order for the recipient to receive the 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 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.

#small_image_icon_urlString

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

Returns:

  • (String)

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

#soundString

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

Returns:

  • (String)

    The sound to play when the recipient receives the push notification.

#substitutionsHash<String,Array<String>>

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

Returns:

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

    The default message variables to use in the notification message.

#time_to_liveInteger

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.

Returns:

  • (Integer)

    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.

#titleString

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

Returns:

  • (String)

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

#urlString

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.

Returns:

  • (String)

    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.