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 Options

OperateOnFiledMessages = 1 << 0, OperateOnSentMessages = 1 << 1

Public Functions Index

MarkOrDeletePriorFilter ()
MarkOrDeletePriorFilter (const MarkOrDeletePriorFilter &other)
~MarkOrDeletePriorFilter ()
MessageFolderKeygetFolderId () const
intgetOptions () const
QStringgetPriorDateTime () const
boolisPriorityInboxSearch () const
MarkOrDeletePriorFilter &operator= (const MarkOrDeletePriorFilter &other)
voidsetFolderId (MessageFolderKey folderId)
voidsetOptions (int value)
voidsetPriorDateTime (QDateTime &dateTime)
voidsetPriorityInboxSearch (bool)

Public Types

Options

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

MarkOrDeletePriorFilter ()

Constructs a new MarkOrDeletePriorFilter.

Since:

BlackBerry 10.0.0

MarkOrDeletePriorFilter (

Copy constructor.

This function constructs a MarkOrDeletePriorFilter containing exactly the same values as the provided MarkOrDeletePriorFilter.

Parameters
other

The MarkOrDeletePriorFilter to be copied.

Since:

BlackBerry 10.0.0

~MarkOrDeletePriorFilter ()

Destructor.

Since:

BlackBerry 10.0.0

MessageFolderKey getFolderId ()

Gets the folder ID of the message folder where operation is to be performed MarkOrDeletePriorFilter applies to.

Since:

BlackBerry 10.0.0

int getOptions ()

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)

Since:

BlackBerry 10.0.0

QString getPriorDateTime ()

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).

Since:

BlackBerry 10.0.0

bool isPriorityInboxSearch ()

Gets the priority inbox flag status for search MessageSearchFilter.

Return:

Return true if Priority Inbox Search flag was set to true earlier.

Since:

BlackBerry 10.2.0

MarkOrDeletePriorFilter & operator= (

Assignment operator.

This operator copies all values from the provided MarkOrDeletePriorFilter into this MarkOrDeletePriorFilter.

Parameters
other

The MarkOrDeletePriorFilter from which to copy all values.

Return:

A MarkOrDeletePriorFilter with all copied data.

Since:

BlackBerry 10.0.0

void setFolderId (
  • MessageFolderKeyfolderId)

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.

Since:

BlackBerry 10.0.0

void setOptions (
  • intvalue)

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

Since:

BlackBerry 10.0.0

void setPriorDateTime (

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).

Since:

BlackBerry 10.0.0

void setPriorityInboxSearch (
  • bool)

Sets the priority inbox flag for search MessageSearchFilter.

Parameters
isPriorityInboxSearch

Set to true if only priority inbox emails are to be operated on.

Since:

BlackBerry 10.2.0

Last modified: 2014-03-13

comments powered by Disqus