Struct AddressConfiguration 

#[non_exhaustive]
pub struct AddressConfiguration {
    pub body_override: Option<String>,
    pub channel_type: Option<ChannelType>,
    pub context: Option<HashMap<String, String>>,
    pub raw_content: Option<String>,
    pub substitutions: Option<HashMap<String, Vec<String>>>,
    pub title_override: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

body_override: Option<String>

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

channel_type: Option<ChannelType>

The channel to use when sending the message.

context: Option<HashMap<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.

raw_content: Option<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.

substitutions: Option<HashMap<String, Vec<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.

title_override: Option<String>

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

Implementations

impl AddressConfiguration

pub fn body_override(&self) -> Option<&str>

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

pub fn channel_type(&self) -> Option<&ChannelType>

The channel to use when sending the message.

pub fn context(&self) -> Option<&HashMap<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.

pub fn raw_content(&self) -> Option<&str>

The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.

pub fn substitutions(&self) -> Option<&HashMap<String, Vec<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.

pub fn title_override(&self) -> Option<&str>

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

impl AddressConfiguration

pub fn builder() -> AddressConfigurationBuilder

Creates a new builder-style object to manufacture AddressConfiguration.

Trait Implementations

impl Clone for AddressConfiguration

fn clone(&self) -> AddressConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AddressConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AddressConfiguration

fn eq(&self, other: &AddressConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AddressConfiguration