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

Enum ButtonType

java.lang.Object

java.lang.Enum<ButtonType>

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

All Implemented Interfaces:

Serializable, Comparable<ButtonType>

@Beta
public enum ButtonType
extends Enum<ButtonType>

Buttons can react in three ways upon getting clicked on: Postback sends a message. WEB_URL opens an url in the webbrowser. PHONE_NUMBER initiates a phone call.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PHONE_NUMBER Buttons initiates a phone call to the saved number.
POSTBACK Button initiates a message to be sent back.
WEB_URL Button initiates a browser to open the saved web url.

Method Summary

Modifier and Type	Method and Description
String	getTypeValue() Get the value to pass back to Recast
static ButtonType	parse(String stringType) Get button type enum for string.
static ButtonType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ButtonType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POSTBACK

public static final ButtonType POSTBACK

Button initiates a message to be sent back.

WEB_URL

public static final ButtonType WEB_URL

Button initiates a browser to open the saved web url.

PHONE_NUMBER

public static final ButtonType PHONE_NUMBER

Buttons initiates a phone call to the saved number.

Method Detail

values

public static ButtonType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ButtonType c : ButtonType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ButtonType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getTypeValue

public String getTypeValue()

Get the value to pass back to Recast

Returns:

the value string

parse

public static ButtonType parse(@Nonnull
                               String stringType)
                        throws IllegalArgumentException

Get button type enum for string.

Parameters:

stringType - to parse

Returns:

the ButtonType

Throws:

IllegalArgumentException - if the given string doesn't exactly match one of the known type values.