BlackBerry Spark Communications Services for iOS  1.9.0
BBMSearchMessage Class Reference
Inheritance diagram for BBMSearchMessage:
BBMJSONMessage

Instance Methods

(id) - initWithText:
 
- Instance Methods inherited from BBMJSONMessage
(NSString *) - requestData
 
(NSDictionary *) - requestDict
 

Properties

NSString * cookie
 
NSString * text
 
NSString * chatId
 
NSNumber * suggestedMaxResults
 

Detailed Description

Represents the search protocol message.

Search bbmcore's local data for chat messages and chat subjects. This searches for the following types of results, in priority order. When the maximum number of results have been found, searching stops. Messages in chats whose 'content' matches the search text . Chats whose subject matches the search text. Your application will receive a 'searchResult' in response.When a 'search' request does not include the 'chatId' field, all chats (in all states) are examined and all result types are possible, but no more than one 'Message' type result will be returned for each matching chat. Each 'Message' result indicates the most recently received matching message in its chat.When a 'search' request includes the 'chatId' field, only that single chat is examined and multiple 'Message' type results can be returned. Other result types will not be present. Each 'Message' result indicates one matching message in the specified chat, with more recently received messages listed first.

Since
R0

Property Documentation

◆ chatId

- (NSString*) chatId
readwritenonatomicstrong

Search a single chat for 'Message' type matches only. See this request's description for details on how this alters the search operation and results.

Since
R8

◆ cookie

- (NSString*) cookie
readnonatomicstrong

The cookie value that will be included in the 'searchResult' response.

Since
R0

◆ suggestedMaxResults

- (NSNumber*) suggestedMaxResults
readwritenonatomicstrong

Iff present, then no more than this many results will be returned. The result size can be limited to an internal unspecified maximum that is at least 50.

Since
R0

◆ text

- (NSString*) text
readnonatomicstrong

The text of the query for case-insensitive substring search. This string must contain at least one Unicode code point or an empty result set will be returned.

Since
R0