MVPbkContactAttributeManager Class Reference

#include <app/MVPbkContactAttributeManager.h>

Link against: VPbkVCardEng.lib

class MVPbkContactAttributeManager
Public Member Functions
virtual ~MVPbkContactAttributeManager()
virtual TAny *ContactAttributeManagerExtension(TUid)
pure virtual MVPbkStoreContactField *FindFieldWithAttributeL(const MVPbkContactAttribute &, MVPbkStoreContact &)
pure virtual MVPbkContactOperationBase *FindFieldsWithAttributeL(TUid, MVPbkStoreContact &, MVPbkMultiAttributePresenceObserver &)
pure virtual MVPbkContactOperationBase *FindFieldsWithAttributeL(const MVPbkContactAttribute &, MVPbkStoreContact &, MVPbkMultiAttributePresenceObserver &)
pure virtual MVPbkStoreContactFieldCollection *FindFieldsWithAttributeLC(TUid, MVPbkStoreContact &)
pure virtual MVPbkStoreContactFieldCollection *FindFieldsWithAttributeLC(const MVPbkContactAttribute &, MVPbkStoreContact &)
pure virtual TBool HasContactAttributeL(TUid, const MVPbkStoreContact &)
pure virtual TBool HasContactAttributeL(const MVPbkContactAttribute &, const MVPbkStoreContact &)
pure virtual MVPbkContactOperationBase *HasContactAttributeL(TUid, const MVPbkStoreContact &, MVPbkSingleAttributePresenceObserver &)
pure virtual MVPbkContactOperationBase *HasContactAttributeL(const MVPbkContactAttribute &, const MVPbkStoreContact &, MVPbkSingleAttributePresenceObserver &)
pure virtual TBool HasFieldAttributeL(TUid, const MVPbkStoreContactField &)
pure virtual TBool HasFieldAttributeL(const MVPbkContactAttribute &, const MVPbkStoreContactField &)
pure virtual MVPbkContactOperationBase *HasFieldAttributeL(TUid, const MVPbkStoreContactField &, MVPbkSingleAttributePresenceObserver &)
pure virtual MVPbkContactOperationBase *HasFieldAttributeL(const MVPbkContactAttribute &, const MVPbkStoreContactField &, MVPbkSingleAttributePresenceObserver &)
pure virtual MVPbkContactOperationBase *ListContactsL(TUid, MVPbkContactFindObserver &)
pure virtual MVPbkContactOperationBase *ListContactsL(const MVPbkContactAttribute &, MVPbkContactFindObserver &)
pure virtual MVPbkContactOperationBase *RemoveContactAttributeL(const MVPbkContactLink &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver &)
pure virtual MVPbkContactOperationBase *RemoveContactAttributeL(const MVPbkContactLink &, TUid, MVPbkSetAttributeObserver &)
pure virtual MVPbkContactOperationBase *RemoveFieldAttributeL(MVPbkStoreContactField &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver &)
pure virtual MVPbkContactOperationBase *RemoveFieldAttributeL(MVPbkStoreContactField &, TUid, MVPbkSetAttributeObserver &)
pure virtual MVPbkContactOperationBase *SetContactAttributeL(const MVPbkContactLink &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver &)
pure virtual MVPbkContactOperationBase *SetFieldAttributeL(MVPbkStoreContactField &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver &)

Detailed Description

Abstract interface for contact attribute manager.

Contact attribute manager can be used to set global attributes such as speed dials for contacts or fields of contacts. The attributes can be stored in external databases so that some kind of mapping is maintained between contacts and attributes. This interface provides unified access to all global attributes.

Constructor & Destructor Documentation

~MVPbkContactAttributeManager ( )

~MVPbkContactAttributeManager()[inline, virtual]

Destructor.

Member Function Documentation

ContactAttributeManagerExtension ( TUid )

TAny *ContactAttributeManagerExtension(TUid)[inline, virtual]

Returns an extension point for this interface or NULL.

Returns: Extension point or NULL

FindFieldWithAttributeL ( const MVPbkContactAttribute &, MVPbkStoreContact & )

MVPbkStoreContactField *FindFieldWithAttributeL(const MVPbkContactAttribute &aAttr,
MVPbkStoreContact &aContact
)const [pure virtual]

Finds the first field that has the aAttr and returns a reference to the field or NULL if not found.

Note: the returned reference will become invalid if MVPbkStoreContactFieldCollection::FieldAt is called for different field. If this is a problem then use MVPbkStoreContactField::CloneLC for permanent copy of the field.

ParameterDescription
aAttrThe attribute that is looked for.
aContactContact whose fields are iterated.

Returns: Returns a reference to the field or NULL if not found.

FindFieldsWithAttributeL ( TUid, MVPbkStoreContact &, MVPbkMultiAttributePresenceObserver & )

