com.nexmo.client

Class NexmoEvent

java.lang.Object

com.nexmo.client.NexmoEvent

All Implemented Interfaces:

android.os.Parcelable, java.io.Serializable

Direct Known Subclasses:

NexmoAttachmentEvent, NexmoCustomEvent, NexmoDeletedEvent, NexmoDeliveredEvent, NexmoDTMFEvent, NexmoLegStatusEvent, NexmoLegTransferEvent, NexmoMediaActionEvent, NexmoMediaEvent, NexmoMemberEvent, NexmoMemberMessageStatusEvent, NexmoMessageEvent, NexmoRejectedEvent, NexmoSeenEvent, NexmoSubmittedEvent, NexmoTextEvent, NexmoTypingEvent, NexmoUndeliverableEvent

public class NexmoEvent
extends java.lang.Object
implements java.io.Serializable, android.os.Parcelable

Represents the base class from which all Nexmo Event classes are derived.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<NexmoEvent>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
NexmoConversation	getConversation() Gets the conversation of this event.
java.lang.String	getConversationId() Gets the NexmoEvent conversation id.
java.util.Date	getCreationDate() Gets the NexmoEvent creationDate.
NexmoEventEmbeddedInfo	getEmbeddedInfo() Gets the NexmoEventEmbeddedInfo embedded info.
NexmoEventType	getEventType() Gets the NexmoEvent type.
java.lang.String	getFromMemberId() Gets the NexmoEvent sender.
int	getId() Gets the NexmoEvent id.
int	hashCode()
protected void	markEventState(NexmoRequestListener listener, java.util.Map<EMessageState,java.util.List<MemberForMessageStateBundle>> eventState, EMessageType messageType, EMessageState desiredState) Marks a Text, Attachment or Message event as seen or delivered.
java.lang.String	toString()
protected void	updateEventState(java.util.concurrent.ConcurrentHashMap<EMessageState,java.util.List<MemberForMessageStateBundle>> eventState, EMessageState messageState, MemberForMessageStateBundle memberState) Updates an event as delivered or seen.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<NexmoEvent> CREATOR

Method Detail

getConversationId

public java.lang.String getConversationId()

Gets the NexmoEvent conversation id.

Returns:

The conversation id.

getId

public int getId()

Gets the NexmoEvent id.

Returns:

The id.

getCreationDate

public java.util.Date getCreationDate()

Gets the NexmoEvent creationDate.

Returns:

The creation date.

getFromMemberId

public java.lang.String getFromMemberId()

Gets the NexmoEvent sender.

Returns:

The fromMemberId.

getEventType

public NexmoEventType getEventType()

Gets the NexmoEvent type.

Returns:

The eventType.

getConversation

public NexmoConversation getConversation()

Gets the conversation of this event.

Returns:

The NexmoConversation payload.

getEmbeddedInfo

public NexmoEventEmbeddedInfo getEmbeddedInfo()

Gets the NexmoEventEmbeddedInfo embedded info.

Returns:

The embedded info.

markEventState

protected void markEventState(NexmoRequestListener listener,
                              java.util.Map<EMessageState,java.util.List<MemberForMessageStateBundle>> eventState,
                              EMessageType messageType,
                              EMessageState desiredState)

Marks a Text, Attachment or Message event as seen or delivered. NexmoEvent seen receipt cannot be revoked.

Parameters:

listener - The request completion listener.

updateEventState

protected void updateEventState(java.util.concurrent.ConcurrentHashMap<EMessageState,java.util.List<MemberForMessageStateBundle>> eventState,
                                EMessageState messageState,
                                MemberForMessageStateBundle memberState)

Updates an event as delivered or seen.

Parameters:

eventState - The current event state for the event

messageState - The message state to update (SEEN or DELIVERED)

memberState - The member id and timestamp of when the member marked the event

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable