MVPbkContactStoreProperties Class Reference

class MVPbkContactStoreProperties

An interface for static contact store properties.

Client can retrieve the static store properties using this interface. The store must be opened before usage.

MVPbkContactStore::StoreProperties

Constructor & Destructor Documentation

~MVPbkContactStoreProperties()

~MVPbkContactStoreProperties()[inline, virtual]

Member Functions Documentation

ContactStorePropertiesExtension(TUid)

TAny *ContactStorePropertiesExtension(TUid)[inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

Local()

TBool Local()const [pure virtual]

Returns true if the store is local.

The data is stored in the device. This is the opposite of the remote stores. E.g. stores that are in device memory, memory card or SIM card are local stores. Stores that reside in an external device are not local.

Name()

TVPbkContactStoreUriPtr Name()const [pure virtual]

Returns the EContactStoreUriStoreLocation component of the URI.

The name could be e.g. contacts.cdb.

Persistent()

TBool Persistent()const [pure virtual]

Returns true if the store is persistent.

Persistent means that if you do changes to a store and then switch of the power of the phone the contact doesn't disappear but can be retrieved from the store later. E.g. a store in RAM wouldn't be persistent.

ReadOnly()

TBool ReadOnly()const [pure virtual]

Returns true if the store is read-only.

Contacts can not be created, edited nor deleted if the store is read-only.

Removable()

TBool Removable()const [pure virtual]

Returns true if the data is stored on removable media.

It means that store can be removed from the device run time by the user. Memory card is typically this kind of memory and also SIM card can be removed run time in some devices. Remote stores are also removable since user can e.g. switch to offline mode.

SupportedFields()

const MVPbkFieldTypeList &SupportedFields()const [pure virtual]

Returns list of supported fields.

The list contains a sub set of field types from the master field type list in CVPbkContactManager.

CVPbkContactManager::FieldTypes

SupportsContactGroups()

TBool SupportsContactGroups()const [pure virtual]

Returns true if the store supports contact groups.

SupportsDefaults()

TBool SupportsDefaults()const [pure virtual]

Returns true if the store supports defaults fields.

Default field information is a contact field attribute and can be retrieved using the attribute manager.

MVPbkContactAttributeManager CVPbkDefaultAttribute

SupportsFieldLabels()

TBool SupportsFieldLabels()const [pure virtual]

Returns true if the store supports field labels.

The support here means a global support i.e all fields of the store support labels.

MVPbkStoreContactField::SupportsLabel

SupportsService(TUid)

TBool SupportsService(TUidaServiceUid)const [pure virtual]

Returns true if the store supports the requested service.

Parameters

TUid aServiceUidThe UID that is mapped to a service.

SupportsSpeedDials()

TBool SupportsSpeedDials()const [pure virtual]

Returns true if the store supports speed dials.

Speed dial information is a contact field attribute and can be retrieved using the attribute manager.

MVPbkContactAttributeManager CVPbkSpeedDialAttribute

SupportsVoiceTags()

TBool SupportsVoiceTags()const [pure virtual]

Returns true if the store supports voice tags.

Voice tag information is a contact field attribute and can be retrieved using the attribute manager.

MVPbkContactAttributeManager CVPbkVoiceTagAttribute

Uri()

TVPbkContactStoreUriPtr Uri()const [pure virtual]

Returns the complete URI of the contact store.

The URI could be e.g cntdb://c:contacts.cdb