CContactDatabase Class Reference

class CContactDatabase : public CBase

A database of contact items.

Contact items can be added to and removed from the database and items in the database can be opened or read. To edit an item, it must first be opened. Changes to the item can then be committed using CommitContactL() (committing can only take place to an open item).

If the available disk space is less than 128 kilobytes then changes to the contact database cannot be started, and methods such as CreateL() or CommitContactL() will leave with a KErrDiskFull error. Less obviously OpenL() can also fail with KErrDiskFull when trying to update the system template.

Each item has an access count. An item cannot be fully deleted unless its access count is zero. This is to prevent items which have been synchronised with another contacts application from being deleted. Also, if the item is a template, it cannot be deleted if other items are based on it.

More than one contact database can exist on a phone, but there is a default contact database. Its filename is contacts.cdb. It can be moved between drives.

CContactDatabase implements searching and sorting and also provides separate phone number matching functions. These provide a fast way of indexing and looking up phone numbers, e.g. for looking up caller IDs on incoming calls.

The database owns speed dial information. This is a mapping between a single digit integer and a telephone number. There may be up to 9 speed dial telephone numbers; each of them belongs to a contact item in the database. If a contact item is deleted, its speed dial mapping is removed.

The following functions defined in class CContactDatabase are not supported. If called, they leave with KErrNotSupported.

  • ReplacePrefL()

  • ReadPrefL()

  • CreatePrefL()

Inherits from

Nested Classes and Structures

Public Member Functions
~CContactDatabase()
IMPORT_C voidAddContactToGroupL(TContactItemId, TContactItemId)
IMPORT_C voidAddContactToGroupL(CContactItem &, CContactItem &)
IMPORT_C voidAddContactToGroupL(TContactItemId, TContactItemId, TBool)
IMPORT_C TContactItemIdAddNewContactL(CContactItem &)
voidAddObserverL(MContactDbObserver &)
IMPORT_C CContactItemViewDef *AllFieldsView()
IMPORT_C voidCancelAsyncSort()
voidCancelNotifyRequestL()
voidCleanupLastLockedContact(TAny *)
voidCleanupTableCancel(TAny *)
IMPORT_C voidCloseContactL(TContactItemId)
IMPORT_C voidCloseTables()
IMPORT_C TIntCntServerResourceCount()
IMPORT_C voidCommitContactL(const CContactItem &)
IMPORT_C voidCompactL()
IMPORT_C TBoolCompressRequired()
IMPORT_C TUintConnectionId()
IMPORT_C TBoolContactDatabaseExistsL(const TDesC &)
IMPORT_C TContactItemIdContactIdByGuidL(const TDesC &)
IMPORT_C TBoolContactMatchesHintFieldL(TInt, TContactItemId)
IMPORT_C CContactIdArray *ContactsChangedSinceL(const TTime &)
IMPORT_C TIntCountL()
IMPORT_C CContactActiveCompress *CreateCompressorLC()
IMPORT_C CContactItem *CreateContactCardTemplateL(const TDesC &, TBool)
IMPORT_C CContactItem *CreateContactCardTemplateL(const CContactItem *, const TDesC &, TBool)
IMPORT_C CContactItem *CreateContactCardTemplateLC(const TDesC &, TBool)
IMPORT_C CContactItem *CreateContactCardTemplateLC(const CContactItem *, const TDesC &, TBool)
IMPORT_C CContactItem *CreateContactGroupL(TBool)
IMPORT_C CContactItem *CreateContactGroupL(const TDesC &, TBool)
IMPORT_C CContactItem *CreateContactGroupLC(TBool)
IMPORT_C CContactItem *CreateContactGroupLC(const TDesC &, TBool)
IMPORT_C CContactDatabase *CreateL(TThreadAccess)
IMPORT_C CContactDatabase *CreateL(const TDesC &, TThreadAccess)
IMPORT_C CContactItem *CreateOwnCardL()
IMPORT_C CContactItem *CreateOwnCardLC()
IMPORT_C CContactActiveRecover *CreateRecoverLC()
IMPORT_C voidDamageDatabaseL(TInt)
IMPORT_C voidDatabaseBeginL(TBool)
IMPORT_C voidDatabaseBeginLC(TBool)
IMPORT_C voidDatabaseCommitL(TBool)
IMPORT_C voidDatabaseCommitLP(TBool)
IMPORT_C TBoolDatabaseDrive(TDriveUnit &)
IMPORT_C voidDatabaseRollback()
IMPORT_C TBoolDefaultContactDatabaseExistsL()
IMPORT_C voidDeleteContactL(TContactItemId)
IMPORT_C voidDeleteContactsL(const CContactIdArray &)
IMPORT_C voidDeleteDatabaseL(const TDesC &)
IMPORT_C voidDeleteDefaultFileL()
IMPORT_C CContactIdArray *DeletedContactsLC()
IMPORT_C voidExportSelectedContactsL(const TUid &, const CContactIdArray &, RWriteStream &, TInt, TBool)
IMPORT_C voidExportSelectedContactsL(const TUid &, const CContactIdArray &, RWriteStream &, TInt, const Versit::TVersitCharSet, TBool)
IMPORT_C voidExportSelectedContactsL(const TUid &, const CContactIdArray &, RWriteStream &, TInt, const TInt64, MConverterCallBack *, const TVCardVersion, const TBool, Versit::TVersitCharSet, TBool)
IMPORT_C TIntFileSize()
IMPORT_C TPtrCFileUid()
IMPORT_C voidFilterDatabaseL(CCntFilter &)
IMPORT_C CIdleFinder *FindAsyncL(const TDesC &, const CContactItemFieldDef *, MIdleFindObserver *)
IMPORT_C CIdleFinder *FindInTextDefAsyncL(const MDesCArray &, MIdleFindObserver *, const TCallBack &)
IMPORT_C CIdleFinder *FindInTextDefAsyncL(const MDesCArray &, const CContactTextDef *, MIdleFindObserver *, const TCallBack &)
IMPORT_C CContactIdArray *FindInTextDefLC(const MDesCArray &, const TCallBack &)
IMPORT_C CContactIdArray *FindInTextDefLC(const MDesCArray &, CContactTextDef *, const TCallBack &)
IMPORT_C CContactIdArray *FindLC(const TDesC &, const CContactItemFieldDef *)
IMPORT_C CContactIdArray *GetCardTemplateIdListL()
IMPORT_C TIntGetCurrentDatabase(TDes &)
IMPORT_C TContactItemIdGetCurrentItem()
IMPORT_C TUidGetDbViewContactType()
IMPORT_C voidGetDefaultNameL(TDes &)
IMPORT_C CContactIdArray *GetGroupIdListL()
IMPORT_C voidGetLastSyncDateL(TContactSyncId, TTime &)
IMPORT_C TContactItemIdGetSpeedDialFieldL(TInt, TDes &)
TInt GroupCount()
voidHandleDatabaseEventL(RDbNotifier::TEvent)
IMPORT_C voidHandleDatabaseEventL(const TContactDbObserverEvent &)
voidHandleDiskSpaceEvent(TInt)
IMPORT_C TContactItemIdICCTemplateIdL()
IMPORT_C TContactItemIdICCTemplateIdL(TUid)
IMPORT_C CArrayPtr< CContactItem > *ImportContactsL(const TUid &, RReadStream &, TBool &, TInt)
IMPORT_C TBoolIsDamaged()
TBool IsICCSynchronisedL()
IMPORT_C CDesCArray *ListDatabasesL()
IMPORT_C CDesCArray *ListDatabasesL(TDriveUnit)
IMPORT_C TIntLockServerCallBackL(TUint)
IMPORT_C voidLockServerCleanup()
IMPORT_C CContactDatabase *LockServerConnectL(const TDesC &)
IMPORT_C CContactDatabase *LockServerConnectL(const TDesC &, TInt)
IMPORT_C TInt64MachineId()
IMPORT_C CContactIdArray *MatchPhoneNumberL(const TDesC &, TInt)
TInt NullUidValue()
IMPORT_C CContactOpenOperation *Open(TRequestStatus &, TThreadAccess)
IMPORT_C CContactOpenOperation *Open(const TDesC &, TRequestStatus &, TThreadAccess)
IMPORT_C CContactItem *OpenContactL(TContactItemId)
IMPORT_C CContactItem *OpenContactL(TContactItemId, const CContactItemViewDef &)
IMPORT_C CContactItem *OpenContactLX(TContactItemId)
IMPORT_C CContactItem *OpenContactLX(TContactItemId, const CContactItemViewDef &)
voidOpenDatabaseAsyncL(TRequestStatus &, const TDesC &)
IMPORT_C CContactDatabase *OpenL(TThreadAccess)
IMPORT_C CContactDatabase *OpenL(const TDesC &, TThreadAccess)
IMPORT_C voidOpenTablesL()
IMPORT_C voidOverrideMachineUniqueId(TInt64)
IMPORT_C TContactItemIdOwnCardId()
IMPORT_C TContactItemIdPhonebookGroupIdL()
IMPORT_C TContactItemIdPrefTemplateId()
IMPORT_C CArrayPtr< CContactItem > *ReadContactAndAgentL(TContactItemId)
IMPORT_C CContactItem *ReadContactL(TContactItemId)
IMPORT_C CContactItem *ReadContactL(TContactItemId, const CContactItemViewDef &)
IMPORT_C CContactItem *ReadContactLC(TContactItemId)
IMPORT_C CContactItem *ReadContactLC(TContactItemId, const CContactItemViewDef &)
IMPORT_C voidReadContactTextDefL(const CContactItem &, TDes &)
IMPORT_C voidReadContactTextDefL(const CContactItem &, TDes &, CContactTextDef *)
IMPORT_C voidReadContactTextDefL(TContactItemId, TDes &)
IMPORT_C voidReadContactTextDefL(TContactItemId, TDes &, CContactTextDef *)
IMPORT_C CContactItem *ReadMinimalContactL(TContactItemId)
IMPORT_C CContactItem *ReadMinimalContactLC(TContactItemId)
IMPORT_C voidRecoverL()
IMPORT_C voidRecreateSystemTemplateL(const TDesC &)
IMPORT_C voidRemoveContactFromGroupL(CContactItem &, CContactItem &)
IMPORT_C voidRemoveContactFromGroupL(TContactItemId, TContactItemId)
voidRemoveObserver(const MContactDbObserver &)
IMPORT_C voidRemoveSpeedDialFieldL(TContactItemId, TInt)
IMPORT_C CContactDatabase *ReplaceL(TThreadAccess)
IMPORT_C CContactDatabase *ReplaceL(const TDesC &, TThreadAccess)
IMPORT_C voidResetServerSpeedDialsL()
IMPORT_C voidRestoreSortOrderL()
IMPORT_C voidSetCntServerHeapFailure(TInt, TInt)
IMPORT_C TIntSetCurrentDatabase(const TDesC &)
IMPORT_C voidSetCurrentItem(const TContactItemId)
IMPORT_C voidSetDatabaseDriveL(TDriveUnit, TBool)
IMPORT_C voidSetDateFormatTextL(const TDesC &)
voidSetDbConnectionState(TDbConnState)
IMPORT_C voidSetDbViewContactType(const TUid)
IMPORT_C voidSetFieldAsSpeedDialL(CContactItem &, TInt, TInt)
IMPORT_C TContactSyncIdSetLastSyncDateL(const TTime &)
IMPORT_C voidSetLastSyncDateL(TContactSyncId, const TTime &)
IMPORT_C voidSetOperationTimeOutL(const TInt)
IMPORT_C voidSetOwnCardL(const CContactItem &)
IMPORT_C voidSetPrefTemplateL(const CContactItem &)
IMPORT_C voidSetSortedItemsList(CContactIdArray *, CArrayFix< TSortPref > *)
IMPORT_C voidSetTextDefinitionL(CContactTextDef *)
IMPORT_C voidSetViewDefinitionL(CContactViewDef *)
IMPORT_C CContactIdArray *SortArrayL(const CContactIdArray *, const CArrayFix< TSortPref > *)
IMPORT_C CContactIdArray *SortArrayLC(const CContactIdArray *, const CArrayFix< TSortPref > *)
IMPORT_C voidSortAsyncL(CArrayFix< TSortPref > *, TRequestStatus &)
IMPORT_C voidSortAsyncL(CArrayFix< TSortPref > *, TRequestStatus &, MContactSortObserver &)
IMPORT_C voidSortByTypeL(CArrayFix< TSortPref > *)
IMPORT_C voidSortL(CArrayFix< TSortPref > *)
IMPORT_C const CArrayFix< TSortPref > *SortOrder()
IMPORT_C const CContactIdArray *SortedItemsL()
TUid SpeedDialFieldUidFromSpeedDialPosition(TInt)
IMPORT_C voidStoreSortOrderL()
IMPORT_C const CContentType &TemplateContentType(const CContactItemField &)
TInt TemplateCount()
IMPORT_C TContactItemIdTemplateId()
IMPORT_C const CContactTextDef *TextDefinition()
IMPORT_C CContactIdArray *UnfiledContactsL()
IMPORT_C CContactItem *UpdateContactLC(TContactItemId, CContactItem *)
IMPORT_C TVersionVersion()
IMPORT_C TIntWastedSpaceInBytes()
IMPORT_C TContactItemIddoAddNewContactL(CContactItem &, TBool, TBool)
IMPORT_C voiddoCommitContactL(const CContactItem &, TBool, TBool)
IMPORT_C voiddoDeleteContactL(TContactItemId, TBool, TBool, TBool)
Private Member Functions
CContactDatabase()
voidAddCntToOpenedGroupL(TContactItemId, CContactItem &)
TBool AddContactToSortListL(TContactItemId, TContactItemId &, CBase *, TUid &, TBool)
voidAddToTemplateListL(const TContactItemId)
voidCheckDbConnForReadL()
voidCheckDbConnForRecoverL()
voidCheckDbConnForWriteL()
TBool CheckSortError(TInt)
voidCheckTemplateField(CContactItem &)
TBool CheckType(TUid)
voidCleanupDatabaseRollback(TAny *)
TInt CompareSortFieldsL(const CContactItem &)
voidConstructL()
voidConstructTableUsageFlagsFromSortOrderL(TInt &)
TInt ContactPosL(TContactItemId)
CContactConverter &ConverterL(const TUid &)
CContactConverter &ConverterL(const TUid &, const TInt64, MConverterCallBack *, const TVCardVersion, const TBool)
voidCreateViewDefL()
TBool DatabaseReadyL()
voidDeleteContactSendEventActionL(TContactItemId, TCntSendEventAction)
TInt DoGotoL(TContactItemId)
voidDoReadContactTextDefL(const CContactItemFieldSet *, TDes &, CContactTextDef *)
voidEndAsyncActivityL()
MLplPersistenceLayerFactory *FactoryL()
voidFetchGroupAndTemplateListsL()
voidHandleDbObserverEventGroupDeletedL(const TContactItemId)
voidHandleDbObserverEventGroupOrContactAddedL(const TContactDbObserverEventType, const TContactItemId)
voidHandleDbObserverEventGroupOrContactChangedL(const TContactItemId)
voidInsertInSortArray(const CContactItem &)
voidInsertInSortArrayL(const CContactItem &)
voidLoadSyncPluginL()
voidMoveInSortArray(const CContactItem &)
voidMoveInSortArrayL(const CContactItem &)
CContactDatabase *NewLC()
TInt NewSortIndexL(const CContactItem &, TInt, TInt)
TInt NextExistingL(TInt)
CContactItem *OpenNoMergeLCX(TContactItemId)
TInt PreviousExistingL(TInt)
voidReSortL(CArrayFix< TSortPref > *)
voidReadTemplateIdsL()
voidRemoveFromGroupIds(const TContactItemId)
voidRemoveFromSortArray(TContactItemId)
voidRemoveFromTemplateList(const TContactItemId)
voidRespondToEventL(const TContactDbObserverEventType, const TContactItemId)
voidSortDuplicatesL(const CArrayFix< TSortPref > &, CSortArray &, TInt)
voidSortDuplicatesL(const CArrayFix< TSortPref > &, CSortArray &, TInt, TInt, TInt)
CContactIdArray *SortLC(const CArrayFix< TSortPref > *, const CContactIdArray *)
voidStartAsyncActivityL()
TBool SystemTemplateFieldsValid(const CContactItem &)
voidValidateDatabaseNameL(const TParse &)
CContactItem *doCreateContactGroupLC(const TDesC &)
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()
Public Member Enumerations
enumTContactViewFilter {
EUnfiltered = 0x00000000, EMailable = 0x00000001, ESmsable = 0x00000002, ELandLine = 0x00000004, EFaxable = 0x00000008, EPhonable = 0x00000010, EWork = 0x00000020, EHome = 0x00000040, ERingTone = 0x00000080, EVoiceDial = 0x00000100, EIMAddress = 0x00000200, EWirelessVillage = 0x00000400, ECustomFilter1 = 0x00000800, ECustomFilter2 = 0x00001000, ECustomFilter3 = 0x00002000, ECustomFilter4 = 0x00004000
}
enumTDbConnState {
EDbConnectionOpen = 0, EDbConnectionNotReady, EDbConnectionFailed, EDbConnectionRecoverRequired, EDbConnectionWriteLockedForBackup, EDbConnectionClosedForRestore, EDbConnectionNeedToCloseForRestore
}
enumTDirection { EAsc, EDesc }
enumTOptions {
EDefault = 0x0000, EIncludeX = 0x0001, ETTFormat = 0x0002, EExcludeUid = 0x0004, EDecreaseAccessCount = 0x0008, EImportSingleContact = 0x0010, EIncreaseAccessCount = 0x0020, ELocalTime = 0x0040, ENullTemplateId = 0x0080, EConverterDefined1 = 0x0100, EConverterDefined2 = 0x0200, EConverterDefined3 = 0x0400, EConverterDefined4 = 0x0800, EConverterDefined5 = 0x1000, EConverterDefined6 = 0x2000, EConverterDefined7 = 0x4000, EConverterDefined8 = 0x8000, EConverterReserved1 = 0x00010000, EConverterReserved2 = 0x00020000, EConverterReserved3 = 0x00040000, EConverterReserved4 = 0x00080000, EConverterReserved5 = 0x00100000, EConverterReserved6 = 0x00200000, EConverterReserved7 = 0x00400000, EConverterReserved8 = 0x00800000, EConverterReserved9 = 0x01000000, EConverterReserved10 = 0x02000000, EConverterReserved11 = 0x04000000, EConverterReserved12 = 0x08000000, EConverterReserved13 = 0x10000000, EConverterReserved14 = 0x20000000, EConverterReserved15 = 0x40000000, EConverterReserved16 = 0x80000000
}
enumTSortDataSource { ENoOrder, EUsesIdentityTableOnly, EUsesAllTables, EIdentityTableNotUsed }
enumTThreadAccess { ESingleThread, EMultiThread }
Private Member Enumerations
enumTSvrSessionType { ESvrSessionPersistent, ESvrSessionTemporary, ESvrSessionFromLockServer }
Public Member Type Definitions
typedef TBuf< KTextFieldMinimalLength > TTextFieldMinimal
Private Attributes
CContactItemViewDef *iAllFieldsView
TInt iAsyncActivityCount
CContactIdArray *iCardTemplateIds
RCntModel *iCntSvr
TCollationMethod iCollateMethod
CContactSynchroniser *iContactSynchroniser
CPrivConverter *iConv
CDataBaseChangeObserver *iDataBaseObserver
TDbConnState iDbConnectionState
TUid iDbViewContactType
CContactIdArray *iGroupIds
CCntIdleSorter *iIdleSorter
CProxyFactory *iProxyFactory
CArrayFix< TSortPref > *iSortOrder
CContactIdArray *iSortedItems
TTime iSyncDate
TBool iTablesOpen
CCntTemplateCache *iTemplateCache
CContactTextDef *iTextDef
CContactViewDef *iView

