BlackBerry Spark Communications Services for iOS  1.11.0
BBMChatMessageCriteria Class Reference
Inheritance diagram for BBMChatMessageCriteria:


NSString * chatId
NSString * tag
NSString * senderUri

Additional Inherited Members

- Instance Methods inherited from BBMContainerMatchingCriteria
(BOOL) - match:
(NSDictionary *) - asDictionary
(BOOL) - matchesValuesInDictionary:
(NSString *) - getId

Property Documentation

◆ chatId

- (NSString*) chatId

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


◆ ref

- (BBMChatMessageCriteria_Ref*) ref

A 'chatMessage' can reference other messages or be referenced by other messages.All references are directional and known to both messages involved. If message A references message B, then A has an entry in its 'ref' array with the 'messageId' of B, and B has an entry in its 'refBy' array that counts the reference from A.Each reference in the 'ref' array has an application-specified 'tag' that indicates what kind of reference it is. A single message can only have one 'ref' for each tag string. Your application uses 'tag' strings to allow multiple different kinds of references between messages. For example, a message could both 'Quote' one message and 'Edit' another.Each reference in the 'refBy' array has the same application-specified tag. A single message can have multiple references to it with the same 'tag'. To find all messages that refer to a given message, use 'requestListMatching' with the 'tag' and the 'messageId' of the referred-to message. Because the number of incoming references to a message can be large, only the most recent referring message is identified by 'newestRef' in 'refBy', along with a count of the total number of referring messages.When there are no references to any other messages, the 'ref' field is omitted.


◆ senderUri

- (NSString*) senderUri

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


◆ tag

- (NSString*) tag

Indicates the type of content this message represents. Admin - The message contains an admin change. This tag contains no content. The 'data' must contain 'Admin'.

Gap - The message history contains a gap at this position where messages have been permanently lost. The 'senderUri' will be that of the local user, the 'state' will be 'Sent', and the 'timestamp' will be the time the gap was detected. This tag has no 'content'

Join - The sender has joined the chat. This tag has no 'content'.

Leave - The sender has left the chat. This tag has no 'content'. The 'data', if present, must contain 'Leave'.

Remove - This message indicates that the sending user has removed another user from the chat. This tag contains no content. The 'data' must contain 'Remove' and will indicate which user has been removed.

Shred - The sender has requested that all previously sent messages be recalled. This tag has no 'content''.

Subject - The sender has changed the chat's 'subject'. The content contains the new subject.

Text - The message contains plain text content. This tag requires 'content'.