Class CContactDatabase

class CContactDatabase : public CBase, public MContactDbPrivObserver, public MContactStorageObserver;

Description

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

Derivation

• MContactStorageObserver - Mixin used to observe low disk events
• MContactDbPrivObserver - Provides notification of database changes to clients
• CBase - Base class for all classes to be instantiated on the heap

• CContactDatabase - A database of contact items

Members

Defined in CContactDatabase:

• AddContactToGroupL()Sets a contact item in the database to be a member of a contact group
• AddContactToGroupL()Sets a contact item in the database to be a member of a contact group
• AddContactToGroupL()Sets a contact item in the database to be a member of a contact group
• AddNewContactL()Adds a new contact item to the database and returns its ID
• CancelAsyncSort()Cancel the CCntIdleSorter object and clean up resources
• CloseContactL()Closes the contact item, allowing other applications to access it
• CloseTables()Closes all database tables
• CommitContactL()Overwrites a contact item with the values contained in aContact
• CompactL()Compacts the database to its minimum size synchronously
• CompressRequired()Tests whether a compress is recommended
• ConnectionId()Gets the ID of the connection to the Contacts server
• ContactDatabaseExistsL()A method to determine if a named contact database exists
• ContactsChangedSinceL()Gets an array of contacts modified since the specified date/time
• CountL()Gets the number of CContactItems in the database
• CreateCompressorLC()Creates an active compressor to compress the database with an active object
• CreateContactCardTemplateL()Creates a contact card template based on the system template and adds it to the database
• CreateContactCardTemplateL()Creates a contact card template and adds it to the database
• CreateContactCardTemplateLC()Creates a contact card template based on the system template and adds it to the database
• CreateContactCardTemplateLC()Creates a contact card template and adds it to the database
• CreateContactGroupL()Creates a new contact group with a default label of 'Group Label' and adds it to the database
• CreateContactGroupL()Creates a new contact group with a specified label and adds it to the database
• CreateContactGroupLC()Creates a new contact group with a default label of 'Group Label' and adds it to the database
• CreateContactGroupLC()Creates a new contact group with a specified label and adds it to the database
• CreateL()Creates and opens an empty contact database using the default database name
• CreateL()Creates and opens a named contact database
• CreateOwnCardL()Creates a default own card based on the system template and adds it to the database
• CreateOwnCardLC()Creates a default own card based on the system template and adds it to the database
• CreateRecoverLC()Creates an active recoverer object to recover the database using an active object
• DatabaseDrive()Gets the current database drive
• DefaultContactDatabaseExistsL()A static method to determine if the default contact database exists
• DeleteContactL()Deletes a contact item
• DeleteContactsL()Deletes an array of contacts
• DeleteDatabaseL()A static method to delete a named contact database
• DeleteDefaultFileL()Deletes the default contact database
• EAsc
• EConverterDefined1For use by implementor of converter plug-in
• EConverterDefined2For use by implementor of converter plug-in
• EConverterDefined3For use by implementor of converter plug-in
• EConverterDefined4For use by implementor of converter plug-in
• EConverterDefined5For use by implementor of converter plug-in
• EConverterDefined6For use by implementor of converter plug-in
• EConverterDefined7For use by implementor of converter plug-in
• EConverterDefined8For use by implementor of converter plug-in
• EConverterReserved1Reserved for use by Symbian
• EConverterReserved10Reserved for use by Symbian
• EConverterReserved11Reserved for use by Symbian
• EConverterReserved12Reserved for use by Symbian
• EConverterReserved13Reserved for use by Symbian
• EConverterReserved14Reserved for use by Symbian
• EConverterReserved15Reserved for use by Symbian
• EConverterReserved16Reserved for use by Symbian
• EConverterReserved2Reserved for use by Symbian
• EConverterReserved3Reserved for use by Symbian
• EConverterReserved4Reserved for use by Symbian
• EConverterReserved5Reserved for use by Symbian
• EConverterReserved6Reserved for use by Symbian
• EConverterReserved7Reserved for use by Symbian
• EConverterReserved8Reserved for use by Symbian
• EConverterReserved9Reserved for use by Symbian
• ECustomFilter1Reserved filters for future use
• ECustomFilter2Reserved filters for future use
• ECustomFilter3Reserved filters for future use
• ECustomFilter4Reserved filters for future use
• EDbConnectionClosedForRestoreThe database has been closed whilst a Restore is in progress
• EDbConnectionFailedAsynchronous Open failed
• EDbConnectionNeedToCloseForRestoreRestore is in progress need to close after current transaction
• EDbConnectionNotReadyInitial state
• EDbConnectionOpenDatabase is open, connection is available for use
• EDbConnectionRecoverRequiredA Rollback has occurred and a Recover is required now
• EDbConnectionWriteLockedForBackupWrite access is locked during backup
• EDecreaseAccessCountDecrease the contact's access count when importing and exporting
• EDefault
• EDesc
• EExcludeUidDon't export the contact ID (for exporting only)
• EFaxableThe filter includes items that have a fax number
• EHomeThe filter excludes items without a home telephone number or email address
• EIMAddressThe filter includes items that have any non empty instant messaging address field
• EImportSingleContactOnly import the first contact in the read stream (for importing only)
• EIncludeXHandle Symbian's extended vCard format options
• EIncreaseAccessCountIncrease the contact's access count when importing and exporting
• ELandLineThe filter includes items that have a landline telephone number
• ELocalTimeSets a contact item to the local time when importing
• EMailableThe filter includes items that have an email address
• EMultiThreadAllows 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
• ENullTemplateIdAllows you to set a template to a contact item that does not exist
• EPhonableThe filter includes items that are phonable
• ERingToneThe filter includes items that have a non-empty ring tone field (a ring tone that is associated with the item)
• ESingleThreadAllows access to the contacts database from a single thread only
• ESmsableThe filter includes items that have a mobile telephone number
• ETTFormatSupport non-standard extensions requried by Symbian PC connectivity software and Microsoft, amongst others
• EUnfilteredThe view is unfiltered; it includes all contact items
• EVoiceDialThe filter includes items that have a non-empty voice dial field (a voice recording associated with a telephone number field in the item)
• EWirelessVillageThe filter includes items that have a non empty Wireless Village ID field
• EWorkThe filter excludes items without a work telephone number or email address
• ExportSelectedContactsL()Converts an array of contact items to vCards and exports them to a write stream
• ExportSelectedContactsL()Converts an array of contact items to vCards and exports them to a write stream using the specified character set
• FileSize()Gets the size of the database file in bytes
• FileUid()Gets the database's UID
• FilterDatabaseL()Filters the database
• FindAsyncL()Searches the database asynchronously for a text string
• FindInTextDefAsyncL()Asynchronously searches the database for an array of words
• FindInTextDefAsyncL()Asynchronously searches the database for an array of words
• FindInTextDefLC()Enables the user to search the database for a string containing text that is stored in one or more fields
• FindInTextDefLC()Enables the user to search the database for a string containing text that is stored in one or more fields
• FindLC()Searches the database for a text string
• GetCardTemplateIdListL()Gets a copy of the database's template ID list
• GetCurrentDatabase()Where there are multiple contact databases on a device, this function can be used to enquire which database is the current one
• GetCurrentItem()Gets the ID of the current item, as set by SetCurrentItem()
• GetDbViewContactType()Gets the type of contact items which are included in sorted views of the database, as set by SetDbViewContactType()
• GetDefaultNameL()Gets the file name of the default contact database
• GetGroupIdListL()Returns a copy of the database's group ID list
• GetLastSyncDateL()Gets the date/time the database was last synchronised with a particular sync ID, as set by SetLastSyncDateL()
• GetSpeedDialFieldL()Returns the ID of the contact item whose telephone number field is mapped to the speed dial position specified
• GroupCount()Gets the number of groups that exist in the database
• HandleDatabaseEventL()
• HandleDiskSpaceEvent()Default behaviour for handling a low disk event - This function is unimplemented
• ICCTemplateIdL()Returns the ID of the template that should be used with CContactICCEntry items
• ICCTemplateIdL()Returns the ID of the template that should be used with CContactICCEntry items belonging to the phonebook with TUid aPhonebookUid
• ImportContactsL()Imports one or more vCards from a read stream
• IsDamaged()Tests whether the database is damaged and needs to be recovered
• ListDatabasesL()A static method to list the contact databases on all drives
• ListDatabasesL()A static method to list the contact databases on a specified drive
• MachineId()Returns a number unique to the contacts database
• MatchPhoneNumberL()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
• NullUidValue()Gets the NULL contact ID value
• Open()Opens the default contact database asynchronously
• Open()Opens a named contact database asynchronously
• OpenContactL()Opens a contact item for editing
• OpenContactL()Opens a contact item for editing, leaving the lock record on the cleanup stack
• OpenContactLX()Opens a contact item for editing using a specified view definition
• OpenContactLX()Opens a contact item for editing, leaving the lock record on the cleanup stack
• OpenL()Opens the default contact database
• OpenL()Opens a named contact database
• OpenTablesL()Opens all database tables
• OwnCardId()Returns the ID of the database's current own card
• PhonebookGroupIdL()Returns the ID of the contacts model group which represents the ADN phonebook
• PrefTemplateId()Returns the ID of the database's preferred template, as set by SetPrefTemplateL()
• ReadContactAndAgentL()Reads a contact item and an agent if the item has an agent field
• ReadContactL()Reads a contact item without locking it
• ReadContactL()Reads a contact item without locking it
• ReadContactLC()Reads a contact item without locking it
• ReadContactLC()Reads a contact item without locking it
• ReadContactTextDefL()Reads text into a descriptor from a pre-loaded contact item
• ReadContactTextDefL()Reads text into a descriptor from a pre-loaded contact item, using the specified text definition
• ReadContactTextDefL()Reads text from a contact item stored in the database into a descriptor
• ReadContactTextDefL()Reads text from a contact item stored in the database into a descriptor using the specified text definition
• ReadMinimalContactL()Reads a contact item (contact card, own card, template, or contact group), but does not read the group or template information
• ReadMinimalContactLC()Reads a contact item (contact card, own card, template, or contact group), but does not read the group or template information
• RecoverL()Recovers the database from a rollback
• RemoveContactFromGroupL()Removes the association between a contact item and a group
• RemoveContactFromGroupL()Removes the association between a contact item and a group
• RemoveSpeedDialFieldL()Removes the mapping between a contact item field and a speed dial position
• ReplaceL()Creates and opens an empty contact database, replacing the existing default database
• ReplaceL()Creates and opens an empty contact database, replacing any existing file with the same name
• RestoreSortOrderL()This function is not currently supported
• SetCurrentDatabase()Where there are multiple contact databases on a device, this function can be used to set a database as the current one
• SetCurrentItem()Sets the ID of the current item and persists it in the database
• SetDatabaseDriveL()Sets the contact database drive and optionally moves the default contact database from its current location to the new drive
• SetDateFormatTextL()This function is not currently supported
• SetDbViewContactType()Sets the type of contact items to be included in sorted views of the database
• SetFieldAsSpeedDialL()Sets a field containing a telephone number as a speed dial field
• SetLastSyncDateL()Sets the date/time the database was last synchronised
• SetLastSyncDateL()Sets the date/time the database was last synchronised
• SetOwnCardL()Sets an existing contact item to be the database's current own card
• SetPrefTemplateL()Sets the database's preferred template
• SetSortedItemsList()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
• SetTextDefinitionL()Sets the text definition
• SetViewDefinitionL()Sets the default view definition
• SortArrayL()Sorts an array of contact IDs
• SortArrayLC()Sorts an array of contact IDs
• SortAsyncL()aSortOrder is owned by the idle sorter
• SortAsyncL()aSortOrder is owned by the idle sorter
• SortByTypeL()Sorts the database using the view type value set by SetDbViewContactType()
• SortL()Sorts the database
• SortOrder()Gets the array of sort preferences
• SortedItemsL()Returns a pointer to the array of contact items which have been sorted by either SortByTypeL() or SortL()
• StoreSortOrderL()This function is not currently supported
• TContactViewFilterContact view filter flags
• TDbConnStateState of database connection
• TDirectionCurrently unused
• TOptionsImport and export format flags
• TSortPrefSpecifies the field type and order preferences used for sorting items in the contacts database
• TTextFieldMinimalA text buffer of KTextFieldMinimalLength used during sorting and searching of contacts
• TThreadAccessSpecifies whether the database can be accessed from single or multiple threads
• TemplateContentType()Gets the content type of the template field which a specified field maps onto
• TemplateCount()Gets the number of contact card templates that exist in the database
• TemplateId()Gets the ID of the system template
• TextDefinition()Gets a pointer to the text definition
• Version()Gets the contact model's version number
• WastedSpaceInBytes()Gets the amount of wasted space in the database in bytes
• doAddNewContactL()Adds a new contact item to the database and returns its ID
• ~CContactDatabase()Frees all resources owned by the contact database, prior to its destruction

