class RMsgStoreSearchCriteria |
This class represents the criteria for a search request
Public Member Functions | |
---|---|
RMsgStoreSearchCriteria () | |
IMPORT_C void | AddFolderId ( TMsgStoreId ) |
IMPORT_C void | AddResultPropertyL (const TDesC8 &) |
IMPORT_C void | AddSearchStringL (const TDesC &) |
IMPORT_C void | Close () |
RArray < TMsgStoreId > & | FolderIds () |
const RPointerArray < TDesC8 > & | PropertyKeys () |
RPointerArray < TDesC > & | SearchStrings () |
Public Attributes | |
---|---|
TUint | iSearchFields |
TMsgStoreSortOrder | iSecondarySortOrder |
TMsgStoreSortByField | iSortBy |
TMsgStoreSortOrder | iSortOrder |
Private Attributes | |
---|---|
RArray < TMsgStoreId > | iFolderIds |
RPointerArray < TDesC8 > | iPropertyKeys |
RPointerArray < TDesC > | iSearchStrings |
IMPORT_C void | AddFolderId | ( | TMsgStoreId | aFolderId | ) |
Call this method to repeatly to specify the folders to be searched.
The order they are searched is the same as the order they are added. For example, to search the messages in "Inbox", "Sent Items", "Drafts" "Outbox", and other user-defined folders, add "Inbox" id first, followed by "Sent Item" id, than "Draft",etc.,
TMsgStoreId aFolderId |
IMPORT_C void | AddResultPropertyL | ( | const TDesC8 & | aPropertyKey | ) |
Call this method to repeatly to specfy all the properties that the search result should include.
For example, in the folder view, the UI may only want to display "sender", "subject", "received date", and "flags", and not to display the rest of the properties. In this case, only add KMsgStorePropertySender, KMsgStorePropertySubject, KMsgStorePropertyReceivedAt, and KMsgStorePropertyFlags to this list and the sorted results will only include these properties.
const TDesC8 & aPropertyKey |
IMPORT_C void | AddSearchStringL | ( | const TDesC & | aSearchString | ) |
Call this method to repeatly to specfy all the search strings.
/note the logical expression among these search strings is: "AND". A message is consider match if each of the search string appears at least once in the any of the search fields.
const TDesC & aSearchString |
const RPointerArray < TDesC8 > & | PropertyKeys | ( | ) | [inline] |
Internal use only, not exported
RPointerArray < TDesC > & | SearchStrings | ( | ) | [inline] |
Internal use only, not exported Note, the return value should be a const, it's removed for unit testing purpose.
TUint | iSearchFields |
Stores the search field masks defined as TMsgStoreSearchFieldMasks. By default, all search fields are enabled.
/note this field is not used in the current release. The server searches all the fields defined in TMsgStoreSearchFieldMasks.
TMsgStoreSortOrder | iSecondarySortOrder |
When the iSortBy field is not EMsgStoreSortByReceivedDate, the received date becomes secondary sorting field. This specifies whether the secondary should be ascending or descending.
Deafult value is EMsgStoreSortDescending.
TMsgStoreSortByField | iSortBy |
Specifies the sort field. Default value is EMsgStoreSortByReceivedDate.
TMsgStoreSortOrder | iSortOrder |
Specifies the sort order. Deafult value is EMsgStoreSortDescending.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.