/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

Specifies the configuration and other settings for a message to send to all * the endpoints that are associated with a list of users.

See Also:

* AWS * API Reference

*/ class SendUsersMessageRequest { public: AWS_PINPOINT_API SendUsersMessageRequest(); AWS_PINPOINT_API SendUsersMessageRequest(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API SendUsersMessageRequest& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline const Aws::Map& GetContext() const{ return m_context; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline bool ContextHasBeenSet() const { return m_contextHasBeenSet; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline void SetContext(const Aws::Map& value) { m_contextHasBeenSet = true; m_context = value; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline void SetContext(Aws::Map&& value) { m_contextHasBeenSet = true; m_context = std::move(value); } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& WithContext(const Aws::Map& value) { SetContext(value); return *this;} /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& WithContext(Aws::Map&& value) { SetContext(std::move(value)); return *this;} /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& AddContext(const Aws::String& key, const Aws::String& value) { m_contextHasBeenSet = true; m_context.emplace(key, value); return *this; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& AddContext(Aws::String&& key, const Aws::String& value) { m_contextHasBeenSet = true; m_context.emplace(std::move(key), value); return *this; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& AddContext(const Aws::String& key, Aws::String&& value) { m_contextHasBeenSet = true; m_context.emplace(key, std::move(value)); return *this; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& AddContext(Aws::String&& key, Aws::String&& value) { m_contextHasBeenSet = true; m_context.emplace(std::move(key), std::move(value)); return *this; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& AddContext(const char* key, Aws::String&& value) { m_contextHasBeenSet = true; m_context.emplace(key, std::move(value)); return *this; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& AddContext(Aws::String&& key, const char* value) { m_contextHasBeenSet = true; m_context.emplace(std::move(key), value); return *this; } /** *

A map of custom attribute-value pairs. For a push notification, Amazon * Pinpoint adds these attributes to the data.pinpoint object in the body of the * notification payload. Amazon Pinpoint also provides these attributes in the * events that it generates for users-messages deliveries.

*/ inline SendUsersMessageRequest& AddContext(const char* key, const char* value) { m_contextHasBeenSet = true; m_context.emplace(key, value); return *this; } /** *

The settings and content for the default message and any default messages * that you defined for specific channels.

*/ inline const DirectMessageConfiguration& GetMessageConfiguration() const{ return m_messageConfiguration; } /** *

The settings and content for the default message and any default messages * that you defined for specific channels.

*/ inline bool MessageConfigurationHasBeenSet() const { return m_messageConfigurationHasBeenSet; } /** *

The settings and content for the default message and any default messages * that you defined for specific channels.

*/ inline void SetMessageConfiguration(const DirectMessageConfiguration& value) { m_messageConfigurationHasBeenSet = true; m_messageConfiguration = value; } /** *

The settings and content for the default message and any default messages * that you defined for specific channels.

*/ inline void SetMessageConfiguration(DirectMessageConfiguration&& value) { m_messageConfigurationHasBeenSet = true; m_messageConfiguration = std::move(value); } /** *

The settings and content for the default message and any default messages * that you defined for specific channels.

*/ inline SendUsersMessageRequest& WithMessageConfiguration(const DirectMessageConfiguration& value) { SetMessageConfiguration(value); return *this;} /** *

The settings and content for the default message and any default messages * that you defined for specific channels.

*/ inline SendUsersMessageRequest& WithMessageConfiguration(DirectMessageConfiguration&& value) { SetMessageConfiguration(std::move(value)); return *this;} /** *

The message template to use for the message.

*/ inline const TemplateConfiguration& GetTemplateConfiguration() const{ return m_templateConfiguration; } /** *

The message template to use for the message.

*/ inline bool TemplateConfigurationHasBeenSet() const { return m_templateConfigurationHasBeenSet; } /** *

The message template to use for the message.

*/ inline void SetTemplateConfiguration(const TemplateConfiguration& value) { m_templateConfigurationHasBeenSet = true; m_templateConfiguration = value; } /** *

The message template to use for the message.

*/ inline void SetTemplateConfiguration(TemplateConfiguration&& value) { m_templateConfigurationHasBeenSet = true; m_templateConfiguration = std::move(value); } /** *

The message template to use for the message.

*/ inline SendUsersMessageRequest& WithTemplateConfiguration(const TemplateConfiguration& value) { SetTemplateConfiguration(value); return *this;} /** *

The message template to use for the message.

*/ inline SendUsersMessageRequest& WithTemplateConfiguration(TemplateConfiguration&& value) { SetTemplateConfiguration(std::move(value)); return *this;} /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline const Aws::String& GetTraceId() const{ return m_traceId; } /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline bool TraceIdHasBeenSet() const { return m_traceIdHasBeenSet; } /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline void SetTraceId(const Aws::String& value) { m_traceIdHasBeenSet = true; m_traceId = value; } /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline void SetTraceId(Aws::String&& value) { m_traceIdHasBeenSet = true; m_traceId = std::move(value); } /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline void SetTraceId(const char* value) { m_traceIdHasBeenSet = true; m_traceId.assign(value); } /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline SendUsersMessageRequest& WithTraceId(const Aws::String& value) { SetTraceId(value); return *this;} /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline SendUsersMessageRequest& WithTraceId(Aws::String&& value) { SetTraceId(std::move(value)); return *this;} /** *

The unique identifier for tracing the message. This identifier is visible to * message recipients.

*/ inline SendUsersMessageRequest& WithTraceId(const char* value) { SetTraceId(value); return *this;} /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline const Aws::Map& GetUsers() const{ return m_users; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline bool UsersHasBeenSet() const { return m_usersHasBeenSet; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline void SetUsers(const Aws::Map& value) { m_usersHasBeenSet = true; m_users = value; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline void SetUsers(Aws::Map&& value) { m_usersHasBeenSet = true; m_users = std::move(value); } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& WithUsers(const Aws::Map& value) { SetUsers(value); return *this;} /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& WithUsers(Aws::Map&& value) { SetUsers(std::move(value)); return *this;} /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& AddUsers(const Aws::String& key, const EndpointSendConfiguration& value) { m_usersHasBeenSet = true; m_users.emplace(key, value); return *this; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& AddUsers(Aws::String&& key, const EndpointSendConfiguration& value) { m_usersHasBeenSet = true; m_users.emplace(std::move(key), value); return *this; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& AddUsers(const Aws::String& key, EndpointSendConfiguration&& value) { m_usersHasBeenSet = true; m_users.emplace(key, std::move(value)); return *this; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& AddUsers(Aws::String&& key, EndpointSendConfiguration&& value) { m_usersHasBeenSet = true; m_users.emplace(std::move(key), std::move(value)); return *this; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& AddUsers(const char* key, EndpointSendConfiguration&& value) { m_usersHasBeenSet = true; m_users.emplace(key, std::move(value)); return *this; } /** *

A map that associates user IDs with EndpointSendConfiguration * objects. You can use an EndpointSendConfiguration * object to tailor the message for a user by specifying settings such as content * overrides and message variables.

*/ inline SendUsersMessageRequest& AddUsers(const char* key, const EndpointSendConfiguration& value) { m_usersHasBeenSet = true; m_users.emplace(key, value); return *this; } private: Aws::Map m_context; bool m_contextHasBeenSet = false; DirectMessageConfiguration m_messageConfiguration; bool m_messageConfigurationHasBeenSet = false; TemplateConfiguration m_templateConfiguration; bool m_templateConfigurationHasBeenSet = false; Aws::String m_traceId; bool m_traceIdHasBeenSet = false; Aws::Map m_users; bool m_usersHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws