com.bbm.sdk.bbmds

Class ChatMessage

java.lang.Object

com.bbm.sdk.bbmds.internal.RequestListActions

com.bbm.sdk.bbmds.ChatMessage

All Implemented Interfaces:

JsonConstructable

public class ChatMessage
extends RequestListActions
implements JsonConstructable

Each element in this list is a message in a hosted chat. The primary key for each element is the 'chatId' and 'messageId'.

The range of valid message ids for a given chat can be found in the chat list as ['lastMessage' - 'numMessages', 'lastMessage'].

When a new message is added to a chat, bbmcore will first 'listAdd' the message entry, and then will 'listChange' the chat to update the 'lastMessage' and 'numMessages' fields.

Note that 'listRemove' is not supported for this list. The message counters maintained in the chat list indicate when messages have been removed from this list.

Since:

R2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChatMessage.ChatMessageKey Creates a new ChatMessageKey instance
static class	ChatMessage.FileState Indicates the state of file upload or download.
static class	ChatMessage.Flags Compact read-only flags about the message.
static class	ChatMessage.Recall This field indicates the recall state of the message.
static class	ChatMessage.State This field indicates the overall delivery state of the message.
static interface	ChatMessage.Tag Indicates the type of content this message represents.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	chatId The unique identifier of the chat to which this message belongs.
java.lang.String	content Holds the text content of the message, when the 'tag' has such a concept; otherwise omitted.
JSONObject	data This field contains opaque data managed by the app that is sent with the message.
Existence	exists Determines whether the data in this object is valid.
java.lang.String	file A path to a large file that is not carried in the message.
ChatMessage.FileState	fileState Indicates the state of file upload or download.
java.lang.String	flags Compact read-only flags about the message.
long	messageId The unique identifier for this message.
ChatMessage.Recall	recall This field indicates the recall state of the message.
java.lang.String	senderUri Holds the URI of the sender of this message.
ChatMessage.State	state This field indicates the overall delivery state of the message.
boolean	stateIsPartial This indicates whether or not the state applies to some (true) or all (false) recipients.
java.lang.String	tag Indicates the type of content this message represents.
java.lang.String	thumb A path to a small file that is carried in the message.
long	timestamp Holds the POSIX timestamp of the message.

Constructor Summary

Constructors

Constructor and Description
ChatMessage() Creates a new instance with default values
ChatMessage(ChatMessage toCopy) Creates a shallow copy of the argument.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Existence	getExists() See Existence
ChatMessage.ChatMessageKey	getPrimaryKey() Provides the unique key for this ChatMessage
boolean	hasFlag(ChatMessage.Flags flag) Check if the Flags string contains the given flag.
int	hashCode()
ChatMessage	setAttributes(JSONObject json) Updates the the attributes of the JsonConstructable based on the values in the JSONObject
void	setExists(Existence exists) See Existence
JsonConstructable	shallowCopy() Creates a shallow copy of the receiver
java.lang.String	toString()

Methods inherited from class com.bbm.sdk.bbmds.internal.RequestListActions

requestListAdd, requestListChange, requestListRemove

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

chatId

public java.lang.String chatId

The unique identifier of the chat to which this message belongs.

Since:

R2

content

public java.lang.String content

Holds the text content of the message, when the 'tag' has such a concept; otherwise omitted.

Since:

R2 PERSONALLY IDENTIFIABLE INFORMATION -DO NOT LOG

data

public JSONObject data

This field contains opaque data managed by the app that is sent with the message. Unless specifically noted, bbmcore does not examine or modify this JSON object.

This can contain a single JSON object, or it can not exist at all. It cannot contain any other JSON type.

Many 'tag' values have a corresponding object defined as a child of the 'data' object with a key equal to the 'tag'. All 'tags' with such a corresponding child of 'data' require that child to be present. Other tags have no such requirement.

The 'data' object can also contain other key-value pairs independently from the 'tag'.

Since:

R2

file

public java.lang.String file

A path to a large file that is not carried in the message. This file is uploaded or download by bbmcore automatically. For downloads, this will only be set once 'fileState' progresses to Done

