com.amazon.ask.response

Class ResponseBuilder

java.lang.Object

com.amazon.ask.response.ResponseBuilder

public class ResponseBuilder
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ResponseBuilder()

Method Summary

Modifier and Type	Method and Description
ResponseBuilder	addAudioPlayerClearQueueDirective(com.amazon.ask.model.interfaces.audioplayer.ClearBehavior clearBehavior) Adds an AudioPlayer ClearQueueDirective to the response.
ResponseBuilder	addAudioPlayerPlayDirective(com.amazon.ask.model.interfaces.audioplayer.PlayBehavior playBehavior, Long offsetInMilliseconds, String expectedPreviousToken, String token, String url) Adds an AudioPlayer PlayDirective to the response.
ResponseBuilder	addAudioPlayerStopDirective() Adds an AudioPlayer StopDirective to the response.
ResponseBuilder	addConfirmIntentDirective(com.amazon.ask.model.Intent updatedIntent) Adds a Dialog ConfirmIntentDirective to the response.
ResponseBuilder	addConfirmSlotDirective(String slotName, com.amazon.ask.model.Intent updatedIntent) Adds a Dialog ConfirmSlotDirective to the response.
ResponseBuilder	addDelegateDirective(com.amazon.ask.model.Intent updatedIntent) Adds a Dialog DelegateDirective to the response.
ResponseBuilder	addDirective(com.amazon.ask.model.Directive directive) Adds a given Directive to the response.
ResponseBuilder	addElicitSlotDirective(String slotName, com.amazon.ask.model.Intent updatedIntent) Adds a Dialog ElicitSlotDirective to the response.
ResponseBuilder	addHintDirective(String hintText) Adds a HintDirective to the response.
ResponseBuilder	addRenderTemplateDirective(com.amazon.ask.model.interfaces.display.Template template) Adds a Display RenderTemplateDirective to the response.
ResponseBuilder	addVideoAppLaunchDirective(String source, String title, String subtitle) Adds a VideoApp LaunchDirective to the response to play a video.
Optional<com.amazon.ask.model.Response>	build()
ResponseBuilder	withAskForPermissionsConsentCard(List<String> permissions) Sets a AskForPermissionsConsentCard card on the response.
ResponseBuilder	withCanFulfillIntent(com.amazon.ask.model.canfulfill.CanFulfillIntent canFulfillIntent) Helper method for adding canFulfillIntent to response
ResponseBuilder	withCard(com.amazon.ask.model.ui.Card card) Sets a Card object on the response.
ResponseBuilder	withLinkAccountCard() Sets a LinkAccountCard on the response.
ResponseBuilder	withReprompt(String text) Sets Reprompt speech on the response.
ResponseBuilder	withShouldEndSession(Boolean shouldEndSession) Sets whether the session should end after this response.
ResponseBuilder	withSimpleCard(String cardTitle, String cardText) Sets a simple Card on the response with the specified title and content.
ResponseBuilder	withSpeech(String speechText) Sets OutputSpeech on the response.
ResponseBuilder	withStandardCard(String cardTitle, String cardText, com.amazon.ask.model.ui.Image image) Sets a standard Card on the response with the specified title, content and image

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseBuilder

public ResponseBuilder()

Method Detail

build

public Optional<com.amazon.ask.model.Response> build()

withSpeech

public ResponseBuilder withSpeech(String speechText)

Sets OutputSpeech on the response. Speech is always wrapped in SSML tags.

Parameters:

speechText - speech text

Returns:

response builder

withCard

public ResponseBuilder withCard(com.amazon.ask.model.ui.Card card)

Sets a Card object on the response.

Parameters:

card - card object

Returns:

response builder

withSimpleCard

public ResponseBuilder withSimpleCard(String cardTitle,
                                      String cardText)

Sets a simple Card on the response with the specified title and content.

Parameters:

cardTitle - title for card

cardText - text in the card

Returns:

response builder

withStandardCard

public ResponseBuilder withStandardCard(String cardTitle,
                                        String cardText,
                                        com.amazon.ask.model.ui.Image image)

Sets a standard Card on the response with the specified title, content and image

Parameters:

cardTitle - title for card

cardText - text in the card

image - image

Returns:

response builder

withLinkAccountCard

public ResponseBuilder withLinkAccountCard()

Sets a LinkAccountCard on the response.

Returns:

