Class: Aws::Pinpoint::Types::GCMMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::GCMMessage
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#action ⇒ String
The action to occur if the recipient taps the push notification.
-
#body ⇒ String
The body of the notification message.
-
#collapse_key ⇒ 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.
-
#data ⇒ Hash<String,String>
The JSON data payload to use for the push notification, if the notification is a silent push notification.
-
#icon_reference ⇒ String
The icon image name of the asset saved in your app.
-
#image_icon_url ⇒ String
The URL of the large icon image to display in the content view of the push notification.
-
#image_url ⇒ String
The URL of an image to display in the push notification.
-
#preferred_authentication_method ⇒ String
The preferred authentication method, with valid values "KEY" or "TOKEN".
-
#priority ⇒ String
para>normal - The notification might be delayed.
-
#raw_content ⇒ String
The raw, JSON-formatted string to use as the payload for the notification message.
-
#restricted_package_name ⇒ String
The package name of the application where registration tokens must match in order for the recipient to receive the message.
-
#silent_push ⇒ 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_url ⇒ String
The URL of the small icon image to display in the status bar and the content view of the push notification.
-
#sound ⇒ String
The sound to play when the recipient receives the push notification.
-
#substitutions ⇒ Hash<String,Array<String>>
The default message variables to use in the notification message.
-
#time_to_live ⇒ 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.
-
#title ⇒ String
The title to display above the notification message on the recipient's device.
-
#url ⇒ 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.
Instance Attribute Details
#action ⇒ String
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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#body ⇒ String
The body of the notification message.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#collapse_key ⇒ 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. 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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#data ⇒ Hash<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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#icon_reference ⇒ String
The icon image name of the asset saved in your app.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#image_icon_url ⇒ String
The URL of the large icon image to display in the content view of the push notification.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#image_url ⇒ String
The URL of an image to display in the push notification.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#preferred_authentication_method ⇒ String
The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the DefaultAuthenticationMethod is used.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#priority ⇒ String
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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#raw_content ⇒ String
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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#restricted_package_name ⇒ String
The package name of the application where registration tokens must match in order for the recipient to receive the message.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#silent_push ⇒ Boolean
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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#small_image_icon_url ⇒ String
The URL of the small icon image to display in the status bar and the content view of the push notification.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#sound ⇒ String
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/.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#substitutions ⇒ Hash<String,Array<String>>
The default message variables to use in the notification message. You can override the default variables with individual address variables.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#time_to_live ⇒ 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. 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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#title ⇒ String
The title to display above the notification message on the recipient's device.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |
#url ⇒ 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.
5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5946 class GCMMessage < Struct.new( :action, :body, :collapse_key, :data, :icon_reference, :image_icon_url, :image_url, :preferred_authentication_method, :priority, :raw_content, :restricted_package_name, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) SENSITIVE = [] include Aws::Structure end |