MarkOrDeletePriorFilter
Since: BlackBerry 10.0.0
#include <bb/pim/message/MarkOrDeletePriorFilter>
To link against this class, add the following line to your .pro file: LIBS += -lbbpim
The MarkOrDeletePriorFilter class lets you specify options and parameters for prior options.
lets you specify options and parameters for prior options. You need to instantiate MarkOrDeletePriorFilter object date prior, folder id and or options such MarkOrDeletePriorFilter::OperateOnFiledMessages or MarkOrDeletePriorFilter::OperateOnSentMessages (Note: These options do not apply, when you are specifying a folder id for folder operation). And then you need to pass this object to MessageService::markOrDeletePrior() function.
Overview
Public Types Index
enum OptionsOperateOnFiledMessages = 1 << 0, OperateOnSentMessages = 1 << 1 |
Public Functions Index
| MarkOrDeletePriorFilter () | |
| MarkOrDeletePriorFilter (const MarkOrDeletePriorFilter &other) | |
| ~MarkOrDeletePriorFilter () | |
| MessageFolderKey | getFolderId () const |
| int | getOptions () const |
| QString | getPriorDateTime () const |
| bool | isPriorityInboxSearch () const |
| MarkOrDeletePriorFilter & | operator= (const MarkOrDeletePriorFilter &other) |
| void | setFolderId (MessageFolderKey folderId) |
| void | setOptions (int value) |
| void | setPriorDateTime (QDateTime &dateTime) |
| void | setPriorityInboxSearch (bool) |
Public Types
- OperateOnFiledMessages = 1 << 0
Indicates that the prior to date operations should apply to unread messages.
NOTE: This Option is not meant to be used for prior operations on search results.
Since:BlackBerry 10.0.0
- OperateOnSentMessages = 1 << 1
Indicates that the prior to date operations should apply to flagged messages.
NOTE: This Option is not meant to be used for prior operations on search results.Since:BlackBerry 10.0.0
Public Functions
Copy constructor.
This function constructs a MarkOrDeletePriorFilter containing exactly the same values as the provided MarkOrDeletePriorFilter.
| Parameters | |
|---|---|
| other |
The MarkOrDeletePriorFilter to be copied. |
BlackBerry 10.0.0
Destructor.
BlackBerry 10.0.0
MessageFolderKey
Gets the folder ID of the message folder where operation is to be performed MarkOrDeletePriorFilter applies to.
BlackBerry 10.0.0
int
Gets all the options set set in form of integer.
For example, if you want check what all options have been set(e.g. if OperateOnFiledMessages options has been), you should call this function and perform check of ((getOptions() & MarkOrDeletePriorFilter::OperateOnFiledMessages) != 0)
BlackBerry 10.0.0
QString
Gets the Date Time prior to which operation will be performed MarkOrDeletePriorFilter.
This function gets the dateTime prior to which an operation is to be performed This return a QString object expressed in yyyy-MM-dd hh:mm:ss.zzzzzz format (for example, 2012-07-25 23:59:59.999999).
BlackBerry 10.0.0
bool
Gets the priority inbox flag status for search MessageSearchFilter.
Return true if Priority Inbox Search flag was set to true earlier.
BlackBerry 10.2.0
MarkOrDeletePriorFilter &
Assignment operator.
This operator copies all values from the provided MarkOrDeletePriorFilter into this MarkOrDeletePriorFilter.
| Parameters | |
|---|---|
| other |
The MarkOrDeletePriorFilter from which to copy all values. |
A MarkOrDeletePriorFilter with all copied data.
BlackBerry 10.0.0
void
Sets the folder ID of the message folder where operation is to be performed MarkOrDeletePriorFilter applies to.
| Parameters | |
|---|---|
| folderId |
The folder where MarkPrior Or DeletePrior operation will be performed. |
BlackBerry 10.0.0
void
Adds a option Flags to this MarkOrDeletePriorFilter.
For example, if you want perform action excluding filed messages, you should call this function with a parameter of (getOptions() | MarkOrDeletePriorFilter::OperateOnFiledMessages) with parameter value
| Parameters | |
|---|---|
| value |
corresponding what all MarkOrDeletePriorFilter::Options are set |
BlackBerry 10.0.0
void
Sets the Date Time prior to which operation will be performed MarkOrDeletePriorFilter.
This function sets the dateTime prior to which an operation has to be performed this MarkOrDeletePriorFilter.
| Parameters | |
|---|---|
| dateTime |
The date and time representing upperbound time limit on the bulk delete action, expressed in yyyy-MM-dd hh:mm:ss.zzzzzz format (for example, 2012-07-25 23:59:59.999999). |
BlackBerry 10.0.0
void
Sets the priority inbox flag for search MessageSearchFilter.
| Parameters | |
|---|---|
| isPriorityInboxSearch |
Set to true if only priority inbox emails are to be operated on. |
BlackBerry 10.2.0