com.amazon.speech.speechlet

Class SessionEndedRequest

java.lang.Object

com.amazon.speech.speechlet.SpeechletRequest

com.amazon.speech.speechlet.CoreSpeechletRequest

com.amazon.speech.speechlet.SessionEndedRequest

public final class SessionEndedRequest
extends CoreSpeechletRequest

The request object containing all the parameters passed to notify a SpeechletV2 that a session ended.

See Also:

SpeechletV2.onSessionEnded(SpeechletRequestEnvelope)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionEndedRequest.Builder Builder used to construct a new SessionEndedRequest.
static class	SessionEndedRequest.Reason This enum lists the reasons why a session ended when not initiated by the SpeechletV2 itself.

Nested classes/interfaces inherited from class com.amazon.speech.speechlet.SpeechletRequest

SpeechletRequest.SpeechletRequestBuilder<T extends SpeechletRequest.SpeechletRequestBuilder,S extends SpeechletRequest>

Method Summary

Modifier and Type	Method and Description
static SessionEndedRequest.Builder	builder() Returns a new builder instance used to construct a new SessionEndedRequest.
Error	getError()
SessionEndedRequest.Reason	getReason() Returns the reason for the session to have ended.

Methods inherited from class com.amazon.speech.speechlet.SpeechletRequest

getLocale, getRequestId, getTimestamp

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SessionEndedRequest.Builder builder()

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

Returns:

the builder

getReason

public SessionEndedRequest.Reason getReason()

Returns the reason for the session to have ended.

Returns:

the reason. Will be null if the value for the reason is not supported by the version of the SDK used.

getError

public Error getError()

Returns:

the error that caused this SessionEndedRquest, if Reason was Reason.ERROR