#include <app/cntfldst.h>
| class CContactAgentField : public CContactFieldStorage |
| 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() |
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().
| void | ExternalizeL | ( | RWriteStream & | aStream | ) | const [virtual] |
Reimplemented from CContactFieldStorage::ExternalizeL(RWriteStream &)const
Externalises the field data.
| Parameter | Description |
|---|---|
| aStream | Write stream to which the contents of the field should be externalised. |
| void | InternalizeL | ( | RReadStream & | aStream | ) | [virtual] |
Reimplemented from CContactFieldStorage::InternalizeL(RReadStream &)
Internalises the field data.
| Parameter | Description |
|---|---|
| aStream | Stream from which the the contents of the field should be internalised. |
| 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.
| void | RestoreL | ( | CStreamStore & | aStore, |
| RReadStream & | aStream | |||
| ) | [virtual] | |||
Reimplemented from CContactFieldStorage::RestoreL(CStreamStore &,RReadStream &)
Restores the field data.
| Parameter | Description |
|---|---|
| aStore | Reference to the store from which the object is to be restored. |
| aStream | Reference to the stream which should be passed to InternalizeL(). |
| IMPORT_C void | SetAgentId | ( | TContactItemId | aId | ) |
Sets the agent ID field data.
| Parameter | Description |
|---|---|
| aId | The agent ID. Must be > 0 otherwise it won't be set. |
| TStreamId | StoreL | ( | CStreamStore & | aStore | ) | const [virtual] |
Reimplemented from CContactFieldStorage::StoreL(CStreamStore &)const
Stores the field data.
| Parameter | Description |
|---|---|
| aStore | Reference to the stream store to which the field data is written. |
Returns: The ID of the stream store.