You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Pinpoint::Types::AddressConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

Instance Attribute Details

#body_overrideString

Body override. If specified will override default body.

Returns:

  • (String)


1082
1083
1084
1085
1086
1087
1088
1089
1090
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1082

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  include Aws::Structure
end

#channel_typeString

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Returns:

  • (String)


1082
1083
1084
1085
1086
1087
1088
1089
1090
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1082

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  include Aws::Structure
end

#contextHash<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.

Returns:

  • (Hash<String,String>)


1082
1083
1084
1085
1086
1087
1088
1089
1090
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1082

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  include Aws::Structure
end

#raw_contentString

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns:

  • (String)


1082
1083
1084
1085
1086
1087
1088
1089
1090
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1082

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  include Aws::Structure
end

#substitutionsHash<String,Array<String>>

A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.

Returns:

  • (Hash<String,Array<String>>)


1082
1083
1084
1085
1086
1087
1088
1089
1090
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1082

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  include Aws::Structure
end

#title_overrideString

Title override. If specified will override default title if applicable.

Returns:

  • (String)


1082
1083
1084
1085
1086
1087
1088
1089
1090
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1082

class AddressConfiguration < Struct.new(
  :body_override,
  :channel_type,
  :context,
  :raw_content,
  :substitutions,
  :title_override)
  include Aws::Structure
end