#include <app/CPbkContactEngine.h>
class CPbkContactEngine : public CBase |
Public Member Enumerations | |
---|---|
enum | TPbkNameOrder { EPbkNameOrderLastNameFirstName, EPbkNameOrderFirstNameLastName, EPbkNameOrderNotDefined } |
The main entrypoint to the Phonebook contact engine. The Phonebook contact engine builds on top of the Symbian Contacts model and implements platform specific functionality and policies that can be reused and followed by clients to implement functionality that is better integrated to the platform functionality. Functionality like contact field typing is implemented by this engine.
~CPbkContactEngine | ( | ) |
Destructor. Destroys this object and closes the contact database connection. REComSession::FinalClose() is called. Notice that FinalClose -call releases resource handles of already destroyed ECom plugins also outside CPbkContactEngine. See REComSession documentation.
IMPORT_C void | AddContactToGroupL | ( | TContactItemId | aItemId, |
TContactItemId | aGroupId | |||
) |
Adds a Contact to a group.
See also: CContactDatabase::AddContactToGroupL
Parameter | Description |
---|---|
aItemId | Contact to be added to group. |
aGroupId | Group where the contact will be added to. |
IMPORT_C TContactItemId | AddNewContactL | ( | CPbkContactItem & | aContact, |
TBool | aImmediateNotify = EFalse | |||
) |
Adds a new contact to the contact database.
See also: CContactDatabase::AddNewContactL
Parameter | Description |
---|---|
aContact | The new contact item to add. |
aImmediateNotify | Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice! |
Returns: The id of the new contact item.
IMPORT_C CContactViewBase & | AllContactsView | ( | ) |
Returns a contact view object containing all the contacts in the database.
See also: CContactViewBase
Returns: Contact view containing all the contacts in the database.
IMPORT_C CContactViewBase & | AllGroupsViewL | ( | ) |
Returns a contact view object containing all the groups in the database.
See also: CContactViewBase
Returns: Contact view containing all the groups in the database.
IMPORT_C void | CloseContactL | ( | TContactItemId | aContactId | ) |
Closes a previously opened contact item without saving changes.
See also: CContactDatabase::CloseContactL
Parameter | Description |
---|---|
aContactId | Contact item to be closed. |
IMPORT_C void | CommitContactGroupL | ( | CContactGroup & | aGroup, |
TBool | aImmediateNotify = EFalse | |||
) |
Commits changes to a contact group to the database.
See also: CContactDatabase::CommitContactL
Parameter | Description |
---|---|
aImmediateNotify | Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice! |
IMPORT_C void | CommitContactL | ( | CPbkContactItem & | aContact, |
TBool | aImmediateNotify = EFalse | |||
) |
Commit changes to a previously opened contact item into the contact database.
See also: CContactDatabase::CommitContactL
Parameter | Description |
---|---|
aContact | Contact item to be updated in the database. |
aImmediateNotify | Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice! |
IMPORT_C CPbkContactChangeNotifier * | CreateContactChangeNotifierL | ( | MPbkContactDbObserver * | aObserver | ) |
Creates and returns a new CPbkContactChangeNotifier for the default contact database. The returned object attaches aObserver to this engine instance as long as the object exists.
Parameter | Description |
---|---|
aObserver | Observer to attach to this object. |
Returns: New CPbkContactChangeNotifier object. Caller is responsible of the object.
IMPORT_C CContactGroup * | CreateContactGroupL | ( | const TDesC & | aGroupLabel, |
TBool | aInTransaction = EFalse | |||
) |
Creates a new contact group.
See also: CContactDatabase::CreateContactGroupL
Parameter | Description |
---|---|
aGroupLabel | Group name. |
aInTransaction | See Symbian Contacts Model documentation for CContactDatabase::CreateContactGroupL documentation. |
IMPORT_C CPbkContactIter * | CreateContactIteratorLC | ( | TBool | aUseMinimalRead = EFalse | ) |
Returns a Phonebook contact iterator.
See also: CPbkContactIter::NewL. CContactDatabase::ReadMinimalContactL
Parameter | Description |
---|---|
aUseMinimalRead | If ETrue the iterator will use the Symbian Contacts model CContactDatabase::ReadMinimalContactL, EFalse will read all the contact fields. Default behaviour is to read all fields. |
IMPORT_C CPbkContactItem * | CreateEmptyContactL | ( | ) |
Returns a new contact card with default fields.
Returns: A new empty contact item object.
IMPORT_C CContactDatabase & | Database | ( | ) |
Returns the underlying CContactDatabase object. Use only if this class's API is not enough for your purposes.
See also: CContactDatabase
Returns: The underlying Symbian Contacts model CContactDatabase instance.
IMPORT_C void | DeleteContactGroupL | ( | TContactItemId | aContactId, |
TBool | aImmediateNotify = EFalse | |||
) |
Deletes a contact group from the database.
See also: CContactDatabase::DeleteContactL
Parameter | Description |
---|---|
aContactId | Contact group to be deleted. |
aImmediateNotify | Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice! |
IMPORT_C void | DeleteContactL | ( | TContactItemId | aContactId, |
TBool | aImmediateNotify = EFalse | |||
) |
Deletes a contact item from the database.
See also: CContactDatabase::DeleteContactL
Parameter | Description |
---|---|
aContactId | Contact item to be deleted. |
aImmediateNotify | Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice! |
IMPORT_C void | DeleteContactsL | ( | const CContactIdArray & | aContactIds, |
TBool | aImmediateNotify = EFalse | |||
) |
Deletes multiple contact items from the database.
See also: CContactDatabase::DeleteContactsL
Parameter | Description |
---|---|
aContactIds | Contact items to be deleted. |
aImmediateNotify | Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice! |
IMPORT_C void | DeleteContactsOnBackgroundL | ( | const CContactIdArray & | aContactIds | ) |
Deletes multiple contacts from the database in an active object -driven asynchronous background process.
Parameter | Description |
---|---|
aContactIds | Contacts to delete. |
IMPORT_C TContactItemId | DuplicateContactL | ( | TContactItemId | aId, |
TBool | aImmediateNotify = EFalse | |||
) |
Duplicates a contact in the database.
Parameter | Description |
---|---|
aId | Id of the contact to duplicate. |
aImmediateNotify | Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice! |
Returns: Contact id of the new duplicate.
IMPORT_C const CPbkFieldsInfo & | FieldsInfo | ( | ) |
Returns the field type info array.
See also: CPbkFieldsInfo
Returns: All the Phonebook field types.
IMPORT_C CContactViewBase & | FilteredContactsViewL | ( | TInt | aFilter | ) |
Returns a contact view object containing all the contacts in the database that match a filter.
See also: CContactViewBase
Parameter | Description |
---|---|
aFilter | Use CContactDatabase::TContactViewFilter. |
IMPORT_C CPbkIdleFinder * | FindAsyncL | ( | const TDesC & | aText, |
const CPbkFieldIdArray * | aFieldTypes = NULL, | |||
MIdleFindObserver * | aObserver = NULL | |||
) |
Searches all contacts in the database for aText asynchronously.
See also: CContactDatabase::FindAsyncL. CPbkIdleFinder
Parameter | Description |
---|---|
aText | Text to search. |
aFieldTypes | Phonebook fields types to at least include in the search. If NULL searches all fields. PLEASE NOTE: The find matches in most cases also other fields than those specified in aFieldTypes. Always loop through the returned contacts to check match in the required fields. |
aObserver | Observer for this operation. |
Returns: CPbkIdleFinder object which is used to access the find results when complete. Deleting this object will cancel this asyncronous find operation.
IMPORT_C CContactIdArray * | FindLC | ( | const TDesC & | aText, |
const CPbkFieldIdArray * | aFieldTypes = NULL | |||
) |
Searches all contacts in the database for aText.
See also: CContactDatabase::FindLC.
Parameter | Description |
---|---|
aText | Text to search. |
aFieldTypes | Phonebook fields types to at least include in the search. If NULL searches all fields. PLEASE NOTE: The find matches in most cases also other fields than those specified in aFieldTypes. Always loop through the returned contacts to check match in the required fields. |
Returns: Array of matching contact IDs.
IMPORT_C RFs & | FsSession | ( | ) | const |
Returns an open file server session.
Returns: A handle to a file server session.
IMPORT_C HBufC * | GetContactTitleL | ( | const CPbkContactItem & | aItem | ) | const |
Gets a title text for a contact or localised text for unnamed contact if contact contains no title.
Parameter | Description |
---|---|
aItem | Contact item for which to make the title. |
Returns: A buffer containing the title or unnamed text if no title can be generated. Caller is responsible of deleting the returned buffer.
IMPORT_C HBufC * | GetContactTitleOrNullL | ( | const MPbkFieldDataArray & | aContactData | ) |
Similar to GetContactTitleL but returns NULL if contact contains no title. Uses the MPbkFieldDataArray interface to access the field content.
See also: CPbkContactEngine::GetContactTitleL
Parameter | Description |
---|---|
aContactData | The contact field data array. |
Returns: Contact title, NULL if field array did not contain any fields used to for constructing contact titles.
IMPORT_C TContactItemId | GetSpeedDialFieldL | ( | TInt | aSpeedDialPosition, |
TDes & | aPhoneNumber | |||
) | const |
Returns a speed dial contact.
See also: CContactDatabase::GetSpeedDialFieldL.
Parameter | Description |
---|---|
aSpeedDialPosition | Speed dial position number. |
aPhoneNumber | Phone number |
IMPORT_C TBool | IsSpeedDialAssigned | ( | const CPbkContactItem & | aItem, |
TInt | aFieldIndex | |||
) | const |
Returns ETrue if this field has been assigned a speed dial position.
Parameter | Description |
---|---|
aItem | contact Item to check for speed dial. |
aFieldIndex | Index of the field to check. This is an index into aItem.CardFields(). |
Returns: ETrue if Speed dial exitst, EFalse if not.
IMPORT_C TBool | IsTitleField | ( | TPbkFieldId | aFieldId | ) | const |
Returns ETrue if field is one of the fields used in building the contact title.
See also: GetContactTitleL GetContactTitleOrNullL
Parameter | Description |
---|---|
aFieldId | The id of the field. |
Returns: ETrue if aFieldId is type of a field used to build contact titles.
IMPORT_C CContactIdArray * | MatchPhoneNumberL | ( | const TDesC & | aNumber, |
const TInt | aMatchLengthFromRight | |||
) |
Call-through for new Phone number matching function in 6.2 version of class CContactDatabase. If you don't need any other functionality from CPbkContactEngine than this consider using the CContactDatabase API directly. See Symbian Contacts Model documentation for CContactDatabase::MatchPhoneNumberL use.
See also: CContactDatabase::MatchPhoneNumberL(const TDesC&,const TInt)
IMPORT_C CPbkContactEngine * | NewL | ( | RFs * | aFs = NULL | ) | [static] |
Creates a new Phonebook engine object and connects to the default contact database. If the default database does not exist it is created.
KErrCorrupt |
if the database is corrupted. |
Parameter | Description |
---|---|
aFs | An open file server connection. If !=NULL aFs is used instead of a locally created RFs connection. aFs must remain connected for the lifetime of the returned object. |
Returns: A new instance of this class.
IMPORT_C CPbkContactEngine * | NewL | ( | const TDesC & | aFileName, |
TBool | aReplace = EFalse, | |||
RFs * | aFs = NULL | |||
) | [static] |
IMPORT_C CContactGroup * | OpenContactGroupL | ( | TContactItemId | aId | ) |
Opens a Contact group for modification.
See also: CContactDatabase::OpenContactL
Parameter | Description |
---|---|
aId | Groups id |
Returns: Contact group object.
IMPORT_C CContactGroup * | OpenContactGroupLCX | ( | TContactItemId | aId | ) |
Opens a Contact group for modification. Pushes the returned contact group object and a lock item on the cleanup stack.
See also: CContactDatabase::OpenContactLX
Parameter | Description |
---|---|
aId | Groups id |
Returns: Contact group object.
IMPORT_C CPbkContactItem * | OpenContactL | ( | TContactItemId | aContactId | ) |
Opens a contact and returns a phonebook contact item.
See also: CContactDatabase::OpenContactL
Parameter | Description |
---|---|
aContactId | Contact item id to be opened. |
Returns: A Phonebook contact item that is marked as open in the database.
IMPORT_C CPbkContactItem * | OpenContactLCX | ( | TContactItemId | aContactId | ) |
Same as OpenContactL, but leaves a lock record AND the opened contact object on the cleanup stack. Use CleanupStack::PopAndDestroy(2) to close the contact and destroy the returned object. First pop pops the contact object and second the lock object.
See also: CContactDatabase::OpenContactLX
Parameter | Description |
---|---|
aContactId | Contact item id to open. |
Returns: A Phonebook contact item that is marked as open in the database.
IMPORT_C CContactGroup * | ReadContactGroupL | ( | TContactItemId | aId | ) |
Reads a Contact group.
See also: CContactDatabase::ReadContactL
Parameter | Description |
---|---|
aId | Group id. |
Returns: Contact group object.
IMPORT_C CPbkContactItem * | ReadContactL | ( | TContactItemId | aContactId, |
const CPbkFieldIdArray * | aFieldTypes = NULL | |||
) |
Reads a contact and returns a phonebook contact item.
See also: CContactDatabase::ReadContactL
Parameter | Description |
---|---|
aContactId | Contact item id to be read. |
aFieldTypes | Array of types of fields to read in, all fields are read if NULL (which is default). NOTE: when using this parameter ReadContactL may return more fields than expected; for example if aFieldTypes contains any phonenumber the method may return all phone number fields of the contact. |
Returns: A new Phonebook contact item.
IMPORT_C CPbkContactItem * | ReadContactLC | ( | TContactItemId | aContactId, |
const CPbkFieldIdArray * | aFieldTypes = NULL | |||
) |
Same as ReadContactL, but leaves the returned contact item on the cleanup stack.
Parameter | Description |
---|---|
aContactId | Contact item id to be read. |
aFieldTypes | Array of types of fields to read in, all fields are read if NULL (which is default). NOTE: when using this parameter ReadContactL may return more fields than expected; for example if aFieldTypes contains any phonenumber the method may return all phone number fields of the contact. |
Returns: A new Phonebook contact item.
IMPORT_C CPbkContactItem * | ReadMinimalContactLC | ( | TContactItemId | aContactId | ) |
Same as ReadContactLC but reads only minimal information. See Symbian Contacts Model documentation for definition of "minimal" in this case.
See also: CContactDatabase::ReadMinimalContactL
Parameter | Description |
---|---|
aContactId | Contact item id to be read. |
Returns: A new phonebook contact item. Leaves the item on the cleanup stack.
IMPORT_C void | RemoveContactFromGroupL | ( | TContactItemId | aItemId, |
TContactItemId | aGroupId | |||
) |
Removes a contact from a group
Parameter | Description |
---|---|
aItemId | Contact to be removed from group. |
aGroupId | Group where the contact will be removed from. |
IMPORT_C void | RemoveSpeedDialFieldL | ( | TContactItemId | aContactId, |
TInt | aSpeedDialPosition | |||
) |
Removes a speed dial from a contact.
See also: CContactDatabase::RemoveSpeedDialFieldL.
Parameter | Description |
---|---|
aContactId | Contact item to remove the speed dial from. |
aSpeedDialPosition | Speed dial position number to remove. |
IMPORT_C CPbkContactEngine * | ReplaceL | ( | RFs * | aFs = NULL | ) | [static] |
Replaces the default contact database and connects to it. See Symbian Contacs model documentation for CContactDatabase::ReplaceL for possible leave codes. PLEASE NOTE: all data in the existing database will be lost!
See also: CContactDatabase::ReplaceL
Parameter | Description |
---|---|
aFs | An open file server connection. If !=NULL aFs is used instead of a locally created RFs connection. aFs must remain connected for the lifetime of the returned object. |
Returns: A new instance of this class.
IMPORT_C void | SetFieldAsSpeedDialL | ( | CPbkContactItem & | aItem, |
TInt | aFieldIndex, | |||
TInt | aSpeedDialPosition | |||
) |
Sets a speed dial to a contact field.
See also: CContactDatabase::SetFieldAsSpeedDialL
Parameter | Description |
---|---|
aItem | Contact item to add speed dial to. |
aFieldIndex | Field index to add Speed dial to. |
aSpeedDialPosition | Speed dial position number to set to the field. |
IMPORT_C CPbkContactEngine * | Static | ( | ) | [static] |
Returns the global Phonebook engine instance, NULL if no instance created yet. Note1: Uses thread local storage (TLS), which is slow. Cache the returned pointer if it is used more than one time! Note2: Only the first engine instance created in calling thread can be accessed with this function.
Returns: Global Phonebook engine instance.
IMPORT_C const TDesC & | UnnamedTitle | ( | ) | const |
Returns the localised title text to use for unnamed contacts.
Returns: Localised title text to use for unnamed contacts.