Constructor & Destructor Documentation

CContactDatabase()

CContactDatabase()[private]

~CContactDatabase()

IMPORT_C~CContactDatabase()

Member Functions Documentation

AddCntToOpenedGroupL(TContactItemId, CContactItem &)

voidAddCntToOpenedGroupL(TContactItemIdaItemId,
CContactItem &aGroup
)[private]

Parameters

TContactItemId aItemId
CContactItem & aGroup

AddContactToGroupL(TContactItemId, TContactItemId)

IMPORT_C voidAddContactToGroupL(TContactItemIdaItemId,
TContactItemIdaGroupId
)

Parameters

TContactItemId aItemId
TContactItemId aGroupId

AddContactToGroupL(CContactItem &, CContactItem &)

IMPORT_C voidAddContactToGroupL(CContactItem &aItem,
CContactItem &aGroup
)

Parameters

CContactItem & aItem
CContactItem & aGroup

AddContactToGroupL(TContactItemId, TContactItemId, TBool)

IMPORT_C voidAddContactToGroupL(TContactItemIdaItemId,
TContactItemIdaGroupId,
TBoolaInTransaction
)

Parameters

TContactItemId aItemId
TContactItemId aGroupId
TBool aInTransaction

AddContactToSortListL(TContactItemId, TContactItemId &, CBase *, TUid &, TBool)

TBool AddContactToSortListL(TContactItemIdaReqId,
TContactItemId &aActualId,
CBase *aItems,
TUid &aFieldType,
TBoolaHasSortOrder
)[private]

Parameters

TContactItemId aReqId
TContactItemId & aActualId
CBase * aItems
TUid & aFieldType
TBool aHasSortOrder

AddNewContactL(CContactItem &)

IMPORT_C TContactItemIdAddNewContactL(CContactItem &aContact)

Parameters

CContactItem & aContact

AddObserverL(MContactDbObserver &)

voidAddObserverL(MContactDbObserver &aChangeNotifier)

Parameters

MContactDbObserver & aChangeNotifier

AddToTemplateListL(const TContactItemId)

voidAddToTemplateListL(const TContactItemIdaNewTemplateId)[private]

Parameters

const TContactItemId aNewTemplateId

AllFieldsView()

IMPORT_C CContactItemViewDef *AllFieldsView()

CancelAsyncSort()

IMPORT_C voidCancelAsyncSort()

CancelNotifyRequestL()

voidCancelNotifyRequestL()

CheckDbConnForReadL()

voidCheckDbConnForReadL()const [private]

CheckDbConnForRecoverL()

voidCheckDbConnForRecoverL()const [private]

CheckDbConnForWriteL()

voidCheckDbConnForWriteL()const [private]

CheckSortError(TInt)

TBool CheckSortError(TIntaError)[private]

Parameters

TInt aError

CheckTemplateField(CContactItem &)

voidCheckTemplateField(CContactItem &aCnt)[private]

Parameters

CContactItem & aCnt

CheckType(TUid)

TBool CheckType(TUidaUid)const [private]

Parameters

TUid aUid

CleanupDatabaseRollback(TAny *)

voidCleanupDatabaseRollback(TAny *aDatabase)[private, static]

Parameters

TAny * aDatabase

CleanupLastLockedContact(TAny *)

voidCleanupLastLockedContact(TAny *aDatabase)[static]

Parameters

TAny * aDatabase

CleanupTableCancel(TAny *)

voidCleanupTableCancel(TAny *aTable)[static]

Parameters

TAny * aTable

CloseContactL(TContactItemId)

IMPORT_C voidCloseContactL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

CloseTables()

IMPORT_C voidCloseTables()

CntServerResourceCount()

IMPORT_C TIntCntServerResourceCount()

CommitContactL(const CContactItem &)

IMPORT_C voidCommitContactL(const CContactItem &aContact)

Parameters

const CContactItem & aContact

CompactL()

IMPORT_C voidCompactL()

CompareSortFieldsL(const CContactItem &)

TInt CompareSortFieldsL(const CContactItem &aContact)[private]

Parameters

const CContactItem & aContact

CompressRequired()

IMPORT_C TBoolCompressRequired()

ConnectionId()

IMPORT_C TUintConnectionId()const

ConstructL()

voidConstructL()[private]

ConstructTableUsageFlagsFromSortOrderL(TInt &)

voidConstructTableUsageFlagsFromSortOrderL(TInt &aFlags)[private]

Parameters

TInt & aFlags

ContactDatabaseExistsL(const TDesC &)

IMPORT_C TBoolContactDatabaseExistsL(const TDesC &aFileName)[static]

Parameters

const TDesC & aFileName

ContactIdByGuidL(const TDesC &)

IMPORT_C TContactItemIdContactIdByGuidL(const TDesC &aGuid)

Parameters

const TDesC & aGuid

ContactMatchesHintFieldL(TInt, TContactItemId)

IMPORT_C TBoolContactMatchesHintFieldL(TIntaBitWiseFilter,
TContactItemIdaContactId
)

Parameters

TInt aBitWiseFilter
TContactItemId aContactId

ContactPosL(TContactItemId)

TInt ContactPosL(TContactItemIdaContactId)[private]

Parameters

TContactItemId aContactId

ContactsChangedSinceL(const TTime &)

IMPORT_C CContactIdArray *ContactsChangedSinceL(const TTime &aTime)

Parameters

const TTime & aTime

ConverterL(const TUid &)

CContactConverter &ConverterL(const TUid &aFormat)[private]

Parameters

const TUid & aFormat