Inherited from CBase:

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

IMPORT_C ~CContactDatabase();

Description

Frees all resources owned by the contact database, prior to its destruction.

static IMPORT_C CContactDatabase *OpenL(TThreadAccess aAccess=ESingleThread);

Description

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.

Parameters

Return value

Leave codes

static IMPORT_C CContactDatabase *OpenL(const TDesC &aFileName, TThreadAccess aAccess=ESingleThread);

Description

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.

Parameters

Return value

Leave codes

static IMPORT_C CContactDatabase *CreateL(TThreadAccess aAccess=ESingleThread);

Description

Creates and opens an empty contact database using the default database name.

Parameters

Return value

Leave codes

static IMPORT_C CContactDatabase *CreateL(const TDesC &aFileName, TThreadAccess aAccess=ESingleThread);

Description

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.

Parameters

Return value

Leave codes

static IMPORT_C CContactDatabase *ReplaceL(TThreadAccess aAccess=ESingleThread);

Description

Creates and opens an empty contact database, replacing the existing default database.

Parameters

Return value

Leave codes

static IMPORT_C CContactDatabase *ReplaceL(const TDesC &aFileName, TThreadAccess aAccess=ESingleThread);

Description

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.

Parameters

Return value

Leave codes

static IMPORT_C CContactOpenOperation *Open(TRequestStatus &aStatus, TThreadAccess aAccess=ESingleThread);

