Collapse all Symbian^3 Product Developer Library

MVPbkContactOperationFactory Class Reference

class MVPbkContactOperationFactory

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

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

Member Functions Documentation

ContactOperationFactoryExtension(TUid)

TAny *

ContactOperationFactoryExtension

(

TUid

)

[inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

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

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

Creates an operation for committing multiple contacts.

Parameters

const TArray< MVPbkStoreContact * > & aContacts	An array of contact links that specify the contacts
MVPbkBatchOperationObserver & aObserver	An observer for the operation.

CreateCompressStoresOperationL(MVPbkBatchOperationObserver &)

MVPbkContactOperation *

CreateCompressStoresOperationL

(

MVPbkBatchOperationObserver &

aObserver

)

[pure virtual]

Creates an operation for compressing the store.

Parameters

MVPbkBatchOperationObserver & aObserver

An observer for the compress operation.

CreateContactRetrieverL(const MVPbkContactLink &, MVPbkSingleContactOperationObserver &)

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

Creates an operation for contact retrieval.

Parameters

const MVPbkContactLink & aLink	A link to the contact
MVPbkSingleContactOperationObserver & aObserver	An observer for the operation.

CreateDeleteContactsOperationL(const MVPbkContactLinkArray &, MVPbkBatchOperationObserver &)

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

Creates an operation for deleting multiple contacts.

Parameters

const MVPbkContactLinkArray & aContactLinks	An array of contact links that specify the contacts.
MVPbkBatchOperationObserver & aObserver	An observer for the operation.

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.

Parameters

const TDesC & aSearchString	String to search for.
const MVPbkFieldTypeList & aFieldTypes	List of field types that the search will include.
MVPbkContactFindObserver & aObserver	Observer for the find process.

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.

Parameters

const MDesC16Array & aSearchStrings	Words that are compared to field data.
const MVPbkFieldTypeList & aFieldTypes	Types of the fields that are used.
MVPbkContactFindFromStoresObserver & aObserver	An observer for asynchronous operation.
const TCallBack & aWordParserCallBack	a client implementation of word parser function that separates the field data into words. Parameter to function is TVPbkWordParserParam.

CreateMatchPhoneNumberOperationL(const TDesC &, TInt, MVPbkContactFindObserver &)

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

Creates an operation for asynchronous phone number matching.

Parameters

const TDesC & aPhoneNumber	A phone number to search for.
TInt aMaxMatchDigits	Maximum number of digits to match from the end of the number.
MVPbkContactFindObserver & aObserver	Observer for the find process.