ConverterL(const TUid &, const TInt64, MConverterCallBack *, const TVCardVersion, const TBool)

CContactConverter &ConverterL(const TUid &aFormat,
const TInt64aContactFieldFilter,
MConverterCallBack *aCallback,
const TVCardVersionaVersion,
const TBoolaExportTel
)[private]

Parameters

const TUid & aFormat
const TInt64 aContactFieldFilter
MConverterCallBack * aCallback
const TVCardVersion aVersion
const TBool aExportTel

CountL()

IMPORT_C TIntCountL()

CreateCompressorLC()

IMPORT_C CContactActiveCompress *CreateCompressorLC()

CreateContactCardTemplateL(const TDesC &, TBool)

IMPORT_C CContactItem *CreateContactCardTemplateL(const TDesC &aTemplateLabel,
TBoolaInTransaction = EFalse
)

Parameters

const TDesC & aTemplateLabel
TBool aInTransaction = EFalse

CreateContactCardTemplateL(const CContactItem *, const TDesC &, TBool)

IMPORT_C CContactItem *CreateContactCardTemplateL(const CContactItem *aTemplate,
const TDesC &aTemplateLabel,
TBoolaInTransaction = EFalse
)

Parameters

const CContactItem * aTemplate
const TDesC & aTemplateLabel
TBool aInTransaction = EFalse

CreateContactCardTemplateLC(const TDesC &, TBool)

IMPORT_C CContactItem *CreateContactCardTemplateLC(const TDesC &aTemplateLabel,
TBoolaInTransaction = EFalse
)

Parameters

const TDesC & aTemplateLabel
TBool aInTransaction = EFalse

CreateContactCardTemplateLC(const CContactItem *, const TDesC &, TBool)

IMPORT_C CContactItem *CreateContactCardTemplateLC(const CContactItem *aTemplate,
const TDesC &aTemplateLabel,
TBoolaInTransaction = EFalse
)

Parameters

const CContactItem * aTemplate
const TDesC & aTemplateLabel
TBool aInTransaction = EFalse

CreateContactGroupL(TBool)

IMPORT_C CContactItem *CreateContactGroupL(TBoolaInTransaction = EFalse)

Parameters

TBool aInTransaction = EFalse

CreateContactGroupL(const TDesC &, TBool)

IMPORT_C CContactItem *CreateContactGroupL(const TDesC &aGroupLabel,
TBoolaInTransaction = EFalse
)

Parameters

const TDesC & aGroupLabel
TBool aInTransaction = EFalse

CreateContactGroupLC(TBool)

IMPORT_C CContactItem *CreateContactGroupLC(TBoolaInTransaction = EFalse)

Parameters

TBool aInTransaction = EFalse

CreateContactGroupLC(const TDesC &, TBool)

IMPORT_C CContactItem *CreateContactGroupLC(const TDesC &aGroupLabel,
TBoolaInTransaction = EFalse
)

Parameters

const TDesC & aGroupLabel
TBool aInTransaction = EFalse

CreateL(TThreadAccess)

IMPORT_C CContactDatabase *CreateL(TThreadAccessaAccess = ESingleThread)[static]

Parameters

TThreadAccess aAccess = ESingleThread

CreateL(const TDesC &, TThreadAccess)

IMPORT_C CContactDatabase *CreateL(const TDesC &aFileName,
TThreadAccessaAccess = ESingleThread
)[static]

Parameters

const TDesC & aFileName
TThreadAccess aAccess = ESingleThread

CreateOwnCardL()

IMPORT_C CContactItem *CreateOwnCardL()

CreateOwnCardLC()

IMPORT_C CContactItem *CreateOwnCardLC()

CreateRecoverLC()

IMPORT_C CContactActiveRecover *CreateRecoverLC()

CreateViewDefL()

voidCreateViewDefL()[private]

DamageDatabaseL(TInt)

IMPORT_C voidDamageDatabaseL(TIntaSecretCode)

Parameters

TInt aSecretCode

DatabaseBeginL(TBool)

IMPORT_C voidDatabaseBeginL(TBoolaIsInTransaction)

Parameters

TBool aIsInTransaction

DatabaseBeginLC(TBool)

IMPORT_C voidDatabaseBeginLC(TBoolaIsInTransaction)

Parameters

TBool aIsInTransaction

DatabaseCommitL(TBool)

IMPORT_C voidDatabaseCommitL(TBoolaIsInTransaction)

Parameters

TBool aIsInTransaction

DatabaseCommitLP(TBool)

IMPORT_C voidDatabaseCommitLP(TBoolaIsInTransaction)

Parameters

TBool aIsInTransaction

DatabaseDrive(TDriveUnit &)

IMPORT_C TBoolDatabaseDrive(TDriveUnit &aDriveUnit)[static]

Parameters

TDriveUnit & aDriveUnit

DatabaseReadyL()

TBool DatabaseReadyL()const [private]

DatabaseRollback()

IMPORT_C voidDatabaseRollback()

DefaultContactDatabaseExistsL()

IMPORT_C TBoolDefaultContactDatabaseExistsL()[static]

DeleteContactL(TContactItemId)

IMPORT_C voidDeleteContactL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

DeleteContactSendEventActionL(TContactItemId, TCntSendEventAction)

voidDeleteContactSendEventActionL(TContactItemIdaContactId,
TCntSendEventActionaActionType
)[private]

Parameters

TContactItemId aContactId
TCntSendEventAction aActionType

DeleteContactsL(const CContactIdArray &)

IMPORT_C voidDeleteContactsL(const CContactIdArray &aContactIds)

Parameters

const CContactIdArray & aContactIds

DeleteDatabaseL(const TDesC &)

IMPORT_C voidDeleteDatabaseL(const TDesC &aFileName)[static]

Parameters

const TDesC & aFileName

DeleteDefaultFileL()

IMPORT_C voidDeleteDefaultFileL()[static]

DeletedContactsLC()

IMPORT_C CContactIdArray *DeletedContactsLC()

DoGotoL(TContactItemId)

TInt DoGotoL(TContactItemIdaContactId)[private]

Parameters

TContactItemId aContactId

DoReadContactTextDefL(const CContactItemFieldSet *, TDes &, CContactTextDef *)

voidDoReadContactTextDefL(const CContactItemFieldSet *aFieldSet,
TDes &aResult,
CContactTextDef *aTextDef
)[private]

Parameters

const CContactItemFieldSet * aFieldSet
TDes & aResult
CContactTextDef * aTextDef

EndAsyncActivityL()

voidEndAsyncActivityL()[private]

ExportSelectedContactsL(const TUid &, const CContactIdArray &, RWriteStream &, TInt, TBool)

IMPORT_C voidExportSelectedContactsL(const TUid &aFormat,
const CContactIdArray &aSelectedContactIds,
RWriteStream &aWriteStream,
TIntaOption,
TBoolaExportPrivateFields = ETrue
)

Parameters

const TUid & aFormat
const CContactIdArray & aSelectedContactIds
RWriteStream & aWriteStream
TInt aOption
TBool aExportPrivateFields = ETrue

ExportSelectedContactsL(const TUid &, const CContactIdArray &, RWriteStream &, TInt, const Versit::TVersitCharSet, TBool)

IMPORT_C voidExportSelectedContactsL(const TUid &aFormat,
const CContactIdArray &aSelectedContactIds,
RWriteStream &aWriteStream,
TIntaOption,
const Versit::TVersitCharSetaCharSet,
TBoolaExportPrivateFields = ETrue
)

Parameters

const TUid & aFormat
const CContactIdArray & aSelectedContactIds
RWriteStream & aWriteStream
TInt aOption
const Versit::TVersitCharSet aCharSet
TBool aExportPrivateFields = ETrue

ExportSelectedContactsL(const TUid &, const CContactIdArray &, RWriteStream &, TInt, const TInt64, MConverterCallBack *, const TVCardVersion, const TBool, Versit::TVersitCharSet, TBool)

IMPORT_C voidExportSelectedContactsL(const TUid &aFormat,
const CContactIdArray &aSelectedContactIds,
RWriteStream &aWriteStream,
TIntaOption,
const TInt64aContactFieldFilter,
MConverterCallBack *aCallback,
const TVCardVersionaVersion,
const TBoolaExportTel,
Versit::TVersitCharSetaCharSet = Versit::EUTF8CharSet,
TBoolaExportPrivateFields = ETrue
)

Parameters

