com.comapi.chat.model

Class ChatMessage

java.lang.Object

com.comapi.chat.model.ChatMessage

All Implemented Interfaces:

java.lang.Comparable<ChatMessage>

public class ChatMessage
extends java.lang.Object
implements java.lang.Comparable<ChatMessage>

Message model for db storage.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChatMessage.Builder

Constructor Summary

Constructors

Constructor and Description
ChatMessage()

Method Summary

Modifier and Type	Method and Description
void	addStatusUpdate(ChatMessageStatus status) Update status list with a new status.
static ChatMessage.Builder	builder()
int	compareTo(ChatMessage message)
java.lang.String	getConversationId() Globally unique identifier of a message.
Sender	getFromWhom() Who is the official sender of the message.
java.lang.String	getMessageId() Globally unique identifier of a message.
java.util.Map<java.lang.String,java.lang.Object>	getMetadata() Metadata associated with the message e.g.
java.util.List<Part>	getParts() Parts of the message with data, type, name and size.
java.lang.String	getSentBy() Who actually sent the message.
java.lang.Long	getSentEventId() Gets Unique monotonically increasing identifier of message in the conversation.
java.lang.Long	getSentOn() UTC time in milliseconds when the message was sent.
java.util.Collection<ChatMessageStatus>	getStatusUpdates() Message statuses 'delivered' or 'read' for particular participants.
ChatMessage	setSentEventId(java.lang.Long sentEventId) Internal setter to update sent event id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChatMessage

public ChatMessage()

Method Detail

getSentEventId

public java.lang.Long getSentEventId()

Gets Unique monotonically increasing identifier of message in the conversation. We recommend to sort the messages based on its value.

Returns:

Unique monotonically increasing identifier of message in the conversation. We recommend to sort the messages based on its value.

getMessageId

public java.lang.String getMessageId()

Globally unique identifier of a message.

Returns:

Globally unique identifier of a message.

getConversationId

public java.lang.String getConversationId()

Globally unique identifier of a message.

Returns:

Globally unique identifier of a message.

getFromWhom

public Sender getFromWhom()

Who is the official sender of the message.

Returns:

Who is the official sender of the message.

getSentBy

public java.lang.String getSentBy()

Who actually sent the message. This is usually internal information.

Returns:

Who actually sent the message. This is usually internal information.

getSentOn

public java.lang.Long getSentOn()

UTC time in milliseconds when the message was sent.

Returns:

UTC time in milliseconds when the message was sent.

getParts

public java.util.List<Part> getParts()

Parts of the message with data, type, name and size.

Returns:

Parts of the message with data, type, name and size.

getStatusUpdates

public java.util.Collection<ChatMessageStatus> getStatusUpdates()

Message statuses 'delivered' or 'read' for particular participants.

Returns:

Message statuses 'delivered' or 'read' for particular participants.

getMetadata

public java.util.Map<java.lang.String,java.lang.Object> getMetadata()

Metadata associated with the message e.g. custom id.

Returns:

Metadata map.

addStatusUpdate

public void addStatusUpdate(ChatMessageStatus status)

Update status list with a new status.

Parameters:

status - New message status details.

setSentEventId

public ChatMessage setSentEventId(java.lang.Long sentEventId)

Internal setter to update sent event id.

builder

public static ChatMessage.Builder builder()

compareTo

public int compareTo(ChatMessage message)

Specified by:

compareTo in interface java.lang.Comparable<ChatMessage>