Description

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.

Parameters

Return value

See also:

• CContactOpenOperationA class that manages the asynchronous open operation for a CContactDatabase

static IMPORT_C CContactOpenOperation *Open(const TDesC &aFileName, TRequestStatus &aStatus, TThreadAccess aAccess=ESingleThread);

Description

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.

Parameters

Return value

See also:

• CContactOpenOperationA class that manages the asynchronous open operation for a CContactDatabase

static IMPORT_C TBool DatabaseDrive(TDriveUnit &aDriveUnit);

Description

Gets the current database drive. The database drive is the drive on which the default contact database is located. Note: this function can leave.

Parameters

Return value

See also:

• CContactDatabase::GetDefaultNameL()Gets the file name of the default contact database

static inline TInt NullUidValue();

Description

Gets the NULL contact ID value.

Return value

static IMPORT_C void SetDatabaseDriveL(TDriveUnit aDriveUnit, TBool aCopy=ETrue);

Description

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.

Parameters

Leave codes

See also:

• CContactDatabase::GetDefaultNameL()Gets the file name of the default contact database
• CContactDatabase::DefaultContactDatabaseExistsL()A static method to determine if the default contact database exists

static IMPORT_C void GetDefaultNameL(TDes &aDes);

Description

Gets the file name of the default contact database.

