448 lines
20 KiB
C++
448 lines
20 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/pinpoint/Pinpoint_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/pinpoint/model/ChannelType.h>
|
|
#include <aws/core/utils/memory/stl/AWSMap.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace Pinpoint
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Specifies address-based configuration settings for a message that's sent
|
|
* directly to an endpoint.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/pinpoint-2016-12-01/AddressConfiguration">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_PINPOINT_API AddressConfiguration
|
|
{
|
|
public:
|
|
AddressConfiguration();
|
|
AddressConfiguration(Aws::Utils::Json::JsonView jsonValue);
|
|
AddressConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline const Aws::String& GetBodyOverride() const{ return m_bodyOverride; }
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline bool BodyOverrideHasBeenSet() const { return m_bodyOverrideHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline void SetBodyOverride(const Aws::String& value) { m_bodyOverrideHasBeenSet = true; m_bodyOverride = value; }
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline void SetBodyOverride(Aws::String&& value) { m_bodyOverrideHasBeenSet = true; m_bodyOverride = std::move(value); }
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline void SetBodyOverride(const char* value) { m_bodyOverrideHasBeenSet = true; m_bodyOverride.assign(value); }
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline AddressConfiguration& WithBodyOverride(const Aws::String& value) { SetBodyOverride(value); return *this;}
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline AddressConfiguration& WithBodyOverride(Aws::String&& value) { SetBodyOverride(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The message body to use instead of the default message body. This value
|
|
* overrides the default message body.</p>
|
|
*/
|
|
inline AddressConfiguration& WithBodyOverride(const char* value) { SetBodyOverride(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The channel to use when sending the message.</p>
|
|
*/
|
|
inline const ChannelType& GetChannelType() const{ return m_channelType; }
|
|
|
|
/**
|
|
* <p>The channel to use when sending the message.</p>
|
|
*/
|
|
inline bool ChannelTypeHasBeenSet() const { return m_channelTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The channel to use when sending the message.</p>
|
|
*/
|
|
inline void SetChannelType(const ChannelType& value) { m_channelTypeHasBeenSet = true; m_channelType = value; }
|
|
|
|
/**
|
|
* <p>The channel to use when sending the message.</p>
|
|
*/
|
|
inline void SetChannelType(ChannelType&& value) { m_channelTypeHasBeenSet = true; m_channelType = std::move(value); }
|
|
|
|
/**
|
|
* <p>The channel to use when sending the message.</p>
|
|
*/
|
|
inline AddressConfiguration& WithChannelType(const ChannelType& value) { SetChannelType(value); return *this;}
|
|
|
|
/**
|
|
* <p>The channel to use when sending the message.</p>
|
|
*/
|
|
inline AddressConfiguration& WithChannelType(ChannelType&& value) { SetChannelType(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline const Aws::Map<Aws::String, Aws::String>& GetContext() const{ return m_context; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline bool ContextHasBeenSet() const { return m_contextHasBeenSet; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline void SetContext(const Aws::Map<Aws::String, Aws::String>& value) { m_contextHasBeenSet = true; m_context = value; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline void SetContext(Aws::Map<Aws::String, Aws::String>&& value) { m_contextHasBeenSet = true; m_context = std::move(value); }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& WithContext(const Aws::Map<Aws::String, Aws::String>& value) { SetContext(value); return *this;}
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& WithContext(Aws::Map<Aws::String, Aws::String>&& value) { SetContext(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddContext(const Aws::String& key, const Aws::String& value) { m_contextHasBeenSet = true; m_context.emplace(key, value); return *this; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddContext(Aws::String&& key, const Aws::String& value) { m_contextHasBeenSet = true; m_context.emplace(std::move(key), value); return *this; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddContext(const Aws::String& key, Aws::String&& value) { m_contextHasBeenSet = true; m_context.emplace(key, std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddContext(Aws::String&& key, Aws::String&& value) { m_contextHasBeenSet = true; m_context.emplace(std::move(key), std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddContext(const char* key, Aws::String&& value) { m_contextHasBeenSet = true; m_context.emplace(key, std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddContext(Aws::String&& key, const char* value) { m_contextHasBeenSet = true; m_context.emplace(std::move(key), value); return *this; }
|
|
|
|
/**
|
|
* <p>An object that maps custom attributes to attributes for the address and is
|
|
* attached to the message. Attribute names are case sensitive.</p> <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddContext(const char* key, const char* value) { m_contextHasBeenSet = true; m_context.emplace(key, value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline const Aws::String& GetRawContent() const{ return m_rawContent; }
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline bool RawContentHasBeenSet() const { return m_rawContentHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline void SetRawContent(const Aws::String& value) { m_rawContentHasBeenSet = true; m_rawContent = value; }
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline void SetRawContent(Aws::String&& value) { m_rawContentHasBeenSet = true; m_rawContent = std::move(value); }
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline void SetRawContent(const char* value) { m_rawContentHasBeenSet = true; m_rawContent.assign(value); }
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline AddressConfiguration& WithRawContent(const Aws::String& value) { SetRawContent(value); return *this;}
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline AddressConfiguration& WithRawContent(Aws::String&& value) { SetRawContent(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The raw, JSON-formatted string to use as the payload for the message. If
|
|
* specified, this value overrides all other values for the message.</p>
|
|
*/
|
|
inline AddressConfiguration& WithRawContent(const char* value) { SetRawContent(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& GetSubstitutions() const{ return m_substitutions; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline bool SubstitutionsHasBeenSet() const { return m_substitutionsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetSubstitutions(const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& value) { m_substitutionsHasBeenSet = true; m_substitutions = value; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline void SetSubstitutions(Aws::Map<Aws::String, Aws::Vector<Aws::String>>&& value) { m_substitutionsHasBeenSet = true; m_substitutions = std::move(value); }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& WithSubstitutions(const Aws::Map<Aws::String, Aws::Vector<Aws::String>>& value) { SetSubstitutions(value); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& WithSubstitutions(Aws::Map<Aws::String, Aws::Vector<Aws::String>>&& value) { SetSubstitutions(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddSubstitutions(const Aws::String& key, const Aws::Vector<Aws::String>& value) { m_substitutionsHasBeenSet = true; m_substitutions.emplace(key, value); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddSubstitutions(Aws::String&& key, const Aws::Vector<Aws::String>& value) { m_substitutionsHasBeenSet = true; m_substitutions.emplace(std::move(key), value); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddSubstitutions(const Aws::String& key, Aws::Vector<Aws::String>&& value) { m_substitutionsHasBeenSet = true; m_substitutions.emplace(key, std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddSubstitutions(Aws::String&& key, Aws::Vector<Aws::String>&& value) { m_substitutionsHasBeenSet = true; m_substitutions.emplace(std::move(key), std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddSubstitutions(const char* key, Aws::Vector<Aws::String>&& value) { m_substitutionsHasBeenSet = true; m_substitutions.emplace(key, std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>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.</p>
|
|
*/
|
|
inline AddressConfiguration& AddSubstitutions(const char* key, const Aws::Vector<Aws::String>& value) { m_substitutionsHasBeenSet = true; m_substitutions.emplace(key, value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline const Aws::String& GetTitleOverride() const{ return m_titleOverride; }
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline bool TitleOverrideHasBeenSet() const { return m_titleOverrideHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline void SetTitleOverride(const Aws::String& value) { m_titleOverrideHasBeenSet = true; m_titleOverride = value; }
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline void SetTitleOverride(Aws::String&& value) { m_titleOverrideHasBeenSet = true; m_titleOverride = std::move(value); }
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline void SetTitleOverride(const char* value) { m_titleOverrideHasBeenSet = true; m_titleOverride.assign(value); }
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline AddressConfiguration& WithTitleOverride(const Aws::String& value) { SetTitleOverride(value); return *this;}
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline AddressConfiguration& WithTitleOverride(Aws::String&& value) { SetTitleOverride(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The message title to use instead of the default message title. This value
|
|
* overrides the default message title.</p>
|
|
*/
|
|
inline AddressConfiguration& WithTitleOverride(const char* value) { SetTitleOverride(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_bodyOverride;
|
|
bool m_bodyOverrideHasBeenSet;
|
|
|
|
ChannelType m_channelType;
|
|
bool m_channelTypeHasBeenSet;
|
|
|
|
Aws::Map<Aws::String, Aws::String> m_context;
|
|
bool m_contextHasBeenSet;
|
|
|
|
Aws::String m_rawContent;
|
|
bool m_rawContentHasBeenSet;
|
|
|
|
Aws::Map<Aws::String, Aws::Vector<Aws::String>> m_substitutions;
|
|
bool m_substitutionsHasBeenSet;
|
|
|
|
Aws::String m_titleOverride;
|
|
bool m_titleOverrideHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace Pinpoint
|
|
} // namespace Aws
|