ResponseBuilder (ASK SDK for Java

java.lang.Object
- com.amazon.ask.response.ResponseBuilder

```
public class ResponseBuilder
extends Object
```
Helper to create response using ask-sdk-model as per Alexa Skills Kit interface

Constructor Summary

Constructors
Constructor and Description

ResponseBuilder()

Constructors
Constructor and Description
`ResponseBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResponseBuilder`	`addAudioPlayerClearQueueDirective(com.amazon.ask.model.interfaces.audioplayer.ClearBehavior clearBehavior)` Adds an AudioPlayer ClearQueue directive - clear the queue without stopping the currently playing stream, or clear the queue and stop any currently playing stream.
`ResponseBuilder`	`addAudioPlayerPlayDirective(com.amazon.ask.model.interfaces.audioplayer.PlayBehavior playBehavior, Long offsetInMilliseconds, String expectedPreviousToken, String token, String url)` Adds an AudioPlayer play directive
`ResponseBuilder`	`addAudioPlayerStopDirective()` Adds an AudioPlayer Stop directive - Stops the current audio Playback
`ResponseBuilder`	`addConfirmIntentDirective(com.amazon.ask.model.Intent updatedIntent)` Adds a Dialog confirmIntent directive to response
`ResponseBuilder`	`addConfirmSlotDirective(String slotName, com.amazon.ask.model.Intent updatedIntent)` Adds a Dialog confirmSlot directive to response
`ResponseBuilder`	`addDelegateDirective(com.amazon.ask.model.Intent updatedIntent)` Adds a Dialog delegate directive to response
`ResponseBuilder`	`addDirective(com.amazon.ask.model.Directive directive)` Helper method for adding directives to responses
`ResponseBuilder`	`addElicitSlotDirective(String slotName, com.amazon.ask.model.Intent updatedIntent)` Adds a Dialog elicitSlot directive to response
`ResponseBuilder`	`addHintDirective(String hintText)` Adds a hint directive - show a hint on the screen of the echo show
`ResponseBuilder`	`addRenderTemplateDirective(com.amazon.ask.model.interfaces.display.Template template)` Adds a Display RenderTemplate Directive
`ResponseBuilder`	`addVideoAppLaunchDirective(String source, String title, String subtitle)` Adds a VideoApp play directive to play a video
`Optional<com.amazon.ask.model.Response>`	`build()`
`ResponseBuilder`	`withAskForPermissionsConsentCard(List<String> permissions)` Renders an AskForPermissionsConsent card
`ResponseBuilder`	`withLinkAccountCard()` Renders a link account card
`ResponseBuilder`	`withReprompt(String text)` Has alexa listen for speech from the user.
`ResponseBuilder`	`withShouldEndSession(Boolean shouldEndSession)` Sets shouldEndSession value to null/false/true
`ResponseBuilder`	`withSimpleCard(String cardTitle, String cardText)` Renders a simple card with the specified title and content
`ResponseBuilder`	`withSpeech(String speechText)` Has Alexa say the provided speech to the user
`ResponseBuilder`	`withStandardCard(String cardTitle, String cardText, com.amazon.ask.model.ui.Image image)` Renders a standard card 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)
```
    Has Alexa say the provided speech to the user
    
    Parameters:
    
    speechText - speech text
    
    Returns:
    
    response builder
  - withSimpleCard
```
public ResponseBuilder withSimpleCard(String cardTitle,
                                      String cardText)
```
    Renders a simple card 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)
```
    Renders a standard card 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()
```
    Renders a link account card
    
    Returns:
    
    response builder
  - withAskForPermissionsConsentCard
```
public ResponseBuilder withAskForPermissionsConsentCard(List<String> permissions)
```
    Renders an AskForPermissionsConsent card
    
    Parameters:
    
    permissions - permission array
    
    Returns:
    
    response builder
  - withReprompt
```
public ResponseBuilder withReprompt(String text)
```
    Has alexa listen for speech from the user. If the user doesn't respond within 8 seconds, then has alexa reprompt with the provided reprompt speech
    
    Parameters:
    
    text - reprompt text
    
    Returns:
    
    response builder
  - withShouldEndSession
```
public ResponseBuilder withShouldEndSession(Boolean shouldEndSession)
```
    Sets shouldEndSession value to null/false/true
    
    Parameters:
    
    shouldEndSession - whether session should end or not
    
    Returns:
    
    response builder
  - addHintDirective
```
public ResponseBuilder addHintDirective(String hintText)
```
    Adds a hint directive - show a hint on the screen of the echo show
    
    Parameters:
    
    hintText - hint text
    
    Returns:
    
    response builder
  - addVideoAppLaunchDirective
```
public ResponseBuilder addVideoAppLaunchDirective(String source,
                                                  String title,
                                                  String subtitle)
```
    Adds a VideoApp play directive to play a video
    
    Parameters:
    
    source - Identifies the location of video content at a remote HTTPS location and video file must be hosted at an Internet-accessible HTTPS endpoint
    
    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 RenderTemplate Directive
    
    Parameters:
    
    template - display template
    
    Returns:
    
    response builder
  - addDelegateDirective
```
public ResponseBuilder addDelegateDirective(com.amazon.ask.model.Intent updatedIntent)
```
    Adds a Dialog delegate directive to response
    
    Parameters:
    
    updatedIntent - updated intent
    
    Returns:
    
    response builder
  - addElicitSlotDirective
```
public ResponseBuilder addElicitSlotDirective(String slotName,
                                              com.amazon.ask.model.Intent updatedIntent)
```
    Adds a Dialog elicitSlot directive to response
    
    Parameters:
    
    slotName - name of slot
    
    updatedIntent - updated intent
    
    Returns:
    
    response builder
  - addConfirmSlotDirective
```
public ResponseBuilder addConfirmSlotDirective(String slotName,
                                               com.amazon.ask.model.Intent updatedIntent)
```
    Adds a Dialog confirmSlot directive to response
    
    Parameters:
    
    slotName - name of slot
    
    updatedIntent - updated intent
    
    Returns:
    
    response builder
  - addConfirmIntentDirective
```
public ResponseBuilder addConfirmIntentDirective(com.amazon.ask.model.Intent updatedIntent)
```
    Adds a Dialog confirmIntent directive to 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 play directive
    
    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 Stop directive - Stops the current audio Playback
    
    Returns:
    
    response builder
  - addAudioPlayerClearQueueDirective
```
public ResponseBuilder addAudioPlayerClearQueueDirective(com.amazon.ask.model.interfaces.audioplayer.ClearBehavior clearBehavior)
```
    Adds an AudioPlayer ClearQueue directive - clear the queue without stopping the currently playing stream, or clear the queue and stop any currently playing stream.
    
    Parameters:
    
    clearBehavior - Describes the clear queue behavior
    
    Returns:
    
    response builder
  - addDirective
```
public ResponseBuilder addDirective(com.amazon.ask.model.Directive directive)
```
    Helper method for adding directives to responses
    
    Parameters:
    
    directive - directive the directive send back to Alexa device
    
    Returns:
    
    response builder

Class ResponseBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResponseBuilder

Method Detail

build

withSpeech

withSimpleCard

withStandardCard

withLinkAccountCard

withAskForPermissionsConsentCard

withReprompt

withShouldEndSession

addHintDirective

addVideoAppLaunchDirective

addRenderTemplateDirective

addDelegateDirective

addElicitSlotDirective

addConfirmSlotDirective

addConfirmIntentDirective

addAudioPlayerPlayDirective

addAudioPlayerStopDirective

addAudioPlayerClearQueueDirective

addDirective