MVPbkContactOperationFactory Class Reference

#include <app/MVPbkContactOperationFactory.h>

Link against: VPbkEng.lib

class MVPbkContactOperationFactory

Public Member Functions
virtual TAny *	ContactOperationFactoryExtension(TUid)
pure virtual MVPbkContactOperation *	CreateCommitContactsOperationL(const TArray< MVPbkStoreContact * > &, MVPbkBatchOperationObserver &)
pure virtual MVPbkContactOperation *	CreateCompressStoresOperationL(MVPbkBatchOperationObserver &)
pure virtual MVPbkContactOperation *	CreateContactRetrieverL(const MVPbkContactLink &, MVPbkSingleContactOperationObserver &)
pure virtual MVPbkContactOperation *	CreateDeleteContactsOperationL(const MVPbkContactLinkArray &, MVPbkBatchOperationObserver &)
pure virtual MVPbkContactOperation *	CreateFindOperationL(const TDesC &, const MVPbkFieldTypeList &, MVPbkContactFindObserver &)
pure virtual MVPbkContactOperation *	CreateFindOperationL(const MDesC16Array &, const MVPbkFieldTypeList &, MVPbkContactFindFromStoresObserver &, const TCallBack &)
pure virtual MVPbkContactOperation *	CreateMatchPhoneNumberOperationL(const TDesC &, TInt, MVPbkContactFindObserver &)

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.

Parameter	Description
aContacts	An array of contact links that specify the contacts
aObserver	An 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.

Parameter	Description
aObserver	An 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.

Parameter	Description
aLink	A link to the contact
aObserver	An 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.

Parameter	Description
aContactLinks	An array of contact links that specify the contacts.
aObserver	An 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.

Parameter	Description
aSearchString	String to search for.
aFieldTypes	List of field types that the search will include.
aObserver	Observer 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.

Parameter	Description
aSearchStrings	Words that are compared to field data.
aFieldTypes	Types of the fields that are used.
aObserver	An observer for asynchronous operation.
aWordParserCallBack	a 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,
			TInt	aMaxMatchDigits,
			MVPbkContactFindObserver &	aObserver
		)	[pure virtual]

Creates an operation for asynchronous phone number matching.

Parameter	Description
aPhoneNumber	A phone number to search for.
aMaxMatchDigits	Maximum number of digits to match from the end of the number.
aObserver	Observer for the find process.

Returns: A handle to the operation or NULL