MVPbkContactStoreList Class Reference

class MVPbkContactStoreList

An interface for a list of contact stores.

The interface provides an access to multiple stores. It's possible to open and close all stores in single call using this interface. When client calls OpenAllL it must also calls CloseAll after usage.

CVPbkContactManager::ContactStoresL

Constructor & Destructor Documentation

~MVPbkContactStoreList()

~MVPbkContactStoreList ( ) [inline, virtual]

Member Functions Documentation

At(TInt)

MVPbkContactStore & At ( TInt aIndex ) const [pure virtual]

Returns the store in given index in the list.

Parameters

TInt aIndex the index of the store in the list aIndex >= 0 && aIndex < Count() VPbkError::Panic(VPbkError::EInvalidStoreIndex) is raised if the precondition does not hold.

CloseAll(MVPbkContactStoreListObserver &)

void CloseAll ( MVPbkContactStoreListObserver & aObserver ) [pure virtual]

Closes all stores in the list.

This is safe to call in all circumstances. Implementations can not trust that OpenAllL has been called before.

Parameters

MVPbkContactStoreListObserver & aObserver An observer for the close process.

ContactStoreListExtension(TUid)

TAny * ContactStoreListExtension ( TUid ) [inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

Count()

TInt Count ( ) const [pure virtual]

Returns the number of stores in the list.

Find(const TVPbkContactStoreUriPtr &)

MVPbkContactStore * Find ( const TVPbkContactStoreUriPtr & aUri ) const [pure virtual]

Finds the contact store corresponding to the aUri.

Parameters

const TVPbkContactStoreUriPtr & aUri the store URI to search for.

OpenAllL(MVPbkContactStoreListObserver &)

void OpenAllL ( MVPbkContactStoreListObserver & aObserver ) [pure virtual]

Opens all stores in the list asynchronously.

A client can not use stores before it has successfully opened them. CloseAll must be always called by the same observer that has opened stores.

NOTE: There can be only one observer for one store list at a time.

Exceptions
KErrInUse

If one observer is currently opening this list.

Parameters

MVPbkContactStoreListObserver & aObserver An observer for the stores.