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.

This class lets you specify options and parameters for prior options, such as mark or delete. To use this class, you need to instantiate a MarkOrDeletePriorFilter object and set the priorDateTime and folderId. You can optionally set MarkOrDeletePriorFilter::OperateOnFiledMessages or MarkOrDeletePriorFilter::OperateOnSentMessages (these options are not required when specifying a folder ID for a folder operation). Once the object is created, you can pass it to the MessageService::markOrDeletePrior() method.


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.

OperateOnSentMessages = 1 << 1

Indicates that the prior to date operations should apply to flagged messages.

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

This method cleans up and frees data and resources for the MarkOrDeletePriorFilter.

Since:

BlackBerry 10.0.0

MessageFolderKey getFolderId ()

Gets the folder ID of the message folder that MarkOrDeletePriorFilter applies to.

Return:

The folder ID of the message folder that MarkOrDeletePriorFilter applies to.

Since:

BlackBerry 10.0.0

int getOptions ()

Gets all the options set for this MarkOrDeletePriorFilter.

This method returns the options set for this MarkOrDeletePriorFilter, as defined by MarkOrDeletePriorFilter::Options. For example, to check if OperateOnFiledMessages is set, call this method as follows:

if (getOptions() & MarkOrDeletePriorFilter::OperateOnFiledMessages) != 0
Return:

The options that are set, as defined by MarkOrDeletePriorFilter::Options.

Since:

BlackBerry 10.0.0

QString getPriorDateTime ()

Gets the prior date and time values.

This method gets the prior date and time values used by operations using MarkOrDeletePriorFilter.

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 for MessageSearchFilter.

Return:

True if only priority inbox messages are operated on, false otherwise.

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 that MarkOrDeletePriorFilter applies to.

Parameters
folderId

The folder where the MarkPrior Or DeletePrior operation is performed.

Since:

BlackBerry 10.0.0

void setOptions (
  • intvalue)

Adds option flags to this MarkOrDeletePriorFilter.

This method sets option flags for this MarkOrDeletePriorFilter. For example, if you want to exclude filed messages, call this method as follows:

setOptions(getOptions() | MarkOrDeletePriorFilter::OperateOnFiledMessages)
Parameters
value

The MarkOrDeletePriorFilter::Options to set.

Since:

BlackBerry 10.0.0

void setPriorDateTime (

Sets the prior date and time values.

This method sets the prior date and time values used by operations using MarkOrDeletePriorFilter.

Parameters
dateTime

The date and time representing the upperbound time limit on the bulk delete action. This is expressed in yyyy-MM-dd hh:mm:ss.zzzzzz format, for example, 2013-07-25 23:59:59.999999).

Since:

BlackBerry 10.0.0

void setPriorityInboxSearch (
  • bool)

Sets the priority inbox flag for MessageSearchFilter.

Parameters
isPriorityInboxSearch

True if only priority inbox messages are to be operated on, false otherwise.

Since:

BlackBerry 10.2.0

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus