com.amazon.ask.request

Class Predicates

java.lang.Object

com.amazon.ask.request.Predicates

public class Predicates
extends Object

A collection of built in Predicates that can be used to evaluate properties of an incoming HandlerInput.

Method Summary

Modifier and Type	Method and Description
static Predicate<HandlerInput>	canFulfillIntentName(String intentName) Returns a predicate that returns to true if the incoming request is an CanFulfillIntentRequest for the given intent name.
static Predicate<HandlerInput>	canFulfillSlotValue(String slotName, String slotValue) Returns a predicate that returns to true if the incoming request is an CanFulfillIntentRequest and contains the given slot name and value.
static Predicate<HandlerInput>	intentName(String intentName) Returns a predicate that returns to true if the incoming request is an IntentRequest for the given intent name.
static Predicate<HandlerInput>	persistentAttribute(String key, Object value) Returns a predicate that returns to true if the persistent attributes included with the HandlerInput contain the expected attribute value.
static Predicate<HandlerInput>	requestAttribute(String key, Object value) Returns a predicate that returns to true if the request attributes included with the HandlerInput contain the expected attribute value.
static <T extends Request> Predicate<HandlerInput>	requestType(Class<T> requestType) Returns a predicate that returns to true if the incoming request is an instance of the given request class.
static Predicate<HandlerInput>	selectedElementToken(String elementToken) Returns a predicate that returns to true if the incoming request is an ElementSelectedRequest with the given token.
static Predicate<HandlerInput>	sessionAttribute(String key, Object value) Returns a predicate that returns to true if session attributes are included with the HandlerInput and contain the expected attribute value.
static Predicate<HandlerInput>	slotValue(String slotName, String slotValue) Returns a predicate that returns to true if the incoming request is an IntentRequest and contains the given slot name and value.
static Predicate<HandlerInput>	viewportProfile(ViewportProfile viewportProfile)

Methods inherited from class java.lang.Object

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

Method Detail

requestType

public static <T extends Request> Predicate<HandlerInput> requestType(Class<T> requestType)

Returns a predicate that returns to true if the incoming request is an instance of the given request class.

Type Parameters:

T - class of the request to evaluate against

Parameters:

requestType - request type to evaluate against

Returns:

true if the incoming request is an instance of the given request class

intentName

public static Predicate<HandlerInput> intentName(String intentName)

Returns a predicate that returns to true if the incoming request is an IntentRequest for the given intent name.

Parameters:

intentName - intent name to evaluate against

Returns:

true if the incoming request is an IntentRequest for the given intent name

canFulfillIntentName

public static Predicate<HandlerInput> canFulfillIntentName(String intentName)

Returns a predicate that returns to true if the incoming request is an CanFulfillIntentRequest for the given intent name.

Parameters:

intentName - intent name to evaluate against

Returns:

true if the incoming request is an CanFulfillIntentRequest for the given intent name

slotValue

public static Predicate<HandlerInput> slotValue(String slotName,
                                                String slotValue)

Returns a predicate that returns to true if the incoming request is an IntentRequest and contains the given slot name and value.

Parameters:

slotName - expected intent slot name

slotValue - expected intent slot value

Returns:

true if the incoming request is an IntentRequest and contains the given slot name and value

canFulfillSlotValue

public static Predicate<HandlerInput> canFulfillSlotValue(String slotName,
                                                          String slotValue)

Returns a predicate that returns to true if the incoming request is an CanFulfillIntentRequest and contains the given slot name and value.

Parameters:

slotName - expected intent slot name

slotValue - expected intent slot value

Returns:

true if the incoming request is an CanFulfillIntentRequest and contains the given slot name and value

selectedElementToken

public static Predicate<HandlerInput> selectedElementToken(String elementToken)

Returns a predicate that returns to true if the incoming request is an ElementSelectedRequest with the given token.

Parameters:

elementToken - token to evaluate against

Returns:

true if the incoming request is an ElementSelectedRequest with the given token

requestAttribute

public static Predicate<HandlerInput> requestAttribute(String key,
                                                       Object value)

Returns a predicate that returns to true if the request attributes included with the HandlerInput contain the expected attribute value.

Parameters:

key - key of the attribute to evaluate

value - value of the attribute to evaluate

Returns:

true if the request attributes included with the HandlerInput contain the expected attribute value

sessionAttribute

public static Predicate<HandlerInput> sessionAttribute(String key,
                                                       Object value)

Returns a predicate that returns to true if session attributes are included with the HandlerInput and contain the expected attribute value.

Parameters:

key - key of the attribute to evaluate

value - value of the attribute to evaluate

Returns:

true if session attributes are included with the HandlerInput and contain the expected attribute value.

persistentAttribute

public static Predicate<HandlerInput> persistentAttribute(String key,
                                                          Object value)

Returns a predicate that returns to true if the persistent attributes included with the HandlerInput contain the expected attribute value.

Parameters:

key - key of the attribute to evaluate

value - value of the attribute to evaluate

Returns:

true if the persistent attributes included with the HandlerInput contain the expected attribute value

viewportProfile

public static Predicate<HandlerInput> viewportProfile(ViewportProfile viewportProfile)