MVPbkContactOperationBase *FindFieldsWithAttributeL(TUidaAttributeType,
MVPbkStoreContact &aContact,
MVPbkMultiAttributePresenceObserver &aObserver
)const [pure virtual]

Initiates an asynchronous operation, which finds the aAttribute type attributed fields from the contact.

ParameterDescription
aAttributeTypeType of the attribute to find for.
aContactContact whose attributes are checked.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

FindFieldsWithAttributeL ( const MVPbkContactAttribute &, MVPbkStoreContact &, MVPbkMultiAttributePresenceObserver & )

MVPbkContactOperationBase *FindFieldsWithAttributeL(const MVPbkContactAttribute &aAttribute,
MVPbkStoreContact &aContact,
MVPbkMultiAttributePresenceObserver &aObserver
)const [pure virtual]

Initiates an asynchronous operation, which finds the aAttribute type attributed fields from the contact.

ParameterDescription
aAttributeAttribute prototype to match against.
aContactContact whose attributes are checked.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

FindFieldsWithAttributeLC ( TUid, MVPbkStoreContact & )

MVPbkStoreContactFieldCollection *FindFieldsWithAttributeLC(TUidaAttributeType,
MVPbkStoreContact &aContact
)const [pure virtual]

Returns fields with attribute type aAttributeType, or NULL if there is no fields with that attribute in this contact.

ParameterDescription
aAttributeTypeType of the attribute to find for.
aContactContact whose attributes are checked.

FindFieldsWithAttributeLC ( const MVPbkContactAttribute &, MVPbkStoreContact & )

MVPbkStoreContactFieldCollection *FindFieldsWithAttributeLC(const MVPbkContactAttribute &aAttribute,
MVPbkStoreContact &aContact
)const [pure virtual]

Returns fields with attribute aAttribute, or NULL if there is no fields with that attribute in this contact.

ParameterDescription
aAttributeAttribute prototype to match against.
aContactContact whose attributes are checked.

HasContactAttributeL ( TUid, const MVPbkStoreContact & )

TBool HasContactAttributeL(TUidaAttributeType,
const MVPbkStoreContact &aContact
)const [pure virtual]

Checks if the given contact has the given attribute.

ParameterDescription
aAttributeTypeType of the attribute to check for.
aContactContact whose attributes are checked.

Returns: ETrue if aContact has an attribute of aAttributeType, EFalse otherwise.

HasContactAttributeL ( const MVPbkContactAttribute &, const MVPbkStoreContact & )

TBool HasContactAttributeL(const MVPbkContactAttribute &aAttribute,
const MVPbkStoreContact &aContact
)const [pure virtual]

Checks if the given contact has an attribute matching the given attribute.

ParameterDescription
aAttributeAttribute prototype to match against.
aContactContact whose attributes are checked.

Returns: ETrue if aContact has an attribute matching the aAttribute, EFalse otherwise.

HasContactAttributeL ( TUid, const MVPbkStoreContact &, MVPbkSingleAttributePresenceObserver & )

MVPbkContactOperationBase *HasContactAttributeL(TUidaAttributeType,
const MVPbkStoreContact &aContact,
MVPbkSingleAttributePresenceObserver &aObserver
)const [pure virtual]

Checks if the given contact has the given attribute asynchronously.

ParameterDescription
aAttributeTypeType of the attribute to check for.
aContactContact whose attributes are checked.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

HasContactAttributeL ( const MVPbkContactAttribute &, const MVPbkStoreContact &, MVPbkSingleAttributePresenceObserver & )

MVPbkContactOperationBase *HasContactAttributeL(const MVPbkContactAttribute &aAttribute,
const MVPbkStoreContact &aContact,
MVPbkSingleAttributePresenceObserver &aObserver
)const [pure virtual]

Checks if the given contact has an attribute matching the given attribute asynchronously.

ParameterDescription
aAttributeAttribute prototype to match against.
aContactContact whose attributes are checked.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

HasFieldAttributeL ( TUid, const MVPbkStoreContactField & )

TBool HasFieldAttributeL(TUidaAttributeType,
const MVPbkStoreContactField &aField
)const [pure virtual]

Checks if the given contact field has the given attribute.

ParameterDescription
aAttributeTypeType of the attribute to check for.
aFieldField whose attributes are checked.

Returns: ETrue if aField has an attribute of aAttributeType, EFalse otherwise.

HasFieldAttributeL ( const MVPbkContactAttribute &, const MVPbkStoreContactField & )

TBool HasFieldAttributeL(const MVPbkContactAttribute &aAttribute,
const MVPbkStoreContactField &aField
)const [pure virtual]

Checks if the given contact field has an attribute matching the given attribute.

ParameterDescription
aAttributeAttribute prototype to match against.
aFieldContact field whose attribute is checked.

Returns: ETrue if aField has an attribute matching the aAttribute, EFalse otherwise.

