CVPbkContactIdConverter Class Reference

#include <app/CVPbkContactIdConverter.h>

class CVPbkContactIdConverter : public CBase

Inherits from

  • CVPbkContactIdConverter
    Public Member Functions
    ~CVPbkContactIdConverter()
    pure virtual voidCommitOpenContactItemL(CPbkContactItem &)
    virtual TAny *ContactIdConverterExtension(TUid)
    pure virtual MVPbkContactLink *IdentifierToLinkLC(TInt32)
    pure virtual TInt32 LinkToIdentifier(const MVPbkContactLink &)
    pure virtual CPbkContactItem *LinkToOpenPbkContactItemLCX(const MVPbkContactLink &)
    pure virtual CPbkContactItem *LinkToPbkContactItemLC(const MVPbkContactLink &)
    CVPbkContactIdConverter *NewL(MVPbkContactStore &)
    pure virtual TInt PbkEngFieldIndexL(const MVPbkStoreContactField &)
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    An ECOM interface for the virtual phonebook converter for contact IDs of the Symbian's Contacts Model and Virtual Phonebook contact links.

    A client has a TContactItemId that needs to be converted to MVPbkContactLink or vice versa.

    Constructor & Destructor Documentation

    ~CVPbkContactIdConverter ( )

    ~CVPbkContactIdConverter()[inline]

    Destructor.

    Member Function Documentation

    CommitOpenContactItemL ( CPbkContactItem & )

    voidCommitOpenContactItemL(CPbkContactItem &aContactItem)[pure virtual]

    Commits the openned contact item.

    ParameterDescription
    aContactItemcontact item to commit

    ContactIdConverterExtension ( TUid )

    TAny *ContactIdConverterExtension(TUid)[inline, virtual]

    Returns an extension point for this interface or NULL.

    Returns: An extension point for this interface or NULL.

    IdentifierToLinkLC ( TInt32 )

    MVPbkContactLink *IdentifierToLinkLC(TInt32aIdentifier)const [pure virtual]

    Converts the given identifier (TContactItemId) to a contact link in the contact store defined in NewL function.

    Created link is left to cleanup stack and ownership is transferred to caller.

    ParameterDescription
    aIdentifierThe contact id to convert.

    Returns: Contact link corresponding the aIdentifier in the contact store given as construction parameter in NewL.

    LinkToIdentifier ( const MVPbkContactLink & )

    TInt32 LinkToIdentifier(const MVPbkContactLink &aLink)const [pure virtual]

    Converts the given link to an Id in the contact store defined in NewL function.

    Returned value is KNullContactId if the link is from any other store than the one given in NewL.

    ParameterDescription
    aLinkA link to convert.

    Returns: A contact item id (TContactItemId) corresponding the aLink in the contact store given as construction parameter in NewL.

    LinkToOpenPbkContactItemLCX ( const MVPbkContactLink & )

    CPbkContactItem *LinkToOpenPbkContactItemLCX(const MVPbkContactLink &aLink)const [pure virtual]

    Converts the given link to an new CPbkContactItem and locks it for modification.

    Created contact item is left to cleanup stack and ownership is transferred to caller. Returns NULL if the link is from any other store than the one given in NewL.

    See also: CPbkContactEngine::OpenContactLCX

    ParameterDescription
    aLinkA link to convert

    Returns: A PbkEng contact item corresponding the aLink in the contact store given as construction parameter in NewL.

    LinkToPbkContactItemLC ( const MVPbkContactLink & )

    CPbkContactItem *LinkToPbkContactItemLC(const MVPbkContactLink &aLink)const [pure virtual]

    Converts the given link to an new CPbkContactItem.

    Created contact item is left to cleanup stack and ownership is transferred to caller. Returns NULL if the link is from any other store than the one given in NewL.

    ParameterDescription
    aLinkA link to convert.

    Returns: A PbkEng contact item corresponding the aLink in the contact store given as construction parameter in NewL.

    NewL ( MVPbkContactStore & )

    CVPbkContactIdConverter *NewL(MVPbkContactStore &aContactStore)[static, inline]

    Creates a new conversion utility object for given contact store.

    The given contact store must be from the cntdb domain, otherwise this function leaves with KErrNotSupported.

    Exceptions
    KErrNotSupported

    if aContactStore is not from cntdb domain.

    ParameterDescription
    aContactStoreContact store that is used for conversion. Links and IDs are converted for this store only. Trying to convert links or IDs from different stores provides unspecified results.

    Returns: A new conversion utility object.

    PbkEngFieldIndexL ( const MVPbkStoreContactField & )

    TInt PbkEngFieldIndexL(const MVPbkStoreContactField &aField)const [pure virtual]

    Returns a PbkEng field index for a Virtual Phonebook field.

    ParameterDescription
    aFieldA Virtual Phonebook field to be converted.

    Returns: A PbkEng field index or KErrNotFound.

    © Nokia 2011.