AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::LexRuntimeService::Model::DialogAction Class Reference

#include <DialogAction.h>

Public Member Functions

 DialogAction ()
 
 DialogAction (Aws::Utils::Json::JsonView jsonValue)
 
DialogActionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const DialogActionTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const DialogActionType &value)
 
void SetType (DialogActionType &&value)
 
DialogActionWithType (const DialogActionType &value)
 
DialogActionWithType (DialogActionType &&value)
 
const Aws::StringGetIntentName () const
 
bool IntentNameHasBeenSet () const
 
void SetIntentName (const Aws::String &value)
 
void SetIntentName (Aws::String &&value)
 
void SetIntentName (const char *value)
 
DialogActionWithIntentName (const Aws::String &value)
 
DialogActionWithIntentName (Aws::String &&value)
 
DialogActionWithIntentName (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetSlots () const
 
bool SlotsHasBeenSet () const
 
void SetSlots (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetSlots (Aws::Map< Aws::String, Aws::String > &&value)
 
DialogActionWithSlots (const Aws::Map< Aws::String, Aws::String > &value)
 
DialogActionWithSlots (Aws::Map< Aws::String, Aws::String > &&value)
 
DialogActionAddSlots (const Aws::String &key, const Aws::String &value)
 
DialogActionAddSlots (Aws::String &&key, const Aws::String &value)
 
DialogActionAddSlots (const Aws::String &key, Aws::String &&value)
 
DialogActionAddSlots (Aws::String &&key, Aws::String &&value)
 
DialogActionAddSlots (const char *key, Aws::String &&value)
 
DialogActionAddSlots (Aws::String &&key, const char *value)
 
DialogActionAddSlots (const char *key, const char *value)
 
const Aws::StringGetSlotToElicit () const
 
bool SlotToElicitHasBeenSet () const
 
void SetSlotToElicit (const Aws::String &value)
 
void SetSlotToElicit (Aws::String &&value)
 
void SetSlotToElicit (const char *value)
 
DialogActionWithSlotToElicit (const Aws::String &value)
 
DialogActionWithSlotToElicit (Aws::String &&value)
 
DialogActionWithSlotToElicit (const char *value)
 
const FulfillmentStateGetFulfillmentState () const
 
bool FulfillmentStateHasBeenSet () const
 
void SetFulfillmentState (const FulfillmentState &value)
 
void SetFulfillmentState (FulfillmentState &&value)
 
DialogActionWithFulfillmentState (const FulfillmentState &value)
 
DialogActionWithFulfillmentState (FulfillmentState &&value)
 
const Aws::StringGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
DialogActionWithMessage (const Aws::String &value)
 
DialogActionWithMessage (Aws::String &&value)
 
DialogActionWithMessage (const char *value)
 
const MessageFormatTypeGetMessageFormat () const
 
bool MessageFormatHasBeenSet () const
 
void SetMessageFormat (const MessageFormatType &value)
 
void SetMessageFormat (MessageFormatType &&value)
 
DialogActionWithMessageFormat (const MessageFormatType &value)
 
DialogActionWithMessageFormat (MessageFormatType &&value)
 

Detailed Description

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

See Also:

AWS API Reference

Definition at line 39 of file DialogAction.h.

Constructor & Destructor Documentation

◆ DialogAction() [1/2]

Aws::LexRuntimeService::Model::DialogAction::DialogAction ( )

◆ DialogAction() [2/2]

Aws::LexRuntimeService::Model::DialogAction::DialogAction ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddSlots() [1/7]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::AddSlots ( const Aws::String key,
const Aws::String value 
)
inline

Map of the slots that have been gathered and their values.

Definition at line 213 of file DialogAction.h.

◆ AddSlots() [2/7]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::AddSlots ( Aws::String &&  key,
const Aws::String value 
)
inline

Map of the slots that have been gathered and their values.

Definition at line 218 of file DialogAction.h.

◆ AddSlots() [3/7]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::AddSlots ( const Aws::String key,
Aws::String &&  value 
)
inline

Map of the slots that have been gathered and their values.

Definition at line 223 of file DialogAction.h.

◆ AddSlots() [4/7]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::AddSlots ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Map of the slots that have been gathered and their values.

Definition at line 228 of file DialogAction.h.

◆ AddSlots() [5/7]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::AddSlots ( const char *  key,
Aws::String &&  value 
)
inline

Map of the slots that have been gathered and their values.

Definition at line 233 of file DialogAction.h.

◆ AddSlots() [6/7]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::AddSlots ( Aws::String &&  key,
const char *  value 
)
inline

Map of the slots that have been gathered and their values.

Definition at line 238 of file DialogAction.h.

◆ AddSlots() [7/7]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::AddSlots ( const char *  key,
const char *  value 
)
inline

Map of the slots that have been gathered and their values.

Definition at line 243 of file DialogAction.h.

◆ FulfillmentStateHasBeenSet()

bool Aws::LexRuntimeService::Model::DialogAction::FulfillmentStateHasBeenSet ( ) const
inline

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Definition at line 307 of file DialogAction.h.

◆ GetFulfillmentState()

const FulfillmentState& Aws::LexRuntimeService::Model::DialogAction::GetFulfillmentState ( ) const
inline

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Definition at line 296 of file DialogAction.h.

◆ GetIntentName()

const Aws::String& Aws::LexRuntimeService::Model::DialogAction::GetIntentName ( ) const
inline

The name of the intent.

Definition at line 142 of file DialogAction.h.

◆ GetMessage()

const Aws::String& Aws::LexRuntimeService::Model::DialogAction::GetMessage ( ) const
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 358 of file DialogAction.h.

◆ GetMessageFormat()

const MessageFormatType& Aws::LexRuntimeService::Model::DialogAction::GetMessageFormat ( ) const
inline
  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Definition at line 413 of file DialogAction.h.

◆ GetSlots()

const Aws::Map<Aws::String, Aws::String>& Aws::LexRuntimeService::Model::DialogAction::GetSlots ( ) const
inline

Map of the slots that have been gathered and their values.

Definition at line 183 of file DialogAction.h.

◆ GetSlotToElicit()

const Aws::String& Aws::LexRuntimeService::Model::DialogAction::GetSlotToElicit ( ) const
inline

The name of the slot that should be elicited from the user.

Definition at line 249 of file DialogAction.h.

◆ GetType()

const DialogActionType& Aws::LexRuntimeService::Model::DialogAction::GetType ( ) const
inline

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Definition at line 61 of file DialogAction.h.

◆ IntentNameHasBeenSet()

bool Aws::LexRuntimeService::Model::DialogAction::IntentNameHasBeenSet ( ) const
inline

The name of the intent.

Definition at line 147 of file DialogAction.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::LexRuntimeService::Model::DialogAction::Jsonize ( ) const

◆ MessageFormatHasBeenSet()

bool Aws::LexRuntimeService::Model::DialogAction::MessageFormatHasBeenSet ( ) const
inline
  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Definition at line 425 of file DialogAction.h.

◆ MessageHasBeenSet()

bool Aws::LexRuntimeService::Model::DialogAction::MessageHasBeenSet ( ) const
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 364 of file DialogAction.h.

◆ operator=()

DialogAction& Aws::LexRuntimeService::Model::DialogAction::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetFulfillmentState() [1/2]

void Aws::LexRuntimeService::Model::DialogAction::SetFulfillmentState ( const FulfillmentState value)
inline

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Definition at line 318 of file DialogAction.h.

◆ SetFulfillmentState() [2/2]

void Aws::LexRuntimeService::Model::DialogAction::SetFulfillmentState ( FulfillmentState &&  value)
inline

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Definition at line 329 of file DialogAction.h.

◆ SetIntentName() [1/3]

void Aws::LexRuntimeService::Model::DialogAction::SetIntentName ( const Aws::String value)
inline

The name of the intent.

Definition at line 152 of file DialogAction.h.

◆ SetIntentName() [2/3]

void Aws::LexRuntimeService::Model::DialogAction::SetIntentName ( Aws::String &&  value)
inline

The name of the intent.

Definition at line 157 of file DialogAction.h.

◆ SetIntentName() [3/3]

void Aws::LexRuntimeService::Model::DialogAction::SetIntentName ( const char *  value)
inline

The name of the intent.

Definition at line 162 of file DialogAction.h.

◆ SetMessage() [1/3]

void Aws::LexRuntimeService::Model::DialogAction::SetMessage ( const Aws::String value)
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 370 of file DialogAction.h.

◆ SetMessage() [2/3]

void Aws::LexRuntimeService::Model::DialogAction::SetMessage ( Aws::String &&  value)
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 376 of file DialogAction.h.

◆ SetMessage() [3/3]

void Aws::LexRuntimeService::Model::DialogAction::SetMessage ( const char *  value)
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 382 of file DialogAction.h.

◆ SetMessageFormat() [1/2]

void Aws::LexRuntimeService::Model::DialogAction::SetMessageFormat ( const MessageFormatType value)
inline
  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Definition at line 437 of file DialogAction.h.

◆ SetMessageFormat() [2/2]

void Aws::LexRuntimeService::Model::DialogAction::SetMessageFormat ( MessageFormatType &&  value)
inline
  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Definition at line 449 of file DialogAction.h.

◆ SetSlots() [1/2]

void Aws::LexRuntimeService::Model::DialogAction::SetSlots ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Map of the slots that have been gathered and their values.

Definition at line 193 of file DialogAction.h.

◆ SetSlots() [2/2]

void Aws::LexRuntimeService::Model::DialogAction::SetSlots ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Map of the slots that have been gathered and their values.

Definition at line 198 of file DialogAction.h.

◆ SetSlotToElicit() [1/3]

void Aws::LexRuntimeService::Model::DialogAction::SetSlotToElicit ( const Aws::String value)
inline

The name of the slot that should be elicited from the user.

Definition at line 259 of file DialogAction.h.

◆ SetSlotToElicit() [2/3]

void Aws::LexRuntimeService::Model::DialogAction::SetSlotToElicit ( Aws::String &&  value)
inline

The name of the slot that should be elicited from the user.

Definition at line 264 of file DialogAction.h.

◆ SetSlotToElicit() [3/3]

void Aws::LexRuntimeService::Model::DialogAction::SetSlotToElicit ( const char *  value)
inline

The name of the slot that should be elicited from the user.

Definition at line 269 of file DialogAction.h.

◆ SetType() [1/2]

void Aws::LexRuntimeService::Model::DialogAction::SetType ( const DialogActionType value)
inline

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Definition at line 91 of file DialogAction.h.

◆ SetType() [2/2]

void Aws::LexRuntimeService::Model::DialogAction::SetType ( DialogActionType &&  value)
inline

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Definition at line 106 of file DialogAction.h.

◆ SlotsHasBeenSet()

bool Aws::LexRuntimeService::Model::DialogAction::SlotsHasBeenSet ( ) const
inline

Map of the slots that have been gathered and their values.

Definition at line 188 of file DialogAction.h.

◆ SlotToElicitHasBeenSet()

bool Aws::LexRuntimeService::Model::DialogAction::SlotToElicitHasBeenSet ( ) const
inline

The name of the slot that should be elicited from the user.

Definition at line 254 of file DialogAction.h.

◆ TypeHasBeenSet()

bool Aws::LexRuntimeService::Model::DialogAction::TypeHasBeenSet ( ) const
inline

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Definition at line 76 of file DialogAction.h.

◆ WithFulfillmentState() [1/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithFulfillmentState ( const FulfillmentState value)
inline

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Definition at line 340 of file DialogAction.h.

◆ WithFulfillmentState() [2/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithFulfillmentState ( FulfillmentState &&  value)
inline

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

Definition at line 351 of file DialogAction.h.

◆ WithIntentName() [1/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithIntentName ( const Aws::String value)
inline

The name of the intent.

Definition at line 167 of file DialogAction.h.

◆ WithIntentName() [2/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithIntentName ( Aws::String &&  value)
inline

The name of the intent.

Definition at line 172 of file DialogAction.h.

◆ WithIntentName() [3/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithIntentName ( const char *  value)
inline

The name of the intent.

Definition at line 177 of file DialogAction.h.

◆ WithMessage() [1/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithMessage ( const Aws::String value)
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 388 of file DialogAction.h.

◆ WithMessage() [2/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithMessage ( Aws::String &&  value)
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 394 of file DialogAction.h.

◆ WithMessage() [3/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithMessage ( const char *  value)
inline

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

Definition at line 400 of file DialogAction.h.

◆ WithMessageFormat() [1/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithMessageFormat ( const MessageFormatType value)
inline
  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Definition at line 461 of file DialogAction.h.

◆ WithMessageFormat() [2/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithMessageFormat ( MessageFormatType &&  value)
inline
  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

Definition at line 473 of file DialogAction.h.

◆ WithSlots() [1/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithSlots ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Map of the slots that have been gathered and their values.

Definition at line 203 of file DialogAction.h.

◆ WithSlots() [2/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithSlots ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Map of the slots that have been gathered and their values.

Definition at line 208 of file DialogAction.h.

◆ WithSlotToElicit() [1/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithSlotToElicit ( const Aws::String value)
inline

The name of the slot that should be elicited from the user.

Definition at line 274 of file DialogAction.h.

◆ WithSlotToElicit() [2/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithSlotToElicit ( Aws::String &&  value)
inline

The name of the slot that should be elicited from the user.

Definition at line 279 of file DialogAction.h.

◆ WithSlotToElicit() [3/3]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithSlotToElicit ( const char *  value)
inline

The name of the slot that should be elicited from the user.

Definition at line 284 of file DialogAction.h.

◆ WithType() [1/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithType ( const DialogActionType value)
inline

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Definition at line 121 of file DialogAction.h.

◆ WithType() [2/2]

DialogAction& Aws::LexRuntimeService::Model::DialogAction::WithType ( DialogActionType &&  value)
inline

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"

  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

Definition at line 136 of file DialogAction.h.


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