MVPbkContactOperationFactory Class Reference

#include <app/MVPbkContactOperationFactory.h>

Link against: VPbkEng.lib

class MVPbkContactOperationFactory

Detailed Description

A factory interface for asynchronous contact operations. This interface is used to create contact operations.

Member Function Documentation

ContactOperationFactoryExtension ( TUid )

TAny *ContactOperationFactoryExtension(TUid)[inline, virtual]

Returns an extension point for this interface or NULL.

Returns: Extension point or NULL.

CreateCommitContactsOperationL ( const TArray< MVPbkStoreContact * > &, MVPbkBatchOperationObserver & )

MVPbkContactOperation *CreateCommitContactsOperationL(const TArray< MVPbkStoreContact * > &aContacts,
MVPbkBatchOperationObserver &aObserver
)[pure virtual]

Creates an operation for committing multiple contacts.

ParameterDescription
aContactsAn array of contact links that specify the contacts
aObserverAn observer for the operation.

Returns: A handle to the operation or NULL

CreateCompressStoresOperationL ( MVPbkBatchOperationObserver & )

MVPbkContactOperation *CreateCompressStoresOperationL(MVPbkBatchOperationObserver &aObserver)[pure virtual]

Creates an operation for compressing the store.

ParameterDescription
aObserverAn observer for the compress operation.

Returns: A handle to the operation or NULL

CreateContactRetrieverL ( const MVPbkContactLink &, MVPbkSingleContactOperationObserver & )

MVPbkContactOperation *CreateContactRetrieverL(const MVPbkContactLink &aLink,
MVPbkSingleContactOperationObserver &aObserver
)[pure virtual]

Creates an operation for contact retrieval.

ParameterDescription
aLinkA link to the contact
aObserverAn observer for the operation.

Returns: A handle to the operation or NULL if the factory doesn't have reference to the store of the link.

CreateDeleteContactsOperationL ( const MVPbkContactLinkArray &, MVPbkBatchOperationObserver & )

MVPbkContactOperation *CreateDeleteContactsOperationL(const MVPbkContactLinkArray &aContactLinks,
MVPbkBatchOperationObserver &aObserver
)[pure virtual]

Creates an operation for deleting multiple contacts.

ParameterDescription
aContactLinksAn array of contact links that specify the contacts.
aObserverAn observer for the operation.

Returns: A handle to the operation or NULL

CreateFindOperationL ( const TDesC &, const MVPbkFieldTypeList &, MVPbkContactFindObserver & )

MVPbkContactOperation *CreateFindOperationL(const TDesC &aSearchString,
const MVPbkFieldTypeList &aFieldTypes,
MVPbkContactFindObserver &aObserver
)[pure virtual]

Creates an operation for asynchronous contact finding.

ParameterDescription
aSearchStringString to search for.
aFieldTypesList of field types that the search will include.
aObserverObserver for the find process.

Returns: A handle to the operation or NULL

CreateFindOperationL ( const MDesC16Array &, const MVPbkFieldTypeList &, MVPbkContactFindFromStoresObserver &, const TCallBack & )

MVPbkContactOperation *CreateFindOperationL(const MDesC16Array &aSearchStrings,
const MVPbkFieldTypeList &aFieldTypes,
MVPbkContactFindFromStoresObserver &aObserver,
const TCallBack &aWordParserCallBack
)[pure virtual]

Creates an operation for asynchronous contact finding. Finds a string containing text that is stored in one or more fields. Client can give multiple find words. All the words must match to separated data. E.g if there are two find words: "Jo" and "Jo" then field data "John Johnson" matches but "John Doe" doesn't if the word parser uses white space as a word separator.

NOTE: The accuracy of the results depends on the ability of the store implementation to implement the find. The performance can vary too depending on the store.

ParameterDescription
aSearchStringsWords that are compared to field data.
aFieldTypesTypes of the fields that are used.
aObserverAn observer for asynchronous operation.
aWordParserCallBacka client implementation of word parser function that separates the field data into words. Parameter to function is TVPbkWordParserParam.

Returns: A handle to the operation or NULL

CreateMatchPhoneNumberOperationL ( const TDesC &, TInt, MVPbkContactFindObserver & )

MVPbkContactOperation *CreateMatchPhoneNumberOperationL(const TDesC &aPhoneNumber,
TIntaMaxMatchDigits,
MVPbkContactFindObserver &aObserver
)[pure virtual]

Creates an operation for asynchronous phone number matching.

ParameterDescription
aPhoneNumberA phone number to search for.
aMaxMatchDigitsMaximum number of digits to match from the end of the number.
aObserverObserver for the find process.

Returns: A handle to the operation or NULL