CContactAgentField Class Reference

#include <app/cntfldst.h>

class CContactAgentField : public CContactFieldStorage, public CContactFieldStorage

Inherits from

CContactAgentField
- CContactFieldStorage
  - CBase
  - CBase
- CContactFieldStorage
  - CBase
  - CBase

Public Member Functions
virtual void	ExternalizeL(RWriteStream &)
virtual void	InternalizeL(RReadStream &)
virtual TBool	IsFull()
virtual void	RestoreL(CStreamStore &, RReadStream &)
IMPORT_C void	SetAgentId(TContactItemId)
virtual TStreamId	StoreL(CStreamStore &)
IMPORT_C TContactItemId	Value()

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

Provides access to an agent ID.

An agent is a field in a contact item which contains another person's contact details. It corresponds to the agent property in the vCard specification (version 2.1). The agent is identified by an agent ID (a TContactItemId).

An object of this class can be retrieved using CContactItemField::AgentStorage().

Member Function Documentation

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

aStream

)

const [virtual]

Reimplemented from CContactFieldStorage::ExternalizeL(RWriteStream &)const

Externalises the field data.

Parameters
aStream	Write stream to which the contents of the field should be externalised.

InternalizeL ( RReadStream & )

void

InternalizeL

(

aStream

)

[virtual]

Reimplemented from CContactFieldStorage::InternalizeL(RReadStream &)

Internalises the field data.

Parameters
aStream	Stream from which the the contents of the field should be internalised.

IsFull ( )

IsFull

(

)

const [virtual]

Reimplemented from CContactFieldStorage::IsFull()const

Tests whether the field storage contains data.

Return Value: True if the field storage contains data, false if not.

RestoreL ( CStreamStore &, RReadStream & )

void	RestoreL	(	CStreamStore &	aStore,
			RReadStream &	aStream
		)	[virtual]

Reimplemented from CContactFieldStorage::RestoreL(CStreamStore &,RReadStream &)

Restores the field data.

Parameters
aStore	Reference to the store from which the object is to be restored.
aStream	Reference to the stream which should be passed to InternalizeL().

SetAgentId ( TContactItemId )

IMPORT_C void

SetAgentId

(

aId

)

Sets the agent ID field data.

Parameters
aId	The agent ID. Must be > 0 or KNullContactId otherwise it won't be set.

StoreL ( CStreamStore & )

StoreL

(

CStreamStore &

aStore

)

const [virtual]

Reimplemented from CContactFieldStorage::StoreL(CStreamStore &)const

Stores the field data.

Parameters
aStore	Reference to the stream store to which the field data is written.

Return Value: The ID of the stream store.

Value ( )

IMPORT_C TContactItemId

Value

(

)

const

Gets the agent ID field data.

Return Value: The agent ID.