Collapse all Symbian^3 Product Developer Library

CVPbkContactIdConverter Class Reference

class CVPbkContactIdConverter : public CBase

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.

Inherits from

CVPbkContactIdConverter
- CBase

Public Member Functions
	~CVPbkContactIdConverter()
void	CommitOpenContactItemL(CPbkContactItem &)
TAny *	ContactIdConverterExtension(TUid)
MVPbkContactLink *	IdentifierToLinkLC(TInt32)
TInt32	LinkToIdentifier(const MVPbkContactLink &)
CPbkContactItem *	LinkToOpenPbkContactItemLCX(const MVPbkContactLink &)
CPbkContactItem *	LinkToPbkContactItemLC(const MVPbkContactLink &)
CVPbkContactIdConverter *	NewL(MVPbkContactStore &)
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()

Private Attributes
TUid	iDtorIDKey

Constructor & Destructor Documentation

~CVPbkContactIdConverter()

~CVPbkContactIdConverter

(

)

[inline]

Destructor.

Member Functions Documentation

CommitOpenContactItemL(CPbkContactItem &)

void

CommitOpenContactItemL

(

CPbkContactItem &

aContactItem

)

[pure virtual]

Commits the openned contact item.

Parameters

CPbkContactItem & aContactItem

contact item to commit

ContactIdConverterExtension(TUid)

TAny *

ContactIdConverterExtension

(

TUid

)

[inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

IdentifierToLinkLC(TInt32)

MVPbkContactLink *

IdentifierToLinkLC

(

TInt32

aIdentifier

)

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.

Parameters

TInt32 aIdentifier

The contact id to convert.

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.

Parameters

const MVPbkContactLink & aLink

A link to convert.

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.

CPbkContactEngine::OpenContactLCX

Parameters

const MVPbkContactLink & aLink

A link to convert

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.

Parameters

const MVPbkContactLink & aLink

A link to convert.

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.

Parameters

MVPbkContactStore & aContactStore

Contact 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.

PbkEngFieldIndexL(const MVPbkStoreContactField &)

TInt

PbkEngFieldIndexL

(

const MVPbkStoreContactField &

aField

)

const [pure virtual]

Returns a PbkEng field index for a Virtual Phonebook field.

Parameters

const MVPbkStoreContactField & aField

A Virtual Phonebook field to be converted.

Member Data Documentation

TUid iDtorIDKey

TUid

iDtorIDKey

[private]