response builder

withAskForPermissionsConsentCard

public ResponseBuilder withAskForPermissionsConsentCard(List<String> permissions)

Sets a AskForPermissionsConsentCard card on the response.

Parameters:

permissions - permission array

Returns:

response builder

withReprompt

public ResponseBuilder withReprompt(String text)

Sets Reprompt speech on the response. Speech is always wrapped in SSML tags.

Parameters:

text - reprompt text

Returns:

response builder

withShouldEndSession

public ResponseBuilder withShouldEndSession(Boolean shouldEndSession)

Sets whether the session should end after this response.

Parameters:

shouldEndSession - whether session should end or not, or null

Returns:

response builder

addHintDirective

public ResponseBuilder addHintDirective(String hintText)

Adds a HintDirective to the response.

Parameters:

hintText - hint text

Returns:

response builder

addVideoAppLaunchDirective

public ResponseBuilder addVideoAppLaunchDirective(String source,
                                                  String title,
                                                  String subtitle)

Adds a VideoApp LaunchDirective to the response to play a video.

Parameters:

source - location of video content at a remote HTTPS location

title - title that can be displayed on VideoApp

subtitle - subtitle that can be displayed on VideoApp

Returns:

response builder

addRenderTemplateDirective

public ResponseBuilder addRenderTemplateDirective(com.amazon.ask.model.interfaces.display.Template template)

Adds a Display RenderTemplateDirective to the response.

Parameters:

template - display template

Returns:

response builder

addDelegateDirective

public ResponseBuilder addDelegateDirective(com.amazon.ask.model.Intent updatedIntent)

Adds a Dialog DelegateDirective to the response.

Parameters:

updatedIntent - updated intent

Returns:

response builder

addElicitSlotDirective

public ResponseBuilder addElicitSlotDirective(String slotName,
                                              com.amazon.ask.model.Intent updatedIntent)

Adds a Dialog ElicitSlotDirective to the response.

Parameters:

slotName - name of slot to elicit

updatedIntent - updated intent

Returns:

response builder

addConfirmSlotDirective

public ResponseBuilder addConfirmSlotDirective(String slotName,
                                               com.amazon.ask.model.Intent updatedIntent)

Adds a Dialog ConfirmSlotDirective to the response.

Parameters:

slotName - name of slot to elicit

updatedIntent - updated intent

Returns:

response builder

addConfirmIntentDirective

public ResponseBuilder addConfirmIntentDirective(com.amazon.ask.model.Intent updatedIntent)

Adds a Dialog ConfirmIntentDirective to the response.

Parameters:

updatedIntent - updated intent

Returns:

response builder

addAudioPlayerPlayDirective

public ResponseBuilder addAudioPlayerPlayDirective(com.amazon.ask.model.interfaces.audioplayer.PlayBehavior playBehavior,
                                                   Long offsetInMilliseconds,
                                                   String expectedPreviousToken,
                                                   String token,
                                                   String url)

Adds an AudioPlayer PlayDirective to the response.

Parameters:

playBehavior - Describes playback behavior

offsetInMilliseconds - The timestamp in the stream from which Alexa should begin playback

expectedPreviousToken - A token that represents the expected previous stream

token - A token that represents the audio stream. This token cannot exceed 1024 characters

url - Identifies the location of audio content at a remote HTTPS location

Returns:

response builder

addAudioPlayerStopDirective

public ResponseBuilder addAudioPlayerStopDirective()

Adds an AudioPlayer StopDirective to the response.

Returns:

response builder

addAudioPlayerClearQueueDirective

public ResponseBuilder addAudioPlayerClearQueueDirective(com.amazon.ask.model.interfaces.audioplayer.ClearBehavior clearBehavior)

Adds an AudioPlayer ClearQueueDirective to the response.

Parameters:

clearBehavior - Describes the clear queue behavior

Returns:

response builder

addDirective

public ResponseBuilder addDirective(com.amazon.ask.model.Directive directive)

Adds a given Directive to the response.

Parameters:

directive - directive to send with the response back to the Alexa device

Returns:

response builder

withCanFulfillIntent

public ResponseBuilder withCanFulfillIntent(com.amazon.ask.model.canfulfill.CanFulfillIntent canFulfillIntent)

Helper method for adding canFulfillIntent to response

Parameters:

canFulfillIntent -

Returns:

response builder