CContactAgentField Class Reference

#include <app/cntfldst.h>

class CContactAgentField : public CContactFieldStorage

Inherits from

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 & )

voidExternalizeL(RWriteStream &aStream)const [virtual]

Reimplemented from CContactFieldStorage::ExternalizeL(RWriteStream &)const

Externalises the field data.

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

InternalizeL ( RReadStream & )

voidInternalizeL(RReadStream &aStream)[virtual]

Reimplemented from CContactFieldStorage::InternalizeL(RReadStream &)

Internalises the field data.

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

IsFull ( )

TBool IsFull()const [virtual]

Reimplemented from CContactFieldStorage::IsFull()const

Tests whether the field storage contains data.

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

RestoreL ( CStreamStore &, RReadStream & )

voidRestoreL(CStreamStore &aStore,
RReadStream &aStream

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

Restores the field data.

aStoreReference to the store from which the object is to be restored.
aStreamReference to the stream which should be passed to InternalizeL().

SetAgentId ( TContactItemId )

IMPORT_C voidSetAgentId(TContactItemIdaId)

Sets the agent ID field data.

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

StoreL ( CStreamStore & )

TStreamId StoreL(CStreamStore &aStore)const [virtual]

Reimplemented from CContactFieldStorage::StoreL(CStreamStore &)const

Stores the field data.

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

Returns: The ID of the stream store.

Value ( )

IMPORT_C TContactItemIdValue()const

Gets the agent ID field data.

Returns: The agent ID.