Class: Aws::Pinpoint::Types::Message
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::Message
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass Message data as a 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",
}
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.
-
#image_icon_url ⇒ String
The URL that points to the icon image for the push notification icon, for example, the app icon.
-
#image_small_icon_url ⇒ String
The URL that points to the small icon image for the push notification icon, for example, the app icon.
-
#image_url ⇒ String
The URL that points to an image used in the push notification.
-
#json_body ⇒ String
The JSON payload used for a silent push.
-
#media_url ⇒ String
The URL that points to the media resource, for example a .mp4 or .gif file.
-
#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.
-
#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.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |
#body ⇒ String
The message body. Can include up to 140 characters.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |
#image_icon_url ⇒ String
The URL that points to the icon image for the push notification icon, for example, the app icon.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |
#image_small_icon_url ⇒ String
The URL that points to the small icon image for the push notification icon, for example, the app icon.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |
#image_url ⇒ String
The URL that points to an image used in the push notification.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |
#json_body ⇒ String
The JSON payload used for a silent push.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |
#media_url ⇒ String
The URL that points to the media resource, for example a .mp4 or .gif file.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :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.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :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.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |
#title ⇒ String
The message title that displays above the message on the user’s device.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :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.
5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5283 class Message < Struct.new( :action, :body, :image_icon_url, :image_small_icon_url, :image_url, :json_body, :media_url, :raw_content, :silent_push, :title, :url) include Aws::Structure end |