MVPbkContactAttributeManager Class Reference

class MVPbkContactAttributeManager

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.

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

Constructor & Destructor Documentation

~MVPbkContactAttributeManager()

~MVPbkContactAttributeManager ( ) [inline, virtual]

Destructor.

Member Functions Documentation

ContactAttributeManagerExtension(TUid)

TAny * ContactAttributeManagerExtension ( TUid ) [inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

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.

Parameters

const MVPbkContactAttribute & aAttr The attribute that is looked for.
MVPbkStoreContact & aContact Contact whose fields are iterated.

FindFieldsWithAttributeL(TUid, MVPbkStoreContact &, MVPbkMultiAttributePresenceObserver &)

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

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

Parameters

TUid aAttributeType Type of the attribute to find for.
MVPbkStoreContact & aContact Contact whose attributes are checked.
MVPbkMultiAttributePresenceObserver & aObserver Observer for the asynchronous process.

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.

Parameters

const MVPbkContactAttribute & aAttribute Attribute prototype to match against.
MVPbkStoreContact & aContact Contact whose attributes are checked.
MVPbkMultiAttributePresenceObserver & aObserver Observer for the asynchronous process.

FindFieldsWithAttributeLC(TUid, MVPbkStoreContact &)

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

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

Parameters

TUid aAttributeType Type of the attribute to find for.
MVPbkStoreContact & aContact Contact 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.

Parameters

const MVPbkContactAttribute & aAttribute Attribute prototype to match against.
MVPbkStoreContact & aContact Contact whose attributes are checked.

HasContactAttributeL(TUid, const MVPbkStoreContact &)

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

Checks if the given contact has the given attribute.

Parameters

TUid aAttributeType Type of the attribute to check for.
const MVPbkStoreContact & aContact Contact whose attributes are checked.

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.

Parameters

const MVPbkContactAttribute & aAttribute Attribute prototype to match against.
const MVPbkStoreContact & aContact Contact whose attributes are checked.

HasContactAttributeL(TUid, const MVPbkStoreContact &, MVPbkSingleAttributePresenceObserver &)

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

Checks if the given contact has the given attribute asynchronously.

Parameters

TUid aAttributeType Type of the attribute to check for.
const MVPbkStoreContact & aContact Contact whose attributes are checked.
MVPbkSingleAttributePresenceObserver & aObserver Observer for the asynchronous process.

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.

Parameters

const MVPbkContactAttribute & aAttribute Attribute prototype to match against.
const MVPbkStoreContact & aContact Contact whose attributes are checked.
MVPbkSingleAttributePresenceObserver & aObserver Observer for the asynchronous process.

HasFieldAttributeL(TUid, const MVPbkStoreContactField &)

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

Checks if the given contact field has the given attribute.

Parameters

TUid aAttributeType Type of the attribute to check for.
const MVPbkStoreContactField & aField Field whose attributes are checked.

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.

Parameters

const MVPbkContactAttribute & aAttribute Attribute prototype to match against.
const MVPbkStoreContactField & aField Contact field whose attribute is checked.

HasFieldAttributeL(TUid, const MVPbkStoreContactField &, MVPbkSingleAttributePresenceObserver &)

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

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

Parameters

TUid aAttributeType Type of the attribute to check for.
const MVPbkStoreContactField & aField Field whose attributes are checked.
MVPbkSingleAttributePresenceObserver & aObserver Observer for the asynchronous process.

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.

Parameters

const MVPbkContactAttribute & aAttribute Attribute prototype to match against.
const MVPbkStoreContactField & aField Contact field whose attribute is checked.
MVPbkSingleAttributePresenceObserver & aObserver Observer for the asynchronous process.

ListContactsL(TUid, MVPbkContactFindObserver &)

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

Lists all contacts having the requested type of attribute asynchronously.

Parameters

TUid aAttributeType Type of the attribute to search for.
MVPbkContactFindObserver & aObserver Observer for the asynchronous process.

ListContactsL(const MVPbkContactAttribute &, MVPbkContactFindObserver &)

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

Lists all contacts matching the given attribute asynchronously.

Parameters

const MVPbkContactAttribute & aAttribute Attribute prototype to match against.
MVPbkContactFindObserver & aObserver Observer for the asynchronous 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.

Parameters

const MVPbkContactLink & aContactLink Link to the contact whose attribute to remove.
const MVPbkContactAttribute & aAttribute Attribute to remove from the contact.
MVPbkSetAttributeObserver & aObserver Observer for the asynchronous process.

RemoveContactAttributeL(const MVPbkContactLink &, TUid, MVPbkSetAttributeObserver &)

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

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

Parameters

const MVPbkContactLink & aContactLink Link to the contact whose attribute to remove.
TUid aAttributeType Type of the attributes to remove from the contact.
MVPbkSetAttributeObserver & aObserver Observer for the asynchronous process.

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.

Parameters

MVPbkStoreContactField & aField Field whose attribute to remove.
const MVPbkContactAttribute & aAttribute Attribute to remove from the contact field.
MVPbkSetAttributeObserver & aObserver Observer for the asynchronous process.

RemoveFieldAttributeL(MVPbkStoreContactField &, TUid, MVPbkSetAttributeObserver &)

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

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

Parameters

MVPbkStoreContactField & aField Field whose attribute to remove.
TUid aAttributeType Type of the attributes to remove from the contact field.
MVPbkSetAttributeObserver & aObserver Observer for the asynchronous process.

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.

Parameters

const MVPbkContactLink & aContactLink Link to contact whose attribute to set.
const MVPbkContactAttribute & aAttribute Attribute to set for the contact.
MVPbkSetAttributeObserver & aObserver Observer for the asynchronous process.

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.

Parameters

MVPbkStoreContactField & aField Contact field whose attribute to set.
const MVPbkContactAttribute & aAttribute Attribute to set for the contact field.
MVPbkSetAttributeObserver & aObserver Observer for the asynchronous process.