FolderKey

Since: BlackBerry 10.0.0

#include <bb/pim/calendar/FolderKey>

To link against this class, add the following line to your .pro file: LIBS += -lbbpim

The FolderKey class represents a database key for calendar folders.

This class includes attributes (such as folder ID and account ID) that uniquely identify a folder in the calendar database.

FolderKey objects are used by the EventSearchParameters class, which itself is used when you want to search for specific events in the calendar database. When you call EventSearchParameters::folders(), a list of FolderKey objects is returned. Each object represents a particular folder to search in. You can call EventSearchParameters::addFolder() or EventSearchParameters::setFolders() to add or set folders to search in.


Overview

Public Functions Index

FolderKey ()
FolderKey (const FolderKey &other)
~FolderKey ()
AccountIdaccountId () const
FolderIdfolderId () const
boolisValid () const
FolderKey &operator= (const FolderKey &other)
voidsetAccountId (AccountId accountId)
voidsetFolderId (FolderId folderId)

Public Functions

FolderKey ()

Constructs a new FolderKey.

Since:

BlackBerry 10.0.0

FolderKey (

Copy constructor.

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

Parameters
other

The FolderKey to be copied.

Since:

BlackBerry 10.0.0

~FolderKey ()

Destructor.

Since:

BlackBerry 10.0.0

AccountId accountId ()

Retrieves the account ID of this FolderKey.

This function returns the identifier of the account that's associated with this FolderKey in the database.

Return:

The accont ID of this FolderKey.

Since:

BlackBerry 10.0.0

FolderId folderId ()

Retrieves the folder ID of this FolderKey.

This function returns the identifier of the folder that's associated with this FolderKey.

Return:

The folder ID of this FolderKey.

Since:

BlackBerry 10.0.0

bool isValid ()

Indicates whether this FolderKey is valid.

This function determines whether the attributes of this FolderKey object have acceptable values.

Return:

true if this FolderKey is valid, false otherwise.

Since:

BlackBerry 10.0.0

FolderKey & operator= (

Assignment operator.

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

Parameters
other

The FolderKey from which to copy all values.

Return:

A reference to this FolderKey.

Since:

BlackBerry 10.0.0

void setAccountId (
  • AccountIdaccountId)

Sets the account ID of this FolderKey.

Parameters
accountId

The new account ID.

Since:

BlackBerry 10.0.0

void setFolderId (
  • FolderIdfolderId)

Sets the folder ID of this FolderKey.

Parameters
folderId

The new folder ID.

Since:

BlackBerry 10.0.0

Last modified: 2014-09-30



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

comments powered by Disqus