RCntModel constructor.

Member variables must be initialised (zero'd) in the constructor since RCntModel does not derive from CBase .

Add a database event observer.

Start a database transaction.

Cancel last asynchronous database open request.

Close session.

Close/unLock an existing contact in the database.

Close currently open database.

Close the database tables.

Get a collection of contact IDs using the specified collection parameters.

Update and unlock an existing contact in the database.

Commit a database transaction.

Open a Contacts server session.

Returns the connection ID of the current client session.

Get the number of contacts in the database.

Tests whether a contact item's hint bit field matches a filter.

Add a new contact to the database.

Create an empty named contact database.

Creates the default contacts database if the default argument is used. The given descriptor must not contain more than KCntMaxFilePath characters.

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

Retrieve the current contact database drive.

Determine if the named contact database file exists.

If the aCntFile argument is the default, determines if default contact database file exists.

Determine if the database is ready. Ready in this context means that the database is open and readable/writable (i.e. the state machine is in CStateWritable).

Get the name of the default contact database file.

The given descriptor must have room for minimum of KCntMaxFilePath characters.

Delete a contact from the database.

Delete a named contact database.

Deletes the default contacts database if the default argument is used. The given descriptor must not contain more than KCntMaxFilePath characters.

Get a collection of contact IDs which have changed since the given time.

Get a collection of contact IDs which have the given GUID. Since GUIDs are unique (i.e. no two contacts can have the same GUID) there will only ever be one contact ID in this collection.

Get a collection of contact IDs for the given collection type.

End (cancel) request for database event from server.

Get a list of group IDs from the server.

Get a list of template IDs from the server.

Gets the size of the database file in bytes.

Get the database file UID.

Filter the database using the given filter.

Initialise the Persistence Layer collection class ready for iterative calls to the FindAsyncL() method. This form of initialisation is for an asynchronous find which uses text and a field definition.

Perform an asynchronous find iteration. Either the FindAsyncTextDefInitL() or the FindAsyncInitL() method above must have first been called.

Initialise the Persistence Layer collection class ready for iterative calls to the FindAsyncL() method. This form of initialisation is for an asynchronous find which uses a text definition and an array of "find words".

When there are multiple contact databases on a device this method 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.

Get the sort preferences from the server.

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.

Handle a premature termination of the contact server process by re-connecting the session and re-opening the database.

Returns the ID of the template that should be used with CContactICCEntry items. If aPhonebookUid is set, the ID of the template belonging to the phonebook with TUid aPhonebookUid is returned.

List the contact database files for any given drive unit. Lists all databases on all drives if aDriveUnit is set to NULL.

Get the machine ID.

Note: This function can leave.

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.

Open and lock an existing contact in the database. The contact item lock is pushed onto the cleanup stack.

Open a named contact database.

Opens the default contacts database if the default argument is used. The given descriptor must not contain more than KCntMaxFilePath characters.

Open a named contact database asynchronously.

Opens the default contacts database if the default argument is used. The given descriptor must not contain more than KCntMaxFilePath characters.

Open the database tables.

Set the machine ID (debug only).

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 contacts model group which represents the ADN phonebook.

Returns the ID of the database's preferred template, as set by the method SetPrefTemplateL() . The preferred template is for clients who may have multiple templates but want to identify one as preferred.

Push a Contact item unlock cleanup item on the cleanup stack.

Create the system template.

Read an existing contact in the database.

Remove a database event observer.

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.

Replace a named contact database with an empty one, replacing any database with the same name. Replaces the default contacts database if the default argument is used. The given descriptor must not contain more than KCntMaxFilePath characters.

Debug only.

Rollback a database transaction.

Seek to the given contact ID.

Set the asynchronous activity flag in the server. Any asynchronous activity such as asynchronous find or asynchronous sort prevent the database from being closed and should set this flag. When all asynchronous activites are finished this flag should be cleared.

When there are multiple contact databases on a device this method 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.

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.

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.

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:

Set the database filename. Used to re-open the database if the server is terminated prematurely.

Debug only.

Set the operation timeout value. This value is the length of time that a deferred request will remain in the request queue in the State Machine before being completed with an error code.

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

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.

Set the sort preferences in the server.

Change the existing contact view definition on the server.

Request a database event from the server.

Unpacks a contact item contained within the Packager's internal buffer and creates a contact item object. Within the server, the contact item has been written to the Packager's internal buffer by the RMessage2 .

If the buffer size was returned then the buffer was not large enough to hold a serialised contact item. The buffer must be expanded to the size returned by the server (ie aBufferSize) and the read operation performed again.

Unlock the last locked contact item on the server. Used by OpenLX().

Get the Contacts server version number.