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()
Private Member Enumerations | |
---|---|
enum | TSvrSessionType { 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 |
void | AddCntToOpenedGroupL | ( | TContactItemId | aItemId, |
CContactItem & | aGroup | |||
) | [private] |
TContactItemId aItemId | |
CContactItem & aGroup |
IMPORT_C void | AddContactToGroupL | ( | TContactItemId | aItemId, |
TContactItemId | aGroupId | |||
) |
TContactItemId aItemId | |
TContactItemId aGroupId |
IMPORT_C void | AddContactToGroupL | ( | CContactItem & | aItem, |
CContactItem & | aGroup | |||
) |
CContactItem & aItem | |
CContactItem & aGroup |
IMPORT_C void | AddContactToGroupL | ( | TContactItemId | aItemId, |
TContactItemId | aGroupId, | |||
TBool | aInTransaction | |||
) |
TContactItemId aItemId | |
TContactItemId aGroupId | |
TBool aInTransaction |
TBool | AddContactToSortListL | ( | TContactItemId | aReqId, |
TContactItemId & | aActualId, | |||
CBase * | aItems, | |||
TUid & | aFieldType, | |||
TBool | aHasSortOrder | |||
) | [private] |
TContactItemId aReqId | |
TContactItemId & aActualId | |
CBase * aItems | |
TUid & aFieldType | |
TBool aHasSortOrder |
IMPORT_C TContactItemId | AddNewContactL | ( | CContactItem & | aContact | ) |
CContactItem & aContact |
void | AddObserverL | ( | MContactDbObserver & | aChangeNotifier | ) |
MContactDbObserver & aChangeNotifier |
void | AddToTemplateListL | ( | const TContactItemId | aNewTemplateId | ) | [private] |
const TContactItemId aNewTemplateId |
void | CheckTemplateField | ( | CContactItem & | aCnt | ) | [private] |
CContactItem & aCnt |
void | CleanupDatabaseRollback | ( | TAny * | aDatabase | ) | [private, static] |
TAny * aDatabase |
void | CleanupLastLockedContact | ( | TAny * | aDatabase | ) | [static] |
TAny * aDatabase |
IMPORT_C void | CloseContactL | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C void | CommitContactL | ( | const CContactItem & | aContact | ) |
const CContactItem & aContact |
TInt | CompareSortFieldsL | ( | const CContactItem & | aContact | ) | [private] |
const CContactItem & aContact |
void | ConstructTableUsageFlagsFromSortOrderL | ( | TInt & | aFlags | ) | [private] |
TInt & aFlags |
IMPORT_C TBool | ContactDatabaseExistsL | ( | const TDesC & | aFileName | ) | [static] |
const TDesC & aFileName |
IMPORT_C TContactItemId | ContactIdByGuidL | ( | const TDesC & | aGuid | ) |
const TDesC & aGuid |
IMPORT_C TBool | ContactMatchesHintFieldL | ( | TInt | aBitWiseFilter, |
TContactItemId | aContactId | |||
) |
TInt aBitWiseFilter | |
TContactItemId aContactId |
TInt | ContactPosL | ( | TContactItemId | aContactId | ) | [private] |
TContactItemId aContactId |
IMPORT_C CContactIdArray * | ContactsChangedSinceL | ( | const TTime & | aTime | ) |
const TTime & aTime |
CContactConverter & | ConverterL | ( | const TUid & | aFormat | ) | [private] |
const TUid & aFormat |
CContactConverter & | ConverterL | ( | const TUid & | aFormat, |
const TInt64 | aContactFieldFilter, | |||
MConverterCallBack * | aCallback, | |||
const TVCardVersion | aVersion, | |||
const TBool | aExportTel | |||
) | [private] |
const TUid & aFormat | |
const TInt64 aContactFieldFilter | |
MConverterCallBack * aCallback | |
const TVCardVersion aVersion | |
const TBool aExportTel |
IMPORT_C CContactItem * | CreateContactCardTemplateL | ( | const TDesC & | aTemplateLabel, |
TBool | aInTransaction = EFalse | |||
) |
IMPORT_C CContactItem * | CreateContactCardTemplateL | ( | const CContactItem * | aTemplate, |
const TDesC & | aTemplateLabel, | |||
TBool | aInTransaction = EFalse | |||
) |
const CContactItem * aTemplate | |
const TDesC & aTemplateLabel | |
TBool aInTransaction = EFalse |
IMPORT_C CContactItem * | CreateContactCardTemplateLC | ( | const TDesC & | aTemplateLabel, |
TBool | aInTransaction = EFalse | |||
) |
IMPORT_C CContactItem * | CreateContactCardTemplateLC | ( | const CContactItem * | aTemplate, |
const TDesC & | aTemplateLabel, | |||
TBool | aInTransaction = EFalse | |||
) |
const CContactItem * aTemplate | |
const TDesC & aTemplateLabel | |
TBool aInTransaction = EFalse |
IMPORT_C CContactItem * | CreateContactGroupL | ( | TBool | aInTransaction = EFalse | ) |
TBool aInTransaction = EFalse |
IMPORT_C CContactItem * | CreateContactGroupL | ( | const TDesC & | aGroupLabel, |
TBool | aInTransaction = EFalse | |||
) |
IMPORT_C CContactItem * | CreateContactGroupLC | ( | TBool | aInTransaction = EFalse | ) |
TBool aInTransaction = EFalse |
IMPORT_C CContactItem * | CreateContactGroupLC | ( | const TDesC & | aGroupLabel, |
TBool | aInTransaction = EFalse | |||
) |
IMPORT_C CContactDatabase * | CreateL | ( | TThreadAccess | aAccess = ESingleThread | ) | [static] |
TThreadAccess aAccess = ESingleThread |
IMPORT_C CContactDatabase * | CreateL | ( | const TDesC & | aFileName, |
TThreadAccess | aAccess = ESingleThread | |||
) | [static] |
const TDesC & aFileName | |
TThreadAccess aAccess = ESingleThread |
IMPORT_C void | DatabaseBeginL | ( | TBool | aIsInTransaction | ) |
TBool aIsInTransaction |
IMPORT_C void | DatabaseBeginLC | ( | TBool | aIsInTransaction | ) |
TBool aIsInTransaction |
IMPORT_C void | DatabaseCommitL | ( | TBool | aIsInTransaction | ) |
TBool aIsInTransaction |
IMPORT_C void | DatabaseCommitLP | ( | TBool | aIsInTransaction | ) |
TBool aIsInTransaction |
IMPORT_C TBool | DatabaseDrive | ( | TDriveUnit & | aDriveUnit | ) | [static] |
TDriveUnit & aDriveUnit |
IMPORT_C void | DeleteContactL | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
void | DeleteContactSendEventActionL | ( | TContactItemId | aContactId, |
TCntSendEventAction | aActionType | |||
) | [private] |
TContactItemId aContactId | |
TCntSendEventAction aActionType |
IMPORT_C void | DeleteContactsL | ( | const CContactIdArray & | aContactIds | ) |
const CContactIdArray & aContactIds |
IMPORT_C void | DeleteDatabaseL | ( | const TDesC & | aFileName | ) | [static] |
const TDesC & aFileName |
TInt | DoGotoL | ( | TContactItemId | aContactId | ) | [private] |
TContactItemId aContactId |
void | DoReadContactTextDefL | ( | const CContactItemFieldSet * | aFieldSet, |
TDes & | aResult, | |||
CContactTextDef * | aTextDef | |||
) | [private] |
const CContactItemFieldSet * aFieldSet | |
TDes & aResult | |
CContactTextDef * aTextDef |
IMPORT_C void | ExportSelectedContactsL | ( | const TUid & | aFormat, |
const CContactIdArray & | aSelectedContactIds, | |||
RWriteStream & | aWriteStream, | |||
TInt | aOption, | |||
TBool | aExportPrivateFields = ETrue | |||
) |
const TUid & aFormat | |
const CContactIdArray & aSelectedContactIds | |
RWriteStream & aWriteStream | |
TInt aOption | |
TBool aExportPrivateFields = ETrue |
IMPORT_C void | ExportSelectedContactsL | ( | const TUid & | aFormat, |
const CContactIdArray & | aSelectedContactIds, | |||
RWriteStream & | aWriteStream, | |||
TInt | aOption, | |||
const Versit::TVersitCharSet | aCharSet, | |||
TBool | aExportPrivateFields = ETrue | |||
) |
const TUid & aFormat | |
const CContactIdArray & aSelectedContactIds | |
RWriteStream & aWriteStream | |
TInt aOption | |
const Versit::TVersitCharSet aCharSet | |
TBool aExportPrivateFields = ETrue |
IMPORT_C void | ExportSelectedContactsL | ( | 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 | |||
) |
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 |
IMPORT_C void | FilterDatabaseL | ( | CCntFilter & | aFilter | ) |
CCntFilter & aFilter |
IMPORT_C CIdleFinder * | FindAsyncL | ( | const TDesC & | aText, |
const CContactItemFieldDef * | aFieldDef, | |||
MIdleFindObserver * | aObserver | |||
) |
const TDesC & aText | |
const CContactItemFieldDef * aFieldDef | |
MIdleFindObserver * aObserver |
IMPORT_C CIdleFinder * | FindInTextDefAsyncL | ( | const MDesCArray & | aFindWords, |
MIdleFindObserver * | aObserver, | |||
const TCallBack & | aWordParserCallback | |||
) |
const MDesCArray & aFindWords | |
MIdleFindObserver * aObserver | |
const TCallBack & aWordParserCallback |
IMPORT_C CIdleFinder * | FindInTextDefAsyncL | ( | const MDesCArray & | aFindWords, |
const CContactTextDef * | aTextDef, | |||
MIdleFindObserver * | aObserver, | |||
const TCallBack & | aWordParserCallback | |||
) |
const MDesCArray & aFindWords | |
const CContactTextDef * aTextDef | |
MIdleFindObserver * aObserver | |
const TCallBack & aWordParserCallback |
IMPORT_C CContactIdArray * | FindInTextDefLC | ( | const MDesCArray & | aFindWords, |
const TCallBack & | aWordParserCallback | |||
) |
const MDesCArray & aFindWords | |
const TCallBack & aWordParserCallback |
IMPORT_C CContactIdArray * | FindInTextDefLC | ( | const MDesCArray & | aFindWords, |
CContactTextDef * | aTextDef, | |||
const TCallBack & | aWordParserCallback | |||
) |
const MDesCArray & aFindWords | |
CContactTextDef * aTextDef | |
const TCallBack & aWordParserCallback |
IMPORT_C CContactIdArray * | FindLC | ( | const TDesC & | aText, |
const CContactItemFieldDef * | aFieldDef | |||
) |
const TDesC & aText | |
const CContactItemFieldDef * aFieldDef |
IMPORT_C TInt | GetCurrentDatabase | ( | TDes & | aDatabase | ) | const |
TDes & aDatabase |
IMPORT_C void | GetLastSyncDateL | ( | TContactSyncId | aSyncId, |
TTime & | aSyncDate | |||
) |
TContactSyncId aSyncId | |
TTime & aSyncDate |
IMPORT_C TContactItemId | GetSpeedDialFieldL | ( | TInt | aSpeedDialPosition, |
TDes & | aPhoneNumber | |||
) |
TInt | GroupCount | ( | ) | const [inline] |
Gets the number of groups that exist in the database. The number of groups that exist in the database.
void | HandleDatabaseEventL | ( | RDbNotifier::TEvent | ) | [inline] |
RDbNotifier::TEvent |
IMPORT_C void | HandleDatabaseEventL | ( | const TContactDbObserverEvent & | aEvent | ) |
const TContactDbObserverEvent & aEvent |
void | HandleDbObserverEventGroupDeletedL | ( | const TContactItemId | aContactId | ) | [private] |
const TContactItemId aContactId |
void | HandleDbObserverEventGroupOrContactAddedL | ( | const TContactDbObserverEventType | aEventType, |
const TContactItemId | aContactId | |||
) | [private] |
const TContactDbObserverEventType aEventType | |
const TContactItemId aContactId |
void | HandleDbObserverEventGroupOrContactChangedL | ( | const TContactItemId | aContactId | ) | [private] |
const TContactItemId aContactId |
IMPORT_C TContactItemId | ICCTemplateIdL | ( | TUid | aPhonebookUid | ) |
TUid aPhonebookUid |
IMPORT_C CArrayPtr< CContactItem > * | ImportContactsL | ( | const TUid & | aFormat, |
RReadStream & | aReadStream, | |||
TBool & | aImportSuccessful, | |||
TInt | aOption | |||
) |
const TUid & aFormat | |
RReadStream & aReadStream | |
TBool & aImportSuccessful | |
TInt aOption |
void | InsertInSortArray | ( | const CContactItem & | aContact | ) | [private] |
const CContactItem & aContact |
void | InsertInSortArrayL | ( | const CContactItem & | aContact | ) | [private] |
const CContactItem & aContact |
IMPORT_C CDesCArray * | ListDatabasesL | ( | TDriveUnit | aDriveUnit | ) | [static] |
TDriveUnit aDriveUnit |
IMPORT_C TInt | LockServerCallBackL | ( | TUint | aServerOperation | ) |
TUint aServerOperation |
IMPORT_C CContactDatabase * | LockServerConnectL | ( | const TDesC & | aFileName | ) | [static] |
const TDesC & aFileName |
IMPORT_C CContactDatabase * | LockServerConnectL | ( | const TDesC & | aFileName, |
TInt | aOperation | |||
) | [static] |
IMPORT_C CContactIdArray * | MatchPhoneNumberL | ( | const TDesC & | aNumber, |
TInt | aMatchLengthFromRight | |||
) |
void | MoveInSortArray | ( | const CContactItem & | aContact | ) | [private] |
const CContactItem & aContact |
void | MoveInSortArrayL | ( | const CContactItem & | aContact | ) | [private] |
const CContactItem & aContact |
TInt | NewSortIndexL | ( | const CContactItem & | aContact, |
TInt | aStartPos, | |||
TInt | aEndPos | |||
) | [private] |
const CContactItem & aContact | |
TInt aStartPos | |
TInt aEndPos |
IMPORT_C CContactOpenOperation * | Open | ( | TRequestStatus & | aStatus, |
TThreadAccess | aAccess = ESingleThread | |||
) | [static] |
TRequestStatus & aStatus | |
TThreadAccess aAccess = ESingleThread |
IMPORT_C CContactOpenOperation * | Open | ( | const TDesC & | aFileName, |
TRequestStatus & | aStatus, | |||
TThreadAccess | aAccess = ESingleThread | |||
) | [static] |
const TDesC & aFileName | |
TRequestStatus & aStatus | |
TThreadAccess aAccess = ESingleThread |
IMPORT_C CContactItem * | OpenContactL | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C CContactItem * | OpenContactL | ( | TContactItemId | aContactId, |
const CContactItemViewDef & | aViewDef | |||
) |
TContactItemId aContactId | |
const CContactItemViewDef & aViewDef |
IMPORT_C CContactItem * | OpenContactLX | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C CContactItem * | OpenContactLX | ( | TContactItemId | aContactId, |
const CContactItemViewDef & | aViewDef | |||
) |
TContactItemId aContactId | |
const CContactItemViewDef & aViewDef |
void | OpenDatabaseAsyncL | ( | TRequestStatus & | aStatus, |
const TDesC & | aFileName = KNullDesC | |||
) |
TRequestStatus & aStatus | |
const TDesC & aFileName = KNullDesC |
IMPORT_C CContactDatabase * | OpenL | ( | TThreadAccess | aAccess = ESingleThread | ) | [static] |
TThreadAccess aAccess = ESingleThread |
IMPORT_C CContactDatabase * | OpenL | ( | const TDesC & | aFileName, |
TThreadAccess | aAccess = ESingleThread | |||
) | [static] |
const TDesC & aFileName | |
TThreadAccess aAccess = ESingleThread |
CContactItem * | OpenNoMergeLCX | ( | TContactItemId | aContactId | ) | [private] |
TContactItemId aContactId |
IMPORT_C void | OverrideMachineUniqueId | ( | TInt64 | aMachineUniqueId | ) |
TInt64 aMachineUniqueId |
IMPORT_C CArrayPtr< CContactItem > * | ReadContactAndAgentL | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C CContactItem * | ReadContactL | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C CContactItem * | ReadContactL | ( | TContactItemId | aContactId, |
const CContactItemViewDef & | aViewDef | |||
) |
TContactItemId aContactId | |
const CContactItemViewDef & aViewDef |
IMPORT_C CContactItem * | ReadContactLC | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C CContactItem * | ReadContactLC | ( | TContactItemId | aContactId, |
const CContactItemViewDef & | aViewDef | |||
) |
TContactItemId aContactId | |
const CContactItemViewDef & aViewDef |
IMPORT_C void | ReadContactTextDefL | ( | const CContactItem & | aItem, |
TDes & | aResult | |||
) |
const CContactItem & aItem | |
TDes & aResult |
IMPORT_C void | ReadContactTextDefL | ( | const CContactItem & | aItem, |
TDes & | aResult, | |||
CContactTextDef * | aTextDef | |||
) |
const CContactItem & aItem | |
TDes & aResult | |
CContactTextDef * aTextDef |
IMPORT_C void | ReadContactTextDefL | ( | TContactItemId | aContactId, |
TDes & | aResult | |||
) |
TContactItemId aContactId | |
TDes & aResult |
IMPORT_C void | ReadContactTextDefL | ( | TContactItemId | aContactId, |
TDes & | aResult, | |||
CContactTextDef * | aTextDef | |||
) |
TContactItemId aContactId | |
TDes & aResult | |
CContactTextDef * aTextDef |
IMPORT_C CContactItem * | ReadMinimalContactL | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C CContactItem * | ReadMinimalContactLC | ( | TContactItemId | aContactId | ) |
TContactItemId aContactId |
IMPORT_C void | RecreateSystemTemplateL | ( | const TDesC & | aFileName | ) | [static] |
const TDesC & aFileName |
IMPORT_C void | RemoveContactFromGroupL | ( | CContactItem & | aItem, |
CContactItem & | aGroup | |||
) |
CContactItem & aItem | |
CContactItem & aGroup |
IMPORT_C void | RemoveContactFromGroupL | ( | TContactItemId | aItemId, |
TContactItemId | aGroupId | |||
) |
TContactItemId aItemId | |
TContactItemId aGroupId |
void | RemoveFromGroupIds | ( | const TContactItemId | aContactId | ) | [private] |
const TContactItemId aContactId |
void | RemoveFromSortArray | ( | TContactItemId | aContactId | ) | [private] |
TContactItemId aContactId |
void | RemoveFromTemplateList | ( | const TContactItemId | aOldTemplateId | ) | [private] |
const TContactItemId aOldTemplateId |
void | RemoveObserver | ( | const MContactDbObserver & | aChangeNotifier | ) |
const MContactDbObserver & aChangeNotifier |
IMPORT_C void | RemoveSpeedDialFieldL | ( | TContactItemId | aContactId, |
TInt | aSpeedDialPosition | |||
) |
TContactItemId aContactId | |
TInt aSpeedDialPosition |
IMPORT_C CContactDatabase * | ReplaceL | ( | TThreadAccess | aAccess = ESingleThread | ) | [static] |
TThreadAccess aAccess = ESingleThread |
IMPORT_C CContactDatabase * | ReplaceL | ( | const TDesC & | aFileName, |
TThreadAccess | aAccess = ESingleThread | |||
) | [static] |
const TDesC & aFileName | |
TThreadAccess aAccess = ESingleThread |
void | RespondToEventL | ( | const TContactDbObserverEventType | aEventType, |
const TContactItemId | aContactId | |||
) | [private] |
const TContactDbObserverEventType aEventType | |
const TContactItemId aContactId |
IMPORT_C void | SetCntServerHeapFailure | ( | TInt | aTAllocFailType, |
TInt | aRate | |||
) |
IMPORT_C TInt | SetCurrentDatabase | ( | const TDesC & | aDatabase | ) | const |
const TDesC & aDatabase |
IMPORT_C void | SetCurrentItem | ( | const TContactItemId | aContactId | ) |
const TContactItemId aContactId |
IMPORT_C void | SetDatabaseDriveL | ( | TDriveUnit | aDriveUnit, |
TBool | aCopy = ETrue | |||
) | [static] |
TDriveUnit aDriveUnit | |
TBool aCopy = ETrue |
IMPORT_C void | SetDateFormatTextL | ( | const TDesC & | aFormat | ) |
const TDesC & aFormat |
void | SetDbConnectionState | ( | TDbConnState | aDbConnectionState | ) |
TDbConnState aDbConnectionState |
IMPORT_C void | SetDbViewContactType | ( | const TUid | aUid | ) |
const TUid aUid |
IMPORT_C void | SetFieldAsSpeedDialL | ( | CContactItem & | aItem, |
TInt | aFieldIndex, | |||
TInt | aSpeedDialPosition | |||
) |
CContactItem & aItem | |
TInt aFieldIndex | |
TInt aSpeedDialPosition |
IMPORT_C TContactSyncId | SetLastSyncDateL | ( | const TTime & | aSyncDate | ) |
const TTime & aSyncDate |
IMPORT_C void | SetLastSyncDateL | ( | TContactSyncId | aSyncId, |
const TTime & | aSyncDate | |||
) |
TContactSyncId aSyncId | |
const TTime & aSyncDate |
IMPORT_C void | SetOperationTimeOutL | ( | const TInt | aMicroSeconds | ) | const |
const TInt aMicroSeconds |
IMPORT_C void | SetOwnCardL | ( | const CContactItem & | aContact | ) |
const CContactItem & aContact |
IMPORT_C void | SetPrefTemplateL | ( | const CContactItem & | aContact | ) |
const CContactItem & aContact |
IMPORT_C void | SetSortedItemsList | ( | CContactIdArray * | aSortedItems, |
CArrayFix< TSortPref > * | aSortOrder | |||
) |
CContactIdArray * aSortedItems | |
CArrayFix< TSortPref > * aSortOrder |
IMPORT_C void | SetTextDefinitionL | ( | CContactTextDef * | aView | ) |
CContactTextDef * aView |
IMPORT_C void | SetViewDefinitionL | ( | CContactViewDef * | aView | ) |
CContactViewDef * aView |
IMPORT_C CContactIdArray * | SortArrayL | ( | const CContactIdArray * | aIdArray, |
const CArrayFix< TSortPref > * | aSortOrder | |||
) |
const CContactIdArray * aIdArray | |
const CArrayFix< TSortPref > * aSortOrder |
IMPORT_C CContactIdArray * | SortArrayLC | ( | const CContactIdArray * | aIdArray, |
const CArrayFix< TSortPref > * | aSortOrder | |||
) |
const CContactIdArray * aIdArray | |
const CArrayFix< TSortPref > * aSortOrder |
IMPORT_C void | SortAsyncL | ( | CArrayFix< TSortPref > * | aSortOrder, |
TRequestStatus & | aStatus | |||
) |
CArrayFix< TSortPref > * aSortOrder | |
TRequestStatus & aStatus |
IMPORT_C void | SortAsyncL | ( | CArrayFix< TSortPref > * | aSortOrder, |
TRequestStatus & | aStatus, | |||
MContactSortObserver & | aObserver | |||
) |
CArrayFix< TSortPref > * aSortOrder | |
TRequestStatus & aStatus | |
MContactSortObserver & aObserver |
void | SortDuplicatesL | ( | const CArrayFix< TSortPref > & | aSortOrder, |
CSortArray & | aList, | |||
TInt | aPos | |||
) | [private] |
void | SortDuplicatesL | ( | const CArrayFix< TSortPref > & | aSortOrder, |
CSortArray & | aList, | |||
TInt | aIndex, | |||
TInt | aStartPos, | |||
TInt | aEndPos | |||
) | [private] |
CContactIdArray * | SortLC | ( | const CArrayFix< TSortPref > * | aSortOrder, |
const CContactIdArray * | aIdArray | |||
) | [private] |
const CArrayFix< TSortPref > * aSortOrder | |
const CContactIdArray * aIdArray |
TUid | SpeedDialFieldUidFromSpeedDialPosition | ( | TInt | aSpeedDialPosition | ) | [static] |
TInt aSpeedDialPosition |
TBool | SystemTemplateFieldsValid | ( | const CContactItem & | aContact | ) | [private] |
const CContactItem & aContact |
IMPORT_C const CContentType & | TemplateContentType | ( | const CContactItemField & | aField | ) | const |
const CContactItemField & aField |
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.
IMPORT_C CContactItem * | UpdateContactLC | ( | TContactItemId | aContactId, |
CContactItem * | aNewContact | |||
) |
TContactItemId aContactId | |
CContactItem * aNewContact |
void | ValidateDatabaseNameL | ( | const TParse & | aParseName | ) | [private, static] |
const TParse & aParseName |
IMPORT_C TContactItemId | doAddNewContactL | ( | CContactItem & | aContact, |
TBool | aIsTemplate, | |||
TBool | aIsInTransaction | |||
) |
CContactItem & aContact | |
TBool aIsTemplate | |
TBool aIsInTransaction |
IMPORT_C void | doCommitContactL | ( | const CContactItem & | aContact, |
TBool | aIsInTransaction, | |||
TBool | aSendChangedEvent | |||
) |
const CContactItem & aContact | |
TBool aIsInTransaction | |
TBool aSendChangedEvent |
CContactItem * | doCreateContactGroupLC | ( | const TDesC & | aGroupLabel = KNullDesC | ) | [private] |
IMPORT_C void | doDeleteContactL | ( | TContactItemId | aContactId, |
TBool | aIsInTransaction, | |||
TBool | aSendChangedEvent, | |||
TBool | aDecAccessCount = EFalse | |||
) |
TContactItemId aContactId | |
TBool aIsInTransaction | |
TBool aSendChangedEvent | |
TBool aDecAccessCount = EFalse |
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.
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. |
State of database connection
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. |
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.
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. |
ENoOrder | |
EUsesIdentityTableOnly | |
EUsesAllTables | |
EIdentityTableNotUsed |
ESvrSessionPersistent | |
ESvrSessionTemporary | |
ESvrSessionFromLockServer |
Specifies whether the database can be accessed from single or multiple threads.
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. |
typedef TBuf< KTextFieldMinimalLength > | TTextFieldMinimal |
A text buffer of KTextFieldMinimalLength used during sorting and searching of contacts