Class CContactOwnCard

class CContactOwnCard : public CContactItemPlusGroup;

Description

Own card.

An own card is a contact card which contains information about the device's owner. This can be sent to another compatible electronic device as a vCard. The contact database recognises a single own card, referred to as the current own card; its ID is returned by CContactDatabase::OwnCardId(). Like a contact card, an own card can be a member of one or more contact card groups. The own card type is identified by a UID of KUidContactOwnCard.

Own cards can be constructed using either CContactDatabase::CreateOwnCardLC() or CreateOwnCardL(). These functions create an own card, based on the system template, add it to the database, set it as the database's current own card and return a pointer to it. To change the database's current own card, use CContactDatabase::SetOwnCardL().

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CContactItem - The abstract base class for contact cards, templates and groups

• CContactItemPlusGroup - Abstract base class for CContactGroup, CContactCard and CContactOwnCard

• CContactOwnCard - Own card

Members

Defined in CContactOwnCard:

• GroupsJoinedLC()Returns a pointer to a list of contact item IDs which identify the groups to which the current own card belongs
• NewL()Allocates and constructs a new own card
• NewL()Allocates and constructs a new own card whose field set is seeded from a template
• NewLC()Allocates and constructs a new own card
• NewLC()Allocates and constructs a new own card whose field set is seeded from a template
• Type()Implements CContactItem::Type()
• ~CContactOwnCard()Frees all resources owned by the own card, prior to its destruction

Inherited from CBase:

• Delete()Deletes the specified object
• Extension_()Extension function
• operator new()Initialises the object to binary zeroes

Inherited from CContactItem:

• AccessCount()Gets the contact item's access count
• AddFieldL()Appends a field to the contact item's field set
• CardFields()Gets a reference to the contact item's field set
• DecAccessCount()Decrements the contact item's access count
• ECompressedGuidTo set the contact item's hidden attribute
• EDeletedTo set the contact item's Is deleted attribute
• EHiddenTo set the contact item's hidden attribute
• ESystemTo set the contact item's system attribute
• Guid()Accessor function for Contact Guid
• Id()Gets the contact item's ID
• IncAccessCount()Increments the contact item's access count
• InsertFieldL()Inserts a field into the contact item's field set
• IsDeletable()Tests whether the contact item is deletable
• IsDeleted()Gets the value of the Is deleted attribute as set by SetDeleted()
• IsHidden()Gets the value of the contact item's hidden attribute
• IsSystem()Gets the value of the contact item's system attribute
• LastModified()Gets the contact item's last modified date/time
• RemoveField()Removes a field from the contact item's field set
• SetDeleted()Sets the value of the contact item's Is deleted attribute
• SetHidden()Sets the contact item's hidden attribute
• SetLastModified()Sets the last modified date/time value stored in the local copy of the contact item
• SetSystem()Sets the contact item's system attribute
• SetTemplateRefId()Sets the ID of the template on which this contact item is based
• SetUidStringL()Sets the item's UID string
• TemplateRefId()Gets the ID of the template which was used to create this contact item
• UidStringL()Returns a descriptor which contains the item's UID string
• UpdateFieldSet()Replaces the contact item's field set
• anonymousContact item's attribute flags

Inherited from CContactItemPlusGroup:

• ExternalizeL()Externalises a CContactItemPlusGroup object to a write stream
• GroupsJoined()Returns a pointer to a list of contact item IDs which identify the groups to which the derived class object belongs
• InternalizeL()Internalises a CContactItemPlusGroup object from a read stream

IMPORT_C ~CContactOwnCard();

Description

Frees all resources owned by the own card, prior to its destruction.

static IMPORT_C CContactOwnCard *NewL();

Description

Allocates and constructs a new own card.

Note: own cards should normally be constructed using the factory functions provided in class CContactDatabase, for example CreateOwnCardL().

Return value

CContactOwnCard * Pointer to the newly created own card.

static IMPORT_C CContactOwnCard *NewLC();

Description

Allocates and constructs a new own card.

Note: own cards should normally be constructed using the factory functions provided in class CContactDatabase, for example CreateOwnCardL().

Return value

CContactOwnCard * Pointer to the newly created own card. This is left on the cleanup stack.

static IMPORT_C CContactOwnCard *NewL(const CContactItem *aTemplate);

Description

Allocates and constructs a new own card whose field set is seeded from a template.

Note: own cards should normally be constructed using the factory functions provided in class CContactDatabase, for example CreateOwnCardL().

Parameters

const CContactItem *aTemplate Pointer to the template whose field set and field data are copied into the new own card.

Return value

CContactOwnCard * Pointer to the newly created own card.

static IMPORT_C CContactOwnCard *NewLC(const CContactItem *aTemplate);

Description

Allocates and constructs a new own card whose field set is seeded from a template.

Note: own cards should normally be constructed using the factory functions provided in class CContactDatabase, for example CreateOwnCardL().

Parameters

const CContactItem *aTemplate Pointer to the template whose field set and field data are copied into the new own card.

Return value

CContactOwnCard * Pointer to the newly created own card. This is left on the cleanup stack.

virtual IMPORT_C TUid Type() const;

Description

Implements CContactItem::Type().

Return value

TUid KUidContactOwnCard.

IMPORT_C CContactIdArray *GroupsJoinedLC() const;

Description

Returns a pointer to a list of contact item IDs which identify the groups to which the current own card belongs.

Return value

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