Since:

R2 PERSONALLY IDENTIFIABLE INFORMATION -DO NOT LOG

fileState

public ChatMessage.FileState fileState

Indicates the state of file upload or download.

Generally, whether the transfer is an upload or download is not exposed to the app. However, some states imply that the transfer is a download that can be started or restarted by the 'chatMessageFileDownload' message. The 'incoming' 'flag' on this 'chatMessage' does not indicate whether the transfer is an upload or download.

Bbmcore automatically handles temporary errors during uploads and downloads. Such errors and the retries that occur are not exposed to the app. Eventually, bbmcore will give up and place a transfer into either the 'Failed' or 'FailedAvailable' state.

Since:

R2

flags

public java.lang.String flags

Compact read-only flags about the message. Each flag that is 'true' has its corresponding letter present in the string. Each flag that is 'false' has its corresponding letter not present in the string. The letters will always be provided in alphabetical order.

Since:

R2

messageId

public long messageId

The unique identifier for this message. These are consecutive integers, ordered by arrival time. The range of valid integers for a given chat is stored in 'listChat's 'lastMessage' and 'numMessages' values.

Since:

R2

recall

public ChatMessage.Recall recall

This field indicates the recall state of the message.

Since:

R2

senderUri

public java.lang.String senderUri

Holds the URI of the sender of this message. See the URIs section for information on the URI format.

Since:

R2

state

public ChatMessage.State state

This field indicates the overall delivery state of the message.

Since:

R2

stateIsPartial

public boolean stateIsPartial

This indicates whether or not the state applies to some (true) or all (false) recipients.

Since:

R2

tag

public java.lang.String tag

Indicates the type of content this message represents.

Since:

R2

thumb

public java.lang.String thumb

A path to a small file that is carried in the message.

Since:

R2 PERSONALLY IDENTIFIABLE INFORMATION -DO NOT LOG

timestamp

public long timestamp

Holds the POSIX timestamp of the message.

Since:

R2

exists

public Existence exists

Determines whether the data in this object is valid. If state is Existence.YES, this object contains real data. Otherwise, all other attributes contain default placeholder data. If the state is Existence.NO, then we know for certain that this entity does not exist in the daemon. If the state is Existence.MAYBE, then we have not yet confirmed whether this entity exists in the daemon -- normally because a request has been sent to the daemon that it has not yet answered.

Constructor Detail

ChatMessage

public ChatMessage()

Creates a new instance with default values

ChatMessage

public ChatMessage(ChatMessage toCopy)

Creates a shallow copy of the argument.

Parameters:

toCopy - the object to copy

Method Detail

hasFlag

public boolean hasFlag(ChatMessage.Flags flag)

Check if the Flags string contains the given flag.

Parameters:

flag - the read-only flag to check

Returns:

True if the flag exists in this ChatMessage

Since:

R2

getPrimaryKey

public ChatMessage.ChatMessageKey getPrimaryKey()

Provides the unique key for this ChatMessage

Specified by:

getPrimaryKey in interface JsonConstructable

Returns:

unique key

Since:

R3

setAttributes

public ChatMessage setAttributes(JSONObject json)

Description copied from interface: JsonConstructable

Updates the the attributes of the JsonConstructable based on the values in the JSONObject

Specified by:

setAttributes in interface JsonConstructable

Parameters:

json - The JSONObject used to update the attributes of this JsonConstructable

Returns:

The element after it has been updated.

shallowCopy

public JsonConstructable shallowCopy()

Description copied from interface: JsonConstructable

Creates a shallow copy of the receiver

Specified by:

shallowCopy in interface JsonConstructable

Returns:

a shallow copy of the receiver

setExists

public void setExists(Existence exists)

Description copied from interface: JsonConstructable

See Existence

Specified by:

setExists in interface JsonConstructable

Parameters:

exists - sets the expected Existence value on the object.

getExists

public Existence getExists()

Description copied from interface: JsonConstructable

See Existence

Specified by:

getExists in interface JsonConstructable

Returns:

One of Existence.MAYBE, Existence.YES or Existence.NO

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object