ContactFolder

Since: BlackBerry 10.3.1

#include <bb/pim/contacts/ContactFolder>

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

The ContactFolder class represents a folder to store contacts.

You can use contact folders to organize contacts into logical groupings. To retrieve the list of contact folders in an account, you can call ContactService::folders().


Overview

Public Functions Index

ContactFolder ()
ContactFolder (const ContactFolder &other)
~ContactFolder ()
ContactFolderKeyid () const
QStringname () const
ContactFolder &operator= (const ContactFolder &other)
ContactFolderKeyparentId () const
boolsyncConfig () const

Public Functions

ContactFolder ()

Constructs a new ContactFolder.

Since:

BlackBerry 10.3.1

ContactFolder (

Copy constructor.

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

Parameters
other

The ContactFolder to be copied.

Since:

BlackBerry 10.3.1

~ContactFolder ()

Destructor.

Since:

BlackBerry 10.3.1

ContactFolderKey id ()

Retrieves the ID of this ContactFolder.

You can use this ID to access contacts within this contact folder.

Return:

The contact folder's ID.

Since:

BlackBerry 10.3.1

QString name ()

Retrieves the name of this ContactFolder.

Return:

The contact folder's name.

Since:

BlackBerry 10.3.1

ContactFolder & operator= (

Assignment operator.

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

Parameters
other

The ContactFolder from which to copy all values.

Return:

A ContactFolder with all copied data.

Since:

BlackBerry 10.3.1

ContactFolderKey parentId ()

Retrieves the ID of the parent folder of this ContactFolder.

You can use the parent folder ID to set up a tree view of contacts folders.

Return:

The contact folder's parent folder ID.

Since:

BlackBerry 10.3.1

bool syncConfig ()

Indicates the current sync configuration of this ContactFolder.

Return:

true if sync is enabled, false if sync is disabled.

Since:

BlackBerry 10.3.1

Last modified: 2015-01-22



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

comments powered by Disqus