const TUid & aFormat
const CContactIdArray & aSelectedContactIds
RWriteStream & aWriteStream
TInt aOption
const TInt64 aContactFieldFilter
MConverterCallBack * aCallback
const TVCardVersion aVersion
const TBool aExportTel
Versit::TVersitCharSet aCharSet = Versit::EUTF8CharSet
TBool aExportPrivateFields = ETrue

FactoryL()

MLplPersistenceLayerFactory *FactoryL()[private]

FetchGroupAndTemplateListsL()

voidFetchGroupAndTemplateListsL()[private]

FileSize()

IMPORT_C TIntFileSize()const

FileUid()

IMPORT_C TPtrCFileUid()

FilterDatabaseL(CCntFilter &)

IMPORT_C voidFilterDatabaseL(CCntFilter &aFilter)

Parameters

CCntFilter & aFilter

FindAsyncL(const TDesC &, const CContactItemFieldDef *, MIdleFindObserver *)

IMPORT_C CIdleFinder *FindAsyncL(const TDesC &aText,
const CContactItemFieldDef *aFieldDef,
MIdleFindObserver *aObserver
)

Parameters

const TDesC & aText
const CContactItemFieldDef * aFieldDef
MIdleFindObserver * aObserver

FindInTextDefAsyncL(const MDesCArray &, MIdleFindObserver *, const TCallBack &)

IMPORT_C CIdleFinder *FindInTextDefAsyncL(const MDesCArray &aFindWords,
MIdleFindObserver *aObserver,
const TCallBack &aWordParserCallback
)

Parameters

const MDesCArray & aFindWords
MIdleFindObserver * aObserver
const TCallBack & aWordParserCallback

FindInTextDefAsyncL(const MDesCArray &, const CContactTextDef *, MIdleFindObserver *, const TCallBack &)

IMPORT_C CIdleFinder *FindInTextDefAsyncL(const MDesCArray &aFindWords,
const CContactTextDef *aTextDef,
MIdleFindObserver *aObserver,
const TCallBack &aWordParserCallback
)

Parameters

const MDesCArray & aFindWords
const CContactTextDef * aTextDef
MIdleFindObserver * aObserver
const TCallBack & aWordParserCallback

FindInTextDefLC(const MDesCArray &, const TCallBack &)

IMPORT_C CContactIdArray *FindInTextDefLC(const MDesCArray &aFindWords,
const TCallBack &aWordParserCallback
)

Parameters

const MDesCArray & aFindWords
const TCallBack & aWordParserCallback

FindInTextDefLC(const MDesCArray &, CContactTextDef *, const TCallBack &)

IMPORT_C CContactIdArray *FindInTextDefLC(const MDesCArray &aFindWords,
CContactTextDef *aTextDef,
const TCallBack &aWordParserCallback
)

Parameters

const MDesCArray & aFindWords
CContactTextDef * aTextDef
const TCallBack & aWordParserCallback

FindLC(const TDesC &, const CContactItemFieldDef *)

IMPORT_C CContactIdArray *FindLC(const TDesC &aText,
const CContactItemFieldDef *aFieldDef
)

Parameters

const TDesC & aText
const CContactItemFieldDef * aFieldDef

GetCardTemplateIdListL()

IMPORT_C CContactIdArray *GetCardTemplateIdListL()const

GetCurrentDatabase(TDes &)

IMPORT_C TIntGetCurrentDatabase(TDes &aDatabase)const

Parameters

TDes & aDatabase

GetCurrentItem()

IMPORT_C TContactItemIdGetCurrentItem()const

GetDbViewContactType()

IMPORT_C TUidGetDbViewContactType()const

GetDefaultNameL(TDes &)

IMPORT_C voidGetDefaultNameL(TDes &aDes)[static]

Parameters

TDes & aDes

GetGroupIdListL()

IMPORT_C CContactIdArray *GetGroupIdListL()const

GetLastSyncDateL(TContactSyncId, TTime &)

IMPORT_C voidGetLastSyncDateL(TContactSyncIdaSyncId,
TTime &aSyncDate
)

Parameters

TContactSyncId aSyncId
TTime & aSyncDate

GetSpeedDialFieldL(TInt, TDes &)

IMPORT_C TContactItemIdGetSpeedDialFieldL(TIntaSpeedDialPosition,
TDes &aPhoneNumber
)

Parameters

TInt aSpeedDialPosition
TDes & aPhoneNumber

GroupCount()

TInt GroupCount()const [inline]

Gets the number of groups that exist in the database. The number of groups that exist in the database.

HandleDatabaseEventL(RDbNotifier::TEvent)

voidHandleDatabaseEventL(RDbNotifier::TEvent)[inline]

HandleDatabaseEventL(const TContactDbObserverEvent &)

IMPORT_C voidHandleDatabaseEventL(const TContactDbObserverEvent &aEvent)

Parameters

const TContactDbObserverEvent & aEvent

HandleDbObserverEventGroupDeletedL(const TContactItemId)

voidHandleDbObserverEventGroupDeletedL(const TContactItemIdaContactId)[private]

Parameters

const TContactItemId aContactId

HandleDbObserverEventGroupOrContactAddedL(const TContactDbObserverEventType, const TContactItemId)

voidHandleDbObserverEventGroupOrContactAddedL(const TContactDbObserverEventTypeaEventType,
const TContactItemIdaContactId
)[private]

Parameters

const TContactDbObserverEventType aEventType
const TContactItemId aContactId

HandleDbObserverEventGroupOrContactChangedL(const TContactItemId)

voidHandleDbObserverEventGroupOrContactChangedL(const TContactItemIdaContactId)[private]

Parameters

const TContactItemId aContactId

HandleDiskSpaceEvent(TInt)

voidHandleDiskSpaceEvent(TIntaDrive)

Parameters

TInt aDrive

ICCTemplateIdL()

IMPORT_C TContactItemIdICCTemplateIdL()

ICCTemplateIdL(TUid)

IMPORT_C TContactItemIdICCTemplateIdL(TUidaPhonebookUid)

Parameters

TUid aPhonebookUid

ImportContactsL(const TUid &, RReadStream &, TBool &, TInt)

IMPORT_C CArrayPtr< CContactItem > *ImportContactsL(const TUid &aFormat,
RReadStream &aReadStream,
TBool &aImportSuccessful,
TIntaOption
)

Parameters

const TUid & aFormat
RReadStream & aReadStream
TBool & aImportSuccessful
TInt aOption

InsertInSortArray(const CContactItem &)

voidInsertInSortArray(const CContactItem &aContact)[private]

Parameters

const CContactItem & aContact

InsertInSortArrayL(const CContactItem &)

voidInsertInSortArrayL(const CContactItem &aContact)[private]

Parameters

const CContactItem & aContact

IsDamaged()

IMPORT_C TBoolIsDamaged()const

IsICCSynchronisedL()

TBool IsICCSynchronisedL()

ListDatabasesL()

IMPORT_C CDesCArray *ListDatabasesL()[static]

ListDatabasesL(TDriveUnit)

IMPORT_C CDesCArray *ListDatabasesL(TDriveUnitaDriveUnit)[static]

Parameters

TDriveUnit aDriveUnit

LoadSyncPluginL()

voidLoadSyncPluginL()[private]

LockServerCallBackL(TUint)

IMPORT_C TIntLockServerCallBackL(TUintaServerOperation)

Parameters

TUint aServerOperation

LockServerCleanup()

IMPORT_C voidLockServerCleanup()

LockServerConnectL(const TDesC &)

IMPORT_C CContactDatabase *LockServerConnectL(const TDesC &aFileName)[static]

Parameters

const TDesC & aFileName

LockServerConnectL(const TDesC &, TInt)

IMPORT_C CContactDatabase *LockServerConnectL(const TDesC &aFileName,
TIntaOperation
)[static]

Parameters

const TDesC & aFileName
TInt aOperation

MachineId()

IMPORT_C TInt64MachineId()const

MatchPhoneNumberL(const TDesC &, TInt)

IMPORT_C CContactIdArray *MatchPhoneNumberL(const TDesC &aNumber,
TIntaMatchLengthFromRight
)

Parameters

const TDesC & aNumber
TInt aMatchLengthFromRight

MoveInSortArray(const CContactItem &)

voidMoveInSortArray(const CContactItem &aContact)[private]

Parameters

const CContactItem & aContact

MoveInSortArrayL(const CContactItem &)

voidMoveInSortArrayL(const CContactItem &aContact)[private]

Parameters

const CContactItem & aContact

NewLC()

CContactDatabase *NewLC()[private, static]

NewSortIndexL(const CContactItem &, TInt, TInt)

TInt NewSortIndexL(const CContactItem &aContact,
TIntaStartPos,
TIntaEndPos
)[private]

