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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::AddressConfiguration

Includes:

Structure

Defined in:

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, VOICE, EMAIL, BAIDU, CUSTOM
  context: {
    "__string" => "__string",
  },
  raw_content: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  title_override: "__string",
}

Specifies address-based configuration settings for a message that’s sent directly to an endpoint.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #body_override ⇒ String

  The message body to use instead of the default message body.

• #channel_type ⇒ String

  The channel to use when sending the message.

• #context ⇒ Hash<String,String>

  An object that maps custom attributes to attributes for the address and is attached to the message.

• #raw_content ⇒ String

  The raw, JSON-formatted string to use as the payload for the message.

• #substitutions ⇒ Hash<String,Array<String>>

  A map of the message variables to merge with the variables specified by properties of the DefaultMessage object.

• #title_override ⇒ String

  The message title to use instead of the default message title.

Instance Attribute Details

#body_override ⇒ String

The message body to use instead of the default message body. This value overrides the default message body.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1666

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

#channel_type ⇒ String

The channel to use when sending the message.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1666

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

#context ⇒ Hash<String,String>

An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.

For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1666

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 use as the payload for the message. If specified, this value overrides all other values for the message.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1666

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

#substitutions ⇒ Hash<String,Array<String>>

A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.

Returns:

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

# File 'lib/aws-sdk-pinpoint/types.rb', line 1666

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

#title_override ⇒ String

The message title to use instead of the default message title. This value overrides the default message title.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 1666

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