Class: Aws::Pinpoint::Types::ADMMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::ADMMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass ADMMessage data as a 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",
md5: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
}
ADM Message.
Instance Attribute Summary collapse
-
#action ⇒ 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.
-
#body ⇒ String
The message body of the notification.
-
#consolidation_key ⇒ String
Optional.
-
#data ⇒ Hash<String,String>
The data payload used for a silent push.
-
#expires_after ⇒ String
Optional.
-
#icon_reference ⇒ String
The icon image name of the asset saved in your application.
-
#image_icon_url ⇒ String
The URL that points to an image used as the large icon to the notification content view.
-
#image_url ⇒ String
The URL that points to an image used in the push notification.
-
#md5 ⇒ String
Optional.
-
#raw_content ⇒ String
The Raw JSON formatted string to be used as the payload.
-
#silent_push ⇒ Boolean
Indicates if the message should display on the users device.
-
#small_image_icon_url ⇒ 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.
-
#sound ⇒ String
Indicates a sound to play when the device receives the notification.
-
#substitutions ⇒ Hash<String,Array<String>>
Default message substitutions.
-
#title ⇒ String
The message title that displays above the message on the user’s device.
-
#url ⇒ String
The URL to open in the user’s mobile browser.
Instance Attribute Details
#action ⇒ 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. 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
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#body ⇒ String
The message body of the notification.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#consolidation_key ⇒ String
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.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#data ⇒ Hash<String,String>
The data payload used for a silent push. This payload is added to the notifications’ data.pinpoint.jsonBody’ object
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#expires_after ⇒ String
Optional. Number of seconds ADM should retain the message if the device is offline
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#icon_reference ⇒ String
The icon image name of the asset saved in your application.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#image_icon_url ⇒ String
The URL that points to an image used as the large icon to the notification content view.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#image_url ⇒ String
The URL that points to an image used in the push notification.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#md5 ⇒ String
Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#raw_content ⇒ String
The Raw JSON formatted string to be used as the payload. This value overrides the message.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#silent_push ⇒ Boolean
Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#small_image_icon_url ⇒ 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
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#sound ⇒ String
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/
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#substitutions ⇒ Hash<String,Array<String>>
Default message substitutions. Can be overridden by individual address substitutions.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#title ⇒ String
The message title that displays above the message on the user’s device.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |
#url ⇒ String
The URL to open in the user’s mobile browser. Used if the value for Action is URL.
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 223 class ADMMessage < Struct.new( :action, :body, :consolidation_key, :data, :expires_after, :icon_reference, :image_icon_url, :image_url, :md5, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :title, :url) include Aws::Structure end |