Messaging query data.
More...
#import <CSMessagingQuery.h>
Inherits NSObject.
Messaging query data.
This class provides data for the messaging service search.
- See also
- -[CSMessagingService searchConversations:watcher:]
Initialize query object with default values:
- query : empty
- queryAfter : empty
- numberResultsPerConversation : 15
- searchParticipants : YES
- searchSubject : YES
- searchBody : YES
| - (instancetype) initWithQuery: |
|
(NSString *) |
query |
| queryAfter: |
|
(NSString *) |
queryAfter |
| numberResultsPerConversation: |
|
(NSUInteger) |
numberResultsPerConversation |
| searchParticipants: |
|
(BOOL) |
searchParticipants |
| searchSubject: |
|
(BOOL) |
searchSubject |
| searchBody: |
|
(BOOL) |
searchBody |
|
|
| |
Initialize query object.
- Parameters
-
| query | Expression to be searched. If query is specified, the server will perform a search operation. If query is omitted, the server will perform a getConversations operation |
| queryAfter | ISO-8601 date string; filters messages based on last-modified-date |
| numberResultsPerConversation | Number of message entries per conversation to return |
| searchParticipants | Search participants attribute |
| searchSubject | Search subject attribute |
| searchBody | Search body attribute |
| - (NSUInteger) numberResultsPerConversation |
|
readwritenonatomicassign |
Number of message entries per conversation to return (if not specified, defaults to 15)
Get expression to be searched.
If a query is specified, the server will perform a search operation. If a query is omitted, the server will perform a getConversations operation.
- Returns
- String to match in search.
ISO-8601 date string; filters messages based on last-modified-date.
| - (BOOL) searchParticipants |
|
readwritenonatomicassign |
Search participants attribute.
Search subject attribute.
The documentation for this class was generated from the following file: