#include <app/cntdb.h>
| class CContactDatabase : public CBase |
| Public Member Type Definitions | |
|---|---|
| typedef | TBuf< KTextFieldMinimalLength > TTextFieldMinimal |
| Public Member Enumerations | |
|---|---|
| enum | TContactViewFilter { EUnfiltered, EMailable, ESmsable, ELandLine, ..., ECustomFilter4 } |
| enum | TDbConnState { EDbConnectionOpen, EDbConnectionNotReady, EDbConnectionFailed, EDbConnectionRecoverRequired, ..., EDbConnectionNeedToCloseForRestore } |
| enum | TDirection { EAsc, EDesc } |
| enum | TOptions { EDefault, EIncludeX, ETTFormat, EExcludeUid, ..., EConverterReserved16 } |
| enum | TSortDataSource { ENoOrder, EUsesIdentityTableOnly, EUsesAllTables, EIdentityTableNotUsed } |
| enum | TThreadAccess { ESingleThread, EMultiThread } |
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()
| typedef TBuf< KTextFieldMinimalLength > | TTextFieldMinimal |
A text buffer of KTextFieldMinimalLength used during sorting and searching of contacts
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.
State of database connection
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.
DeprecatedThis 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.
| IMPORT_C | ~CContactDatabase | ( | ) |
Frees all resources owned by the contact database, prior to its destruction.
| IMPORT_C void | AddContactToGroupL | ( | TContactItemId | aItemId, |
| TContactItemId | aGroupId | |||
| ) | ||||
Sets a contact item in the database to be a member of a contact group.
The item and group are identified by their IDs.
| Parameter | Description |
|---|---|
| aItemId | The ID of the item to add to the group. |
| aGroupId | The ID of the group to which the item should be added. |
| IMPORT_C void | AddContactToGroupL | ( | CContactItem & | aItem, |
| CContactItem & | aGroup | |||
| ) | ||||
Sets a contact item in the database to be a member of a contact group.
| Parameter | Description |
|---|---|
| aItem | The item to add to the group. |
| aGroup | The group to which the item should be added. |
| IMPORT_C void | AddContactToGroupL | ( | TContactItemId | aItemId, |
| TContactItemId | aGroupId, | |||
| TBool | aInTransaction | |||
| ) | ||||
Sets a contact item in the database to be a member of a contact group.
The item and group are identified by their IDs.
| Parameter | Description |
|---|---|
| aItemId | The ID of the item to add to the group. |
| aGroupId | The ID of the group to which the item should be added. |
| aInTransaction | This argument should be ignored by developers. |
| IMPORT_C TContactItemId | AddNewContactL | ( | CContactItem & | aContact | ) |
Adds a new contact item to the database and returns its ID.
| Parameter | Description |
|---|---|
| aContact | The contact item to add to the database. |
Returns: The ID of the new contact item.
| IMPORT_C CContactItemViewDef * | AllFieldsView | ( | ) |
Returns the full view definition, that loads every field, the returned pointer is owned by the CContactDatabase object.
Returns: The definition for a full view with all the contact item fields.
| IMPORT_C void | CancelAsyncSort | ( | ) |
Cancel the CCntIdleSorter object and clean up resources.
| IMPORT_C void | CloseContactL | ( | TContactItemId | aContactId | ) |
Closes the contact item, allowing other applications to access it. Specifying a contact item that is not open, or cannot be found, is harmless. This function does not commit any changes made to the item. Despite the trailing L in the function's name, this function cannot leave.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact to close. |
| IMPORT_C void | CloseTables | ( | ) |
This method is no longer required and should not be called.
Closes all database tables. After a rollback and recover all tables need to be closed and re-opened before the database can be accessed again.
| IMPORT_C TInt | CntServerResourceCount | ( | ) |
Debug only.
Returns: return the heap size usage of the server in debug mode, 0 in release mode.
| IMPORT_C void | CommitContactL | ( | const CContactItem & | aContact | ) |
Overwrites a contact item with the values contained in aContact. The contact item is also closed by this call.
| Parameter | Description |
|---|---|
| aContact | Contains the new values for the contact item. |
| IMPORT_C void | CompactL | ( | ) |
This function does nothing and has been deprecated.
| IMPORT_C TBool | CompressRequired | ( | ) |
This function is deprecated. It always returns EFalse.
Returns: EFalse
| IMPORT_C TUint | ConnectionId | ( | ) | const |
Gets the ID of the connection to the Contacts server.
This can be compared with the connection IDs of incoming messages to identify which connection generated the message.
Returns: The ID of the connection to the Contacts server.
A method to determine if a named contact database exists.
If the file is found, it is tested for the correct UIDs.
In v8.1, contact databases can be located in any directory on any writeable drive, and the format of the filename must include an absolute directory path such as c:\system\data\contacts.cdb.
From v9.0 onwards, contact databases can only be located in the correct data caged subdirectory. The filenames must have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
See also: CContactDatabase::DefaultContactDatabaseExistsL() CContactDatabase::ListDatabasesL()
| Parameter | Description |
|---|---|
| aFileName | The contact database to search for. |
Returns: ETrue if the file is found, EFalse otherwise.
| IMPORT_C TContactItemId | ContactIdByGuidL | ( | const TDesC & | aGuid | ) |
Searches the contact tables for the contact described by aGuid.
| Parameter | Description |
|---|---|
| aGuid | Describes the contact item to be found. |
Returns: The unique id of the contact item within the database.
| IMPORT_C TBool | ContactMatchesHintFieldL | ( | TInt | aBitWiseFilter, |
| TContactItemId | aContactId | |||
| ) | ||||
Tests whether a contact item's hint bit field matches a filter.
For a match to occur, the item must be of the correct type for inclusion in the database (as returned by GetDbViewContactType()) and its hint bit field (which indicates whether the item contains a work or home telephone number, fax number or email address) must match the filter, according to the rules described in TContactViewFilter.
| Parameter | Description |
|---|---|
| aBitWiseFilter | The filter to compare the item against. This is a combination of TContactViewFilter values. |
| aContactId | The ID of the item in the database. |
Returns: ETrue if the item is of the correct type for inclusion in the database, and its hint bit field matches the specified filter, EFalse if either of these conditions are not met.
| IMPORT_C CContactIdArray * | ContactsChangedSinceL | ( | const TTime & | aTime | ) |
Gets an array of contacts modified since the specified date/time. The array includes those contacts that have changed since the beginning of the specified micro-second. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aTime | The date/time of interest. |
Returns: Pointer to the array of contacts modified since the specified time.
| IMPORT_C TInt | CountL | ( | ) |
Gets the number of CContactItems in the database. The count includes non-system template items. It does not include items marked as deleted.
Returns: The number of contact items in the database.
| IMPORT_C CContactActiveCompress * | CreateCompressorLC | ( | ) |
This function is deprecated. It returns an object whose functions do nothing.
Returns: Pointer to an active compressor.
| IMPORT_C CContactItem * | CreateContactCardTemplateL | ( | const TDesC & | aTemplateLabel, |
| TBool | aInTransaction = EFalse | |||
| ) | ||||
Creates a contact card template based on the system template and adds it to the database.
A template label must be specifed. This can be changed later using CContactCardTemplate::SetTemplateLabelL().
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aTemplateLabel | The string to set as the template label. |
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the contact card template.
| IMPORT_C CContactItem * | CreateContactCardTemplateL | ( | const CContactItem * | aTemplate, |
| const TDesC & | aTemplateLabel, | |||
| TBool | aInTransaction = EFalse | |||
| ) | ||||
Creates a contact card template and adds it to the database.
The new template's field set is based on the specified contact item. This could be a contact card, an own card, another template or even a group. Note that no field data is copied into the new template. All of the new template's fields are marked as template fields.
A template label must be specifed. This can be changed later using CContactCardTemplate::SetTemplateLabelL().
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aTemplate | Pointer to an instance of a CContactItem-derived class. This is used to initialise the new template's field set. |
| aTemplateLabel | The string to set as the template label. |
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the contact card template.
| IMPORT_C CContactItem * | CreateContactCardTemplateLC | ( | const TDesC & | aTemplateLabel, |
| TBool | aInTransaction = EFalse | |||
| ) | ||||
Creates a contact card template based on the system template and adds it to the database.
A template label must be specifed. This can be changed later using CContactCardTemplate::SetTemplateLabelL().
The pointer to the template is left on the cleanup stack. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aTemplateLabel | The string to set as the template label. |
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the contact card template.
| IMPORT_C CContactItem * | CreateContactCardTemplateLC | ( | const CContactItem * | aTemplate, |
| const TDesC & | aTemplateLabel, | |||
| TBool | aInTransaction = EFalse | |||
| ) | ||||
Creates a contact card template and adds it to the database.
The new template's field set is based on the specified contact item. This could be a contact card, an own card, another template or even a group. Note that no field data is copied into the new template. All of the new template's fields are marked as template fields.
A template label must be specifed. This can be changed later using CContactCardTemplate::SetTemplateLabelL().
The pointer to the object is left on the cleanup stack. The caller takes ownership of it.
| Parameter | Description |
|---|---|
| aTemplate | Pointer to an instance of a CContactItem-derived class. This is used to initialise the new template's field set. |
| aTemplateLabel | The string to set as the template label. |
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the contact card template.
| IMPORT_C CContactItem * | CreateContactGroupL | ( | TBool | aInTransaction = EFalse | ) |
Creates a new contact group with a default label of 'Group Label' and adds it to the database.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the newly created contact group.
| IMPORT_C CContactItem * | CreateContactGroupL | ( | const TDesC & | aGroupLabel, |
| TBool | aInTransaction = EFalse | |||
| ) | ||||
Creates a new contact group with a specified label and adds it to the database.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aGroupLabel | The string to set as the group label. |
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the newly created contact group.
| IMPORT_C CContactItem * | CreateContactGroupLC | ( | TBool | aInTransaction = EFalse | ) |
Creates a new contact group with a default label of 'Group Label' and adds it to the database.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the newly created contact group.
| IMPORT_C CContactItem * | CreateContactGroupLC | ( | const TDesC & | aGroupLabel, |
| TBool | aInTransaction = EFalse | |||
| ) | ||||
Creates a new contact group with a specified label and adds it to the database.
The pointer to the group is left on the cleanup stack. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aGroupLabel | The string to set as the group label. |
| aInTransaction | This argument should be ignored by developers. |
Returns: Pointer to the newly created contact group.
| IMPORT_C CContactDatabase * | CreateL | ( | TThreadAccess | aAccess = ESingleThread | ) | [static] |
Creates and opens an empty contact database using the default database name.
| Parameter | Description |
|---|---|
| aAccess | The default (ESingleThread) allows access to the session with the database server from a single client thread only (as in v5 and v5.1). EMultiThread allows multiple client threads to share the same session with the server. As multi-threaded programs are uncommon in Symbian OS, this argument can be ignored by most C++ developers |
Returns: A pointer to the new contact database.
| IMPORT_C CContactDatabase * | CreateL | ( | const TDesC & | aFileName, |
| TThreadAccess | aAccess = ESingleThread | |||
| ) | [static] | |||
Creates and opens a named contact database.
From v9.0 onwards, contact databases can only be located in the correct data caged subdirectory. The filenames must have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
| Parameter | Description |
|---|---|
| aFileName | The filename of the database to create. |
| aAccess | The default (ESingleThread) allows access to the session with the database server from a single client thread only (as in v5 and v5.1). EMultiThread allows multiple client threads to share the same session with the server. As multi-threaded programs are uncommon in Symbian OS, this argument can be ignored by most C++ developers |
Returns: A pointer to the new contact database.
| IMPORT_C CContactItem * | CreateOwnCardL | ( | ) |
Creates a default own card based on the system template and adds it to the database. This is set as the database's current own card, replacing any existing current own card. The caller takes ownership of the returned object.
Returns: Pointer to the new default own card.
| IMPORT_C CContactItem * | CreateOwnCardLC | ( | ) |
Creates a default own card based on the system template and adds it to the database. This is set as the database's current own card, replacing any existing current own card. The caller takes ownership of the returned object.
Returns: Pointer to the new default own card. The pointer is left on the cleanup stack.
| IMPORT_C CContactActiveRecover * | CreateRecoverLC | ( | ) |
This function is deprecated. It returns an object whose functions do nothing.
Returns: Pointer to an active recoverer.
| IMPORT_C void | DamageDatabaseL | ( | TInt | aSecretCode | ) |
Debug Only
| IMPORT_C void | DatabaseBeginL | ( | TBool | aIsInTransaction | ) |
Starts a new transaction, without placing a cleanup item to rollback the database onto the cleanupstack. This is to enable clients to call contacts methods from an active object.
| Parameter | Description |
|---|---|
| aIsInTransaction | ETrue if transaction already started |
| IMPORT_C void | DatabaseBeginLC | ( | TBool | aIsInTransaction | ) |
Starts a new transaction. Places and leaves a cleanup item to rollback the database on the cleanupstack.
| Parameter | Description |
|---|---|
| aIsInTransaction | Used to determine whether or not to start the transaction depending on if a transaction is currently in progress. |
| IMPORT_C void | DatabaseCommitL | ( | TBool | aIsInTransaction | ) |
Commits an existing transaction, without popping a cleanup item.
| Parameter | Description |
|---|---|
| aIsInTransaction | ETrue if transaction already started |
| IMPORT_C void | DatabaseCommitLP | ( | TBool | aIsInTransaction | ) |
Commits an existing transaction, pops the rollback cleanup item off the CleanupStack. Closes the database if the connection state is EDbConnectionNeedToCloseForRestore.
| Parameter | Description |
|---|---|
| aIsInTransaction | Used to determine whether or not to commit the transaction depending on whether a transaction is currently in progress. |
| IMPORT_C TBool | DatabaseDrive | ( | TDriveUnit & | aDriveUnit | ) | [static] |
Gets the current database drive. The database drive is the drive on which the default contact database is located. Note: this function can leave.
See also: CContactDatabase::SetDatabaseDrive() CContactDatabase::GetDefaultNameL()
| Parameter | Description |
|---|---|
| aDriveUnit | On return, contains the database drive. |
Returns: ETrue if the database drive has been set using SetDatabaseDriveL(). Otherwise EFalse and in this case, the function returns drive c: in aDriveUnit as the current drive.
| IMPORT_C void | DatabaseRollback | ( | ) |
Force a rollback of the database.
| IMPORT_C TBool | DefaultContactDatabaseExistsL | ( | ) | [static] |
A static method to determine if the default contact database exists.
It searches the drive set by SetDatabaseDriveL(), or if no drive has been set, it searches drive c:.
If the file is found, it is tested for the correct UIDs.
Returns: ETrue if the file is found, EFalse otherwise.
| IMPORT_C void | DeleteContactL | ( | TContactItemId | aContactId | ) |
Deletes a contact item.
Note: if the contact's access count is greater than zero, the contact is not fully deleted from the database. A 'skeleton' of the contact is left, containing only basic information, and no field data. The skeleton contact can still be accessed if a record of its contact ID has been retained (or call DeletedContactsLC()). The skeleton is removed when the access count is zero.
| Parameter | Description |
|---|---|
| aContactId | The contact item ID of the contact to delete. |
| IMPORT_C void | DeleteContactsL | ( | const CContactIdArray & | aContactIds | ) |
Deletes an array of contacts.
The function commits the changes for every 32 (for 9.5 onwards it commits after every 50) contacts deleted, and compresses the database as required. A changed message is not sent for every contact deleted, instead a single unknown change event message (EContactDbObserverEventUnknownChanges) is sent after all the contacts have been deleted and the changes committed.
| Parameter | Description |
|---|---|
| aContactIds | An array of contacts to delete. |
| IMPORT_C void | DeleteDatabaseL | ( | const TDesC & | aFileName | ) | [static] |
A static method to delete a named contact database.
If the file is found, it is tested for the correct UIDs.
In v8.1, contact databases can be located in any directory on any writeable drive, and the format of the filename must include an absolute directory path such as c:\system\data\contacts.cdb.
From v9.0 onwards, contact databases can only be located in the correct data caged subdirectory. The filenames must have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
See also: CContactDatabase::DeleteDefaultFileL()
| Parameter | Description |
|---|---|
| aFileName | The contact database file to delete. |
| IMPORT_C void | DeleteDefaultFileL | ( | ) | [static] |
Deletes the default contact database.
See also: CContactDatabase::DeleteDatabaseL() CContactDatabase::GetDefaultNameL() CContactDatabase::DefaultContactDatabaseExistsL()
| IMPORT_C CContactIdArray * | DeletedContactsLC | ( | ) |
Gets an array of IDs for contact items that still exist in the database, but are marked as deleted. These are contact items which have been deleted, but which have a non-zero access count. The caller takes ownership of the returned object.
Debug only.
Returns: Pointer to the array of contacts marked as deleted.
| IMPORT_C void | ExportSelectedContactsL | ( | const TUid & | aFormat, |
| const CContactIdArray & | aSelectedContactIds, | |||
| RWriteStream & | aWriteStream, | |||
| TInt | aOption, | |||
| TBool | aExportPrivateFields = ETrue | |||
| ) | ||||
Converts an array of contact items to vCards and exports them to a write stream.
The default character set CVersitParser::EUTF8CharSet is used to convert into. If you need a different character set, use the other overload of this function.
| Parameter | Description |
|---|---|
| aFormat | Indicates the format for imported and exported contacts. Must have a value of KUidVCardConvDefaultImpl. |
| aSelectedContactIds | Array of contact IDs to export. |
| aWriteStream | The stream to write to. |
| aOption | Indicates the options for import and export. See the TOptions enum. |
| aExportPrivateFields | ETrue exports fields marked as private. EFalse does not export fields marked as private. See CContactItemField::SetPrivate(). |
| IMPORT_C void | ExportSelectedContactsL | ( | const TUid & | aFormat, |
| const CContactIdArray & | aSelectedContactIds, | |||
| RWriteStream & | aWriteStream, | |||
| TInt | aOption, | |||
| const Versit::TVersitCharSet | aCharSet, | |||
| TBool | aExportPrivateFields = ETrue | |||
| ) | ||||
Converts an array of contact items to vCards and exports them to a write stream using the specified character set.
| Parameter | Description |
|---|---|
| aFormat | Indicates the format for imported and exported contacts. Must have a value of KUidVCardConvDefaultImpl. |
| aSelectedContactIds | Array of contact IDs to export. |
| aWriteStream | The stream to write to. |
| aOption | Indicates the options for import and export. See the TOptions enum. |
| aCharSet | The character set to convert into. |
| aExportPrivateFields | ETrue exports fields marked as private. EFalse does not export fields marked as private. See CContactItemField::SetPrivate(). |
| 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 | |||
| ) | ||||
Converts an array of contact items to PBAP compliant vCards following vCard2.1 and vCard3.0 specifications and exports them to a write stream using UTF-8 as the character set. It also provides support for exporting contacts as standard vCard2.1.
| Parameter | Description |
|---|---|
| aFormat | Indicates the format for imported and exported contacts. It should have a value of KUidPBAPVCardConvImpl if user wants to export contacts as PBAP specific vCards and KUidVCardConvDefaultImpl for standard vCard2.1. |
| aSelectedContactIds | Array of contact IDs to export. |
| aWriteStream | The stream to write to. |
| aOption | Indicates the options for import and export. See the TOptions enum. |
| aContactFieldFilter | 64-bit filter,specifies the contact fields to export, argument value not considered for standard vCard2.1 export. |
| aCallback | Calls client which has to implement class MConverterCallBack, used to add intra-contact properties, argument value not considered for standard vCard2.1 export. |
| aVersion | TVCardVersion specifies vCard version to which contacts should be exported. |
| aExportTel | If TEL property should be exported, it should be set to ETrue, argument value not considered for standard vCard2.1 export. |
| aCharSet | The character set to convert into.Must be UTF-8 for PBAP export, provided as default value. |
| aExportPrivateFields | ETrue exports fields marked as private. EFalse does not export fields marked as private. See CContactItemField::SetPrivate(). |
| IMPORT_C TInt | FileSize | ( | ) | const |
Gets the size of the database file in bytes.
Returns: The size of the contact database.
| IMPORT_C TPtrC | FileUid | ( | ) |
Gets the database's UID. This value is used to identify a particular contact database. The database UID is generated when the database is first created.
Note: This method can leave.
Returns: Descriptor containing the database UID.
| IMPORT_C void | FilterDatabaseL | ( | CCntFilter & | aFilter | ) |
Filters the database. On return, aFilter contains an array of filtered contact item IDs.
| Parameter | Description |
|---|---|
| aFilter | The filter to use. On return, contains a filtered array of contact item IDs. |
| IMPORT_C CIdleFinder * | FindAsyncL | ( | const TDesC & | aText, |
| const CContactItemFieldDef * | aFieldDef, | |||
| MIdleFindObserver * | aObserver | |||
| ) | ||||
Searches the database asynchronously for a text string. The function searches the fields contained in the field definition asynchronously using the MIdleFindObserver and CIdleFinder classes. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aText | The text to search for. |
| aFieldDef | Specifies the fields to search. |
| aObserver | Implements the callback function IdleFindCallback(). NULL if no observer is needed. |
Returns: A CIdle-derived object which provides information about the progress of the operation, and which can be used to retrieve an array of contact IDs.
| IMPORT_C CIdleFinder * | FindInTextDefAsyncL | ( | const MDesCArray & | aFindWords, |
| MIdleFindObserver * | aObserver, | |||
| const TCallBack & | aWordParserCallback | |||
| ) | ||||
| IMPORT_C CIdleFinder * | FindInTextDefAsyncL | ( | const MDesCArray & | aFindWords, |
| const CContactTextDef * | aTextDef, | |||
| MIdleFindObserver * | aObserver, | |||
| const TCallBack & | aWordParserCallback | |||
| ) | ||||
| IMPORT_C CContactIdArray * | FindInTextDefLC | ( | const MDesCArray & | aFindWords, |
| const TCallBack & | aWordParserCallback | |||
| ) | ||||
| IMPORT_C CContactIdArray * | FindInTextDefLC | ( | const MDesCArray & | aFindWords, |
| CContactTextDef * | aTextDef, | |||
| const TCallBack & | aWordParserCallback | |||
| ) | ||||
| IMPORT_C CContactIdArray * | FindLC | ( | const TDesC & | aText, |
| const CContactItemFieldDef * | aFieldDef | |||
| ) | ||||
Searches the database for a text string. The function searches the fields contained in the field definition. The caller takes ownership of the returned object. There is a limit of 255 characters on the search string length, due to the implementation of the DBMS API, which also has a search string length restriction of 255 chars. If the search string passed in is over 255 characters this method will leave with KErrArgument.
| Parameter | Description |
|---|---|
| aText | The text to search for. |
| aFieldDef | Specifies the fields to search. |
Returns: Array of contact IDs identifying the contact items which contain the specified text.
| IMPORT_C CContactIdArray * | GetCardTemplateIdListL | ( | ) | const |
Gets a copy of the database's template ID list. This is a list of the IDs of all contact card templates which have been added to the database. The caller takes ownership of the returned object.
Returns: Pointer to a copy of the database's template ID list. This does not include the system template. NULL if there are no templates in the database.
Where there are multiple contact databases on a device, this function can be used to enquire which database is the current one. The current database functions are provided as part of current item functionality. In order to pass a current item from one contacts model client to another, the receiving client needs to be using the same database.
The current database is a path and filename, set using SetCurrentDatabase() which is persisted by the contacts server.
| Parameter | Description |
|---|---|
| aDatabase | The path and filename of the current database. KNullDesC if no current database has been set. |
Returns: KErrNone if the function completed successfully, otherwise one of the standard error codes.
| IMPORT_C TContactItemId | GetCurrentItem | ( | ) | const |
Gets the ID of the current item, as set by SetCurrentItem(). The current item ID is initialised to KNullContactId when the database is opened.
Returns: The ID of the current item.
| IMPORT_C TUid | GetDbViewContactType | ( | ) | const |
Gets the type of contact items which are included in sorted views of the database, as set by SetDbViewContactType().
Returns: Specifies a contact type. One of the following: KUidContactCard (contact cards), KUidContactGroup (contact item groups), KUidContactOwnCard (own cards), KUidContactCardTemplate (templates which are not system, in other words, which have been added to the database), KUidContactItem (all of the above)
| IMPORT_C void | GetDefaultNameL | ( | TDes & | aDes | ) | [static] |
Gets the file name of the default contact database.
By default it is on drive C: but this can be changed using SetDatabaseDriveL().
See also: CContactDatabase::SetDatabaseDriveL() CContactDatabase::DatabaseDrive() CContactDatabase::DefaultContactDatabaseExistsL()
| Parameter | Description |
|---|---|
| aDes | On return, contains the drive and filename of the default contact database. From v9.0 onwards, this has the form driveletter:filename, in other words, it does not include a path. |
| IMPORT_C CContactIdArray * | GetGroupIdListL | ( | ) | const |
Returns a copy of the database's group ID list. This is a list which contains the contact item IDs for each group in the database. The caller takes ownership of the returned object.
Returns: Pointer to an array containing the contact item IDs for each group in the database. NULL if there are no groups in the database.
| IMPORT_C void | GetLastSyncDateL | ( | TContactSyncId | aSyncId, |
| TTime & | aSyncDate | |||
| ) | ||||
Gets the date/time the database was last synchronised with a particular sync ID, as set by SetLastSyncDateL().
| Parameter | Description |
|---|---|
| aSyncId | This argument should be ignored by developers. |
| aSyncDate | On return contains the date/time the database was last synchronised with the sync ID specified. |
| IMPORT_C TContactItemId | GetSpeedDialFieldL | ( | TInt | aSpeedDialPosition, |
| TDes & | aPhoneNumber | |||
| ) | ||||
Returns the ID of the contact item whose telephone number field is mapped to the speed dial position specified. This function is provided so that information may be displayed about a contact item whose telephone number is being dialled using speed dialling.
The function also retrieves the telephone number stored in the field.
| Parameter | Description |
|---|---|
| aSpeedDialPosition | The speed dial position. This is an integer in the range 1 to 9 inclusive. If outside this range, the function leaves with KErrArgument. |
| aPhoneNumber | On return, contains the telephone number which is mapped to the speed dial position specified. Returns KNullDesC if the speed dial position requested has not been set. |
Returns: The ID of the contact item for which the speed dial has been set.
| TInt | GroupCount | ( | ) | const [inline] |
Gets the number of groups that exist in the database. Deprecated
Returns: The number of groups that exist in the database.
| IMPORT_C void | HandleDatabaseEventL | ( | const TContactDbObserverEvent & | aEvent | ) |
Handle the Database event
| Parameter | Description |
|---|---|
| aEvent | Database change event |
| void | HandleDiskSpaceEvent | ( | TInt | aDrive | ) |
Default behaviour for handling a low disk event - This function is unimplemented.
| IMPORT_C TContactItemId | ICCTemplateIdL | ( | ) |
Returns the ID of the template that should be used with CContactICCEntry items.
Returns: A template ID.
| IMPORT_C TContactItemId | ICCTemplateIdL | ( | TUid | aPhonebookUid | ) |
Returns the ID of the template that should be used with CContactICCEntry items belonging to the phonebook with TUid aPhonebookUid.
| Parameter | Description |
|---|---|
| aPhonebookUid | The phonebook ID. |
Returns: A template ID.
| IMPORT_C CArrayPtr< CContactItem > * | ImportContactsL | ( | const TUid & | aFormat, |
| RReadStream & | aReadStream, | |||
| TBool & | aImportSuccessful, | |||
| TInt | aOption | |||
| ) | ||||
Imports one or more vCards from a read stream. The vCards are converted into contact items, and added to the database. If at least one contact item was successfully imported, aImportSuccessful is set to ETrue. If EImportSingleContact is specified in aOption, the read stream marker is left at the next position, ready to read the next contact item. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aFormat | Indicates the format for imported and exported contacts. Its value must be KUidVCardConvDefaultImpl. |
| aReadStream | The stream to read from. |
| aImportSuccessful | On return, ETrue if at least one contact was successfully imported. EFalse if not. |
| aOption | Indicates the options for import and export. See the TOptions enum. |
Returns: The array of contact items imported.
| IMPORT_C TBool | IsDamaged | ( | ) | const |
This function is deprecated. It always returns EFalse.
Returns: EFalse
| IMPORT_C CDesCArray * | ListDatabasesL | ( | ) | [static] |
A static method to list the contact databases on all drives.
In v8.1, this function finds contact databases located anywhere on the drives, and the format of the returned filenames is c:\system\data\contacts.cdb.
From v9.0 onwards, this function finds contact databases only in the correct data caged subdirectory. The returned filenames have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
In either case, the filenames returned are in the correct format for Open(), OpenL(), CreateL(), ReplaceL() and DeleteDatabaseL().
Returns: An array containing zero or more contact database names.
| IMPORT_C CDesCArray * | ListDatabasesL | ( | TDriveUnit | aDriveUnit | ) | [static] |
A static method to list the contact databases on a specified drive.
In v8.1, this function finds contact databases located anywhere on the drive, and the format of the returned filenames is c:\system\data\contacts.cdb.
From v9.0 onwards, this function finds contact databases only in the correct data caged subdirectory. The returned filenames have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
In either case, the filenames returned are in the correct format for Open(), OpenL(), CreateL(), ReplaceL() and DeleteDatabaseL().
| Parameter | Description |
|---|---|
| aDriveUnit | The drive unit to search for contact databases. |
Returns: An array containing zero or more contact database names.
| IMPORT_C CContactDatabase * | LockServerConnectL | ( | const TDesC & | aFileName | ) | [static] |
For BC.
| IMPORT_C CContactDatabase * | LockServerConnectL | ( | const TDesC & | aFileName, |
| TInt | aOperation | |||
| ) | [static] | |||
For BC.
| IMPORT_C TInt64 | MachineId | ( | ) | const |
Returns a number unique to the contacts database. This value may be passed to CContactItem::UidStringL().
Returns: The database's unique ID.
| IMPORT_C CContactIdArray * | MatchPhoneNumberL | ( | const TDesC & | aNumber, |
| TInt | aMatchLengthFromRight | |||
| ) | ||||
Returns an array of contact item IDs for all the contact items which may contain the specified telephone number in a telephone, fax or SMS type field.
The comparison method used is not exact. The number is compared starting from the right side of the number and the method returns an array of candidate matches. Punctuation (eg. spaces) and other alphabetic characters are ignored when comparing.
Additionally, if the contacts model phone parser (CNTPHONE.DLL) is available, then any DTMF digits are also excluded from the comparision.
Notes: Due to the way numbers are stored in the database, it is recommended that at least 7 match digits are specified even when matching a number containing fewer digits. Failure to follow this guideline may (depending on the database contents) mean that the function will not return the expected Contacts Id set.
| Parameter | Description |
|---|---|
| aNumber | Phone number string. If the length of phone number string is greater than KCntMaxTextFieldLength then only the first KCntMaxTextFieldLength characters are used in the match. |
| aMatchLengthFromRight | Number of digits from the right of the phone number to use Up to 15 digits can be specified, and it is recommended that at least 7 match digits are specified. |
Returns: CContactIdArray of candidate matches
| IMPORT_C CContactOpenOperation * | Open | ( | TRequestStatus & | aStatus, |
| TThreadAccess | aAccess = ESingleThread | |||
| ) | [static] | |||
Opens the default contact database asynchronously.
The Contacts server is asked to prepare the database to be opened. This may include cleaning up incomplete writes from when the device was last switched off, or updating the database format.
If an error is encountered starting the asynchronous open the return value is NULL and the error is returned in the TRequestStatus parameter.
Errors from the asynchronous open include: KErrNotFound The database file was not found or it did not have the correct UIDs. KErrLocked The file is in use by another client. Other system wide error codes.
If the return value is not NULL the ownership of the CContactOpenOperation object is passed to the client. This may be deleted before the asynchronous open completes.
When the client supplied TRequestStatus is completed with KErrNone the TakeDatabase() method of CContactOpenOperation is called to pass ownership of the open database to the client.
See also: CContactOpenOperation
| Parameter | Description |
|---|---|
| aStatus | On return, the request status for the asynchronous phase request. The Open() action can fail with one of the system wide error codes. In this case, the CContactDatabase object cannot access the database and must be deleted. |
| aAccess | This argument should be ignored by developers. |
Returns: NULL if there is an error starting the asynhchronous open, otherwise a pointer to an active object that manages the open operation.
| IMPORT_C CContactOpenOperation * | Open | ( | const TDesC & | aFileName, |
| TRequestStatus & | aStatus, | |||
| TThreadAccess | aAccess = ESingleThread | |||
| ) | [static] | |||
Opens a named contact database asynchronously.
The Contacts server is asked to prepare the database to be opened. This may include cleaning up incomplete writes from when the device was last switched off, or updating the database format.
In v8.1, contact databases can be located in any directory on any writeable drive, and the format of the filename must include an absolute directory path such as c:\system\data\contacts.cdb.
From v9.0 onwards, contact databases can only be located in the correct data caged subdirectory. The filenames must have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
If an empty path is entered, it will be treated as a request to open the default contact database.
If an error is encountered starting the asynchronous open the return value is NULL and the error is returned in the TRequestStatus parameter.
Errors from the asynchronous open include: KErrNotFound The database file was not found or it did not have the correct UIDs. KErrLocked The file is in use by another client. KErrBadName The filename is invalid; for example it includes wildcard characters or the drive is missing. Other system wide error codes.
If the return value is not NULL the ownership of the CContactOpenOperation object is passed to the client. This may be deleted before the asynchronous open completes.
When the client supplied TRequestStatus is completed with KErrNone the TakeDatabase() method of CContactOpenOperation is called to pass ownership of the open database to the client.
See also: CContactOpenOperation
| Parameter | Description |
|---|---|
| aFileName | The filename of the database to open. |
| aStatus | On return, the request status for the asynchronous phase request. The Open() action can fail with one of the system wide error codes. In this case the CContactDatabase object cannot access the database and must be deleted. |
| aAccess | This argument should be ignored by developers. |
Returns: NULL if there is an error starting the asynhchronous open, otherwise a pointer to an active object that manages the open operation.
| IMPORT_C CContactItem * | OpenContactL | ( | TContactItemId | aContactId | ) |
Opens a contact item for editing.
The returned contact item is locked and left open until either CommitContactL() or CloseContactL() is called.
This function uses a view definition that loads every field. If you need to specify your own view definition use the other overload of this function.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to open. |
Returns: The open, locked contact.
| IMPORT_C CContactItem * | OpenContactL | ( | TContactItemId | aContactId, |
| const CContactItemViewDef & | aViewDef | |||
| ) | ||||
Opens a contact item for editing, leaving the lock record on the cleanup stack.
The returned item is locked and left open until either CommitContactL() or CloseContactL() is called.
This function uses the specified view definition. Note: Care should be taken when specifying a view definition because when committing the contact item any fields not loaded by the view definition are deleted from the item.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to open. |
| aViewDef | The view definition. |
Returns: The open, locked contact item.
| IMPORT_C CContactItem * | OpenContactLX | ( | TContactItemId | aContactId | ) |
Opens a contact item for editing using a specified view definition.
The returned contact item is locked and left open until either CommitContactL() or CloseContactL() is called.
Note: care should be taken when specifying a view definition because when committing the contact item, any fields not loaded by the view definition are deleted from the item.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to open. |
Returns: The open, locked contact.
| IMPORT_C CContactItem * | OpenContactLX | ( | TContactItemId | aContactId, |
| const CContactItemViewDef & | aViewDef | |||
| ) | ||||
Opens a contact item for editing, leaving the lock record on the cleanup stack.
The returned item is locked and left open until either CommitContactL() or CloseContactL() is called.
This function uses the specified view definition. Note: Care should be taken when specifying a view definition because when committing the contact item any fields not loaded by the view definition are deleted from the item.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to open. |
| aViewDef | The view definition. |
Returns: The open, locked contact item.
| void | OpenDatabaseAsyncL | ( | TRequestStatus & | aStatus, |
| const TDesC & | aFileName = KNullDesC | |||
| ) | ||||
| IMPORT_C CContactDatabase * | OpenL | ( | TThreadAccess | aAccess = ESingleThread | ) | [static] |
Opens the default contact database.
Note: clients should not assume any knowledge of the default database name or location because they may be changed in future releases.
| Parameter | Description |
|---|---|
| aAccess | The default (ESingleThread) allows access to the session with the database server from a single client thread only (as in v5 and v5.1). EMultiThread allows multiple client threads to share the same session with the server. As multi-threaded programs are uncommon in Symbian OS, this argument can be ignored by most C++ developers |
Returns: Pointer to the open contact database.
| IMPORT_C CContactDatabase * | OpenL | ( | const TDesC & | aFileName, |
| TThreadAccess | aAccess = ESingleThread | |||
| ) | [static] | |||
Opens a named contact database.
From v9.0 onwards, contact databases can only be located in the correct data caged subdirectory. The filenames must have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters, and empty string is not accepted.
| Parameter | Description |
|---|---|
| aFileName | The filename of the database to open. |
| aAccess | The default (ESingleThread) allows access to the session with the database server from a single client thread only (as in v5 and v5.1). EMultiThread allows multiple client threads to share the same session with the server. As multi-threaded programs are uncommon in Symbian OS, this argument can be ignored by most C++ developers |
Returns: A pointer to the open contact database.
| IMPORT_C void | OpenTablesL | ( | ) |
This method is no longer required and should not be called.
Opens all database tables. After a rollback and recover all tables need to be closed and re-opened before the database can be accessed again.
| IMPORT_C void | OverrideMachineUniqueId | ( | TInt64 | aMachineUniqueId | ) |
Debug only.
| Parameter | Description |
|---|---|
| aMachineUniqueId | The Machine ID to set. |
| IMPORT_C TContactItemId | OwnCardId | ( | ) | const |
Returns the ID of the database's current own card.
Having obtained this ID, the client may then open the own card in the same way as an ordinary contact card (using ReadContactL() or OpenContactL()).
Returns: The ID of the database's current own card. KNullContactId if the own card has been deleted or has not yet been set.
| IMPORT_C TContactItemId | PhonebookGroupIdL | ( | ) |
Returns the ID of the contacts model group which represents the ADN phonebook.
Returns: Group ID.
| IMPORT_C TContactItemId | PrefTemplateId | ( | ) | const |
Returns the ID of the database's preferred template, as set by SetPrefTemplateL(). KNullContactId if not set. The preferred template is for clients who may have multiple templates but want to identify one as preferred.
Returns: The ID of the database's current preferred template.
| IMPORT_C CArrayPtr< CContactItem > * | ReadContactAndAgentL | ( | TContactItemId | aContactId | ) |
Reads a contact item and an agent if the item has an agent field. The item and agent (if present) are returned in an array. The function uses the database's default view definition (as set by SetViewDefinitionL()). The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to read. |
Returns: Pointer to an array containing the contact item and agent, if present.
| IMPORT_C CContactItem * | ReadContactL | ( | TContactItemId | aContactId | ) |
Reads a contact item without locking it.
This function uses the default view definition (as set by SetViewDefinitionL()). The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to read. |
Returns: Pointer to the contact item.
| IMPORT_C CContactItem * | ReadContactL | ( | TContactItemId | aContactId, |
| const CContactItemViewDef & | aViewDef | |||
| ) | ||||
Reads a contact item without locking it.
This function uses the view definition specified. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to read. |
| aViewDef | The view definition to use. |
Returns: Pointer to the contact item.
| IMPORT_C CContactItem * | ReadContactLC | ( | TContactItemId | aContactId | ) |
Reads a contact item without locking it.
This function uses the default view definition (as set by SetViewDefinitionL()). The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to read. |
Returns: Pointer to the contact item. This is left on the cleanup stack.
| IMPORT_C CContactItem * | ReadContactLC | ( | TContactItemId | aContactId, |
| const CContactItemViewDef & | aViewDef | |||
| ) | ||||
Reads a contact item without locking it.
This function uses the view definition specified. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item to read. |
| aViewDef | The view definition to use. |
Returns: Pointer to the contact item. This is left on the cleanup stack.
| IMPORT_C void | ReadContactTextDefL | ( | const CContactItem & | aItem, |
| TDes & | aResult | |||
| ) | ||||
Reads text into a descriptor from a pre-loaded contact item.
This function uses the database's current text definition (as set using CContactDatabase::SetTextDefinitionL()).
| Parameter | Description |
|---|---|
| aItem | The contact item to read. |
| aResult | On return, contains the text read from the contact item aItem, using the database's current text definition. |
| IMPORT_C void | ReadContactTextDefL | ( | const CContactItem & | aItem, |
| TDes & | aResult, | |||
| CContactTextDef * | aTextDef | |||
| ) | ||||
Reads text into a descriptor from a pre-loaded contact item, using the specified text definition.
| Parameter | Description |
|---|---|
| aItem | The contact item to read. |
| aResult | On return, contains the text read from the contact item aItem, using the text definition specified in aTextDef. |
| aTextDef | The text definition to use. |
| IMPORT_C void | ReadContactTextDefL | ( | TContactItemId | aContactId, |
| TDes & | aResult | |||
| ) | ||||
Reads text from a contact item stored in the database into a descriptor.
This function uses the database's currently set text definition (as set using CContactDatabase::SetTextDefinitionL()).
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact to read. |
| aResult | On return, contains the text read from the contact item identified by aContactId, using the database's current text definition. |
| IMPORT_C void | ReadContactTextDefL | ( | TContactItemId | aContactId, |
| TDes & | aResult, | |||
| CContactTextDef * | aTextDef | |||
| ) | ||||
Reads text from a contact item stored in the database into a descriptor using the specified text definition.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact to read. |
| aResult | On return, contains the text read from the contact item identified by aContactId, using the text definition specified in aTextDef. |
| aTextDef | The text definition to use. |
| IMPORT_C CContactItem * | ReadMinimalContactL | ( | TContactItemId | aContactId | ) |
Reads a contact item (contact card, own card, template, or contact group), but does not read the group or template information.
This function is identical to the variant of ReadContactL() which uses the database's default view definition, except that this function does not read:
the list of group members and the group label (if the item is a CContactGroup)
the template label (if the item is a CContactCardTemplate)
the list of groups to which the item belongs, if any (not applicable to templates)
any fields inherited from a non-system template, if any (not applicable if the item is a CContactCardTemplate)
Notes:
This function is faster than the standard reading function (ReadContactL()), which needs to match the template fields and groups etc.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact to read. |
Returns: Pointer to the contact whose ID is aContactId.
| IMPORT_C CContactItem * | ReadMinimalContactLC | ( | TContactItemId | aContactId | ) |
Reads a contact item (contact card, own card, template, or contact group), but does not read the group or template information.
This function is identical to the variant of ReadContactLC() which uses the server's default view definition, except that this function does not read:
the list of group members and the group label (if the item is a CContactGroup)
the template label (if the item is a CContactCardTemplate)
the list of groups to which the item belongs, if any (not applicable to templates)
any fields inherited from a non-system template, if any (not applicable if the item is a CContactCardTemplate)
Notes:
This function is faster than the standard reading function (ReadContactLC()), which needs to match the template fields and groups etc.
The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact to read. |
Returns: Pointer to the contact whose ID is aContactId. The contact is left on the cleanup stack.
| IMPORT_C void | RecoverL | ( | ) |
Recovers the database from a rollback. It first closes all tables and then reopens them after the recover.
| IMPORT_C void | RecreateSystemTemplateL | ( | const TDesC & | aFileName | ) | [static] |
A static method to recreate the system template.
From v9.0 onwards, contact databases can only be located in the correct data caged subdirectory. The filenames must have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
| Parameter | Description |
|---|---|
| aFileName | The contact database filename. |
| IMPORT_C void | RemoveContactFromGroupL | ( | CContactItem & | aItem, |
| CContactItem & | aGroup | |||
| ) | ||||
Removes the association between a contact item and a group.
| Parameter | Description |
|---|---|
| aItem | The item to remove. |
| aGroup | The group from which the item should be removed. |
| IMPORT_C void | RemoveContactFromGroupL | ( | TContactItemId | aItemId, |
| TContactItemId | aGroupId | |||
| ) | ||||
Removes the association between a contact item and a group.
The item and group are identified by their IDs.
| Parameter | Description |
|---|---|
| aItemId | The ID of the item to remove. |
| aGroupId | The ID of the group from which the item should be removed. |
| void | RemoveObserver | ( | const MContactDbObserver & | aChangeNotifier | ) |
| IMPORT_C void | RemoveSpeedDialFieldL | ( | TContactItemId | aContactId, |
| TInt | aSpeedDialPosition | |||
| ) | ||||
Removes the mapping between a contact item field and a speed dial position.
Removes the KUidSpeedDialXxx UID from the field's content type, removes the field's speed dial attribute and commits the changes to the item.
| Parameter | Description |
|---|---|
| aContactId | The ID of the contact item containing the speed dial field. |
| aSpeedDialPosition | The speed dial position. This is an integer in the range 1 to 9 inclusive. If outside this range, the function leaves with KErrArgument. |
| IMPORT_C CContactDatabase * | ReplaceL | ( | TThreadAccess | aAccess = ESingleThread | ) | [static] |
Creates and opens an empty contact database, replacing the existing default database.
| Parameter | Description |
|---|---|
| aAccess | The default (ESingleThread) allows access to the session with the database server from a single client thread only (as in v5 and v5.1). EMultiThread allows multiple client threads to share the same session with the server. As multi-threaded programs are uncommon in Symbian OS, this argument can be ignored by most C++ developers |
Returns: Pointer to the new contact database.
| IMPORT_C CContactDatabase * | ReplaceL | ( | const TDesC & | aFileName, |
| TThreadAccess | aAccess = ESingleThread | |||
| ) | [static] | |||
Creates and opens an empty contact database, replacing any existing file with the same name.
From v9.0 onwards, contact databases can only be located in the correct data caged subdirectory. The filenames must have no path, for example c:contacts.cdb. The maximum length for the drive, filename and extension is 190 characters.
| Parameter | Description |
|---|---|
| aFileName | The filename of the database to replace. |
| aAccess | The default (ESingleThread) allows access to the session with the database server from a single client thread only (as in v5 and v5.1). EMultiThread allows multiple client threads to share the same session with the server. As multi-threaded programs are uncommon in Symbian OS, this argument can be ignored by most C++ developers |
Returns: A pointer to the new contact database.
| IMPORT_C void | ResetServerSpeedDialsL | ( | ) |
Requests that the server reset all its speed dials to a NULL state. Needed so that T_NOMACH works (since deleting the db no longer resets the speed dials)
Debug only.
| IMPORT_C void | RestoreSortOrderL | ( | ) |
This function is not currently supported. Deprecated
Where there are multiple contact databases on a device, this function can be used to set a database as the current one.
Note: this function simply updates a file name which is stored by the contacts server and its use is optional. It is provided as part of current item functionality. In order to pass a current item from one contacts model client to another, the receiving client needs to be using the same database.
| Parameter | Description |
|---|---|
| aDatabase | The path and filename of the current database. |
Returns: KErrNone if the function completed successfully, otherwise one of the standard error codes.
| IMPORT_C void | SetCurrentItem | ( | const TContactItemId | aContactId | ) |
Sets the ID of the current item and persists it in the database. The current item is provided for use by clients who want to identify one contact item in the database as the currently selected item.
| Parameter | Description |
|---|---|
| aContactId | The ID of the current item. |
| IMPORT_C void | SetDatabaseDriveL | ( | TDriveUnit | aDriveUnit, |
| TBool | aCopy = ETrue | |||
| ) | [static] | |||
Sets the contact database drive and optionally moves the default contact database from its current location to the new drive. This function guarantees an all or nothing operation. If the database is not successfully moved, the drive setting is not updated to reflect the change.
In v8.1 when copying the file is moved to \system\data on the specified drive, and if the destination file already exists it is replaced.
From v9.0 onwards the file copying goes to the correct data caged directory on the destination drive. If the destination file already exists the copy fails.
See also: CContactdatabase::DatabaseDrive() CContactDatabase::GetDefaultNameL() CContactDatabase::DefaultContactDatabaseExistsL()
| Parameter | Description |
|---|---|
| aDriveUnit | The drive to which to move the database. |
| aCopy | ETrue moves the existing file to the specified drive. Deletion of the source file will fail if it is in use. EFalse does not move the file. |
| IMPORT_C void | SetDateFormatTextL | ( | const TDesC & | aFormat | ) |
This function is not currently supported. Deprecated
| Parameter | Description |
|---|---|
| aFormat | This parameter should be ignored. |
| IMPORT_C void | SetDbViewContactType | ( | const TUid | aUid | ) |
Sets the type of contact items to be included in sorted views of the database.
See also SortL() and SortByTypeL().
This value is initialised to KUidContactItem when the database is opened. This means that all CContactItem-derived types (cards, non-system templates, groups, own cards) are included in database views.
| Parameter | Description |
|---|---|
| aUid | Specifies a contact type. One of the following: KUidContactCard (contact cards), KUidContactGroup (contact item groups), KUidContactOwnCard (own cards), KUidContactCardTemplate (templates which are not system templates, in other words, which have been added to the database), KUidContactItem (all of the above) |
| IMPORT_C void | SetFieldAsSpeedDialL | ( | CContactItem & | aItem, |
| TInt | aFieldIndex, | |||
| TInt | aSpeedDialPosition | |||
| ) | ||||
Sets a field containing a telephone number as a speed dial field. The field is identified by aFieldIndex within the contact item aItem. It is assigned a speed dial position between 1 and 9 inclusive.
The field's speed dial and user added attributes are set and the appropriate UID (KUidSpeedDialXxx) is added to the field's content type. The changes are committed to the database.
Notes:
If an item's telephone number field has already been assigned to position aSpeedDialPosition, that item is updated so that the speed dial attribute is removed from its field and the speed dial field type UID is removed from the field's content type, before the new speed dial field is set.
The speed dial attribute can be tested for using the CContactItemField::IsSpeedDial() function.
The contact item passed to this function (aItem) must have been obtained using one of the variants of CContactDatabase::OpenContactL(). This is because it is modified and committed to the database by this function - no further commits are necessary.
| Parameter | Description |
|---|---|
| aItem | The contact item containing the field to set as a speed dial field. |
| aFieldIndex | Index of a field in aItem's field set to set as a speed dial field. |
| aSpeedDialPosition | The speed dial position. This is an integer in the range 1 to 9 inclusive. If outside this range, the function leaves with KErrArgument. |
| IMPORT_C TContactSyncId | SetLastSyncDateL | ( | const TTime & | aSyncDate | ) |
Sets the date/time the database was last synchronised.
This overload sets the last synchronised date/time where the sync ID is not known, and returns the sync ID that was created (a sync ID identifies a machine with which the database has been synchronised).
| Parameter | Description |
|---|---|
| aSyncDate | The database's new last synchronised date/time. |
Returns: The sync ID created by the function.
| IMPORT_C void | SetLastSyncDateL | ( | TContactSyncId | aSyncId, |
| const TTime & | aSyncDate | |||
| ) | ||||
Sets the date/time the database was last synchronised.
This overload is for a known sync ID and updates the database's last synchronised date/time for that ID.
| Parameter | Description |
|---|---|
| aSyncId | This argument should be ignored by developers. |
| aSyncDate | The database's new last synchronised date/time. |
| IMPORT_C void | SetOperationTimeOutL | ( | const TInt | aMicroSeconds | ) | const |
Sets the time out of operations on the database server.
This API allows the behaviour of the Contacts Model to be tuned for scenarios where clients either expect to encounter or know they will encounter operations failing primarily due to the database being locked.
Not all clients will find they need to use this API. By default the operation timeout is 1 second.
The timeout only needs to be set once per session. Multiple clients using the same database can specify independent values for the operation timeout.
| Parameter | Description |
|---|---|
| aMicroSeconds | The operation timeout in microseconds. This timeout will only be applied to requests sent by clients of this database after this point in time. |
| IMPORT_C void | SetOwnCardL | ( | const CContactItem & | aContact | ) |
Sets an existing contact item to be the database's current own card.
| Parameter | Description |
|---|---|
| aContact | The contact item to set as the database's current own card. It must already exist in the database. It cannot be a group or a template. |
| IMPORT_C void | SetPrefTemplateL | ( | const CContactItem & | aContact | ) |
Sets the database's preferred template.
The preferred template's ID persists when the database is opened and closed. If the preferred template is subsequently deleted, the preferred template ID is set to KNullContactId.
| Parameter | Description |
|---|---|
| aContact | The contact card template to set as the database's preferred template. |
| IMPORT_C void | SetSortedItemsList | ( | CContactIdArray * | aSortedItems, |
| CArrayFix< TSortPref > * | aSortOrder | |||
| ) | ||||
This method allows clients of contacts model to set the sorted item list and sort order from a default sort order server as proposed for Crystal 6.0
Note: This method can leave.
| Parameter | Description |
|---|---|
| aSortedItems | Specifies an array sorted items |
| aSortOrder | Specifies the sort order |
| IMPORT_C void | SetTextDefinitionL | ( | CContactTextDef * | aView | ) |
Sets the text definition. The contact database takes ownership of the text definition specified.
| Parameter | Description |
|---|---|
| aView | The new text definition. |
| IMPORT_C void | SetViewDefinitionL | ( | CContactViewDef * | aView | ) |
Sets the default view definition. The contact database takes ownership of the view definition specified. The default view definition is used in calls to ReadContactL(), ReadContactLC() and ReadContactAndAgentL() when no view definition is explicitly specified.
| Parameter | Description |
|---|---|
| aView | The view definition. This method does nothing if this is null. |
| IMPORT_C CContactIdArray * | SortArrayL | ( | const CContactIdArray * | aIdArray, |
| const CArrayFix< TSortPref > * | aSortOrder | |||
| ) | ||||
Sorts an array of contact IDs. The sort uses the same logic as SortL(). The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aIdArray | Pointer to array of contact IDs to sort. |
| aSortOrder | Sort order array. |
Returns: Pointer to sorted array of contact IDs.
| IMPORT_C CContactIdArray * | SortArrayLC | ( | const CContactIdArray * | aIdArray, |
| const CArrayFix< TSortPref > * | aSortOrder | |||
| ) | ||||
Sorts an array of contact IDs. The sort uses the same logic as SortL(). The returned array is left on the cleanup stack. The caller takes ownership of the returned object.
| Parameter | Description |
|---|---|
| aIdArray | Pointer to array of contact IDs to sort. |
| aSortOrder | Sort order array. |
Returns: Pointer to sorted array of contact IDs.
| IMPORT_C void | SortAsyncL | ( | CArrayFix< TSortPref > * | aSortOrder, |
| TRequestStatus & | aStatus | |||
| ) | ||||
aSortOrder is owned by the idle sorter. Deprecated
| Parameter | Description |
|---|---|
| aSortOrder | Specifies the sort order |
| aStatus | The request status for the asynchronous phase request. |
| IMPORT_C void | SortAsyncL | ( | CArrayFix< TSortPref > * | aSortOrder, |
| TRequestStatus & | aStatus, | |||
| MContactSortObserver & | aObserver | |||
| ) | ||||
aSortOrder is owned by the idle sorter. Deprecated
| Parameter | Description |
|---|---|
| aSortOrder | Specifies the sort order |
| aStatus | The request status for the asynchronous phase request. |
Sorts the database using the view type value set by SetDbViewContactType(). The database takes ownership of the sort order array passed in.
The sort uses the same logic as SortL(). The two functions have the same effect.
After calling this function, use CContactDatabase::SortedItemsL() to retrieve the sorted array of contact IDs.
| Parameter | Description |
|---|---|
| aSortOrder | Sort order array. |
Sorts the database. The sort only includes items of the type set by SetDbViewContactType(). The database takes ownership of the sort order array passed in. Contacts are sorted using the first TSortPref in the array. Any identical matches are then sorted using the next TSortPref and so on. When there are no more TSortPrefs to use, any remaining unsorted contacts are left in the original database order.
Note: after calling this function, use CContactDatabase::SortedItemsL() to retrieve the sorted array of contact IDs.
| Parameter | Description |
|---|---|
| aSortOrder | Sort order array. If the array's count is zero, no sorting takes place. |
| IMPORT_C const CContactIdArray * | SortedItemsL | ( | ) |
Returns a pointer to the array of contact items which have been sorted by either SortByTypeL() or SortL(). This pointer is valid until a change is made to the database or until the database's active object is allowed to run. If the array is required after one of the above two events has occurred, a copy of the array must first be made.
Returns: A pointer to the array of sorted items. The caller does not take ownership of this object.
Returns the field UID for the given speed dial position. This method is copied from CCntServerSpeedDialManager::SpeedDialFieldUidFromSpeedDialPosition() rather than export this method for use here and on the server. Once the BC break referred to in SetFieldAsSpeedDialL() has been made this method should be removed.
| Parameter | Description |
|---|---|
| aSpeedDialPosition | The speed dial position for which we want the field UID. |
Returns: The field UID corresponding to aSpeedDialPosition.
| IMPORT_C void | StoreSortOrderL | ( | ) |
This function is not currently supported. Deprecated
| IMPORT_C const CContentType & | TemplateContentType | ( | const CContactItemField & | aField | ) | const |
Gets the content type of the template field which a specified field maps onto. If the field does not map onto a field in a template, then its own content type is returned.
Note: this function can leave.
| Parameter | Description |
|---|---|
| aField | The field of interest. |
Returns: The content type of the field.
| TInt | TemplateCount | ( | ) | const [inline] |
Gets the number of contact card templates that exist in the database. This does not include the system template. Deprecated
Returns: The number of contact card templates that exist in the database.
| IMPORT_C TContactItemId | TemplateId | ( | ) | const |
Gets the ID of the system template. This can then be read, opened and committed like any other contact item.
Returns: ID of the system template.
| IMPORT_C const CContactTextDef * | TextDefinition | ( | ) | const |
Gets a pointer to the text definition.
Returns: A pointer to the text definition.
| IMPORT_C CContactIdArray * | UnfiledContactsL | ( | ) |
Returns a list of 'unfiled' contacts. These are contacts which do not belong to any group.
Returns: The list of 'unfiled' contacts.
| IMPORT_C CContactItem * | UpdateContactLC | ( | TContactItemId | aContactId, |
| CContactItem * | aNewContact | |||
| ) | ||||
Updates a contact identified by aContactId with the data in aNewContact. All empty fields are deleted.
| Parameter | Description |
|---|---|
| aContactId | This argument should be ignored by developers. |
| aNewContact | The contact item to replace it with. |
Returns: The contact item after the update.
| IMPORT_C TVersion | Version | ( | ) | const |
Gets the contact model's version number.
Returns: The version number of the contacts model.
| IMPORT_C TInt | WastedSpaceInBytes | ( | ) | const |
This function is deprecated and always returns 0.
Returns: The wasted space in the contacts database.
| IMPORT_C TContactItemId | doAddNewContactL | ( | CContactItem & | aContact, |
| TBool | aIsTemplate, | |||
| TBool | aIsInTransaction | |||
| ) | ||||
Adds a new contact item to the database and returns its ID.
| Parameter | Description |
|---|---|
| aContact | The contact item to add to the database. |
| aIsTemplate | This argument should be ignored by developers. |
| aIsInTransaction | This argument should be ignored by developers. |
Returns: The ID of the new contact item.
| IMPORT_C void | doCommitContactL | ( | const CContactItem & | aContact, |
| TBool | aIsInTransaction, | |||
| TBool | aSendChangedEvent | |||
| ) | ||||
Updates the existing contact information.
| Parameter | Description |
|---|---|
| aContact | Contains the new values for the contact item. |
| aIsInTransaction | This argument should be ignored by developers. |
| aSendChangedEvent | This argument should be ignored by developers. |
| IMPORT_C void | doDeleteContactL | ( | TContactItemId | aContactId, |
| TBool | aIsInTransaction, | |||
| TBool | aSendChangedEvent, | |||
| TBool | aDecAccessCount = EFalse | |||
| ) | ||||
Deletes a contact item.
Note: if the contact's access count is greater than zero, the contact is not fully deleted from the database. A 'skeleton' of the contact is left, containing only basic information, and no field data. The skeleton contact can still be accessed if a record of its contact ID has been retained (or call DeletedContactsLC()). The skeleton is removed when the access count is zero.
| Parameter | Description |
|---|---|
| aContactId | The contact item ID of the contact to delete. |
| aIsInTransaction | This argument should be ignored by developers. |
| aSendChangedEvent | This argument should be ignored by developers. |
| aDecAccessCount | This argument should be ignored by developers. |