DialogAction (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.lexrts.model.DialogAction

All Implemented Interfaces:

java.io.Serializable
```
public class DialogAction
extends java.lang.Object
implements java.io.Serializable
```
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:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DialogAction()

Constructors
Constructor and Description
`DialogAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DialogAction`	`addslotsEntry(java.lang.String key, java.lang.String value)` Map of the slots that have been gathered and their values.
`DialogAction`	`clearslotsEntries()` Removes all the entries added into slots.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getFulfillmentState()` The fulfillment state of the intent.
`java.lang.String`	`getIntentName()` The name of the intent.
`java.lang.String`	`getMessage()` The message that should be shown to the user.
`java.lang.String`	`getMessageFormat()`
`java.util.Map<java.lang.String,java.lang.String>`	`getSlots()` Map of the slots that have been gathered and their values.
`java.lang.String`	`getSlotToElicit()` The name of the slot that should be elicited from the user.
`java.lang.String`	`getType()` The next action that the bot should take in its interaction with the user.
`int`	`hashCode()`
`void`	`setFulfillmentState(FulfillmentState fulfillmentState)` The fulfillment state of the intent.
`void`	`setFulfillmentState(java.lang.String fulfillmentState)` The fulfillment state of the intent.
`void`	`setIntentName(java.lang.String intentName)` The name of the intent.
`void`	`setMessage(java.lang.String message)` The message that should be shown to the user.
`void`	`setMessageFormat(MessageFormatType messageFormat)`
`void`	`setMessageFormat(java.lang.String messageFormat)`
`void`	`setSlots(java.util.Map<java.lang.String,java.lang.String> slots)` Map of the slots that have been gathered and their values.
`void`	`setSlotToElicit(java.lang.String slotToElicit)` The name of the slot that should be elicited from the user.
`void`	`setType(DialogActionType type)` The next action that the bot should take in its interaction with the user.
`void`	`setType(java.lang.String type)` The next action that the bot should take in its interaction with the user.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DialogAction`	`withFulfillmentState(FulfillmentState fulfillmentState)` The fulfillment state of the intent.
`DialogAction`	`withFulfillmentState(java.lang.String fulfillmentState)` The fulfillment state of the intent.
`DialogAction`	`withIntentName(java.lang.String intentName)` The name of the intent.
`DialogAction`	`withMessage(java.lang.String message)` The message that should be shown to the user.
`DialogAction`	`withMessageFormat(MessageFormatType messageFormat)`
`DialogAction`	`withMessageFormat(java.lang.String messageFormat)`
`DialogAction`	`withSlots(java.util.Map<java.lang.String,java.lang.String> slots)` Map of the slots that have been gathered and their values.
`DialogAction`	`withSlotToElicit(java.lang.String slotToElicit)` The name of the slot that should be elicited from the user.
`DialogAction`	`withType(DialogActionType type)` The next action that the bot should take in its interaction with the user.
`DialogAction`	`withType(java.lang.String type)` The next action that the bot should take in its interaction with the user.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DialogAction
```
public DialogAction()
```
- Method Detail
  - getType
```
public java.lang.String getType()
```
    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.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
    Returns:
    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.
    See Also:
    
    DialogActionType
  - setType
```
public void setType(java.lang.String type)
```
    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.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
    Parameters:
    type -
    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.
    See Also:
    
    DialogActionType
  - withType
```
public DialogAction withType(java.lang.String type)
```
    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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
    Parameters:
    type -
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DialogActionType
  - setType
```
public void setType(DialogActionType type)
```
    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.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
    Parameters:
    type -
    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.
    See Also:
    
    DialogActionType
  - withType
```
public DialogAction withType(DialogActionType type)
```
    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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
    Parameters:
    type -
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DialogActionType
  - getIntentName
```
public java.lang.String getIntentName()
```
    The name of the intent.
    
    Returns:
    
    The name of the intent.
  - setIntentName
```
public void setIntentName(java.lang.String intentName)
```
    The name of the intent.
    
    Parameters:
    
    intentName -
    The name of the intent.
  - withIntentName
```
public DialogAction withIntentName(java.lang.String intentName)
```
    The name of the intent.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    intentName -
    The name of the intent.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSlots
```
public java.util.Map<java.lang.String,java.lang.String> getSlots()
```
    Map of the slots that have been gathered and their values.
    
    Returns:
    
    Map of the slots that have been gathered and their values.
  - setSlots
```
public void setSlots(java.util.Map<java.lang.String,java.lang.String> slots)
```
    Map of the slots that have been gathered and their values.
    
    Parameters:
    
    slots -
    Map of the slots that have been gathered and their values.
  - withSlots
```
public DialogAction withSlots(java.util.Map<java.lang.String,java.lang.String> slots)
```
    Map of the slots that have been gathered and their values.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    slots -
    Map of the slots that have been gathered and their values.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addslotsEntry
```
public DialogAction addslotsEntry(java.lang.String key,
                                  java.lang.String value)
```
    Map of the slots that have been gathered and their values.
    
    The method adds a new key-value pair into slots parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into slots.
    
    value - The corresponding value of the entry to be added into slots.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearslotsEntries
```
public DialogAction clearslotsEntries()
```
    Removes all the entries added into slots.
    Returns a reference to this object so that method calls can be chained together.
  - getSlotToElicit
```
public java.lang.String getSlotToElicit()
```
    The name of the slot that should be elicited from the user.
    
    Returns:
    
    The name of the slot that should be elicited from the user.
  - setSlotToElicit
```
public void setSlotToElicit(java.lang.String slotToElicit)
```
    The name of the slot that should be elicited from the user.
    
    Parameters:
    
    slotToElicit -
    The name of the slot that should be elicited from the user.
  - withSlotToElicit
```
public DialogAction withSlotToElicit(java.lang.String slotToElicit)
```
    The name of the slot that should be elicited from the user.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    slotToElicit -
    The name of the slot that should be elicited from the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFulfillmentState
```
public java.lang.String getFulfillmentState()
```
    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.
    Constraints:
    Allowed Values: Fulfilled, Failed, ReadyForFulfillment
    Returns:
    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.
    See Also:
    
    FulfillmentState
  - setFulfillmentState
```
public void setFulfillmentState(java.lang.String fulfillmentState)
```
    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.
    Constraints:
    Allowed Values: Fulfilled, Failed, ReadyForFulfillment
    Parameters:
    fulfillmentState -
    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.
    See Also:
    
    FulfillmentState
  - withFulfillmentState
```
public DialogAction withFulfillmentState(java.lang.String fulfillmentState)
```
    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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Fulfilled, Failed, ReadyForFulfillment
    Parameters:
    fulfillmentState -
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    FulfillmentState
  - setFulfillmentState
```
public void setFulfillmentState(FulfillmentState fulfillmentState)
```
    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.
    Constraints:
    Allowed Values: Fulfilled, Failed, ReadyForFulfillment
    Parameters:
    fulfillmentState -
    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.
    See Also:
    
    FulfillmentState
  - withFulfillmentState
```
public DialogAction withFulfillmentState(FulfillmentState fulfillmentState)
```
    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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Fulfilled, Failed, ReadyForFulfillment
    Parameters:
    fulfillmentState -
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    FulfillmentState
  - getMessage
```
public java.lang.String getMessage()
```
    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.
    
    Constraints:
    Length: 1 - 1024
    
    Returns:
    
    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.
  - setMessage
```
public void setMessage(java.lang.String message)
```
    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.
    
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    message -
    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.
  - withMessage
```
public DialogAction withMessage(java.lang.String message)
```
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    message -
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMessageFormat
```
public java.lang.String getMessageFormat()
```
    - 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.
    Constraints:
    Allowed Values: PlainText, CustomPayload, SSML, Composite
    Returns:
    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.
    See Also:
    
    MessageFormatType
  - setMessageFormat
```
public void setMessageFormat(java.lang.String messageFormat)
```
    - 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.
    Constraints:
    Allowed Values: PlainText, CustomPayload, SSML, Composite
    Parameters:
    messageFormat -
    
    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.
    See Also:
    
    MessageFormatType
  - withMessageFormat
```
public DialogAction withMessageFormat(java.lang.String messageFormat)
```
    - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PlainText, CustomPayload, SSML, Composite
    Parameters:
    messageFormat -
    
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MessageFormatType
  - setMessageFormat
```
public void setMessageFormat(MessageFormatType messageFormat)
```
    - 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.
    Constraints:
    Allowed Values: PlainText, CustomPayload, SSML, Composite
    Parameters:
    messageFormat -
    
    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.
    See Also:
    
    MessageFormatType
  - withMessageFormat
```
public DialogAction withMessageFormat(MessageFormatType messageFormat)
```
    - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PlainText, CustomPayload, SSML, Composite
    Parameters:
    messageFormat -
    
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    MessageFormatType
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DialogAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DialogAction

Method Detail

getType

setType

withType

setType

withType

getIntentName

setIntentName

withIntentName

getSlots

setSlots

withSlots

addslotsEntry

clearslotsEntries

getSlotToElicit

setSlotToElicit

withSlotToElicit

getFulfillmentState

setFulfillmentState

withFulfillmentState

setFulfillmentState

withFulfillmentState

getMessage

setMessage

withMessage

getMessageFormat

setMessageFormat

withMessageFormat

setMessageFormat

withMessageFormat

toString

hashCode

equals