Parameters

const CContactItem & aContact
TInt aStartPos
TInt aEndPos

NextExistingL(TInt)

TInt NextExistingL(TIntaIndex)[private]

Parameters

TInt aIndex

NullUidValue()

TInt NullUidValue()[static, inline]

Gets the NULL contact ID value.

KNullContactId.

Open(TRequestStatus &, TThreadAccess)

IMPORT_C CContactOpenOperation *Open(TRequestStatus &aStatus,
TThreadAccessaAccess = ESingleThread
)[static]

Parameters

TRequestStatus & aStatus
TThreadAccess aAccess = ESingleThread

Open(const TDesC &, TRequestStatus &, TThreadAccess)

IMPORT_C CContactOpenOperation *Open(const TDesC &aFileName,
TRequestStatus &aStatus,
TThreadAccessaAccess = ESingleThread
)[static]

Parameters

const TDesC & aFileName
TRequestStatus & aStatus
TThreadAccess aAccess = ESingleThread

OpenContactL(TContactItemId)

IMPORT_C CContactItem *OpenContactL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

OpenContactL(TContactItemId, const CContactItemViewDef &)

IMPORT_C CContactItem *OpenContactL(TContactItemIdaContactId,
const CContactItemViewDef &aViewDef
)

Parameters

TContactItemId aContactId
const CContactItemViewDef & aViewDef

OpenContactLX(TContactItemId)

