Class: Aws::Pinpoint::Types::AddressConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::AddressConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass AddressConfiguration data as a hash:
{
body_override: "__string",
channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, EMAIL, BAIDU, CUSTOM
context: {
"__string" => "__string",
},
raw_content: "__string",
substitutions: {
"__string" => ["__string"],
},
title_override: "__string",
}
Address configuration.
Instance Attribute Summary collapse
-
#body_override ⇒ String
Body override.
-
#channel_type ⇒ String
The channel type.
-
#context ⇒ Hash<String,String>
A map of custom attributes to attributes to be attached to the message for this address.
-
#raw_content ⇒ String
The Raw JSON formatted string to be used as the payload.
- #substitutions ⇒ Hash<String,Array<String>>
-
#title_override ⇒ String
Title override.
Instance Attribute Details
#body_override ⇒ String
Body override. If specified will override default body.
1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1078 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) include Aws::Structure end |
#channel_type ⇒ String
The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1078 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) include Aws::Structure end |
#context ⇒ Hash<String,String>
A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification’s ‘data.pinpoint’ object or added to the email/sms delivery receipt event attributes.
1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1078 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) include Aws::Structure end |
#raw_content ⇒ String
The Raw JSON formatted string to be used as the payload. This value overrides the message.
1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1078 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) include Aws::Structure end |
#substitutions ⇒ Hash<String,Array<String>>
1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1078 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) include Aws::Structure end |
#title_override ⇒ String
Title override. If specified will override default title if applicable.
1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 1078 class AddressConfiguration < Struct.new( :body_override, :channel_type, :context, :raw_content, :substitutions, :title_override) include Aws::Structure end |