com.amazon.speech.json

Class SpeechletRequestEnvelope<T extends SpeechletRequest>

java.lang.Object

com.amazon.speech.json.SpeechletRequestEnvelope<T>

Type Parameters:

T - the specific type of request the envelope is for

public class SpeechletRequestEnvelope<T extends SpeechletRequest>
extends Object

Envelope to wrap the various parameters of a SpeechletV2 invocation.

See Also:

SpeechletV2, IntentRequest, Session, Context

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpeechletRequestEnvelope.Builder<T extends SpeechletRequest> Builder used to construct a new SpeechletRequestEnvelope.

Method Summary

Modifier and Type	Method and Description
static <E extends SpeechletRequest> SpeechletRequestEnvelope.Builder<E>	builder() Returns a new builder instance used to construct a new SpeechletRequestEnvelope.
static SpeechletRequestEnvelope<?>	fromJson(byte[] json) Read a SpeechletRequestEnvelope from a byte array.
static SpeechletRequestEnvelope<?>	fromJson(InputStream in) Read a SpeechletRequestEnvelope from an InputStream.
static SpeechletRequestEnvelope<?>	fromJson(String json) Read a SpeechletRequestEnvelope from a String.
Context	getContext() Returns the context.
T	getRequest() Returns the request.
Session	getSession() Returns the session, if present.
String	getVersion() Returns the envelope version.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <E extends SpeechletRequest> SpeechletRequestEnvelope.Builder<E> builder()

Returns a new builder instance used to construct a new SpeechletRequestEnvelope.

Returns:

the builder

getVersion

public String getVersion()

Returns the envelope version.

Returns:

version the envelope version

getSession

public Session getSession()

Returns the session, if present. It will only be present if the parameterized type T is IntentRequest, LaunchRequest, or SessionEndedRequest.

Returns:

the session, if present

getContext

public Context getContext()

Returns the context.

Returns:

the context

getRequest

public T getRequest()

Returns the request.

Returns:

the request

fromJson

public static SpeechletRequestEnvelope<?> fromJson(InputStream in)
                                            throws IOException

Read a SpeechletRequestEnvelope from an InputStream. The byte stream must be UTF-8 encoded.

Parameters:

in - the input stream to read from

Returns:

the envelope read from the stream

Throws:

IOException - if deserialization fails

fromJson

public static SpeechletRequestEnvelope<?> fromJson(byte[] json)
                                            throws IOException

Read a SpeechletRequestEnvelope from a byte array. The byte array must be UTF-8 encoded.

Parameters:

json - the bytes to read from.

Returns:

the envelope read from the bytes.

Throws:

IOException - if deserialization fails.

fromJson

public static SpeechletRequestEnvelope<?> fromJson(String json)
                                            throws IOException

Read a SpeechletRequestEnvelope from a String.

Parameters:

json - the String to read from

Returns:

the envelope read from the String

Throws:

IOException - if deserialization fails