By default it is on drive C: but this can be changed using SetDatabaseDriveL().

Parameters

See also:

• CContactDatabase::SetDatabaseDriveL()Sets the contact database drive and optionally moves the default contact database from its current location to the new drive
• CContactDatabase::DatabaseDrive()Gets the current database drive
• CContactDatabase::DefaultContactDatabaseExistsL()A static method to determine if the default contact database exists

static IMPORT_C void DeleteDefaultFileL();

Description

Deletes the default contact database.

Leave codes

See also:

• CContactDatabase::DeleteDatabaseL()A static method to delete a named contact database
• CContactDatabase::GetDefaultNameL()Gets the file name of the default contact database
• CContactDatabase::DefaultContactDatabaseExistsL()A static method to determine if the default contact database exists

static IMPORT_C void DeleteDatabaseL(const TDesC &aFileName);

Description

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.

Parameters

Leave codes

See also:

• CContactDatabase::DeleteDefaultFileL()Deletes the default contact database

static IMPORT_C CDesCArray *ListDatabasesL();

Description

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

Return value

Leave codes

static IMPORT_C CDesCArray *ListDatabasesL(TDriveUnit aDriveUnit);

Description

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

Parameters

Return value

Leave codes

static IMPORT_C TBool DefaultContactDatabaseExistsL();

Description

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.

Return value

Leave codes

See also:

• CContactDatabase::ContactDatabaseExistsL()A method to determine if a named contact database exists

static IMPORT_C TBool ContactDatabaseExistsL(const TDesC &aFileName);

Description

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.

Parameters

Return value

Leave codes

See also:

• CContactDatabase::DefaultContactDatabaseExistsL()A static method to determine if the default contact database exists
• CContactDatabase::ListDatabasesL()A static method to list the contact databases on all drives

IMPORT_C void SetViewDefinitionL(CContactViewDef *aView);

Description

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.

Parameters

IMPORT_C void SetTextDefinitionL(CContactTextDef *aView);

Description

Sets the text definition. The contact database takes ownership of the text definition specified.

Parameters

IMPORT_C const CContactTextDef *TextDefinition() const;

Description

Gets a pointer to the text definition.

Return value

IMPORT_C TInt CountL();

Description

Gets the number of CContactItems in the database. The count includes non-system template items. It does not include items marked as deleted.

