com.amazonaws.mobileconnectors.lex.interactionkit

Class InteractionClient

java.lang.Object

com.amazonaws.mobileconnectors.lex.interactionkit.InteractionClient

public class InteractionClient
extends Object

The main service interface for the developers. This class abstracts all service complexities. Developers will primarily interact with this class. The parameters for interactions with a user are read from InteractionConfig. Set the these configurations before initializing this class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SAMPLE_SIZE The size of the each sample in bit.

Constructor Summary

Constructors

Constructor and Description
InteractionClient(android.content.Context context, AWSCredentialsProvider credentialsProvider, Regions region, InteractionConfig interactionConfig)
InteractionClient(android.content.Context context, AWSCredentialsProvider credentialsProvider, Regions region, InteractionConfig interactionConfig, ClientConfiguration clientConfiguration)
InteractionClient(android.content.Context context, AWSCredentialsProvider credentialsProvider, Regions region, String botName, String botAlias) Constructors for Amazon Lex local clients.

Method Summary

Modifier and Type	Method and Description
void	audioInForAudioOut(Map<String,String> sessionAttributes) Accept input from mic (speech) for audio response from the service.
void	audioInForAudioOut(Map<String,String> sessionAttributes, Map<String,String> requestAttributes) Accept input from mic (speech) for audio response from the service.
void	audioInForTextOut(Map<String,String> sessionAttributes) Accept input from mic (speech) for text, String, response from the service.
void	audioInForTextOut(Map<String,String> sessionAttributes, Map<String,String> requestAttributes) Accept input from mic (speech) for text, String, response from the service.
void	cancel() Cancel the current with the user's.
void	setAudioPlaybackListener(AudioPlaybackListener audioPlaybackListener) Assign a audio playback listener to this interaction client.
void	setInteractionListener(InteractionListener interactionListener) Set an interaction listener for this client.
void	setMicrophoneListener(MicrophoneListener microphoneListener) Assign a listener for microphone events.
void	textInForAudioOut(String text, Map<String,String> sessionAttributes) Accept input as text, String, for audio response from the service.
void	textInForAudioOut(String text, Map<String,String> sessionAttributes, Map<String,String> requestAttributes) Accept input as text, String, for audio response from the service.
void	textInForTextOut(String text, Map<String,String> sessionAttributes) Accept input as text, String, for text, String, reponse from the service.
void	textInForTextOut(String text, Map<String,String> sessionAttributes, Map<String,String> requestAttributes) Accept input as text, String, for text, String, reponse from the service.

Methods inherited from class java.lang.Object

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

Field Detail

SAMPLE_SIZE

public static final int SAMPLE_SIZE

The size of the each sample in bit.

See Also:

Constant Field Values

Constructor Detail

InteractionClient

public InteractionClient(android.content.Context context,
                         AWSCredentialsProvider credentialsProvider,
                         Regions region,
                         String botName,
                         String botAlias)

Constructors for Amazon Lex local clients.

InteractionClient

public InteractionClient(android.content.Context context,
                         AWSCredentialsProvider credentialsProvider,
                         Regions region,
                         InteractionConfig interactionConfig)

InteractionClient

public InteractionClient(android.content.Context context,
                         AWSCredentialsProvider credentialsProvider,
                         Regions region,
                         InteractionConfig interactionConfig,
                         ClientConfiguration clientConfiguration)

Method Detail

audioInForTextOut

public void audioInForTextOut(Map<String,String> sessionAttributes,
                              Map<String,String> requestAttributes)

Accept input from mic (speech) for text, String, response from the service.

Parameters:

sessionAttributes - Map.

requestAttributes - Map.

audioInForTextOut

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

Accept input from mic (speech) for text, String, response from the service.

Parameters:

sessionAttributes - Map.

audioInForAudioOut

public void audioInForAudioOut(Map<String,String> sessionAttributes,
                               Map<String,String> requestAttributes)

Accept input from mic (speech) for audio response from the service. To allow the to playback audio from the service response, use InteractionConfig.setEnableAudioPlayback(boolean).

Parameters:

sessionAttributes - Map.

requestAttributes - Map.

audioInForAudioOut

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

Accept input from mic (speech) for audio response from the service. To allow the to playback audio from the service response, use InteractionConfig.setEnableAudioPlayback(boolean).

Parameters:

sessionAttributes - Map.

textInForTextOut

public void textInForTextOut(String text,
                             Map<String,String> sessionAttributes,
                             Map<String,String> requestAttributes)

Accept input as text, String, for text, String, reponse from the service.

Parameters:

text - input as String.

sessionAttributes - Map.

requestAttributes - Map.

textInForTextOut

public void textInForTextOut(String text,
                             Map<String,String> sessionAttributes)

Accept input as text, String, for text, String, reponse from the service.

Parameters:

text - input as String.

sessionAttributes - Map.

textInForAudioOut

public void textInForAudioOut(String text,
                              Map<String,String> sessionAttributes,
                              Map<String,String> requestAttributes)

Accept input as text, String, for audio response from the service. To allow the to playback audio from the service response, use InteractionConfig.setEnableAudioPlayback(boolean).

Parameters:

text - input as String.

sessionAttributes - Map.

requestAttributes - Map.

textInForAudioOut

public void textInForAudioOut(String text,
                              Map<String,String> sessionAttributes)

Accept input as text, String, for audio response from the service. To allow the to playback audio from the service response, use InteractionConfig.setEnableAudioPlayback(boolean).

Parameters:

text - input as String.

sessionAttributes - Map.

cancel

public void cancel()

Cancel the current with the user's.

setAudioPlaybackListener

public void setAudioPlaybackListener(AudioPlaybackListener audioPlaybackListener)

Assign a audio playback listener to this interaction client. This will be invoked during audio playback events only when audio playback is enabled.

Parameters:

audioPlaybackListener -

setMicrophoneListener

public void setMicrophoneListener(MicrophoneListener microphoneListener)

Assign a listener for microphone events.

Parameters:

microphoneListener -

setInteractionListener

public void setInteractionListener(InteractionListener interactionListener)

Set an interaction listener for this client. If no internaction listner was provided, the default implementation is used.

Parameters:

interactionListener - the interaction listener InteractionListener.