Class CContactGroup

CContactGroup

Support

Supported from 6.0

Description

A contact group.

A contact group is a contact item which holds a set of associated contact item IDs. The members of the group may be contact cards, own cards, or even other groups. The group has a label which identifies the group to users, e.g. "family", or "colleagues". The type of a contact group is KUidContactGroup, as returned by Type().

Objects of this class are constructed using CContactDatabase::CreateContactGroupL() or CreateContactGroupLC(). These functions create the group, optionally with a label, add it to the database, and return a pointer to it.

To create an association between a card and a group, use CContactDatabase::AddContactToGroupL() and to remove the association, use RemoveContactFromGroupL(). To find out which groups a card belongs to, use CContactCard::GroupsJoinedLC() or CContactOwnCard::GroupsJoinedLC().

The function CContactDatabase::GetGroupIdListL() may be used to retrieve a list of IDs for all groups in the database.

Derivation

CBase Base class for all classes to be instantiated on the heap CContactGroup A contact group CContactItem The abstract base class for contact cards, templates and groups CContactItemPlusGroup Abstract base class for CContactGroup, CContactCard and CContactOwnCard

Defined in CContactGroup:
ContainsItem(), GetGroupLabelL(), GroupsJoinedLC(), HasItemLabelField(), IsSystem(), ItemsContained(), ItemsContainedLC(), NewL(), NewLC(), SetGroupLabelL(), SetSystem(), Type(), ~CContactGroup()

Inherited from CBase:
operator new()

Inherited from CContactItem:
AccessCount(), AddFieldL(), CardFields(), DecAccessCount(), Id(), IncAccessCount(), InsertFieldL(), IsDeletable(), IsDeleted(), IsHidden(), LastModified(), RemoveField(), SetDeleteFlag(), SetDeleted(), SetHidden(), SetLastModified(), SetTemplateRefId(), SetUidStringL(), TemplateRefId(), UidStringL(), UpdateFieldSet()

Inherited from CContactItemPlusGroup:
GroupsJoined()

static CContactGroup* NewL();

Description

Allocates and constructs a new contact card group. The group has no label and its list of members is NULL.

Return value

CContactGroup* Pointer to the new contact card group.

Notes:

• Contact groups should be constructed using the factory functions provided in class CContactDatabase, for example CreateContactGroupL().

static CContactGroup* NewLC();

Description

Allocates and constructs a new contact card group, leaving a pointer to the object on the cleanup stack. The group has no label and its list of members is NULL.

Return value

CContactGroup* Pointer to the new contact card group.

Notes:

• Contact groups should be constructed using the factory functions provided in class CContactDatabase, for example CreateContactGroupLC().

~CContactGroup();

Description

The destructor frees all resources owned by the contact group, prior to its destruction.

TUid Type() const;

Description

Implements the pure virtual function inherited from the base class CContactItem. Returns KUidContactGroup.

Return value

TUid KUidContactGroup.

CContactIdArray* ItemsContainedLC() const;

Description

Returns a pointer to a copy of the group's list of members.

Return value

CContactIdArray* Pointer to a copy of the group's list of members. This is left on the cleanup stack.

const CContactIdArray* ItemsContained() const;

Description

Returns a constant pointer to the group's list of members.

Return value

CContactIdArray* Pointer to the group's list of members.

TBool ContainsItem(TContactItemId aContactId);

Description

Tests whether a contact item is a member of the group.

Parameters

TContactItemId aContactId The ID of the contact item to test.

Return value

TBool ETrue if the item is a member of the group, EFalse if not.

CContactIdArray* GroupsJoinedLC() const;

Description

Returns a pointer to a list of contact groups to which the current group belongs (a contact group can belong to other groups).

Return value

CContactIdArray* A pointer to a copy of the array of groups IDs to which this group belongs. This array is empty if the group is not a member of any other groups. The caller takes ownership of this object, so is responsible for its deletion.

TBool IsSystem() const;

Description

Tests the value of the group's system attribute. Note that the system attribute is not currently used in the Contacts Model API.

Return value

TBool ETrue if system, EFalse if not.

void SetSystem(TBool aSystem);

Description

Sets the group's system attribute. Note that the system attribute is not currently used in the Contacts Model API.

Parameters

TBool aSystem ETrue to set the system attribute, EFalse to unset it.

void SetGroupLabelL(const TDesC& aLabel);

Description

Sets the group label. Any existing label is replaced.

Parameters

const TDesC& aLabel The new group label.

Leave codes

KErrNotFound The group has no field of type KUidContactFieldTemplateLabel.

TPtrC GetGroupLabelL();

Description

Gets the group label.

Return value

TPtrC The new group label.

Leave codes

KErrNotFound The group has no field of type KUidContactFieldTemplateLabel.

TBool HasItemLabelField();

Description

Tests whether the group has a label field (of type KUidContactFieldTemplateLabel).

Return value

TBool ETrue if the group has a label field. EFalse if not.