Return value

IMPORT_C void SetDbViewContactType(const TUid aUid);

Description

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.

Parameters

IMPORT_C TUid GetDbViewContactType() const;

Description

Gets the type of contact items which are included in sorted views of the database, as set by SetDbViewContactType().

Return value

IMPORT_C TContactItemId AddNewContactL(CContactItem &aContact);

Description

Adds a new contact item to the database and returns its ID.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *CreateContactGroupL(TBool aInTransaction=EFalse);

Description

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.

Parameters

Return value

IMPORT_C CContactItem *CreateContactGroupLC(TBool aInTransaction=EFalse);

Description

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.

Parameters

Return value

IMPORT_C CContactItem *CreateContactGroupL(const TDesC &aGroupLabel, TBool aInTransaction=EFalse);

Description

Creates a new contact group with a specified label and adds it to the database.

The caller takes ownership of the returned object.

Parameters

Return value

IMPORT_C CContactItem *CreateContactGroupLC(const TDesC &aGroupLabel, TBool aInTransaction=EFalse);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *CreateContactCardTemplateL(const TDesC &aTemplateLabel, TBool aInTransaction=EFalse);

Description

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.

Parameters

Return value

IMPORT_C CContactItem *CreateContactCardTemplateLC(const TDesC &aTemplateLabel, TBool aInTransaction=EFalse);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *CreateContactCardTemplateL(const CContactItem *aTemplate, const TDesC &aTemplateLabel, TBool aInTransaction=EFalse);

Description

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.

Parameters

Return value

IMPORT_C CContactItem *CreateContactCardTemplateLC(const CContactItem *aTemplate, const TDesC &aTemplateLabel, TBool aInTransaction=EFalse);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactIdArray *GetCardTemplateIdListL() const;

Description

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.

Return value

IMPORT_C CContactIdArray *GetGroupIdListL() const;

Description

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.

Return value

IMPORT_C void AddContactToGroupL(TContactItemId aItemId, TContactItemId aGroupId);

Description

Sets a contact item in the database to be a member of a contact group.

The item and group are identified by their IDs.

Parameters

Leave codes

IMPORT_C void AddContactToGroupL(CContactItem &aItem, CContactItem &aGroup);

Description

Sets a contact item in the database to be a member of a contact group.

Parameters

Leave codes

IMPORT_C void AddContactToGroupL(TContactItemId aItemId, TContactItemId aGroupId, TBool aInTransaction);

Description

Sets a contact item in the database to be a member of a contact group.

The item and group are identified by their IDs.

Parameters

Leave codes

IMPORT_C void RemoveContactFromGroupL(CContactItem &aItem, CContactItem &aGroup);

Description

Removes the association between a contact item and a group.

Parameters

Leave codes

IMPORT_C void RemoveContactFromGroupL(TContactItemId aItemId, TContactItemId aGroupId);

Description

Removes the association between a contact item and a group.

The item and group are identified by their IDs.

Parameters

Leave codes

inline TInt GroupCount() const;

Description

Gets the number of groups that exist in the database.

Return value

inline TInt TemplateCount() const;

Description

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

Return value

IMPORT_C void SetFieldAsSpeedDialL(CContactItem &aItem, TInt aFieldIndex, TInt aSpeedDialPosition);

Description

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.

Parameters

Leave codes

IMPORT_C TContactItemId GetSpeedDialFieldL(TInt aSpeedDialPosition, TDes &aPhoneNumber);

Description

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.

Parameters

Return value

IMPORT_C void RemoveSpeedDialFieldL(TContactItemId aContactId, TInt aSpeedDialPosition);

Description

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.

Parameters

Leave codes

IMPORT_C CContactItem *ReadMinimalContactL(TContactItemId aContactId);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *ReadMinimalContactLC(TContactItemId aContactId);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *ReadContactL(TContactItemId aContactId);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CArrayPtr< CContactItem > *ReadContactAndAgentL(TContactItemId aContactId);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *ReadContactL(TContactItemId aContactId, const CContactItemViewDef &aViewDef);

Description

Reads a contact item without locking it.

This function uses the view definition specified. The caller takes ownership of the returned object.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *ReadContactLC(TContactItemId aContactId);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *ReadContactLC(TContactItemId aContactId, const CContactItemViewDef &aViewDef);

Description

Reads a contact item without locking it.

This function uses the view definition specified. The caller takes ownership of the returned object.

Parameters

Return value

Leave codes

IMPORT_C void ReadContactTextDefL(const CContactItem &aItem, TDes &aResult);

