CPbk2StoreConfiguration Class Reference

class CPbk2StoreConfiguration : public CBase

Phonebook 2 contact store configuration. The responsability of this class is to provide a centrally managed location where clients can retrieve the current store configuration of the device and to register as an observer to any store configuration events.

Inherits from

  • CPbk2StoreConfiguration

Constructor & Destructor Documentation

CPbk2StoreConfiguration()

CPbk2StoreConfiguration()[private]

~CPbk2StoreConfiguration()

~CPbk2StoreConfiguration()

Destructor.

Member Functions Documentation

AddContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C voidAddContactStoreURIL(TVPbkContactStoreUriPtraURI)

Adds a new contact store URI to current configuration. Then use AddSupportedContactStoreUriL to add the store to supported configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURIThe URI to add.

AddDefaultSavingStoreObserverL(MPbk2DefaultSavingStoreObserver &)

IMPORT_C voidAddDefaultSavingStoreObserverL(MPbk2DefaultSavingStoreObserver &aObserver)

Adds a default saving store observer.

Parameters

MPbk2DefaultSavingStoreObserver & aObserverThe observer to add.

AddObserverL(MPbk2StoreConfigurationObserver &)

IMPORT_C voidAddObserverL(MPbk2StoreConfigurationObserver &aObserver)

Adds a new configuration observer.

Parameters

MPbk2StoreConfigurationObserver & aObserverThe observer to add.

AddSupportedContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C voidAddSupportedContactStoreURIL(TVPbkContactStoreUriPtraURI)

Adds a new contact store URI to supported configuration. Use AddContactStoreURIL to add the store to current configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURIThe URI to add.

ConstructL()

voidConstructL()[private]

CurrentConfigurationL()

IMPORT_C CVPbkContactStoreUriArray *CurrentConfigurationL()const

Fetches an array of configured contact store URIs.

DefaultSavingStoreL()

IMPORT_C TVPbkContactStoreUriPtrDefaultSavingStoreL()const

Returns the URI of the default store for saving contacts.

NewL()

IMPORT_C CPbk2StoreConfiguration *NewL()[static]

Creates a new instance of this class.

RemoveContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C voidRemoveContactStoreURIL(TVPbkContactStoreUriPtraURI)

Removes a contact store URI from current configuration. Then use RemoveSupportedContactStoreUriL to remove the store from supported configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURIThe URI to remove.

RemoveDefaultSavingStoreObserver(MPbk2DefaultSavingStoreObserver &)

IMPORT_C voidRemoveDefaultSavingStoreObserver(MPbk2DefaultSavingStoreObserver &aObserver)

Removes a default saving store observer.

Parameters

MPbk2DefaultSavingStoreObserver & aObserverThe observer to remove.

RemoveObserver(MPbk2StoreConfigurationObserver &)

IMPORT_C voidRemoveObserver(MPbk2StoreConfigurationObserver &aObserver)

Removes a configuration observer.

Parameters

MPbk2StoreConfigurationObserver & aObserverThe observer to remove.

RemoveSupportedContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C voidRemoveSupportedContactStoreURIL(TVPbkContactStoreUriPtraURI)

Removes a contact store URI from supported configuration. Use RemoveContactStoreUriL to remove the store from current configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURIThe URI to remove.

SearchStoreConfigurationL()

IMPORT_C CVPbkContactStoreUriArray *SearchStoreConfigurationL()

Fetches an array of contact store URIs to be used in searching, for example in phone number matching.

SupportedStoreConfigurationL()

IMPORT_C CVPbkContactStoreUriArray *SupportedStoreConfigurationL()const

Fetches an array of supported contact stores URIs. NOTE: All returned stores are not necessarily supported by the current HW / SW configuration of the phone.

Member Data Documentation

CPbk2StoreConfigurationImpl * iImplementation

CPbk2StoreConfigurationImpl *iImplementation[private]