Package com.vonage.client.conversations

Class MessageEvent

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.conversations.Event

com.vonage.client.conversations.MessageEvent

All Implemented Interfaces:

Jsonable

public final class MessageEvent
extends Event

Represents a EventType.MESSAGE event. All possible fields are presented and accessible, but only those applicable to the message type will be populated. Use getMessageType() to determine the type of message, and query the other fields accordingly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MessageEvent.Builder	Builder for configuring parameters of the event request.

Method Summary

Modifier and Type	Method	Description
static MessageEvent.Builder	builder(MessageType messageType)	Entry point for constructing an instance of this class.
Location	getLocation()	If getMessageType() is MessageType.LOCATION, returns the location.
MessageType	getMessageType()	Describes the media type for this event.
String	getText()	If getMessageType() is MessageType.TEXT, returns the text.
URI	getUrl()	If getMessageType() is multimedia, returns the URL of the media.

Methods inherited from class com.vonage.client.conversations.Event

getFrom, getFromMember, getFromUser, getId, getTimestamp, getType

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

Method Details

getMessageType

public MessageType getMessageType()

Describes the media type for this event.

Returns:

The message type as an enum.

getText

public String getText()

If getMessageType() is MessageType.TEXT, returns the text.

Returns:

The message text, or null if not applicable.

getUrl

public URI getUrl()

If getMessageType() is multimedia, returns the URL of the media.

Returns:

The absolute media URL, or null if not applicable.

getLocation

public Location getLocation()

If getMessageType() is MessageType.LOCATION, returns the location.

Returns:

The location details, or null if not applicable.

builder

public static MessageEvent.Builder builder(MessageType messageType)

Entry point for constructing an instance of this class.

Parameters:

messageType - The type of message for this event.

Returns:

A new Builder.