Collapse all Symbian^3 Application Developer Library

CContactAgentField Class Reference

class CContactAgentField : public CContactFieldStorage

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() .

Inherits from

CContactAgentField
- CContactFieldStorage
  - CBase

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

Private Member Functions
IMPORT_C void	CContactFieldStorage_Reserved1 ()

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
TContactItemId	iAgentId

Member Functions Documentation

CContactFieldStorage_Reserved1()

IMPORT_C void

CContactFieldStorage_Reserved1

(

)

[private, virtual]

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Externalises the field data.

Parameters

RWriteStream & aStream

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

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Internalises the field data.

Parameters

RReadStream & aStream

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

IsFull()

TBool

IsFull

(

)

const [virtual]

Tests whether the field storage contains data.

RestoreL(CStreamStore &, RReadStream &)

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

Restores the field data.

Parameters

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

SetAgentId(TContactItemId)

IMPORT_C void

SetAgentId

(

TContactItemId

aId

)

Sets the agent ID field data.

Parameters

TContactItemId aId

The agent ID. Must be > 0 otherwise it won't be set.

StoreL(CStreamStore &)

TStreamId

StoreL

(

CStreamStore &

aStore

)

const [virtual]

Stores the field data.

Parameters

CStreamStore & aStore

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

Value()

IMPORT_C TContactItemId

Value

(

)

const

Gets the agent ID field data.

Member Data Documentation

TContactItemId iAgentId

TContactItemId

iAgentId

[private]