Description

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

Parameters

IMPORT_C void ReadContactTextDefL(const CContactItem &aItem, TDes &aResult, CContactTextDef *aTextDef);

Description

Reads text into a descriptor from a pre-loaded contact item, using the specified text definition.

Parameters

IMPORT_C void ReadContactTextDefL(TContactItemId aContactId, TDes &aResult);

Description

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

Parameters

Leave codes

IMPORT_C void ReadContactTextDefL(TContactItemId aContactId, TDes &aResult, CContactTextDef *aTextDef);

Description

Reads text from a contact item stored in the database into a descriptor using the specified text definition.

Parameters

Leave codes

IMPORT_C CContactItem *OpenContactL(TContactItemId aContactId);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *OpenContactL(TContactItemId aContactId, const CContactItemViewDef &aViewDef);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *OpenContactLX(TContactItemId aContactId);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C CContactItem *OpenContactLX(TContactItemId aContactId, const CContactItemViewDef &aViewDef);

Description

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.

Parameters

Return value

Leave codes

IMPORT_C void CloseContactL(TContactItemId aContactId);

Description

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.

Parameters

IMPORT_C void CommitContactL(const CContactItem &aContact);

Description

Overwrites a contact item with the values contained in aContact. The contact item is also closed by this call.

Parameters

Leave codes

IMPORT_C void DeleteContactL(TContactItemId aContactId);

Description

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.

Parameters

Leave codes

IMPORT_C void DeleteContactsL(const CContactIdArray &aContactIds);

Description

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.

Parameters

Leave codes

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

Description

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.

Parameters

Return value

Leave codes

IMPORT_C void ExportSelectedContactsL(const TUid &aFormat, const CContactIdArray &aSelectedContactIds, RWriteStream &aWriteStream, TInt aOption, TBool aExportPrivateFields=ETrue);

Description

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.

Parameters

Leave codes

IMPORT_C void ExportSelectedContactsL(const TUid &aFormat, const CContactIdArray &aSelectedContactIds, RWriteStream &aWriteStream, TInt aOption, const Versit::TVersitCharSet aCharSet, TBool aExportPrivateFields=ETrue);

Description

Converts an array of contact items to vCards and exports them to a write stream using the specified character set.

Parameters

Leave codes

IMPORT_C void CompactL();

Description

Compacts the database to its minimum size synchronously.

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

Description

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.

Parameters

Return value

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

Description

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.

Parameters

Return value

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

Description

Enables the user to search the database for a string containing text that is stored in one or more fields.

The string is specified as an array of words.

For example, a user might want to search for the string "John Smith". To the user the string is a single item, but the text which makes up the string is stored in two separate fields in the database.

The caller of this function needs to provide an array of words to find (aFindWords), and a function to break down the text in the contact item into a list of words (aWordParserCallback).

The array of words to find would typically not contain punctuation. For example if the user searches for 'Smith, John' this would be passed to this function as an array of two words: 'Smith' and 'John', with the separator being discarded.

For a match to succeed, all words in the aFindWords array must match words in the array generated from the contact item by the aWordParserCallback function. To match, the word generated from the contact item must begin with the search word, i.e. a search for "Sm" would find any word beginning in "Sm". If a word is specified twice in the aFindWords array, then it must exist in two separate places in the contact item.

The function only searches the fields contained in the currently set text definition.

The caller takes ownership of the returned object.

Parameters

Return value

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

Description

Enables the user to search the database for a string containing text that is stored in one or more fields.

The string is specified as an array of words.

For example, a user might want to search for the string "John Smith". To the user the string is a single item, but the text which makes up the string is stored in two separate fields in the database.

The caller of this function needs to provide an array of words to find (aFindWords), and a function to break down the text in the contact item into a list of words (aWordParserCallback).

The array of words to find would typically not contain punctuation. For example if the user searches for 'Smith, John' this would be passed to this function as an array of two words: 'Smith' and 'John', with the separator being discarded.

For a match to succeed, all words in the aFindWords array must match words in the array generated from the contact item by the aWordParserCallback function. To match, the word generated from the contact item must begin with the search word, i.e. a search for "Sm" would find any word beginning in "Sm". If a word is specified twice in the aFindWords array, then it must exist in two separate places in the contact item.

The function only searches the fields contained in the text definition aTextDef.

The caller takes ownership of the returned object.

Parameters

Return value

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

Description

Asynchronously searches the database for an array of words.

This function works in the same way as its corresponding variant in FindInTextDefLC(), except that it operates asynchronously using the MIdleFindObserver and CIdleFinder classes. The caller takes ownership of the returned object.

