com.amazonaws.mobileconnectors.lex.interactionkit.continuations

Class LexServiceContinuation

java.lang.Object

com.amazonaws.mobileconnectors.lex.interactionkit.continuations.LexServiceContinuation

public final class LexServiceContinuation
extends Object

Continuations

"Continuation"s provide a simple technique to continue with a transaction after a user responds to a prompt from the Amazon Lex service. This encapsulates and provides access to responses from the Amazon Lex service.

Constructor Summary

Constructors

Constructor and Description
LexServiceContinuation(InteractionClient interactionClient, ResponseType responseMode, ResponseType requestMode) Constructs a continuation for speech request.

Method Summary

Modifier and Type	Method and Description
void	cancel() Use this method to cancel the current transaction.
void	continueWithAudioInForAudioOut() Use this method if the users response is speech.
void	continueWithAudioInForAudioOut(Map<String,String> requestAttributes) Use this method if the users response is speech.
void	continueWithAudioInForTextOut() Use this method if the users response is speech.
void	continueWithAudioInForTextOut(Map<String,String> requestAttributes) Use this method if the users response is speech.
void	continueWithCurrentMode() Use this method to continue with the current audio input and output mode, and current session attributes.
void	continueWithTextInForAudioOut(String text) Use this method to respond with text and expect service response with audio.
void	continueWithTextInForAudioOut(String text, Map<String,String> requestAttributes) Use this method to respond with text and expect service response with audio.
void	continueWithTextInForTextOut(String text) Use this method to respond with text and expect service response with text.
void	continueWithTextInForTextOut(String text, Map<String,String> requestAttributes) Use this method to respond with text and expect service response with text.
String	getSessionAttribute(String attribute) Returns a specific session attribute.
Map<String,String>	getSessionAttributes() Returns all session attributes.
void	setSessionAttribute(String attribute, String value) Set value for a specific session attribute, will over-write current value.
void	setSessionAttributes(Map<String,String> sessionAttributes) Replace all session attributes with a new set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LexServiceContinuation

public LexServiceContinuation(InteractionClient interactionClient,
                              ResponseType responseMode,
                              ResponseType requestMode)

Constructs a continuation for speech request.

Parameters:

interactionClient - InteractionClient.

Method Detail

getSessionAttribute

public String getSessionAttribute(String attribute)

Returns a specific session attribute.

Parameters:

attribute - the request attribute as a String.

Returns:

the value for the attribute, null if the attribute is not set.

getSessionAttributes

public Map<String,String> getSessionAttributes()

Returns all session attributes.

Returns:

All session attributes as a Map.

setSessionAttributes

public void setSessionAttributes(Map<String,String> sessionAttributes)

Replace all session attributes with a new set.

Parameters:

sessionAttributes - Map.

setSessionAttribute

public void setSessionAttribute(String attribute,
                                String value)

Set value for a specific session attribute, will over-write current value.

Parameters:

attribute - name of the attribute as String.

value - value of the attribute as String.

continueWithAudioInForTextOut

public void continueWithAudioInForTextOut()

Use this method if the users response is speech. The client will listen to user's input from the device's microphone. The service will respond to this request with text.

continueWithAudioInForTextOut

public void continueWithAudioInForTextOut(Map<String,String> requestAttributes)

Use this method if the users response is speech. The client will listen to user's input from the device's microphone. The service will respond to this request with text.

Parameters:

requestAttributes - attributes to add to this request

continueWithAudioInForAudioOut

public void continueWithAudioInForAudioOut()

Use this method if the users response is speech. The client will listen to user's input from the device's microphone. The service will respond to this request with audio.

continueWithAudioInForAudioOut

public void continueWithAudioInForAudioOut(Map<String,String> requestAttributes)

Use this method if the users response is speech. The client will listen to user's input from the device's microphone. The service will respond to this request with audio.

Parameters:

requestAttributes - attributes to add to this request

continueWithTextInForAudioOut

public void continueWithTextInForAudioOut(String text)

Use this method to respond with text and expect service response with audio.

Parameters:

text - the response to the prompt as a String.

continueWithTextInForAudioOut

public void continueWithTextInForAudioOut(String text,
                                          Map<String,String> requestAttributes)

Use this method to respond with text and expect service response with audio.

Parameters:

text - the response to the prompt as a String.

requestAttributes - attributes to add to this request

continueWithTextInForTextOut

public void continueWithTextInForTextOut(String text)

Use this method to respond with text and expect service response with text.

Parameters:

text - the response to the prompt as a String.

continueWithTextInForTextOut

public void continueWithTextInForTextOut(String text,
                                         Map<String,String> requestAttributes)

Use this method to respond with text and expect service response with text.

Parameters:

text - the response to the prompt as a String.

requestAttributes - attributes to add to this request

continueWithCurrentMode

public void continueWithCurrentMode()

Use this method to continue with the current audio input and output mode, and current session attributes.

cancel

public void cancel()

Use this method to cancel the current transaction.