com.amazon.speech.speechlet

Enum IntentRequest.DialogState

java.lang.Object

java.lang.Enum<IntentRequest.DialogState>

com.amazon.speech.speechlet.IntentRequest.DialogState

All Implemented Interfaces:

Serializable, Comparable<IntentRequest.DialogState>

Enclosing class:

IntentRequest

public static enum IntentRequest.DialogState
extends Enum<IntentRequest.DialogState>

When a skill has a managed dialog configured, this field indicates the current dialog state for the intent request.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETED Indicates that all required slot values and confirmations have been provided, the dialog is considered complete, and the skill can proceed to fulfilling the intent.
IN_PROGRESS Indicates that a multi-turn dialog is in process and it is not the first turn.
STARTED Indicates this is the first turn in a multi-turn dialog.

Method Summary

Modifier and Type	Method and Description
static IntentRequest.DialogState	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntentRequest.DialogState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STARTED

public static final IntentRequest.DialogState STARTED

Indicates this is the first turn in a multi-turn dialog. Skills can use this state to trigger behavior that only needs to be executed in the first turn. For example, a skill may wish to provide missing slot values that it can determine based on the current user, or other such session information, but doesn't wish to perform that action for every turn in a dialog.

IN_PROGRESS

public static final IntentRequest.DialogState IN_PROGRESS

Indicates that a multi-turn dialog is in process and it is not the first turn. Skills may assume that all of the required slot values and confirmations have not yet been provided, and react accordingly (for instance by immediately returning a response containing a DelegateDirective).

COMPLETED

public static final IntentRequest.DialogState COMPLETED

Indicates that all required slot values and confirmations have been provided, the dialog is considered complete, and the skill can proceed to fulfilling the intent. Nevertheless, the skill may manually continue the dialog if it determines at runtime that it requires more input in order to fulfill the intent, in which case it may return an appropriate DialogDirective and update slot values/confirmations as required.

Method Detail

values

public static IntentRequest.DialogState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IntentRequest.DialogState c : IntentRequest.DialogState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IntentRequest.DialogState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null