HasFieldAttributeL ( TUid, const MVPbkStoreContactField &, MVPbkSingleAttributePresenceObserver & )

MVPbkContactOperationBase *HasFieldAttributeL(TUidaAttributeType,
const MVPbkStoreContactField &aField,
MVPbkSingleAttributePresenceObserver &aObserver
)const [pure virtual]

Checks if the given contact field has the given attribute asynchronously.

ParameterDescription
aAttributeTypeType of the attribute to check for.
aFieldField whose attributes are checked.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

HasFieldAttributeL ( const MVPbkContactAttribute &, const MVPbkStoreContactField &, MVPbkSingleAttributePresenceObserver & )

MVPbkContactOperationBase *HasFieldAttributeL(const MVPbkContactAttribute &aAttribute,
const MVPbkStoreContactField &aField,
MVPbkSingleAttributePresenceObserver &aObserver
)const [pure virtual]

Checks if the given contact field has an attribute matching the given attribute asynchronously.

ParameterDescription
aAttributeAttribute prototype to match against.
aFieldContact field whose attribute is checked.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

ListContactsL ( TUid, MVPbkContactFindObserver & )

MVPbkContactOperationBase *ListContactsL(TUidaAttributeType,
MVPbkContactFindObserver &aObserver
)[pure virtual]

Lists all contacts having the requested type of attribute asynchronously.

ParameterDescription
aAttributeTypeType of the attribute to search for.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the process.

ListContactsL ( const MVPbkContactAttribute &, MVPbkContactFindObserver & )

MVPbkContactOperationBase *ListContactsL(const MVPbkContactAttribute &aAttribute,
MVPbkContactFindObserver &aObserver
)[pure virtual]

Lists all contacts matching the given attribute asynchronously.

ParameterDescription
aAttributeAttribute prototype to match against.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the process.

RemoveContactAttributeL ( const MVPbkContactLink &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver & )

MVPbkContactOperationBase *RemoveContactAttributeL(const MVPbkContactLink &aContactLink,
const MVPbkContactAttribute &aAttribute,
MVPbkSetAttributeObserver &aObserver
)[pure virtual]

asynchronously removes the given attribute from the contact referred by the aContactLink.

ParameterDescription
aContactLinkLink to the contact whose attribute to remove.
aAttributeAttribute to remove from the contact.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

RemoveContactAttributeL ( const MVPbkContactLink &, TUid, MVPbkSetAttributeObserver & )

MVPbkContactOperationBase *RemoveContactAttributeL(const MVPbkContactLink &aContactLink,
TUidaAttributeType,
MVPbkSetAttributeObserver &aObserver
)[pure virtual]

asynchronously removes all attributes having the attribute type aAttributeType from the contact.

ParameterDescription
aContactLinkLink to the contact whose attribute to remove.
aAttributeTypeType of the attributes to remove from the contact.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

RemoveFieldAttributeL ( MVPbkStoreContactField &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver & )

MVPbkContactOperationBase *RemoveFieldAttributeL(MVPbkStoreContactField &aField,
const MVPbkContactAttribute &aAttribute,
MVPbkSetAttributeObserver &aObserver
)[pure virtual]

Asynchronously removes the given attribute from the given contact field.

ParameterDescription
aFieldField whose attribute to remove.
aAttributeAttribute to remove from the contact field.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

RemoveFieldAttributeL ( MVPbkStoreContactField &, TUid, MVPbkSetAttributeObserver & )

MVPbkContactOperationBase *RemoveFieldAttributeL(MVPbkStoreContactField &aField,
TUidaAttributeType,
MVPbkSetAttributeObserver &aObserver
)[pure virtual]

Asynchronously removes all attributes having the attribute type aAttributeType from the contact field.

ParameterDescription
aFieldField whose attribute to remove.
aAttributeTypeType of the attributes to remove from the contact field.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

SetContactAttributeL ( const MVPbkContactLink &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver & )

MVPbkContactOperationBase *SetContactAttributeL(const MVPbkContactLink &aContactLink,
const MVPbkContactAttribute &aAttribute,
MVPbkSetAttributeObserver &aObserver
)[pure virtual]

Asynchronously sets the contact attribute for the contact referred by the given contact link.

ParameterDescription
aContactLinkLink to contact whose attribute to set.
aAttributeAttribute to set for the contact.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.

SetFieldAttributeL ( MVPbkStoreContactField &, const MVPbkContactAttribute &, MVPbkSetAttributeObserver & )

MVPbkContactOperationBase *SetFieldAttributeL(MVPbkStoreContactField &aField,
const MVPbkContactAttribute &aAttribute,
MVPbkSetAttributeObserver &aObserver
)[pure virtual]

Asynchronously sets the contact field attribute for the give contact field.

ParameterDescription
aFieldContact field whose attribute to set.
aAttributeAttribute to set for the contact field.
aObserverObserver for the asynchronous process.

Returns: Newly created handle to the operation.