Parameters

Return value

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

Description

Asynchronously searches the database for an array of words.

This function works in the same way as its corresponding variant in FindInTextDefLC(), except that it operates asynchronously using the MIdleFindObserver and CIdleFinder classes. The caller takes ownership of the returned object.

Parameters

Return value

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

Description

Sorts an array of contact IDs. The sort uses the same logic as SortL(). The caller takes ownership of the returned object.

Parameters

Return value

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

Description

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.

Parameters

Return value

IMPORT_C void SortByTypeL(CArrayFix< TSortPref > *aSortOrder);

Description

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.

Parameters

IMPORT_C void SortL(CArrayFix< TSortPref > *aSortOrder);

Description

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.

Parameters

IMPORT_C void SortAsyncL(CArrayFix< TSortPref > *aSortOrder, TRequestStatus &aStatus);

Description

aSortOrder is owned by the idle sorter.

Parameters

IMPORT_C void CancelAsyncSort();

Description

Cancel the CCntIdleSorter object and clean up resources.

IMPORT_C void SortAsyncL(CArrayFix< TSortPref > *aSortOrder, TRequestStatus &aStatus, MContactSortObserver &aObserver);

Description

aSortOrder is owned by the idle sorter.

Parameters

IMPORT_C TPtrC FileUid();

Description

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.

Return value

IMPORT_C CContactActiveCompress *CreateCompressorLC();

Description

Creates an active compressor to compress the database with an active object.

An observer set up on the active compressor can be used to provide progress information. The caller takes ownership of the returned object.

Return value

IMPORT_C CContactActiveRecover *CreateRecoverLC();

Description

Creates an active recoverer object to recover the database using an active object. The caller takes ownership of the returned object.

Return value

IMPORT_C void RecoverL();

Description

Recovers the database from a rollback. It first closes all tables and then reopens them after the recover.

IMPORT_C TBool IsDamaged() const;

Description

Tests whether the database is damaged and needs to be recovered.

Return value

IMPORT_C TBool CompressRequired();

Description

Tests whether a compress is recommended. This function provides an easy way of testing whether the database is being used efficiently.

ETrue is returned if:

• greater than 64K of disk space is wasted

• greater than 16K of disk space is wasted AND there is greater than 50% wasted disk space

• greater than 16K of disk space is wasted AND there is less than 5% free disk space

• greater than 16K of disk space is wasted AND there is less than 16K free disk space

Return value

IMPORT_C void CloseTables();

Description

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 void OpenTablesL();

Description

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 CContactIdArray *MatchPhoneNumberL(const TDesC &aNumber, TInt aMatchLengthFromRight);

Description

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.

Parameters

Return value

IMPORT_C const CContactIdArray *SortedItemsL();

Description

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.

Return value

IMPORT_C TContactItemId TemplateId() const;

Description

Gets the ID of the system template. This can then be read, opened and committed like any other contact item.

Return value

IMPORT_C CContactItem *CreateOwnCardLC();

Description

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.

Return value

IMPORT_C CContactItem *CreateOwnCardL();

Description

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.

Return value

IMPORT_C TContactItemId OwnCardId() const;

Description

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

Return value

IMPORT_C void SetOwnCardL(const CContactItem &aContact);

Description

Sets an existing contact item to be the database's current own card.

Parameters

Leave codes

IMPORT_C TContactItemId PrefTemplateId() const;

Description

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.

Return value

IMPORT_C void SetPrefTemplateL(const CContactItem &aContact);

Description

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.

Parameters

Leave codes

IMPORT_C void SetCurrentItem(const TContactItemId aContactId);

Description

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.

Parameters

IMPORT_C TContactItemId GetCurrentItem() const;

Description

Gets the ID of the current item, as set by SetCurrentItem(). The current item ID is initialised to KNullContactId when the database is opened.

Return value

IMPORT_C void SetDateFormatTextL(const TDesC &aFormat);

Description

This function is not currently supported.

Parameters

IMPORT_C void FilterDatabaseL(CCntFilter &aFilter);

Description

Filters the database. On return, aFilter contains an array of filtered contact item IDs.

Parameters

IMPORT_C CContactIdArray *ContactsChangedSinceL(const TTime &aTime);

Description

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.

Parameters

Return value

IMPORT_C TContactSyncId SetLastSyncDateL(const TTime &aSyncDate);

Description

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

Parameters

Return value

IMPORT_C void SetLastSyncDateL(TContactSyncId aSyncId, const TTime &aSyncDate);