IMPORT_C CContactItem *OpenContactLX(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

OpenContactLX(TContactItemId, const CContactItemViewDef &)

IMPORT_C CContactItem *OpenContactLX(TContactItemIdaContactId,
const CContactItemViewDef &aViewDef
)

Parameters

TContactItemId aContactId
const CContactItemViewDef & aViewDef

OpenDatabaseAsyncL(TRequestStatus &, const TDesC &)

voidOpenDatabaseAsyncL(TRequestStatus &aStatus,
const TDesC &aFileName =  KNullDesC
)

Parameters

TRequestStatus & aStatus
const TDesC & aFileName =  KNullDesC

OpenL(TThreadAccess)

IMPORT_C CContactDatabase *OpenL(TThreadAccessaAccess = ESingleThread)[static]

Parameters

TThreadAccess aAccess = ESingleThread

OpenL(const TDesC &, TThreadAccess)

IMPORT_C CContactDatabase *OpenL(const TDesC &aFileName,
TThreadAccessaAccess = ESingleThread
)[static]

Parameters

const TDesC & aFileName
TThreadAccess aAccess = ESingleThread

OpenNoMergeLCX(TContactItemId)

CContactItem *OpenNoMergeLCX(TContactItemIdaContactId)[private]

Parameters

TContactItemId aContactId

OpenTablesL()

IMPORT_C voidOpenTablesL()

OverrideMachineUniqueId(TInt64)

IMPORT_C voidOverrideMachineUniqueId(TInt64aMachineUniqueId)

Parameters

TInt64 aMachineUniqueId

OwnCardId()

IMPORT_C TContactItemIdOwnCardId()const

PhonebookGroupIdL()

IMPORT_C TContactItemIdPhonebookGroupIdL()

PrefTemplateId()

IMPORT_C TContactItemIdPrefTemplateId()const

PreviousExistingL(TInt)

TInt PreviousExistingL(TIntaIndex)[private]

Parameters

TInt aIndex

ReSortL(CArrayFix< TSortPref > *)

voidReSortL(CArrayFix< TSortPref > *aSortOrder)[private]

Parameters

CArrayFix< TSortPref > * aSortOrder

ReadContactAndAgentL(TContactItemId)

IMPORT_C CArrayPtr< CContactItem > *ReadContactAndAgentL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ReadContactL(TContactItemId)

IMPORT_C CContactItem *ReadContactL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ReadContactL(TContactItemId, const CContactItemViewDef &)

IMPORT_C CContactItem *ReadContactL(TContactItemIdaContactId,
const CContactItemViewDef &aViewDef
)

Parameters

TContactItemId aContactId
const CContactItemViewDef & aViewDef

ReadContactLC(TContactItemId)

IMPORT_C CContactItem *ReadContactLC(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ReadContactLC(TContactItemId, const CContactItemViewDef &)

IMPORT_C CContactItem *ReadContactLC(TContactItemIdaContactId,
const CContactItemViewDef &aViewDef
)

Parameters

TContactItemId aContactId
const CContactItemViewDef & aViewDef

ReadContactTextDefL(const CContactItem &, TDes &)

IMPORT_C voidReadContactTextDefL(const CContactItem &aItem,
TDes &aResult
)

Parameters

const CContactItem & aItem
TDes & aResult

ReadContactTextDefL(const CContactItem &, TDes &, CContactTextDef *)

IMPORT_C voidReadContactTextDefL(const CContactItem &aItem,
TDes &aResult,
CContactTextDef *aTextDef
)

Parameters

const CContactItem & aItem
TDes & aResult
CContactTextDef * aTextDef

ReadContactTextDefL(TContactItemId, TDes &)

IMPORT_C voidReadContactTextDefL(TContactItemIdaContactId,
TDes &aResult
)

Parameters

TContactItemId aContactId
TDes & aResult

ReadContactTextDefL(TContactItemId, TDes &, CContactTextDef *)

IMPORT_C voidReadContactTextDefL(TContactItemIdaContactId,
TDes &aResult,
CContactTextDef *aTextDef
)

Parameters

TContactItemId aContactId
TDes & aResult
CContactTextDef * aTextDef

ReadMinimalContactL(TContactItemId)

IMPORT_C CContactItem *ReadMinimalContactL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ReadMinimalContactLC(TContactItemId)

IMPORT_C CContactItem *ReadMinimalContactLC(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ReadTemplateIdsL()

voidReadTemplateIdsL()[private]

RecoverL()

IMPORT_C voidRecoverL()

RecreateSystemTemplateL(const TDesC &)

IMPORT_C voidRecreateSystemTemplateL(const TDesC &aFileName)[static]

Parameters

const TDesC & aFileName

RemoveContactFromGroupL(CContactItem &, CContactItem &)

IMPORT_C voidRemoveContactFromGroupL(CContactItem &aItem,
CContactItem &aGroup
)

Parameters

CContactItem & aItem
CContactItem & aGroup

RemoveContactFromGroupL(TContactItemId, TContactItemId)

IMPORT_C voidRemoveContactFromGroupL(TContactItemIdaItemId,
TContactItemIdaGroupId
)

Parameters

TContactItemId aItemId
TContactItemId aGroupId

RemoveFromGroupIds(const TContactItemId)

voidRemoveFromGroupIds(const TContactItemIdaContactId)[private]

Parameters

const TContactItemId aContactId

RemoveFromSortArray(TContactItemId)

voidRemoveFromSortArray(TContactItemIdaContactId)[private]

Parameters

TContactItemId aContactId

RemoveFromTemplateList(const TContactItemId)

voidRemoveFromTemplateList(const TContactItemIdaOldTemplateId)[private]

Parameters

const TContactItemId aOldTemplateId

RemoveObserver(const MContactDbObserver &)

voidRemoveObserver(const MContactDbObserver &aChangeNotifier)

Parameters

const MContactDbObserver & aChangeNotifier

RemoveSpeedDialFieldL(TContactItemId, TInt)

IMPORT_C voidRemoveSpeedDialFieldL(TContactItemIdaContactId,
TIntaSpeedDialPosition
)

Parameters

TContactItemId aContactId
TInt aSpeedDialPosition

ReplaceL(TThreadAccess)

IMPORT_C CContactDatabase *ReplaceL(TThreadAccessaAccess = ESingleThread)[static]

Parameters

TThreadAccess aAccess = ESingleThread

ReplaceL(const TDesC &, TThreadAccess)

IMPORT_C CContactDatabase *ReplaceL(const TDesC &aFileName,
TThreadAccessaAccess = ESingleThread
)[static]

Parameters

const TDesC & aFileName
TThreadAccess aAccess = ESingleThread

ResetServerSpeedDialsL()

IMPORT_C voidResetServerSpeedDialsL()

RespondToEventL(const TContactDbObserverEventType, const TContactItemId)

voidRespondToEventL(const TContactDbObserverEventTypeaEventType,
const TContactItemIdaContactId
)[private]

Parameters

const TContactDbObserverEventType aEventType
const TContactItemId aContactId

RestoreSortOrderL()

IMPORT_C voidRestoreSortOrderL()

SetCntServerHeapFailure(TInt, TInt)

IMPORT_C voidSetCntServerHeapFailure(TIntaTAllocFailType,
TIntaRate
)

Parameters

TInt aTAllocFailType
TInt aRate

SetCurrentDatabase(const TDesC &)

IMPORT_C TIntSetCurrentDatabase(const TDesC &aDatabase)const

Parameters

const TDesC & aDatabase

SetCurrentItem(const TContactItemId)

IMPORT_C voidSetCurrentItem(const TContactItemIdaContactId)

Parameters

const TContactItemId aContactId

SetDatabaseDriveL(TDriveUnit, TBool)

IMPORT_C voidSetDatabaseDriveL(TDriveUnitaDriveUnit,
TBoolaCopy = ETrue
)[static]

Parameters

TDriveUnit aDriveUnit
TBool aCopy = ETrue

SetDateFormatTextL(const TDesC &)

IMPORT_C voidSetDateFormatTextL(const TDesC &aFormat)

Parameters

const TDesC & aFormat

SetDbConnectionState(TDbConnState)

voidSetDbConnectionState(TDbConnStateaDbConnectionState)

Parameters

TDbConnState aDbConnectionState

SetDbViewContactType(const TUid)

IMPORT_C voidSetDbViewContactType(const TUidaUid)

Parameters

const TUid aUid

SetFieldAsSpeedDialL(CContactItem &, TInt, TInt)

IMPORT_C voidSetFieldAsSpeedDialL(CContactItem &aItem,
TIntaFieldIndex,
TIntaSpeedDialPosition
)

Parameters

CContactItem & aItem
TInt aFieldIndex
TInt aSpeedDialPosition

SetLastSyncDateL(const TTime &)

IMPORT_C TContactSyncIdSetLastSyncDateL(const TTime &aSyncDate)

Parameters

const TTime & aSyncDate

SetLastSyncDateL(TContactSyncId, const TTime &)

IMPORT_C voidSetLastSyncDateL(TContactSyncIdaSyncId,
const TTime &aSyncDate
)

Parameters

TContactSyncId aSyncId
const TTime & aSyncDate

SetOperationTimeOutL(const TInt)

IMPORT_C voidSetOperationTimeOutL(const TIntaMicroSeconds)const

Parameters

const TInt aMicroSeconds

SetOwnCardL(const CContactItem &)

IMPORT_C voidSetOwnCardL(const CContactItem &aContact)

Parameters

const CContactItem & aContact

SetPrefTemplateL(const CContactItem &)

IMPORT_C voidSetPrefTemplateL(const CContactItem &aContact)

Parameters

const CContactItem & aContact

SetSortedItemsList(CContactIdArray *, CArrayFix< TSortPref > *)

IMPORT_C voidSetSortedItemsList(CContactIdArray *aSortedItems,
CArrayFix< TSortPref > *aSortOrder
)

Parameters

CContactIdArray * aSortedItems
CArrayFix< TSortPref > * aSortOrder

SetTextDefinitionL(CContactTextDef *)

IMPORT_C voidSetTextDefinitionL(CContactTextDef *aView)

Parameters

CContactTextDef * aView

SetViewDefinitionL(CContactViewDef *)

IMPORT_C voidSetViewDefinitionL(CContactViewDef *aView)

Parameters

CContactViewDef * aView

SortArrayL(const CContactIdArray *, const CArrayFix< TSortPref > *)

IMPORT_C CContactIdArray *SortArrayL(const CContactIdArray *aIdArray,
const CArrayFix< TSortPref > *aSortOrder
)

Parameters

const CContactIdArray * aIdArray
const CArrayFix< TSortPref > * aSortOrder

SortArrayLC(const CContactIdArray *, const CArrayFix< TSortPref > *)

IMPORT_C CContactIdArray *SortArrayLC(const CContactIdArray *aIdArray,
const CArrayFix< TSortPref > *aSortOrder
)

Parameters

const CContactIdArray * aIdArray
const CArrayFix< TSortPref > * aSortOrder

SortAsyncL(CArrayFix< TSortPref > *, TRequestStatus &)

IMPORT_C voidSortAsyncL(CArrayFix< TSortPref > *aSortOrder,
TRequestStatus &aStatus
)

Parameters

CArrayFix< TSortPref > * aSortOrder
TRequestStatus & aStatus

SortAsyncL(CArrayFix< TSortPref > *, TRequestStatus &, MContactSortObserver &)

IMPORT_C voidSortAsyncL(CArrayFix< TSortPref > *aSortOrder,
TRequestStatus &aStatus,
MContactSortObserver &aObserver
)

Parameters

CArrayFix< TSortPref > * aSortOrder
TRequestStatus & aStatus
MContactSortObserver & aObserver

SortByTypeL(CArrayFix< TSortPref > *)

IMPORT_C voidSortByTypeL(CArrayFix< TSortPref > *aSortOrder)

Parameters

CArrayFix< TSortPref > * aSortOrder

SortDuplicatesL(const CArrayFix< TSortPref > &, CSortArray &, TInt)

voidSortDuplicatesL(const CArrayFix< TSortPref > &aSortOrder,
CSortArray &aList,
TIntaPos
)[private]

Parameters

const CArrayFix< TSortPref > & aSortOrder
CSortArray & aList
TInt aPos

SortDuplicatesL(const CArrayFix< TSortPref > &, CSortArray &, TInt, TInt, TInt)

voidSortDuplicatesL(const CArrayFix< TSortPref > &aSortOrder,
CSortArray &aList,
TIntaIndex,
TIntaStartPos,
TIntaEndPos
)[private]

Parameters

const CArrayFix< TSortPref > & aSortOrder
CSortArray & aList
TInt aIndex
TInt aStartPos
TInt aEndPos

SortL(CArrayFix< TSortPref > *)

IMPORT_C voidSortL(CArrayFix< TSortPref > *aSortOrder)

Parameters

CArrayFix< TSortPref > * aSortOrder

SortLC(const CArrayFix< TSortPref > *, const CContactIdArray *)

CContactIdArray *SortLC(const CArrayFix< TSortPref > *aSortOrder,
const CContactIdArray *aIdArray
)[private]

Parameters

const CArrayFix< TSortPref > * aSortOrder
const CContactIdArray * aIdArray

SortOrder()

IMPORT_C const CArrayFix< TSortPref > *SortOrder()const

SortedItemsL()

IMPORT_C const CContactIdArray *SortedItemsL()

SpeedDialFieldUidFromSpeedDialPosition(TInt)

TUid SpeedDialFieldUidFromSpeedDialPosition(TIntaSpeedDialPosition)[static]

Parameters

TInt aSpeedDialPosition

StartAsyncActivityL()

voidStartAsyncActivityL()[private]

StoreSortOrderL()

IMPORT_C voidStoreSortOrderL()

SystemTemplateFieldsValid(const CContactItem &)

TBool SystemTemplateFieldsValid(const CContactItem &aContact)[private]

Parameters

const CContactItem & aContact

TemplateContentType(const CContactItemField &)

IMPORT_C const CContentType &TemplateContentType(const CContactItemField &aField)const

Parameters

const CContactItemField & aField

TemplateCount()

TInt TemplateCount()const [inline]

Gets the number of contact card templates that exist in the database. This does not include the system template. The number of contact card templates that exist in the database.

TemplateId()

IMPORT_C TContactItemIdTemplateId()const

TextDefinition()

IMPORT_C const CContactTextDef *TextDefinition()const

UnfiledContactsL()

IMPORT_C CContactIdArray *UnfiledContactsL()

UpdateContactLC(TContactItemId, CContactItem *)

IMPORT_C CContactItem *UpdateContactLC(TContactItemIdaContactId,
CContactItem *aNewContact
)

Parameters

TContactItemId aContactId
CContactItem * aNewContact

ValidateDatabaseNameL(const TParse &)

voidValidateDatabaseNameL(const TParse &aParseName)[private, static]

Parameters

const TParse & aParseName

Version()

IMPORT_C TVersionVersion()const

WastedSpaceInBytes()

IMPORT_C TIntWastedSpaceInBytes()const

doAddNewContactL(CContactItem &, TBool, TBool)

IMPORT_C TContactItemIddoAddNewContactL(CContactItem &aContact,
TBoolaIsTemplate,
TBoolaIsInTransaction
)

Parameters

CContactItem & aContact
TBool aIsTemplate
TBool aIsInTransaction

doCommitContactL(const CContactItem &, TBool, TBool)

IMPORT_C voiddoCommitContactL(const CContactItem &aContact,
TBoolaIsInTransaction,
TBoolaSendChangedEvent
)

Parameters

const CContactItem & aContact
TBool aIsInTransaction
TBool aSendChangedEvent

doCreateContactGroupLC(const TDesC &)

CContactItem *doCreateContactGroupLC(const TDesC &aGroupLabel =  KNullDesC )[private]

Parameters

const TDesC & aGroupLabel =  KNullDesC

doDeleteContactL(TContactItemId, TBool, TBool, TBool)

IMPORT_C voiddoDeleteContactL(TContactItemIdaContactId,
TBoolaIsInTransaction,
TBoolaSendChangedEvent,
TBoolaDecAccessCount = EFalse
)

Parameters

TContactItemId aContactId
TBool aIsInTransaction
TBool aSendChangedEvent
TBool aDecAccessCount = EFalse

Member Enumerations Documentation

Enum TContactViewFilter

Contact view filter flags.

These flags define the bits that can be set in filtered views (CContactFilteredView) and in the filter passed to CContactDatabase::ContactMatchesHintFieldL() for comparing against contact view items (CViewContact).

If the item's bit field and the view's filter have the same settings for the CContactDatabase::EHome and CContactDatabase::EWork flags and any of the other flags are set in both, a match occurs and the item is included in the view.

Filters only apply to non-hidden contact fields with content.

Enumerators

EUnfiltered = 0x00000000

The view is unfiltered; it includes all contact items.

EMailable = 0x00000001

The filter includes items that have an email address.

ESmsable = 0x00000002

The filter includes items that have a mobile telephone number.

ELandLine = 0x00000004

The filter includes items that have a landline telephone number.

EFaxable = 0x00000008

The filter includes items that have a fax number.

EPhonable = 0x00000010

The filter includes items that are phonable. (All items with any of the above three flags set also have this flag set).

EWork = 0x00000020

The filter excludes items without a work telephone number or email address.

EHome = 0x00000040

The filter excludes items without a home telephone number or email address.

ERingTone = 0x00000080

The filter includes items that have a non-empty ring tone field (a ring tone that is associated with the item).

EVoiceDial = 0x00000100

The filter includes items that have a non-empty voice dial field (a voice recording associated with a telephone number field in the item).

EIMAddress = 0x00000200

The filter includes items that have any non empty instant messaging address field.

EWirelessVillage = 0x00000400

The filter includes items that have a non empty Wireless Village ID field. An item with this flag set will also have the EIMAddress flag set.

ECustomFilter1 = 0x00000800

Reserved filters for future use.

ECustomFilter2 = 0x00001000

Reserved filters for future use.

ECustomFilter3 = 0x00002000

Reserved filters for future use.

ECustomFilter4 = 0x00004000

Reserved filters for future use.

Enum TDbConnState

State of database connection

Enumerators

EDbConnectionOpen = 0

Database is open, connection is available for use.

EDbConnectionNotReady

Initial state.

EDbConnectionFailed

Asynchronous Open failed.

EDbConnectionRecoverRequired

A Rollback has occurred and a Recover is required now.

EDbConnectionWriteLockedForBackup

Write access is locked during backup.

EDbConnectionClosedForRestore

The database has been closed whilst a Restore is in progress.

EDbConnectionNeedToCloseForRestore

Restore is in progress need to close after current transaction.

Enum TDirection

Currently unused

Enumerators

EAsc
EDesc

Enum TOptions

Import and export format flags. Contacts can be imported into or exported from the contact database as vCards.

The following options are available during import and export.

This enum is deprecated. It has been replaced by the TOptions enum in the plugin convertor class CContactVCardConverter, so that each plugin converter can define its own options.

Enumerators

EDefault = 0x0000
EIncludeX = 0x0001

Handle Symbian's extended vCard format options.

ETTFormat = 0x0002

Support non-standard extensions requried by Symbian PC connectivity software and Microsoft, amongst others.

EExcludeUid = 0x0004

Don't export the contact ID (for exporting only).

EDecreaseAccessCount = 0x0008

Decrease the contact's access count when importing and exporting.

EImportSingleContact = 0x0010

Only import the first contact in the read stream (for importing only).

EIncreaseAccessCount = 0x0020

Increase the contact's access count when importing and exporting.

ELocalTime = 0x0040

Sets a contact item to the local time when importing.

ENullTemplateId = 0x0080

Allows you to set a template to a contact item that does not exist.

EConverterDefined1 = 0x0100

For use by implementor of converter plug-in.

EConverterDefined2 = 0x0200

For use by implementor of converter plug-in.

EConverterDefined3 = 0x0400

For use by implementor of converter plug-in.

EConverterDefined4 = 0x0800

For use by implementor of converter plug-in.

EConverterDefined5 = 0x1000

For use by implementor of converter plug-in.

EConverterDefined6 = 0x2000

For use by implementor of converter plug-in.

EConverterDefined7 = 0x4000

For use by implementor of converter plug-in.

EConverterDefined8 = 0x8000

For use by implementor of converter plug-in.

EConverterReserved1 = 0x00010000

Reserved for use by Symbian.

EConverterReserved2 = 0x00020000

Reserved for use by Symbian.

EConverterReserved3 = 0x00040000

Reserved for use by Symbian.

EConverterReserved4 = 0x00080000

Reserved for use by Symbian.

EConverterReserved5 = 0x00100000

Reserved for use by Symbian.

EConverterReserved6 = 0x00200000

Reserved for use by Symbian.

EConverterReserved7 = 0x00400000

Reserved for use by Symbian.

EConverterReserved8 = 0x00800000

Reserved for use by Symbian.

EConverterReserved9 = 0x01000000

Reserved for use by Symbian.

EConverterReserved10 = 0x02000000

Reserved for use by Symbian.

EConverterReserved11 = 0x04000000

Reserved for use by Symbian.

EConverterReserved12 = 0x08000000

Reserved for use by Symbian.

EConverterReserved13 = 0x10000000

Reserved for use by Symbian.

EConverterReserved14 = 0x20000000

Reserved for use by Symbian.

EConverterReserved15 = 0x40000000

Reserved for use by Symbian.

EConverterReserved16 = 0x80000000

Reserved for use by Symbian.

Enum TSortDataSource

Enumerators

ENoOrder
EUsesIdentityTableOnly
EUsesAllTables
EIdentityTableNotUsed

Enum TSvrSessionType

Enumerators

ESvrSessionPersistent
ESvrSessionTemporary
ESvrSessionFromLockServer

Enum TThreadAccess

Specifies whether the database can be accessed from single or multiple threads.

Enumerators

ESingleThread

Allows access to the contacts database from a single thread only.

EMultiThread

Allows for a multi-threaded program to access the contact database from multiple threads but note that the contacts model provides no synchronisation support for such use.

Member Type Definitions Documentation

Typedef TTextFieldMinimal

typedef TBuf< KTextFieldMinimalLength >TTextFieldMinimal

A text buffer of KTextFieldMinimalLength used during sorting and searching of contacts

Member Data Documentation

CContactItemViewDef * iAllFieldsView

CContactItemViewDef *iAllFieldsView[private]

TInt iAsyncActivityCount

TInt iAsyncActivityCount[private]

CContactIdArray * iCardTemplateIds

CContactIdArray *iCardTemplateIds[private]

RCntModel * iCntSvr

RCntModel *iCntSvr[private]

TCollationMethod iCollateMethod

TCollationMethod iCollateMethod[private]

CContactSynchroniser * iContactSynchroniser

CContactSynchroniser *iContactSynchroniser[private]

CPrivConverter * iConv

CPrivConverter *iConv[private]

CDataBaseChangeObserver * iDataBaseObserver

CDataBaseChangeObserver *iDataBaseObserver[private]

TDbConnState iDbConnectionState

TDbConnState iDbConnectionState[private]

TUid iDbViewContactType

TUid iDbViewContactType[private]

CContactIdArray * iGroupIds

CContactIdArray *iGroupIds[private]

CCntIdleSorter * iIdleSorter

CCntIdleSorter *iIdleSorter[private]

CProxyFactory * iProxyFactory

CProxyFactory *iProxyFactory[private]

CArrayFix< TSortPref > * iSortOrder

CArrayFix< TSortPref > *iSortOrder[private]

CContactIdArray * iSortedItems

CContactIdArray *iSortedItems[private]

TTime iSyncDate

TTime iSyncDate[private]

TBool iTablesOpen

TBool iTablesOpen[private]

CCntTemplateCache * iTemplateCache

CCntTemplateCache *iTemplateCache[private]

CContactTextDef * iTextDef

CContactTextDef *iTextDef[private]

CContactViewDef * iView

CContactViewDef *iView[private]