Class: Aws::Pinpoint::Types::DefaultPushNotificationMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::DefaultPushNotificationMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass DefaultPushNotificationMessage data as a hash:
{
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
silent_push: false,
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
}
Default Push Notification 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, the email body or the text message.
-
#data ⇒ Hash<String,String>
The data payload used for a silent push.
-
#silent_push ⇒ Boolean
Indicates if the message should display on the users device.
- #substitutions ⇒ Hash<String,Array<String>>
-
#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
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2237 class DefaultPushNotificationMessage < Struct.new( :action, :body, :data, :silent_push, :substitutions, :title, :url) include Aws::Structure end |
#body ⇒ String
The message body of the notification, the email body or the text message.
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2237 class DefaultPushNotificationMessage < Struct.new( :action, :body, :data, :silent_push, :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
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2237 class DefaultPushNotificationMessage < Struct.new( :action, :body, :data, :silent_push, :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.
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2237 class DefaultPushNotificationMessage < Struct.new( :action, :body, :data, :silent_push, :substitutions, :title, :url) include Aws::Structure end |
#substitutions ⇒ Hash<String,Array<String>>
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2237 class DefaultPushNotificationMessage < Struct.new( :action, :body, :data, :silent_push, :substitutions, :title, :url) include Aws::Structure end |
#title ⇒ String
The message title that displays above the message on the user’s device.
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2237 class DefaultPushNotificationMessage < Struct.new( :action, :body, :data, :silent_push, :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.
2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2237 class DefaultPushNotificationMessage < Struct.new( :action, :body, :data, :silent_push, :substitutions, :title, :url) include Aws::Structure end |