Description

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.

Parameters

Leave codes

IMPORT_C void GetLastSyncDateL(TContactSyncId aSyncId, TTime &aSyncDate);

Description

Gets the date/time the database was last synchronised with a particular sync ID, as set by SetLastSyncDateL().

Parameters

Leave codes

IMPORT_C TInt FileSize() const;

Description

Gets the size of the database file in bytes.

Return value

IMPORT_C TInt WastedSpaceInBytes() const;

Description

Gets the amount of wasted space in the database in bytes. This is the database's size minus the amount of data in it.

Return value

IMPORT_C TUint ConnectionId() const;

Description

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.

Return value

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

Description

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.

Parameters

Return value

IMPORT_C TVersion Version() const;

Description

Gets the contact model's version number.

Return value

IMPORT_C TInt64 MachineId() const;

Description

Returns a number unique to the contacts database. This value may be passed to CContactItem::UidStringL().

Return value

IMPORT_C TContactItemId ICCTemplateIdL();

Description

Returns the ID of the template that should be used with CContactICCEntry items.

Return value

IMPORT_C TContactItemId ICCTemplateIdL(TUid aPhonebookUid);

Description

Returns the ID of the template that should be used with CContactICCEntry items belonging to the phonebook with TUid aPhonebookUid.

Parameters

Return value

IMPORT_C TContactItemId PhonebookGroupIdL();

Description

Returns the ID of the contacts model group which represents the ADN phonebook.

Return value

virtual inline void HandleDatabaseEventL(RDbNotifier::TEvent);

Description

Parameters

IMPORT_C TInt GetCurrentDatabase(TDes &aDatabase) const;

Description

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.

Parameters

Return value

IMPORT_C TInt SetCurrentDatabase(const TDesC &aDatabase) const;

Description

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.

Parameters

Return value

IMPORT_C void StoreSortOrderL();

Description

This function is not currently supported.

IMPORT_C void RestoreSortOrderL();

Description

This function is not currently supported.

IMPORT_C const CArrayFix< TSortPref > *SortOrder() const;

Description

Gets the array of sort preferences.

Return value

IMPORT_C TContactItemId doAddNewContactL(CContactItem &aContact, TBool aIsTemplate, TBool aIsInTransaction);

Description

Adds a new contact item to the database and returns its ID.

Parameters

Return value

Leave codes

IMPORT_C void SetSortedItemsList(CContactIdArray *aSortedItems, CArrayFix< TSortPref > *aSortOrder);

Description

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

Parameters

virtual void HandleDiskSpaceEvent(TInt aDrive);

Description

Default behaviour for handling a low disk event - This function is unimplemented.

Parameters

class TSortPref;

Description

Specifies the field type and order preferences used for sorting items in the contacts database.

The contents of the first field in a contact item matching the field type is used as the data to sort on. The order can either be ascending or descending.

Members

Defined in CContactDatabase::TSortPref:

• EAscAscending sort order
• EDescDescending sort order
• ExternalizeL()Store this TSortPref object in the given stream
• InternalizeL()Initialise this TSortPref object from the given stream
• TOrderThe sort order
• TSortPref()Constructs a TSortPref object
• TSortPref()Constructs the TSortPref object with a field type and an order
• iFieldTypeThe first field matching this field type is used for the text to sort on
• iOrderSpecifies whether the sort should be ascending or descending

See also:

• CContactDatabase::SortL()Sorts the database
• CContactDatabase::SortArrayL()Sorts an array of contact IDs

Construction and destruction

TSortPref()

inline TSortPref();

Description

Constructs a TSortPref object. The order is initialised to EAsc and the field type to KNullUid.

TSortPref()

inline TSortPref(TFieldType aFieldType, TOrder aOrder=EAsc);

Description

Constructs the TSortPref object with a field type and an order.

Parameters

Member functions

ExternalizeL()

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Store this TSortPref object in the given stream.

Parameters

InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Initialise this TSortPref object from the given stream.

Parameters

Member enumerations

Enum TOrder

TOrder

Description

The sort order.

Member data

iOrder

TOrder iOrder;

Description

Specifies whether the sort should be ascending or descending.

iFieldType

TFieldType iFieldType;

Description

The first field matching this field type is used for the text to sort on.

TOptions

Description

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.

TThreadAccess

Description

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

TContactViewFilter

Description

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.

TDbConnState

Description

State of database connection

TDirection

Description

Currently unused

typedef TBuf<KTextFieldMinimalLength> CContactDatabase::TTextFieldMinimal;

Description

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