Package com.vonage.client.conversations

Enum Class EventType

java.lang.Object

java.lang.Enum<EventType>

com.vonage.client.conversations.EventType

All Implemented Interfaces:

Serializable, Comparable<EventType>, java.lang.constant.Constable

public enum EventType
extends Enum<EventType>

Represents the possible types of events in Event.getType().

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUDIO_ASR_DONE	Automatic speech recognition has finished.
AUDIO_ASR_RECORD_DONE	Automatic speech recognition of recording has finished.
AUDIO_DTMF	Play DTMF audio.
AUDIO_EARMUFF_OFF	Unearmuff audio, i.e. the receiver will be able to hear it.
AUDIO_EARMUFF_ON	Earmuff audio, i.e. the receiver won't be able to hear it.
AUDIO_MUTE_OFF	Unmute audio, i.e. the producer will be able to be heard by others.
AUDIO_MUTE_ON	Mute audio, i.e. the producer won't be able to be heard by others.
AUDIO_PLAY	Play audio.
AUDIO_PLAY_DONE	Playing audio has finished.
AUDIO_PLAY_STOP	Stop the audio currently playing.
AUDIO_RECORD	Record the audio.
AUDIO_RECORD_DONE	Audio recording has finished.
AUDIO_RECORD_STOP	Stop current recording of audio.
AUDIO_SAY	Use text-to-speech to say the given text.
AUDIO_SAY_DONE	Playing text-to-speech has finished.
AUDIO_SAY_STOP	Stop the currently playing text-to-speech.
AUDIO_SPEAKING_OFF	Disable speaking.
AUDIO_SPEAKING_ON	Enable speaking.
CONVERSATION_UPDATED	Conversation details have been updated.
CUSTOM	Custom event.
EPHEMERAL	Ephemeral (temporary) event.
EVENT_DELETE	Event has been deleted.
LEG_STATUS_UPDATE	Update on the status of a conversation leg.
MEMBER_INVITED	Member has been invited to the conversation.
MEMBER_JOINED	Member has joined the conversation.
MEMBER_LEFT	Member has left the conversation.
MEMBER_MEDIA	Member has media.
MEMBER_MESSAGE_STATUS	Status update on a member message.
MESSAGE	Message event.
MESSAGE_DELIVERED	Message has been delivered.
MESSAGE_REJECTED	Message rejected.
MESSAGE_SEEN	Message has been seen.
MESSAGE_SUBMITTED	Message submitted.
MESSAGE_UNDELIVERABLE	Message could not be delivered.
RTC_ANSWER	RTC call answer.
RTC_ANSWERED	RTC call has been answered.
RTC_HANGUP	RTC call has hung up.
RTC_RINGING	RTC call is ringing.
RTC_STATUS	RTC status.
RTC_TRANSFER	RTC call transfer.
SIP_AMD_MACHINE	SIP call encountered machine using Advanced Machine Detection.
SIP_ANSWERED	SIP call has been answered.
SIP_HANGUP	SIP call has been hung up.
SIP_MACHINE	SIP call encountered machine.
SIP_RINGING	SIP call is ringing.
SIP_STATUS	Status of SIP.
UNKNOWN	Event type is not defined in this enum.

Method Summary

Modifier and Type	Method	Description
static EventType	fromString(String name)
String	toString()
static EventType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final EventType UNKNOWN

Event type is not defined in this enum.

EPHEMERAL

public static final EventType EPHEMERAL

Ephemeral (temporary) event.

CUSTOM

public static final EventType CUSTOM

Custom event.

MESSAGE

public static final EventType MESSAGE

Message event. See MessageType for the specifics. Applicable events are: Text, Image, Audio, Video, File, Template, Custom, VCard, Location, Random.

MESSAGE_SUBMITTED

public static final EventType MESSAGE_SUBMITTED

Message submitted.

MESSAGE_REJECTED

public static final EventType MESSAGE_REJECTED

Message rejected.

MESSAGE_UNDELIVERABLE

public static final EventType MESSAGE_UNDELIVERABLE

Message could not be delivered.

MESSAGE_SEEN

public static final EventType MESSAGE_SEEN

Message has been seen.

MESSAGE_DELIVERED

public static final EventType MESSAGE_DELIVERED

Message has been delivered.

AUDIO_PLAY

public static final EventType AUDIO_PLAY

Play audio.

AUDIO_PLAY_STOP

public static final EventType AUDIO_PLAY_STOP

Stop the audio currently playing.

AUDIO_SAY

public static final EventType AUDIO_SAY

Use text-to-speech to say the given text.

AUDIO_SAY_STOP

public static final EventType AUDIO_SAY_STOP

Stop the currently playing text-to-speech.

AUDIO_DTMF

public static final EventType AUDIO_DTMF

Play DTMF audio.

AUDIO_RECORD

public static final EventType AUDIO_RECORD

Record the audio.

AUDIO_RECORD_STOP

public static final EventType AUDIO_RECORD_STOP

Stop current recording of audio.

AUDIO_MUTE_ON

public static final EventType AUDIO_MUTE_ON

Mute audio, i.e. the producer won't be able to be heard by others.

AUDIO_MUTE_OFF

public static final EventType AUDIO_MUTE_OFF

Unmute audio, i.e. the producer will be able to be heard by others.

AUDIO_EARMUFF_ON

public static final EventType AUDIO_EARMUFF_ON

Earmuff audio, i.e. the receiver won't be able to hear it.

AUDIO_EARMUFF_OFF

public static final EventType AUDIO_EARMUFF_OFF

Unearmuff audio, i.e. the receiver will be able to hear it.

EVENT_DELETE

public static final EventType EVENT_DELETE

Event has been deleted.

LEG_STATUS_UPDATE

public static final EventType LEG_STATUS_UPDATE

Update on the status of a conversation leg.

CONVERSATION_UPDATED

public static final EventType CONVERSATION_UPDATED

Conversation details have been updated.

AUDIO_SAY_DONE

public static final EventType AUDIO_SAY_DONE

Playing text-to-speech has finished.

AUDIO_PLAY_DONE

public static final EventType AUDIO_PLAY_DONE

Playing audio has finished.

AUDIO_RECORD_DONE

public static final EventType AUDIO_RECORD_DONE

Audio recording has finished.

AUDIO_SPEAKING_ON

public static final EventType AUDIO_SPEAKING_ON

Enable speaking.

AUDIO_SPEAKING_OFF

public static final EventType AUDIO_SPEAKING_OFF

Disable speaking.

AUDIO_ASR_DONE

public static final EventType AUDIO_ASR_DONE

Automatic speech recognition has finished.

AUDIO_ASR_RECORD_DONE

public static final EventType AUDIO_ASR_RECORD_DONE

Automatic speech recognition of recording has finished.

MEMBER_MESSAGE_STATUS

public static final EventType MEMBER_MESSAGE_STATUS

Status update on a member message.

MEMBER_INVITED

public static final EventType MEMBER_INVITED

Member has been invited to the conversation.

MEMBER_JOINED

public static final EventType MEMBER_JOINED

Member has joined the conversation.

MEMBER_LEFT

public static final EventType MEMBER_LEFT

Member has left the conversation.

MEMBER_MEDIA

public static final EventType MEMBER_MEDIA

Member has media.

SIP_STATUS

public static final EventType SIP_STATUS

Status of SIP.

SIP_HANGUP

public static final EventType SIP_HANGUP

SIP call has been hung up.

SIP_ANSWERED

public static final EventType SIP_ANSWERED

SIP call has been answered.

SIP_MACHINE

public static final EventType SIP_MACHINE

SIP call encountered machine.

SIP_AMD_MACHINE

public static final EventType SIP_AMD_MACHINE

SIP call encountered machine using Advanced Machine Detection.

SIP_RINGING

public static final EventType SIP_RINGING

SIP call is ringing.

RTC_STATUS

public static final EventType RTC_STATUS

RTC status.

RTC_TRANSFER

public static final EventType RTC_TRANSFER

RTC call transfer.

RTC_HANGUP

public static final EventType RTC_HANGUP

RTC call has hung up.

RTC_ANSWERED

public static final EventType RTC_ANSWERED

RTC call has been answered.

RTC_RINGING

public static final EventType RTC_RINGING

RTC call is ringing.

RTC_ANSWER

public static final EventType RTC_ANSWER

RTC call answer.

Method Details

values

public static EventType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EventType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static EventType fromString(String name)

toString

public String toString()

Overrides:

toString in class Enum<EventType>