com.quickblox.chat.model

Class QBChatMessage

java.lang.Object

com.quickblox.chat.model.QBChatMessage

All Implemented Interfaces:

java.io.Serializable

public class QBChatMessage
extends java.lang.Object
implements java.io.Serializable

QBChatMessage model describes a chat message.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QBChatMessage() Constructs a new QBChatMessage object.
QBChatMessage(Message smackMessage)

Method Summary

Modifier and Type	Method and Description
boolean	addAttachment(QBAttachment attachment) Add an attachment.
static Message	buildDeliveredOrReadStatusMessage(boolean delivered, java.lang.Integer senderId, java.lang.String originMessageID, java.lang.String dialogId)
static Message	buildTypingStatusMessage(java.lang.String to, Message.Type type, ChatState chatState)
boolean	equals(java.lang.Object o)
java.util.Collection<QBAttachment>	getAttachments() Gets the array of attachments.
java.lang.String	getBody() Gets the body.
long	getDateSent() Gets the date sent value
java.util.Collection<java.lang.Integer>	getDeliveredIds() Gets the array of users who received the message.
java.lang.String	getDialogId() Gets the dialog ID of a Message.
java.lang.String	getId() Gets the ID of a message.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Gets a map of message's properties
java.lang.Object	getProperty(java.lang.String name) Returns the message custom property with the specified name or null if the property doesn't exist.
java.util.Collection<java.lang.String>	getPropertyNames() Gets a collection of all the custom properties names that are set.
java.util.Collection<java.lang.Integer>	getReadIds() Gets the array of users who read the message.
java.lang.Integer	getRecipientId() Gets the recipient user ID.
java.lang.Integer	getSenderId() Gets the sender user ID.
Message	getSmackMessage()
int	hashCode()
boolean	isDelayed() Is this message delayed, for example a user was offline when another sent the message to him.
boolean	isMarkable() Returns true if the message marked as markable.
boolean	removeAttachment(QBAttachment attachment) Remove an attachment.
java.lang.Object	removeComplexProperty(java.lang.String name) Deletes a complex property.
java.lang.String	removeProperty(java.lang.String name) Deletes a custom property.
void	removeQBChatUnMarkedMessageExtension()
void	setAttachments(java.util.Collection<QBAttachment> attachments) Sets the attachments
void	setBody(java.lang.String body) Sets the body.
java.lang.Object	setComplexProperty(java.lang.String name, java.lang.Object value) Adds complex property.
void	setDateSent(long dateSent) Sets the date sent value
void	setDeliveredIds(java.util.Collection<java.lang.Integer> deliveredIds)
void	setDialogId(java.lang.String dialogId) Sets the dialog id
void	setId(java.lang.String id) Sets the ID of a Message.
void	setMarkable(boolean markable) Marks message as markable.
java.lang.String	setProperty(java.lang.String name, java.lang.String value) Adds custom property to a message
void	setQBChatUnMarkedMessageExtension(QBChatMessageExtension packetExtension)
void	setReadIds(java.util.Collection<java.lang.Integer> readIds)
void	setRecipientId(java.lang.Integer recipientId) Sets the recipient user ID.
void	setSaveToHistory(boolean saveToHistory) Mark message to be saved to message history.
void	setSenderId(java.lang.Integer senderId) Sets the sender id
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

QBChatMessage

public QBChatMessage()

Constructs a new QBChatMessage object.

QBChatMessage

public QBChatMessage(Message smackMessage)

Method Detail

getId

public java.lang.String getId()

Gets the ID of a message.

setId

public void setId(java.lang.String id)

Sets the ID of a Message. The string set in params should be built according to MongoDB ObjectID format. In case setting wrong format id, a Message will be created with generated by system id.

Parameters:

id - - is string representation of globally unique identifier for objects.

getDialogId

public java.lang.String getDialogId()

Gets the dialog ID of a Message. Null in current version.

setDialogId

public void setDialogId(java.lang.String dialogId)

Sets the dialog id

Parameters:

dialogId - The ID of a dialog to set

getSenderId

public java.lang.Integer getSenderId()

Gets the sender user ID.

setSenderId

