CContactOwnCard Class Reference

#include <app/cntitem.h>

class CContactOwnCard : public CContactItemPlusGroup, public CContactItemPlusGroup
Public Member Functions
~CContactOwnCard()
IMPORT_C CContactIdArray *GroupsJoinedLC()
IMPORT_C CContactOwnCard *NewL()
IMPORT_C CContactOwnCard *NewL(const CContactItem *)
IMPORT_C CContactOwnCard *NewLC()
IMPORT_C CContactOwnCard *NewLC(const CContactItem *)
virtual IMPORT_C TUidType()
Inherited Enumerations
CContactItem:@19
CContactItem:@3
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CContactItem::AccessCount()const
CContactItem::AddFieldL(CContactItemField &)
CContactItem::AddLabelFieldL()
CContactItem::Agent()
CContactItem::Attributes()const
CContactItem::CardFields()const
CContactItem::ClearFieldContent()
CContactItem::DecAccessCount()
CContactItem::Guid()
CContactItem::Id()const
CContactItem::IncAccessCount()
CContactItem::InsertFieldL(CContactItemField &,TInt)
CContactItem::IsDeletable()
CContactItem::IsDeleted()const
CContactItem::IsHidden()
CContactItem::IsSystem()
CContactItem::LastModified()const
CContactItem::NewLC(RReadStream &)
CContactItem::NewLC(TUid)
CContactItem::PopulateStoreL(CStreamStore &,CArrayFix< TFieldHeader > &)const
CContactItem::RemoveField(TInt)
CContactItem::RestoreTemplateFieldsL(const CContactItemFieldSet &,const CContactItemFieldSet &,const CContactItemViewDef &)
CContactItem::SetAccessCount(TUint32)
CContactItem::SetAttributes(TUint32)
CContactItem::SetCreationDate(const TTime &)
CContactItem::SetDeleted(TBool)
CContactItem::SetHidden(TBool)
CContactItem::SetId(TContactItemId)
CContactItem::SetLastModified(const TTime &)
CContactItem::SetSystem(TBool)
CContactItem::SetTemplateRefId(TContactItemId)
CContactItem::SetUidStringL(TDesC &)
CContactItem::TemplateRefId()const
CContactItem::UidStringL(TInt64)const
CContactItem::UpdateFieldSet(CContactItemFieldSet *)
CContactItem::~CContactItem()
CContactItemPlusGroup::CContactItemPlusGroup()
CContactItemPlusGroup::ExternalizeL(RWriteStream &)const
CContactItemPlusGroup::GroupsJoined()const
CContactItemPlusGroup::InternalizeL(RReadStream &)
CContactItemPlusGroup::ResetGroups()
CContactItemPlusGroup::SetGroups(CContactIdArray *)
CContactItemPlusGroup::~CContactItemPlusGroup()

Detailed 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().

Constructor & Destructor Documentation

~CContactOwnCard ( )

IMPORT_C~CContactOwnCard()

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

Member Function Documentation

GroupsJoinedLC ( )

IMPORT_C CContactIdArray *GroupsJoinedLC()const

Reimplemented from CContactItemPlusGroup::GroupsJoinedLC()const

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

Return Value
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.

NewL ( )

IMPORT_C CContactOwnCard *NewL()[static]

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
Pointer to the newly created own card.

NewL ( const CContactItem * )

IMPORT_C CContactOwnCard *NewL(const CContactItem *aTemplate)[static]

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
aTemplatePointer to the template whose field set and field data are copied into the new own card.
Return Value
Pointer to the newly created own card.

NewLC ( )

IMPORT_C CContactOwnCard *NewLC()[static]

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
Pointer to the newly created own card. This is left on the cleanup stack.

NewLC ( const CContactItem * )

IMPORT_C CContactOwnCard *NewLC(const CContactItem *aTemplate)[static]

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
aTemplatePointer to the template whose field set and field data are copied into the new own card.
Return Value
Pointer to the newly created own card. This is left on the cleanup stack.

Type ( )

IMPORT_C TUidType()const [virtual]

Reimplemented from CContactItem::Type()const

Implements CContactItem::Type().

Return Value
KUidContactOwnCard.