com.sap.cloud.sdk.services.recastai.botresponses

Class ButtonResponse

java.lang.Object

com.sap.cloud.sdk.services.recastai.botresponses.ButtonResponse

All Implemented Interfaces:

ResponseInterface

@Beta
public class ButtonResponse
extends Object
implements ResponseInterface

Represents all different types of button responses. They include Quick Replies and ButtonResponse. Each of them can be different types of buttons. Including phonenumber, a web url and a reply.

Constructor Summary

Constructors

Constructor and Description
ButtonResponse(ButtonCollection<Button> content) Assumes buttons as a type - full button style instead of quick replies.
ButtonResponse(String buttonResponseType, ButtonCollection<?> content) Allows to set type to either quickReplies or buttons.

Method Summary

Modifier and Type	Method and Description
static ButtonResponse	createForFullButtons(ButtonCollection<Button> content) Create a button response with complex buttons which allow visiting web urls or dial phone numbers, on top of the regular postback feature.
static ButtonResponse	createForQuickReplies(ButtonCollection<SlimButton> content) Create a response with only POSTBACK buttons.
ButtonCollection<?>	getContent() This Function returns the button collection of this response.
String	getType() Returns the type of this button response
void	setContent(ButtonCollection<?> content) Sets the content of the button collection to the given one.

Methods inherited from class java.lang.Object

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

Constructor Detail

ButtonResponse

public ButtonResponse(@Nonnull
                      ButtonCollection<Button> content)

Assumes buttons as a type - full button style instead of quick replies.

Parameters:

content - the ButtonCollection to be sent as content of this buttonresponse.

ButtonResponse

public ButtonResponse(@Nonnull
                      String buttonResponseType,
                      @Nonnull
                      ButtonCollection<?> content)

Allows to set type to either quickReplies or buttons.

Parameters:

buttonResponseType - one of buttons or quickReplies

content - a button collection with all buttons to be sent back

Method Detail

createForQuickReplies

@Nonnull
public static ButtonResponse createForQuickReplies(@Nonnull
                                                            ButtonCollection<SlimButton> content)

Create a response with only POSTBACK buttons.

Parameters:

content - the buttons to set. Don't use Button type buttons.

Returns:

the new response

createForFullButtons

@Nonnull
public static ButtonResponse createForFullButtons(@Nonnull
                                                           ButtonCollection<Button> content)

Create a button response with complex buttons which allow visiting web urls or dial phone numbers, on top of the regular postback feature.

Parameters:

content - the buttons.

Returns:

the new response

getContent

@Nullable
public ButtonCollection<?> getContent()

This Function returns the button collection of this response.

Returns:

a ButtonCollection object

setContent

public void setContent(@Nonnull
                       ButtonCollection<?> content)

Sets the content of the button collection to the given one.

Parameters:

content - the new ButtonCollection

getType

@Nullable
public String getType()

Returns the type of this button response

Specified by:

getType in interface ResponseInterface

Returns:

a string representation of the ButtonResponseTypes enums