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

#include <Template.h>

Public Member Functions

 Template ()
 
 Template (Aws::Utils::Json::JsonView jsonValue)
 
Templateoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
TemplateWithName (const Aws::String &value)
 
TemplateWithName (Aws::String &&value)
 
TemplateWithName (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
TemplateWithVersion (const Aws::String &value)
 
TemplateWithVersion (Aws::String &&value)
 
TemplateWithVersion (const char *value)
 

Detailed Description

Specifies the name and version of the message template to use for the message.

See Also:

AWS API Reference

Definition at line 32 of file Template.h.

Constructor & Destructor Documentation

◆ Template() [1/2]

Aws::Pinpoint::Model::Template::Template ( )

◆ Template() [2/2]

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

Member Function Documentation

◆ GetName()

const Aws::String& Aws::Pinpoint::Model::Template::GetName ( ) const
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 45 of file Template.h.

◆ GetVersion()

const Aws::String& Aws::Pinpoint::Model::Template::GetVersion ( ) const
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 102 of file Template.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

bool Aws::Pinpoint::Model::Template::NameHasBeenSet ( ) const
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 51 of file Template.h.

◆ operator=()

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

◆ SetName() [1/3]

void Aws::Pinpoint::Model::Template::SetName ( const Aws::String value)
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 57 of file Template.h.

◆ SetName() [2/3]

void Aws::Pinpoint::Model::Template::SetName ( Aws::String &&  value)
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 63 of file Template.h.

◆ SetName() [3/3]

void Aws::Pinpoint::Model::Template::SetName ( const char *  value)
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 69 of file Template.h.

◆ SetVersion() [1/3]

void Aws::Pinpoint::Model::Template::SetVersion ( const Aws::String value)
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 130 of file Template.h.

◆ SetVersion() [2/3]

void Aws::Pinpoint::Model::Template::SetVersion ( Aws::String &&  value)
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 144 of file Template.h.

◆ SetVersion() [3/3]

void Aws::Pinpoint::Model::Template::SetVersion ( const char *  value)
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 158 of file Template.h.

◆ VersionHasBeenSet()

bool Aws::Pinpoint::Model::Template::VersionHasBeenSet ( ) const
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 116 of file Template.h.

◆ WithName() [1/3]

Template& Aws::Pinpoint::Model::Template::WithName ( const Aws::String value)
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 75 of file Template.h.

◆ WithName() [2/3]

Template& Aws::Pinpoint::Model::Template::WithName ( Aws::String &&  value)
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 81 of file Template.h.

◆ WithName() [3/3]

Template& Aws::Pinpoint::Model::Template::WithName ( const char *  value)
inline

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Definition at line 87 of file Template.h.

◆ WithVersion() [1/3]

Template& Aws::Pinpoint::Model::Template::WithVersion ( const Aws::String value)
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 172 of file Template.h.

◆ WithVersion() [2/3]

Template& Aws::Pinpoint::Model::Template::WithVersion ( Aws::String &&  value)
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 186 of file Template.h.

◆ WithVersion() [3/3]

Template& Aws::Pinpoint::Model::Template::WithVersion ( const char *  value)
inline

The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend="templates-template-name-template-type-versions">Template Versions</link> resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Definition at line 200 of file Template.h.


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