ContactGroup

Since: BlackBerry 10.3.0

#include <bb/pim/contacts/ContactGroup>

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

The ContactGroup class represents a group contact which can contain a number of individual contacts as members.

A contact group is a way of associating a number of contacts together to facilitate browsing and group communication. A Contact can be added as a member of the group using ContactService::addContactToGroup. All available contact groups can be retrieved using ContactService::groups. The addresses to use when communicating with a contact through a group can be specified using ContactService::updateGroupMembership.


Overview

Public Functions Index

ContactGroup ()
ContactGroup (const ContactGroup &contactGroup)
~ContactGroup ()
GroupIdid () const
boolisFavourite () const
QStringname () const
ContactGroup &operator= (const ContactGroup &contactGroup)

Public Functions

ContactGroup ()

Constructs an empty ContactGroup.

Since:

BlackBerry 10.3.0

ContactGroup (

Copy constructor.

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

Parameters
contactGroup

The ContactGroup to be copied.

Since:

BlackBerry 10.3.0

~ContactGroup ()

Destructor.

Since:

BlackBerry 10.3.0

GroupId id ()

Retrieves the ID of this ContactGroup.

You can use this value to interact with this ContactGroup and perform different operations using the ContactService, such as retrieving the contact group details. The ID is assigned automatically when the contact group is added to the database using the ContactService, and you can't change the ID after it's been assigned.

Return:

The ID of this ContactGroup.

Since:

BlackBerry 10.3.0

bool isFavourite ()

Indicates whether this ContactGroup is a favorite.

If this ContactGroup is a favorite, this function returns true. Favorite contacts are displayed in the favorites grid in the Contacts application.

Return:

true if this ContactGroup is a favorite, false otherwise.

Since:

BlackBerry 10.3.0

QString name ()

Retrieves the name of this ContactGroup.

Return:

name The name of this ContactGroup.

See also:

ContactService

Since:

BlackBerry 10.3.0

ContactGroup & operator= (

Assignment operator.

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

Parameters
contact

The ContactGroup from which to copy all values.

Return:

A ContactGroup with all copied data

Since:

BlackBerry 10.3.0

Last modified: 2014-11-17



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

comments powered by Disqus