public void setSenderId(java.lang.Integer senderId)

Sets the sender id

Parameters:

senderId - The sender user ID to set.

isDelayed

public boolean isDelayed()

Is this message delayed, for example a user was offline when another sent the message to him.

getRecipientId

public java.lang.Integer getRecipientId()

Gets the recipient user ID.

setRecipientId

public void setRecipientId(java.lang.Integer recipientId)

Sets the recipient user ID.

Parameters:

recipientId - The value to set

getBody

public java.lang.String getBody()

Gets the body.

setBody

public void setBody(java.lang.String body)

Sets the body.

Parameters:

body - The value to set

isMarkable

public boolean isMarkable()

Returns true if the message marked as markable.

setMarkable

public void setMarkable(boolean markable)

Marks message as markable. This enables "delivered" and "read" status handling.

getAttachments

public java.util.Collection<QBAttachment> getAttachments()

Gets the array of attachments.

setAttachments

public void setAttachments(java.util.Collection<QBAttachment> attachments)

Sets the attachments

Parameters:

attachments - The attachments to set

addAttachment

public boolean addAttachment(QBAttachment attachment)

Add an attachment.

Parameters:

attachment - An instance of QBAttachment to add.

Returns:

true if this collection changed as a result of the call

See Also:

QBAttachment

removeAttachment

public boolean removeAttachment(QBAttachment attachment)

Remove an attachment.

Parameters:

attachment - An instance of QBAttachment to remove.

Returns:

true if an element was removed as a result of this call

See Also:

QBAttachment

getReadIds

public java.util.Collection<java.lang.Integer> getReadIds()

Gets the array of users who read the message.

setReadIds

public void setReadIds(java.util.Collection<java.lang.Integer> readIds)

getDeliveredIds

public java.util.Collection<java.lang.Integer> getDeliveredIds()

Gets the array of users who received the message.

setDeliveredIds

public void setDeliveredIds(java.util.Collection<java.lang.Integer> deliveredIds)

getProperty

public java.lang.Object getProperty(java.lang.String name)

Returns the message custom property with the specified name or null if the property doesn't exist.

Parameters:

name - The custom property name.

getPropertyNames

public java.util.Collection<java.lang.String> getPropertyNames()

Gets a collection of all the custom properties names that are set.

getProperties

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

Gets a map of message's properties

setProperty

public java.lang.String setProperty(java.lang.String name,
                                    java.lang.String value)

Adds custom property to a message

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

the previous value associated with key, or null if there was no mapping for key.

removeProperty

public java.lang.String removeProperty(java.lang.String name)

Deletes a custom property.

Parameters:

name - The name of the property to delete.

Returns:

the previous value associated with key, or null if there was no mapping for key.

setComplexProperty

public java.lang.Object setComplexProperty(java.lang.String name,
                                           java.lang.Object value)

Adds complex property.

Parameters:

name - The name of the property.

value - The value of the property.

Returns:

the previous value associated with key, or null if there was no mapping for key.

removeComplexProperty

public java.lang.Object removeComplexProperty(java.lang.String name)

Deletes a complex property.

Parameters:

name - The name of the property to delete.

Returns:

the previous value associated with key, or null if there was no mapping for key.

getDateSent

public long getDateSent()

Gets the date sent value

setDateSent

public void setDateSent(long dateSent)

Sets the date sent value

Parameters:

dateSent - The value to set

setSaveToHistory

public void setSaveToHistory(boolean saveToHistory)

Mark message to be saved to message history.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

setQBChatUnMarkedMessageExtension

public void setQBChatUnMarkedMessageExtension(QBChatMessageExtension packetExtension)

removeQBChatUnMarkedMessageExtension

public void removeQBChatUnMarkedMessageExtension()

getSmackMessage

public Message getSmackMessage()

buildDeliveredOrReadStatusMessage

public static Message buildDeliveredOrReadStatusMessage(boolean delivered,
                                                        java.lang.Integer senderId,
                                                        java.lang.String originMessageID,
                                                        java.lang.String dialogId)

buildTypingStatusMessage

public static Message buildTypingStatusMessage(java.lang.String to,
                                               Message.Type type,
                                               ChatState chatState)