com.askfast.askfastapi.model

Enum MediaProperty.MediaPropertyKey

java.lang.Object

java.lang.Enum<MediaProperty.MediaPropertyKey>

com.askfast.askfastapi.model.MediaProperty.MediaPropertyKey

All Implemented Interfaces:

Serializable, Comparable<MediaProperty.MediaPropertyKey>

Enclosing class:

MediaProperty

public static enum MediaProperty.MediaPropertyKey
extends Enum<MediaProperty.MediaPropertyKey>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANSWER_INPUT defines if the answer is given via dtmf, text etc
ANSWER_INPUT_MAX_LENGTH
ANSWER_INPUT_MIN_LENGTH defines the length of th answer input.
CONFERENCE_END_ON_DISCONNECT The conference ends when this flag is set to true.
CONFERENCE_ROOM_NAME The conference room name that has to be used to add a call to.
CONFERENCE_START_ON_CONNECT The conference starts when this flag is set to true.
CONFERENCE_WAIT_URL A valid url must be set against this key.
DTMF_TERMINATE boolean flag to indicate if the call should terminate when a dtmf is pressed
RETRY_LIMIT defines the number of times the question should repeat in case of a wrong answer input.
TIMEOUT defines the timeout associated with the call
TSS_SPEED defines the speed at which the TTS is spoken by the TTS engine
TYPE defines a subtype for the question type.
USE_EXTERNAL_CALLERID defines which caller id should be when redirecting a call.
USE_PRECONNECT Pre-connect message.
VOICE_MESSAGE_BEEP boolean flag to indicate if a voice mssage start should be indicated by a beep or not
VOICE_MESSAGE_LENGTH defines the length of the voicemail to be recorded

Method Summary

Methods

Modifier and Type	Method and Description
static MediaProperty.MediaPropertyKey	fromJson(String name)
static MediaProperty.MediaPropertyKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static MediaProperty.MediaPropertyKey[]	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

TIMEOUT

public static final MediaProperty.MediaPropertyKey TIMEOUT

defines the timeout associated with the call

ANSWER_INPUT

public static final MediaProperty.MediaPropertyKey ANSWER_INPUT

defines if the answer is given via dtmf, text etc

ANSWER_INPUT_MIN_LENGTH

public static final MediaProperty.MediaPropertyKey ANSWER_INPUT_MIN_LENGTH

defines the length of th answer input. Typically dtmf

ANSWER_INPUT_MAX_LENGTH

public static final MediaProperty.MediaPropertyKey ANSWER_INPUT_MAX_LENGTH

TYPE

public static final MediaProperty.MediaPropertyKey TYPE

defines a subtype for the question type.
E.g. open question with type: audio refers to voicemail

VOICE_MESSAGE_LENGTH

public static final MediaProperty.MediaPropertyKey VOICE_MESSAGE_LENGTH

defines the length of the voicemail to be recorded

RETRY_LIMIT

public static final MediaProperty.MediaPropertyKey RETRY_LIMIT

defines the number of times the question should repeat in case of a wrong answer input. works only for phonecalls so as to end a call with repeated input errors.

VOICE_MESSAGE_BEEP

public static final MediaProperty.MediaPropertyKey VOICE_MESSAGE_BEEP

boolean flag to indicate if a voice mssage start should be indicated by a beep or not

DTMF_TERMINATE

public static final MediaProperty.MediaPropertyKey DTMF_TERMINATE

boolean flag to indicate if the call should terminate when a dtmf is pressed

TSS_SPEED

public static final MediaProperty.MediaPropertyKey TSS_SPEED

defines the speed at which the TTS is spoken by the TTS engine

USE_EXTERNAL_CALLERID

public static final MediaProperty.MediaPropertyKey USE_EXTERNAL_CALLERID

defines which caller id should be when redirecting a call. If this is set to true the caller id of the connected user will be used. If false the adapterid caller id will be used. (Default: false)

USE_PRECONNECT

public static final MediaProperty.MediaPropertyKey USE_PRECONNECT

Pre-connect message. Gives opertunity to play a message before connecting the redirected call

CONFERENCE_ROOM_NAME

public static final MediaProperty.MediaPropertyKey CONFERENCE_ROOM_NAME

The conference room name that has to be used to add a call to.

CONFERENCE_START_ON_CONNECT

public static final MediaProperty.MediaPropertyKey CONFERENCE_START_ON_CONNECT

The conference starts when this flag is set to true. If not found, the conference starts as soon as there are two people in the conference

CONFERENCE_END_ON_DISCONNECT

public static final MediaProperty.MediaPropertyKey CONFERENCE_END_ON_DISCONNECT

The conference ends when this flag is set to true. If not found, the conference ends as soon as all participants leave the conference

CONFERENCE_WAIT_URL

public static final MediaProperty.MediaPropertyKey CONFERENCE_WAIT_URL

A valid url must be set against this key. This audio is played when participant is waiting in a conference room to be connected to other participants

Method Detail

values

public static MediaProperty.MediaPropertyKey[] 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 (MediaProperty.MediaPropertyKey c : MediaProperty.MediaPropertyKey.values())
    System.out.println(c);

Returns:

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

valueOf

public static MediaProperty.MediaPropertyKey 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

fromJson

public static MediaProperty.MediaPropertyKey fromJson(String name)