com.amazon.ask.request

Class RequestHelper

java.lang.Object

com.amazon.ask.request.RequestHelper

public final class RequestHelper
extends Object

Helper class that makes it easy to retrieve request properties from a HandlerInput.

Method Summary

Modifier and Type	Method and Description
static RequestHelper	forHandlerInput(HandlerInput input) Creates an RequestHelper instance against the provided handler input.
String	getAccountLinkingAccessToken() Retrieves the account linking access token from the request.
String	getApiAccessToken() Retrieves the API access token from the request.
String	getDeviceId() Retrieves the device ID from the request.
DialogState	getDialogState() Retrieves the dialog state from the request.
String	getIntentName() Retrieves the name of the Intent from the request.
String	getLocale() Retrieves the locale from the the request.
String	getRequestType() Retrieves the type of the request.
Optional<Slot>	getSlot(String slotName) Returns the Slot for the given slot name from the request.
Optional<String>	getSlotValue(String slotName) Returns the value from the given Slot in the request.
SupportedInterfaces	getSupportedInterfaces() Retrieves the SupportedInterfaces from the request.
Optional<String>	getUserId() Returns the userId in the request.
boolean	isNewSession() Returns whether the request is a new session.

Methods inherited from class java.lang.Object

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

Method Detail

forHandlerInput

public static RequestHelper forHandlerInput(HandlerInput input)

Creates an RequestHelper instance against the provided handler input.

Parameters:

input - handler input

Returns:

an RequestHelper, providing convience methods for retrieving request properties out of the provided handler input.

getLocale

public String getLocale()

Retrieves the locale from the the request. The method returns the locale value present in the request. More information about the locale can be found here: https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#request-locale

Returns:

locale property value

getRequestType

public String getRequestType()

Retrieves the type of the request. The method retrieves the request type of the input request. More information about the different request types are mentioned here: https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#request-body-parameters

Returns:

request type property value

getIntentName

public String getIntentName()

Retrieves the name of the Intent from the request. The method retrieves the intent name from the input request, only if the input request is an IntentRequest. An IllegalArgumentException is thrown if not.

Returns:

intent name

getAccountLinkingAccessToken

public String getAccountLinkingAccessToken()

Retrieves the account linking access token from the request. The method retrieves the user's accessToken from the input request. Once a user successfully enables a skill and links their Alexa account to the skill, the input request will have the user's access token. A null value is returned if there is no access token in the input request. More information on this can be found here: https://developer.amazon.com/docs/account-linking/add-account-linking-logic-custom-skill.html

Returns:

account linking access token

getApiAccessToken

public String getApiAccessToken()

Retrieves the API access token from the request. The method retrieves the apiAccessToken from the input request, which has the encapsulated information of permissions granted by the user. This token can be used to call Alexa-specific APIs. More information about this can be found here: https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#system-object The SDK automatically injects this value into service client instances retrieved from the ServiceClientFactory.

Returns:

API access token

getDeviceId

public String getDeviceId()

Retrieves the device ID from the request. The method retrieves the deviceId property from the input request. This value uniquely identifies the device and is generally used as input for some Alexa-specific API calls. More information about this can be found here: https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#system-object

Returns:

device ID

getDialogState

public DialogState getDialogState()

Retrieves the dialog state from the request. The method retrieves the `dialogState` from the intent request, if the skill's interaction model includes a dialog model. This can be used to determine the current status of user conversation and return the appropriate dialog directives if the conversation is not yet complete. More information on dialog management can be found here: https://developer.amazon.com/docs/custom-skills/define-the-dialog-to-collect-and-confirm-required-information.html This method returns an IllegalArgumentException if the incoming request is not an IntentRequest.

Returns:

dialog state

getSlot

public Optional<Slot> getSlot(String slotName)

Returns the Slot for the given slot name from the request. This method attempts to retrieve the requested Slot from the incoming request. If the slot does not exist in the request, an Optional empty is returned. This method returns an IllegalArgumentException if the incoming request is not an IntentRequest.

Parameters:

slotName - name of the slot to retrieve

Returns:

an Optional containing the target slot if it exists in the request, else an empty Optional

getSlotValue

public Optional<String> getSlotValue(String slotName)

Returns the value from the given Slot in the request. This method attempts to retrieve the requested Slot's value from the incoming request. If the slot does exist in the request, an Optional empty is returned. This method returns an IllegalArgumentException if the incoming request is not an IntentRequest.

Parameters:

slotName - name of the slot to retrieve

Returns:

an Optional containing the target slot's value if it exists in the request, else an empty Optional

getSupportedInterfaces

public SupportedInterfaces getSupportedInterfaces()

Retrieves the SupportedInterfaces from the request. This method returns an object listing each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer, then you know that the device supports streaming audio using the AudioPlayer interface.

Returns:

supported interfaces

isNewSession

public boolean isNewSession()

Returns whether the request is a new session. The method retrieves the new value from the input request's session, which indicates if it's a new session or not. More information can be found here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#session-object This method returns an IllegalArgumentException if the request is not an in-session request.

Returns:

true if the request is a new session

getUserId

public Optional<String> getUserId()

Returns the userId in the request. The method retrieves the userId from the input request's context. This value uniquely identifies the user and is generally used as input for some Alexa-specific API calls. More information can be found here : https://developer.amazon.com/docs/custom-skills/request-and-response-json-reference.html#session-object

Returns:

an Optional containing the userId if the userId exists, else an empty Optional