com.amazon.speech.json

Class SpeechletResponseEnvelope

java.lang.Object

com.amazon.speech.json.SpeechletResponseEnvelope

public class SpeechletResponseEnvelope
extends Object

Envelope to wrap the response of a SpeechletV2 invocation as well as mutable elements of the SpeechletV2 invocation parameters.

See Also:

SpeechletResponse

Constructor Summary

Constructors

Constructor and Description
SpeechletResponseEnvelope()

Method Summary

Modifier and Type	Method and Description
SpeechletResponse	getResponse() Returns the SpeechletV2 response.
Map<String,Object>	getSessionAttributes() Returns the session attributes to send back to the server.
String	getVersion() Returns the envelope version.
void	setResponse(SpeechletResponse response) Sets the SpeechletV2 response.
void	setSessionAttributes(Map<String,Object> sessionAttributes) Sets the session attributes to send back to the server.
void	setVersion(String version) Sets the envelope version.
void	toJson(OutputStream out) Write a SpeechletResponseEnvelope to an OutputStream.
byte[]	toJsonBytes() Write a SpeechletResponseEnvelope as a JSON byte array.
String	toJsonString() Write a SpeechletResponseEnvelope as a JSON String.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeechletResponseEnvelope

public SpeechletResponseEnvelope()

Method Detail

getVersion

public String getVersion()

Returns the envelope version.

Returns:

version the envelope version

setVersion

public void setVersion(String version)

Sets the envelope version.

Parameters:

version - the envelope version to set

getResponse

public SpeechletResponse getResponse()

Returns the SpeechletV2 response.

Returns:

the response

setResponse

public void setResponse(SpeechletResponse response)

Sets the SpeechletV2 response.

Parameters:

response - the response to set

getSessionAttributes

public Map<String,Object> getSessionAttributes()

Returns the session attributes to send back to the server.

Returns:

the session attributes

setSessionAttributes

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

Sets the session attributes to send back to the server.

Parameters:

sessionAttributes - the session attributes to set

toJson

public void toJson(OutputStream out)
            throws IOException

Write a SpeechletResponseEnvelope to an OutputStream. The output is encoded using UTF-8.

Parameters:

out - the OutputStream to write to

Throws:

IOException - if serialization fails

toJsonBytes

public byte[] toJsonBytes()
                   throws IOException

Write a SpeechletResponseEnvelope as a JSON byte array. The output is encoded using UTF-8.

Returns:

the JSON as bytes

Throws:

IOException - if serialization fails

toJsonString

public String toJsonString()
                    throws IOException

Write a SpeechletResponseEnvelope as a JSON String.

Returns:

the JSON as a String

Throws:

IOException - if serialization fails