Class: Aws::Pinpoint::Types::DirectMessageConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::DirectMessageConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass DirectMessageConfiguration data as a hash:
{
adm_message: {
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",
},
apns_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
badge: 1,
body: "__string",
category: "__string",
collapse_id: "__string",
data: {
"__string" => "__string",
},
media_url: "__string",
preferred_authentication_method: "__string",
priority: "__string",
raw_content: "__string",
silent_push: false,
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
thread_id: "__string",
time_to_live: 1,
title: "__string",
url: "__string",
},
baidu_message: {
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"],
},
title: "__string",
url: "__string",
},
default_message: {
body: "__string",
substitutions: {
"__string" => ["__string"],
},
},
default_push_notification_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
data: {
"__string" => "__string",
},
silent_push: false,
substitutions: {
"__string" => ["__string"],
},
title: "__string",
url: "__string",
},
gcm_message: {
action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
body: "__string",
collapse_key: "__string",
data: {
"__string" => "__string",
},
icon_reference: "__string",
image_icon_url: "__string",
image_url: "__string",
priority: "__string",
raw_content: "__string",
restricted_package_name: "__string",
silent_push: false,
small_image_icon_url: "__string",
sound: "__string",
substitutions: {
"__string" => ["__string"],
},
time_to_live: 1,
title: "__string",
url: "__string",
},
sms_message: {
body: "__string",
message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
origination_number: "__string",
sender_id: "__string",
substitutions: {
"__string" => ["__string"],
},
},
}
The message configuration.
Instance Attribute Summary collapse
-
#adm_message ⇒ Types::ADMMessage
The message to ADM channels.
-
#apns_message ⇒ Types::APNSMessage
The message to APNS channels.
-
#baidu_message ⇒ Types::BaiduMessage
The message to Baidu GCM channels.
-
#default_message ⇒ Types::DefaultMessage
The default message for all channels.
-
#default_push_notification_message ⇒ Types::DefaultPushNotificationMessage
The default push notification message for all push channels.
-
#gcm_message ⇒ Types::GCMMessage
The message to GCM channels.
-
#sms_message ⇒ Types::SMSMessage
The message to SMS channels.
Instance Attribute Details
#adm_message ⇒ Types::ADMMessage
The message to ADM channels. Overrides the default push notification message.
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2813 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :gcm_message, :sms_message) include Aws::Structure end |
#apns_message ⇒ Types::APNSMessage
The message to APNS channels. Overrides the default push notification message.
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2813 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :gcm_message, :sms_message) include Aws::Structure end |
#baidu_message ⇒ Types::BaiduMessage
The message to Baidu GCM channels. Overrides the default push notification message.
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2813 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :gcm_message, :sms_message) include Aws::Structure end |
#default_message ⇒ Types::DefaultMessage
The default message for all channels.
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2813 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :gcm_message, :sms_message) include Aws::Structure end |
#default_push_notification_message ⇒ Types::DefaultPushNotificationMessage
The default push notification message for all push channels.
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2813 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :gcm_message, :sms_message) include Aws::Structure end |
#gcm_message ⇒ Types::GCMMessage
The message to GCM channels. Overrides the default push notification message.
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2813 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :gcm_message, :sms_message) include Aws::Structure end |
#sms_message ⇒ Types::SMSMessage
The message to SMS channels. Overrides the default message.
2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 2813 class DirectMessageConfiguration < Struct.new( :adm_message, :apns_message, :baidu_message, :default_message, :default_push_notification_message, :gcm_message, :sms_message) include Aws::Structure end |