AWS SDK for C++  1.9.41
AWS SDK for C++
Public Member Functions | List of all members
Aws::Pinpoint::Model::PushNotificationTemplateRequest Class Reference

#include <PushNotificationTemplateRequest.h>

Public Member Functions

 PushNotificationTemplateRequest ()
 
 PushNotificationTemplateRequest (Aws::Utils::Json::JsonView jsonValue)
 
PushNotificationTemplateRequestoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AndroidPushNotificationTemplate & GetADM () const
 
bool ADMHasBeenSet () const
 
void SetADM (const AndroidPushNotificationTemplate &value)
 
void SetADM (AndroidPushNotificationTemplate &&value)
 
PushNotificationTemplateRequestWithADM (const AndroidPushNotificationTemplate &value)
 
PushNotificationTemplateRequestWithADM (AndroidPushNotificationTemplate &&value)
 
const APNSPushNotificationTemplateGetAPNS () const
 
bool APNSHasBeenSet () const
 
void SetAPNS (const APNSPushNotificationTemplate &value)
 
void SetAPNS (APNSPushNotificationTemplate &&value)
 
PushNotificationTemplateRequestWithAPNS (const APNSPushNotificationTemplate &value)
 
PushNotificationTemplateRequestWithAPNS (APNSPushNotificationTemplate &&value)
 
const AndroidPushNotificationTemplate & GetBaidu () const
 
bool BaiduHasBeenSet () const
 
void SetBaidu (const AndroidPushNotificationTemplate &value)
 
void SetBaidu (AndroidPushNotificationTemplate &&value)
 
PushNotificationTemplateRequestWithBaidu (const AndroidPushNotificationTemplate &value)
 
PushNotificationTemplateRequestWithBaidu (AndroidPushNotificationTemplate &&value)
 
const DefaultPushNotificationTemplateGetDefault () const
 
bool DefaultHasBeenSet () const
 
void SetDefault (const DefaultPushNotificationTemplate &value)
 
void SetDefault (DefaultPushNotificationTemplate &&value)
 
PushNotificationTemplateRequestWithDefault (const DefaultPushNotificationTemplate &value)
 
PushNotificationTemplateRequestWithDefault (DefaultPushNotificationTemplate &&value)
 
const Aws::StringGetDefaultSubstitutions () const
 
bool DefaultSubstitutionsHasBeenSet () const
 
void SetDefaultSubstitutions (const Aws::String &value)
 
void SetDefaultSubstitutions (Aws::String &&value)
 
void SetDefaultSubstitutions (const char *value)
 
PushNotificationTemplateRequestWithDefaultSubstitutions (const Aws::String &value)
 
PushNotificationTemplateRequestWithDefaultSubstitutions (Aws::String &&value)
 
PushNotificationTemplateRequestWithDefaultSubstitutions (const char *value)
 
const AndroidPushNotificationTemplate & GetGCM () const
 
bool GCMHasBeenSet () const
 
void SetGCM (const AndroidPushNotificationTemplate &value)
 
void SetGCM (AndroidPushNotificationTemplate &&value)
 
PushNotificationTemplateRequestWithGCM (const AndroidPushNotificationTemplate &value)
 
PushNotificationTemplateRequestWithGCM (AndroidPushNotificationTemplate &&value)
 
const Aws::StringGetRecommenderId () const
 
bool RecommenderIdHasBeenSet () const
 
void SetRecommenderId (const Aws::String &value)
 
void SetRecommenderId (Aws::String &&value)
 
void SetRecommenderId (const char *value)
 
PushNotificationTemplateRequestWithRecommenderId (const Aws::String &value)
 
PushNotificationTemplateRequestWithRecommenderId (Aws::String &&value)
 
