com.amazon.ask.dispatcher.request.handler

Class HandlerInput

java.lang.Object

com.amazon.ask.dispatcher.request.handler.HandlerInput

public class HandlerInput
extends Object

Input that is passed to all RequestHandler, ExceptionHandler, RequestInterceptor, and ResponseInterceptor. Contains the RequestEnvelope, AttributesManager, ServiceClientFactory, ResponseBuilder, and other useful utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HandlerInput.Builder

Method Summary

Modifier and Type	Method and Description
static HandlerInput.Builder	builder()
AttributesManager	getAttributesManager() Returns an AttributesManager which can be used to retrieve and store skill attributes.
Optional<Object>	getContext() Optionally returns the container context.
com.amazon.ask.model.RequestEnvelope	getRequestEnvelope() Returns the RequestEnvelope of the incoming request.
ResponseBuilder	getResponseBuilder() Returns a ResponseBuilder that can be used to construct a complete skill response containing speech, directives, etc.
com.amazon.ask.model.services.ServiceClientFactory	getServiceClientFactory() Returns a ServiceClientFactory used to retrieve service client instances that can call Alexa APIs.
boolean	matches(Predicate<HandlerInput> predicate) Evaluates a Predicate against the current handler input state.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static HandlerInput.Builder builder()

getRequestEnvelope

public com.amazon.ask.model.RequestEnvelope getRequestEnvelope()

Returns the RequestEnvelope of the incoming request.

Returns:

request envelope

getAttributesManager

public AttributesManager getAttributesManager()

Returns an AttributesManager which can be used to retrieve and store skill attributes.

Returns:

attributes manager

getContext

public Optional<Object> getContext()

Optionally returns the container context. If this skill is running on AWS Lambda and using the standard Lambda SDK stream handler, this will return the AWS Lambda function context object. If this skill is running on other containers, the returned value is implementation specific.

Returns:

an Optional that may contain the container context

getServiceClientFactory

public com.amazon.ask.model.services.ServiceClientFactory getServiceClientFactory()

Returns a ServiceClientFactory used to retrieve service client instances that can call Alexa APIs.

Returns:

service client factory

Throws:

IllegalStateException - if this method is called when an ApiClient is not configured on this SDK instance.

matches

public boolean matches(Predicate<HandlerInput> predicate)

Evaluates a Predicate against the current handler input state.

Parameters:

predicate - predicate to evaluate

Returns:

true if the predicates matches this input, false if not

getResponseBuilder

public ResponseBuilder getResponseBuilder()

Returns a ResponseBuilder that can be used to construct a complete skill response containing speech, directives, etc.

Returns:

response builder