com.amazon.speech.speechlet

Class SpeechletResponse

java.lang.Object

com.amazon.speech.speechlet.SpeechletResponse

public class SpeechletResponse
extends Object

The response to a SpeechletV2 invocation. Defines text to speak to the user, content to display in the companion application, and whether or not the current SpeechletV2 session should end.

See Also:

SpeechletV2.onLaunch(SpeechletRequestEnvelope), SpeechletV2.onIntent(SpeechletRequestEnvelope)

Constructor Summary

Constructors

Constructor and Description
SpeechletResponse() Default public constructor

Method Summary

Modifier and Type	Method and Description
Card	getCard() Returns the UI card associated with this response.
List<Directive>	getDirectives() Returns the directives associated with this response.
Boolean	getNullableShouldEndSession() Returns value of shouldEndSession attribute
OutputSpeech	getOutputSpeech() Returns the speech associated with this response.
Reprompt	getReprompt() Returns the reprompt associated with this response.
boolean	getShouldEndSession() Deprecated. with version 1.4.0 replaced with getNullableShouldEndSession()
static SpeechletResponse	newAskResponse(OutputSpeech outputSpeech, Reprompt reprompt) Creates and returns a response intended to ask the user a question.
static SpeechletResponse	newAskResponse(OutputSpeech outputSpeech, Reprompt reprompt, Card card) Creates and returns a response intended to ask the user a question, both in speech and with a graphical card displayed in the companion app.
static SpeechletResponse	newTellResponse(OutputSpeech outputSpeech) Creates and returns a response intended to tell the user something.
static SpeechletResponse	newTellResponse(OutputSpeech outputSpeech, Card card) Creates and returns a response intended to tell the user something, both in speech and with a graphical card in the companion app.
void	setCard(Card card) Sets the UI card associated with this response.
void	setDirectives(List<Directive> directives) Sets the directives for this response.
void	setNullableShouldEndSession(Boolean shouldEndSession) Sets value of shouldEndSession attribute
void	setOutputSpeech(OutputSpeech outputSpeech) Sets the speech associated with this response.
void	setReprompt(Reprompt reprompt) Sets the reprompt associated with this response.
void	setShouldEndSession(boolean shouldEndSession) Deprecated. with version 1.4.0 null value is allowed. See setNullableShouldEndSession(Boolean)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeechletResponse

public SpeechletResponse()

Default public constructor

Method Detail

getOutputSpeech

public OutputSpeech getOutputSpeech()

Returns the speech associated with this response.

Returns:

the speech

setOutputSpeech

public void setOutputSpeech(OutputSpeech outputSpeech)

Sets the speech associated with this response.

Parameters:

outputSpeech - the speech to set

getShouldEndSession

@Deprecated
public boolean getShouldEndSession()

Deprecated. with version 1.4.0 replaced with getNullableShouldEndSession()

Returns whether or not the session should end with this response. in case of null value returns false

Returns:

whether the session should end

setShouldEndSession

@Deprecated
public void setShouldEndSession(boolean shouldEndSession)

Deprecated. with version 1.4.0 null value is allowed. See setNullableShouldEndSession(Boolean)

Sets whether or not the session should end with this response.

Parameters:

shouldEndSession - true if the session should end with this response

getNullableShouldEndSession

public Boolean getNullableShouldEndSession()

Returns value of shouldEndSession attribute

false means session should be kept open and voice command is expected

true means session should be terminated

null for non-display cases defaults to true and for display template scenarios keeps session open without expecting voice command

Refer to online documentation for more information

Returns:

value of shouldEndSession attribute

setNullableShouldEndSession

public void setNullableShouldEndSession(Boolean shouldEndSession)

Sets value of shouldEndSession attribute

Set it to true to end session

Set it to false to keep session open and wait for a voice command or response

Set it to null to keep session open without waiting for a voice command when displaying template. If no template is displayed it will default to previous behavior and end session.

Refer to online documentation for more details.

Parameters:

shouldEndSession - new value of shouldEndSession attribute

getCard

public Card getCard()

Returns the UI card associated with this response.

Returns:

the UI card to set

setCard

public void setCard(Card card)

Sets the UI card associated with this response.

Parameters:

card - the UI card to set

getDirectives

public List<Directive> getDirectives()

Returns the directives associated with this response.

Returns:

the directives

setDirectives

public void setDirectives(List<Directive> directives)

Sets the directives for this response.

Parameters:

directives - the directives

getReprompt

public Reprompt getReprompt()

Returns the reprompt associated with this response.

Returns:

the reprompt

setReprompt

public void setReprompt(Reprompt reprompt)

Sets the reprompt associated with this response.

Parameters:

reprompt - the reprompt

newTellResponse

public static SpeechletResponse newTellResponse(OutputSpeech outputSpeech)

Creates and returns a response intended to tell the user something. After the specified output is read to the user, the session ends. Note that the response created with this method does not include a graphical card for the companion app.

All arguments in this method are required and cannot be null.

Parameters:

outputSpeech - output speech content for the tell voice response

Returns:

SpeechletResponse spoken response for the given input

newTellResponse

public static SpeechletResponse newTellResponse(OutputSpeech outputSpeech,
                                                Card card)

Creates and returns a response intended to tell the user something, both in speech and with a graphical card in the companion app. After the tell output is read to the user, the session ends.

All arguments in this method are required and cannot be null.

Parameters:

outputSpeech - output speech content for the tell voice response

card - card to display in the companion application

Returns:

SpeechletResponse spoken and visual response for the given input

newAskResponse

public static SpeechletResponse newAskResponse(OutputSpeech outputSpeech,
                                               Reprompt reprompt)

Creates and returns a response intended to ask the user a question. After the ask response is read to the user, the user can respond and continue to interact with the skill. The session does not immediately end after the ask response. Note that the response created with this method does not include a graphical card for the companion app.

All arguments in this method are required and cannot be null.

Parameters:

outputSpeech - output speech content for the ask voice response

reprompt - reprompt speech for the ask voice response. This speech is played if the user does not reply to the question or replies with something that is not understood.

Returns:

SpeechletResponse spoken response for the given input

newAskResponse

public static SpeechletResponse newAskResponse(OutputSpeech outputSpeech,
                                               Reprompt reprompt,
                                               Card card)

Creates and returns a response intended to ask the user a question, both in speech and with a graphical card displayed in the companion app. After the ask response is read to the user, the user can respond and continue to interact with the skill. The session does not immediately end after the ask response.

All arguments in this method are required and cannot be null.

Parameters:

outputSpeech - output speech content for the ask voice response

reprompt - reprompt speech for the ask voice response. This speech is played if the user does not reply to the question or replies with something that is not understood.

card - card to display in the companion application

Returns:

SpeechletResponse spoken and visual response for the given input