PushNotificationTemplateRequestWithRecommenderId (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
PushNotificationTemplateRequestWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
PushNotificationTemplateRequestWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
PushNotificationTemplateRequestAddTags (const Aws::String &key, const Aws::String &value)
 
PushNotificationTemplateRequestAddTags (Aws::String &&key, const Aws::String &value)
 
PushNotificationTemplateRequestAddTags (const Aws::String &key, Aws::String &&value)
 
PushNotificationTemplateRequestAddTags (Aws::String &&key, Aws::String &&value)
 
PushNotificationTemplateRequestAddTags (const char *key, Aws::String &&value)
 
PushNotificationTemplateRequestAddTags (Aws::String &&key, const char *value)
 
PushNotificationTemplateRequestAddTags (const char *key, const char *value)
 
const Aws::StringGetTemplateDescription () const
 
bool TemplateDescriptionHasBeenSet () const
 
void SetTemplateDescription (const Aws::String &value)
 
void SetTemplateDescription (Aws::String &&value)
 
void SetTemplateDescription (const char *value)
 
PushNotificationTemplateRequestWithTemplateDescription (const Aws::String &value)
 
PushNotificationTemplateRequestWithTemplateDescription (Aws::String &&value)
 
PushNotificationTemplateRequestWithTemplateDescription (const char *value)
 

Detailed Description

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

See Also:

AWS API Reference

Definition at line 37 of file PushNotificationTemplateRequest.h.

Constructor & Destructor Documentation

◆ PushNotificationTemplateRequest() [1/2]

Aws::Pinpoint::Model::PushNotificationTemplateRequest::PushNotificationTemplateRequest ( )

◆ PushNotificationTemplateRequest() [2/2]

Aws::Pinpoint::Model::PushNotificationTemplateRequest::PushNotificationTemplateRequest ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTags() [1/7]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 477 of file PushNotificationTemplateRequest.h.

◆ AddTags() [2/7]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 463 of file PushNotificationTemplateRequest.h.

◆ AddTags() [3/7]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 491 of file PushNotificationTemplateRequest.h.

◆ AddTags() [4/7]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 470 of file PushNotificationTemplateRequest.h.

◆ AddTags() [5/7]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 456 of file PushNotificationTemplateRequest.h.

◆ AddTags() [6/7]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 484 of file PushNotificationTemplateRequest.h.

◆ AddTags() [7/7]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::AddTags ( const char *  key,
const char *  value 
)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 498 of file PushNotificationTemplateRequest.h.

◆ ADMHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::ADMHasBeenSet ( ) const
inline

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 58 of file PushNotificationTemplateRequest.h.

◆ APNSHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::APNSHasBeenSet ( ) const
inline

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 101 of file PushNotificationTemplateRequest.h.

◆ BaiduHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::BaiduHasBeenSet ( ) const
inline

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 144 of file PushNotificationTemplateRequest.h.

◆ DefaultHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::DefaultHasBeenSet ( ) const
inline

The default message template to use for push notification channels.

Definition at line 183 of file PushNotificationTemplateRequest.h.

◆ DefaultSubstitutionsHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::DefaultSubstitutionsHasBeenSet ( ) const
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 224 of file PushNotificationTemplateRequest.h.

◆ GCMHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::GCMHasBeenSet ( ) const
inline

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 301 of file PushNotificationTemplateRequest.h.

◆ GetADM()

const AndroidPushNotificationTemplate& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetADM ( ) const
inline

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 51 of file PushNotificationTemplateRequest.h.

◆ GetAPNS()

const APNSPushNotificationTemplate& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetAPNS ( ) const
inline

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 94 of file PushNotificationTemplateRequest.h.

◆ GetBaidu()

const AndroidPushNotificationTemplate& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetBaidu ( ) const
inline

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 137 of file PushNotificationTemplateRequest.h.

◆ GetDefault()

const DefaultPushNotificationTemplate& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetDefault ( ) const
inline

The default message template to use for push notification channels.

Definition at line 178 of file PushNotificationTemplateRequest.h.

◆ GetDefaultSubstitutions()

const Aws::String& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetDefaultSubstitutions ( ) const
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 214 of file PushNotificationTemplateRequest.h.

◆ GetGCM()

const AndroidPushNotificationTemplate& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetGCM ( ) const
inline

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 293 of file PushNotificationTemplateRequest.h.

◆ GetRecommenderId()

const Aws::String& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetRecommenderId ( ) const
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 343 of file PushNotificationTemplateRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetTags ( ) const
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 414 of file PushNotificationTemplateRequest.h.

◆ GetTemplateDescription()

const Aws::String& Aws::Pinpoint::Model::PushNotificationTemplateRequest::GetTemplateDescription ( ) const
inline

A custom description of the message template.

Definition at line 504 of file PushNotificationTemplateRequest.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Pinpoint::Model::PushNotificationTemplateRequest::Jsonize ( ) const

◆ operator=()

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RecommenderIdHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::RecommenderIdHasBeenSet ( ) const
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 352 of file PushNotificationTemplateRequest.h.

◆ SetADM() [1/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetADM ( AndroidPushNotificationTemplate &&  value)
inline

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 72 of file PushNotificationTemplateRequest.h.

◆ SetADM() [2/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetADM ( const AndroidPushNotificationTemplate &  value)
inline

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 65 of file PushNotificationTemplateRequest.h.

◆ SetAPNS() [1/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetAPNS ( APNSPushNotificationTemplate &&  value)
inline

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 115 of file PushNotificationTemplateRequest.h.

◆ SetAPNS() [2/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetAPNS ( const APNSPushNotificationTemplate value)
inline

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 108 of file PushNotificationTemplateRequest.h.

◆ SetBaidu() [1/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetBaidu ( AndroidPushNotificationTemplate &&  value)
inline

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 158 of file PushNotificationTemplateRequest.h.

◆ SetBaidu() [2/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetBaidu ( const AndroidPushNotificationTemplate &  value)
inline

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 151 of file PushNotificationTemplateRequest.h.

◆ SetDefault() [1/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetDefault ( const DefaultPushNotificationTemplate value)
inline

The default message template to use for push notification channels.

Definition at line 188 of file PushNotificationTemplateRequest.h.

◆ SetDefault() [2/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetDefault ( DefaultPushNotificationTemplate &&  value)
inline

The default message template to use for push notification channels.

Definition at line 193 of file PushNotificationTemplateRequest.h.

◆ SetDefaultSubstitutions() [1/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetDefaultSubstitutions ( Aws::String &&  value)
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 244 of file PushNotificationTemplateRequest.h.

◆ SetDefaultSubstitutions() [2/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetDefaultSubstitutions ( const Aws::String value)
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 234 of file PushNotificationTemplateRequest.h.

◆ SetDefaultSubstitutions() [3/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetDefaultSubstitutions ( const char *  value)
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 254 of file PushNotificationTemplateRequest.h.

◆ SetGCM() [1/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetGCM ( AndroidPushNotificationTemplate &&  value)
inline

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 317 of file PushNotificationTemplateRequest.h.

◆ SetGCM() [2/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetGCM ( const AndroidPushNotificationTemplate &  value)
inline

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 309 of file PushNotificationTemplateRequest.h.

◆ SetRecommenderId() [1/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetRecommenderId ( Aws::String &&  value)
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 370 of file PushNotificationTemplateRequest.h.

◆ SetRecommenderId() [2/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetRecommenderId ( const Aws::String value)
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 361 of file PushNotificationTemplateRequest.h.

◆ SetRecommenderId() [3/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetRecommenderId ( const char *  value)
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 379 of file PushNotificationTemplateRequest.h.

◆ SetTags() [1/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 435 of file PushNotificationTemplateRequest.h.

◆ SetTags() [2/2]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 428 of file PushNotificationTemplateRequest.h.

◆ SetTemplateDescription() [1/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetTemplateDescription ( Aws::String &&  value)
inline

A custom description of the message template.

Definition at line 519 of file PushNotificationTemplateRequest.h.

◆ SetTemplateDescription() [2/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetTemplateDescription ( const Aws::String value)
inline

A custom description of the message template.

Definition at line 514 of file PushNotificationTemplateRequest.h.

◆ SetTemplateDescription() [3/3]

void Aws::Pinpoint::Model::PushNotificationTemplateRequest::SetTemplateDescription ( const char *  value)
inline

A custom description of the message template.

Definition at line 524 of file PushNotificationTemplateRequest.h.

◆ TagsHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::TagsHasBeenSet ( ) const
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 421 of file PushNotificationTemplateRequest.h.

◆ TemplateDescriptionHasBeenSet()

bool Aws::Pinpoint::Model::PushNotificationTemplateRequest::TemplateDescriptionHasBeenSet ( ) const
inline

A custom description of the message template.

Definition at line 509 of file PushNotificationTemplateRequest.h.

◆ WithADM() [1/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithADM ( AndroidPushNotificationTemplate &&  value)
inline

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 86 of file PushNotificationTemplateRequest.h.

◆ WithADM() [2/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithADM ( const AndroidPushNotificationTemplate &  value)
inline

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 79 of file PushNotificationTemplateRequest.h.

◆ WithAPNS() [1/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithAPNS ( APNSPushNotificationTemplate &&  value)
inline

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 129 of file PushNotificationTemplateRequest.h.

◆ WithAPNS() [2/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithAPNS ( const APNSPushNotificationTemplate value)
inline

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 122 of file PushNotificationTemplateRequest.h.

◆ WithBaidu() [1/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithBaidu ( AndroidPushNotificationTemplate &&  value)
inline

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 172 of file PushNotificationTemplateRequest.h.

◆ WithBaidu() [2/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithBaidu ( const AndroidPushNotificationTemplate &  value)
inline

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 165 of file PushNotificationTemplateRequest.h.

◆ WithDefault() [1/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithDefault ( const DefaultPushNotificationTemplate value)
inline

The default message template to use for push notification channels.

Definition at line 198 of file PushNotificationTemplateRequest.h.

◆ WithDefault() [2/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithDefault ( DefaultPushNotificationTemplate &&  value)
inline

The default message template to use for push notification channels.

Definition at line 203 of file PushNotificationTemplateRequest.h.

◆ WithDefaultSubstitutions() [1/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithDefaultSubstitutions ( Aws::String &&  value)
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 274 of file PushNotificationTemplateRequest.h.

◆ WithDefaultSubstitutions() [2/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithDefaultSubstitutions ( const Aws::String value)
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 264 of file PushNotificationTemplateRequest.h.

◆ WithDefaultSubstitutions() [3/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithDefaultSubstitutions ( const char *  value)
inline

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Definition at line 284 of file PushNotificationTemplateRequest.h.

◆ WithGCM() [1/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithGCM ( AndroidPushNotificationTemplate &&  value)
inline

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 333 of file PushNotificationTemplateRequest.h.

◆ WithGCM() [2/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithGCM ( const AndroidPushNotificationTemplate &  value)
inline

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Definition at line 325 of file PushNotificationTemplateRequest.h.

◆ WithRecommenderId() [1/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithRecommenderId ( Aws::String &&  value)
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 397 of file PushNotificationTemplateRequest.h.

◆ WithRecommenderId() [2/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithRecommenderId ( const Aws::String value)
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 388 of file PushNotificationTemplateRequest.h.

◆ WithRecommenderId() [3/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithRecommenderId ( const char *  value)
inline

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Definition at line 406 of file PushNotificationTemplateRequest.h.

◆ WithTags() [1/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 449 of file PushNotificationTemplateRequest.h.

◆ WithTags() [2/2]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Definition at line 442 of file PushNotificationTemplateRequest.h.

◆ WithTemplateDescription() [1/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithTemplateDescription ( Aws::String &&  value)
inline

A custom description of the message template.

Definition at line 534 of file PushNotificationTemplateRequest.h.

◆ WithTemplateDescription() [2/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithTemplateDescription ( const Aws::String value)
inline

A custom description of the message template.

Definition at line 529 of file PushNotificationTemplateRequest.h.

◆ WithTemplateDescription() [3/3]

PushNotificationTemplateRequest& Aws::Pinpoint::Model::PushNotificationTemplateRequest::WithTemplateDescription ( const char *  value)
inline

A custom description of the message template.

Definition at line 539 of file PushNotificationTemplateRequest.h.


The documentation for this class was generated from the following file: