Package com.vonage.client.conversations

Class Event

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.conversations.Event

All Implemented Interfaces:

Jsonable

Direct Known Subclasses:

AudioEarmuffOffEvent, AudioEarmuffOnEvent, AudioMuteOffEvent, AudioMuteOnEvent, AudioPlayDoneEvent, AudioPlayEvent, AudioPlayStopEvent, AudioRecordEvent, AudioRecordStopEvent, AudioSayDoneEvent, AudioSayEvent, AudioSayStopEvent, ConversationUpdatedEvent, EventDeleteEvent, GenericEvent, MessageDeliveredEvent, MessageEvent, MessageRejectedEvent, MessageSeenEvent, MessageSubmittedEvent, MessageUndeliverableEvent

public abstract class Event
extends JsonableBaseObject

Events are actions that occur within a conversation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Event.Builder<E extends Event,B extends Event.Builder<? extends E,? extends B>>	Builder for constructing an event request's parameters.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Event()

Method Summary

Modifier and Type	Method	Description
String	getFrom()	Member ID this event was sent from.
BaseMember	getFromMember()	Member that initiated the event.
User	getFromUser()	Details about the user that initiated the event.
Integer	getId()	Event id.
Instant	getTimestamp()	Time of creation.
EventType	getType()	Type of event.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

Event

protected Event()

Method Details

getId

public Integer getId()

Event id. This is a progressive integer.

Returns:

The event ID as an integer, or null if unknown.

getType

public EventType getType()

Type of event.

Returns:

The event type as an enum.

getFrom

public String getFrom()

Member ID this event was sent from.

Returns:

The member ID, or null if unspecified.

getTimestamp

public Instant getTimestamp()

Time of creation.

Returns:

The event timestamp, or null if unknown.

getFromUser

public User getFromUser()

Details about the user that initiated the event.

Returns:

The embedded from_user object, or null if absent.

getFromMember

public BaseMember getFromMember()

Member that initiated the event. Only the id field will be present.

Returns:

The embedded from_member object, or null if absent.