Class: Aws::Pinpoint::Types::BaiduMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::BaiduMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass BaiduMessage data as a hash:
{
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
raw_content: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
}
Baidu 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.
-
#data ⇒ Hash<String,String>
The data payload used for a silent push.
-
#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.
-
#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.
-
#time_to_live ⇒ Integer
This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline.
-
#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
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) include Aws::Structure end |
#body ⇒ String
The message body of the notification.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :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
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) include Aws::Structure end |
#icon_reference ⇒ String
The icon image name of the asset saved in your application.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :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.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) include Aws::Structure end |
#image_url ⇒ String
The URL that points to an image used in the push notification.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :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.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :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.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :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
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :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/
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) include Aws::Structure end |
#substitutions ⇒ Hash<String,Array<String>>
Default message substitutions. Can be overridden by individual address substitutions.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) include Aws::Structure end |
#time_to_live ⇒ Integer
This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) include Aws::Structure end |
#title ⇒ String
The message title that displays above the message on the user’s device.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :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.
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1434 class BaiduMessage < Struct.new( :action, :body, :data, :icon_reference, :image_icon_url, :image_url, :raw_content, :silent_push, :small_image_icon_url, :sound, :substitutions, :time_to_live, :title, :url) include Aws::Structure end |