AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | List of all members
Aws::LexModelBuildingService::Model::Prompt Class Reference

#include <Prompt.h>

Public Member Functions

 Prompt ()
 
 Prompt (Aws::Utils::Json::JsonView jsonValue)
 
Promptoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Message > & GetMessages () const
 
bool MessagesHasBeenSet () const
 
void SetMessages (const Aws::Vector< Message > &value)
 
void SetMessages (Aws::Vector< Message > &&value)
 
PromptWithMessages (const Aws::Vector< Message > &value)
 
PromptWithMessages (Aws::Vector< Message > &&value)
 
PromptAddMessages (const Message &value)
 
PromptAddMessages (Message &&value)
 
int GetMaxAttempts () const
 
bool MaxAttemptsHasBeenSet () const
 
void SetMaxAttempts (int value)
 
PromptWithMaxAttempts (int value)
 
const Aws::StringGetResponseCard () const
 
bool ResponseCardHasBeenSet () const
 
void SetResponseCard (const Aws::String &value)
 
void SetResponseCard (Aws::String &&value)
 
void SetResponseCard (const char *value)
 
PromptWithResponseCard (const Aws::String &value)
 
PromptWithResponseCard (Aws::String &&value)
 
PromptWithResponseCard (const char *value)
 

Detailed Description

Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.

See Also:

AWS API Reference

Definition at line 37 of file Prompt.h.

Constructor & Destructor Documentation

◆ Prompt() [1/2]

Aws::LexModelBuildingService::Model::Prompt::Prompt ( )

◆ Prompt() [2/2]

Aws::LexModelBuildingService::Model::Prompt::Prompt ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddMessages() [1/2]

Prompt& Aws::LexModelBuildingService::Model::Prompt::AddMessages ( const Message value)
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 93 of file Prompt.h.

◆ AddMessages() [2/2]

Prompt& Aws::LexModelBuildingService::Model::Prompt::AddMessages ( Message &&  value)
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 100 of file Prompt.h.

◆ GetMaxAttempts()

int Aws::LexModelBuildingService::Model::Prompt::GetMaxAttempts ( ) const
inline

The number of times to prompt the user for information.

Definition at line 106 of file Prompt.h.

◆ GetMessages()

const Aws::Vector<Message>& Aws::LexModelBuildingService::Model::Prompt::GetMessages ( ) const
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 51 of file Prompt.h.

◆ GetResponseCard()

const Aws::String& Aws::LexModelBuildingService::Model::Prompt::GetResponseCard ( ) const
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 130 of file Prompt.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::LexModelBuildingService::Model::Prompt::Jsonize ( ) const

◆ MaxAttemptsHasBeenSet()

bool Aws::LexModelBuildingService::Model::Prompt::MaxAttemptsHasBeenSet ( ) const
inline

The number of times to prompt the user for information.

Definition at line 111 of file Prompt.h.

◆ MessagesHasBeenSet()

bool Aws::LexModelBuildingService::Model::Prompt::MessagesHasBeenSet ( ) const
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 58 of file Prompt.h.

◆ operator=()

Prompt& Aws::LexModelBuildingService::Model::Prompt::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResponseCardHasBeenSet()

bool Aws::LexModelBuildingService::Model::Prompt::ResponseCardHasBeenSet ( ) const
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 138 of file Prompt.h.

◆ SetMaxAttempts()

void Aws::LexModelBuildingService::Model::Prompt::SetMaxAttempts ( int  value)
inline

The number of times to prompt the user for information.

Definition at line 116 of file Prompt.h.

◆ SetMessages() [1/2]

void Aws::LexModelBuildingService::Model::Prompt::SetMessages ( Aws::Vector< Message > &&  value)
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 72 of file Prompt.h.

◆ SetMessages() [2/2]

void Aws::LexModelBuildingService::Model::Prompt::SetMessages ( const Aws::Vector< Message > &  value)
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 65 of file Prompt.h.

◆ SetResponseCard() [1/3]

void Aws::LexModelBuildingService::Model::Prompt::SetResponseCard ( Aws::String &&  value)
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 154 of file Prompt.h.

◆ SetResponseCard() [2/3]

void Aws::LexModelBuildingService::Model::Prompt::SetResponseCard ( const Aws::String value)
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 146 of file Prompt.h.

◆ SetResponseCard() [3/3]

void Aws::LexModelBuildingService::Model::Prompt::SetResponseCard ( const char *  value)
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 162 of file Prompt.h.

◆ WithMaxAttempts()

Prompt& Aws::LexModelBuildingService::Model::Prompt::WithMaxAttempts ( int  value)
inline

The number of times to prompt the user for information.

Definition at line 121 of file Prompt.h.

◆ WithMessages() [1/2]

Prompt& Aws::LexModelBuildingService::Model::Prompt::WithMessages ( Aws::Vector< Message > &&  value)
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 86 of file Prompt.h.

◆ WithMessages() [2/2]

Prompt& Aws::LexModelBuildingService::Model::Prompt::WithMessages ( const Aws::Vector< Message > &  value)
inline

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

Definition at line 79 of file Prompt.h.

◆ WithResponseCard() [1/3]

Prompt& Aws::LexModelBuildingService::Model::Prompt::WithResponseCard ( Aws::String &&  value)
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 178 of file Prompt.h.

◆ WithResponseCard() [2/3]

Prompt& Aws::LexModelBuildingService::Model::Prompt::WithResponseCard ( const Aws::String value)
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 170 of file Prompt.h.

◆ WithResponseCard() [3/3]

Prompt& Aws::LexModelBuildingService::Model::Prompt::WithResponseCard ( const char *  value)
inline

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Definition at line 186 of file Prompt.h.


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