CCalDataExchange Class Reference

class CCalDataExchange : public CBase

This class provides functionality for importing and exporting vCal entries.

Inherits from

Constructor & Destructor Documentation

CCalDataExchange()

CCalDataExchange()[private]

~CCalDataExchange()

IMPORT_C~CCalDataExchange()

Destructor capability

None

Member Functions Documentation

ConstructL(CCalSession &)

voidConstructL(CCalSession &aSession)[private]

Parameters

CCalSession & aSession

ExportAsyncL(TUid, RWriteStream &, RPointerArray< CCalEntry > &, MCalDataExchangeCallBack &)

IMPORT_C voidExportAsyncL(TUidaDataFormat,
RWriteStream &aWriteStream,
RPointerArray< CCalEntry > &aCalEntryArray,
MCalDataExchangeCallBack &aObserver
)

Asynchronously exports data of aDataFormat type from an array of CCalEntries corresponding to this data

Currently only VCal 1.0 (with extensions) is supported. The entry is exported either as a vTodo (if it is a to-do), or as a vEvent. The exported property values are converted from Unicode into the character set indicated by the last parameter (UTF-8 by default). capability

ReadUserData

Parameters

TUid aDataFormatSpecifies the format of the data to be exported. Currently this must be KUidVCalendar (see CalDataFormat.h)
RWriteStream & aWriteStreamThe stream to which the calender entries should be externalised.
RPointerArray< CCalEntry > & aCalEntryArrayThe array of calender entries to export.
MCalDataExchangeCallBack & aObserverCallback class to indicate the progress of the import and when it has completed.

ExportL(TUid, RWriteStream &, RPointerArray< CCalEntry > &)

IMPORT_C voidExportL(TUidaDataFormat,
RWriteStream &aWriteStream,
RPointerArray< CCalEntry > &aCalEntryArray
)

Exports data of aDataFormat type from an array of CCalEntries corresponding to this data

Currently only VCal 1.0 (with extensions) is supported. The entry is exported either as a vTodo (if it is a to-do), or as a vEvent. The exported property values are converted from Unicode into the character set indicated by the last parameter (UTF-8 by default). capability

ReadUserData

Parameters

TUid aDataFormatSpecifies the format of the data to be exported. Currently this must be KUidVCalendar (see CalDataFormat.h)
RWriteStream & aWriteStreamThe stream to which the calender entries should be externalised.
RPointerArray< CCalEntry > & aCalEntryArrayThe array of calender entries to export.

ImportAsyncL(TUid, RReadStream &, RPointerArray< CCalEntry > &, MCalDataExchangeCallBack &, TInt)

IMPORT_C voidImportAsyncL(TUidaDataFormat,
RReadStream &aReadStream,
RPointerArray< CCalEntry > &aCalEntryArray,
MCalDataExchangeCallBack &aObserver,
TIntaFlags
)

Asynchronously imports data of aDataFormat type and returns an array of CCalEntries corresponding to this data

Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities are converted into CCalEntries and passed back in the array parameter aCalEntryArray. capability

WriteUserData

Parameters

TUid aDataFormatSpecifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
RReadStream & aReadStreamThe read stream which contains the (vCalendar) data.
RPointerArray< CCalEntry > & aCalEntryArrayOn return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are specific to the data format
MCalDataExchangeCallBack & aObserverCallback class to indicate the progress of the import and when it has completed.
TInt aFlagscontrols the behaviour of the parser during the import process.

ImportL(TUid, RReadStream &, RPointerArray< CCalEntry > &)

IMPORT_C voidImportL(TUidaDataFormat,
RReadStream &aReadStream,
RPointerArray< CCalEntry > &aCalEntryArray
)

Imports data of aDataFormat type and returns an array of CCalEntries corresponding to this data

Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities are converted into CCalEntries and passed back in the array parameter aCalEntryArray. capability

WriteUserData

Parameters

TUid aDataFormatSpecifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
RReadStream & aReadStreamThe read stream which contains the (vCalendar) data.
RPointerArray< CCalEntry > & aCalEntryArrayOn return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are specific to the data format

ImportL(TUid, RReadStream &, RPointerArray< CCalEntry > &, TInt)

IMPORT_C voidImportL(TUidaDataFormat,
RReadStream &aReadStream,
RPointerArray< CCalEntry > &aCalEntryArray,
TIntaFlags
)

Imports data of aDataFormat type and returns an array of CCalEntries corresponding to this data

Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities are converted into CCalEntries and passed back in the array parameter aCalEntryArray. capability

WriteUserData

Parameters

TUid aDataFormatSpecifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
RReadStream & aReadStreamThe read stream which contains the (vCalendar) data.
RPointerArray< CCalEntry > & aCalEntryArrayOn return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are specific to the data format
TInt aFlagscontrols the behaviour of the parser during the import process.

ImportL(TUid, RReadStream &, RPointerArray< CCalEntry > &, TInt, TInt)

IMPORT_C voidImportL(TUidaDataFormat,
RReadStream &aReadStream,
RPointerArray< CCalEntry > &aCalEntryArray,
TIntaFlags,
TIntaNumEntries
)

Imports data of aDataFormat type and returns an array of a selected number of CCalEntries corresponding to this data.

Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities are converted into CCalEntries and passed back in the array parameter aCalEntryArray. capability

WriteUserData

Parameters

TUid aDataFormatSpecifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
RReadStream & aReadStreamThe read stream which contains the (vCalendar) data.
RPointerArray< CCalEntry > & aCalEntryArrayOn return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are specific to the data format
TInt aFlagscontrols the behaviour of the parser during the import process.
TInt aNumEntriesSpecifies how many entries are to be imported at once.

NewL(CCalSession &)

IMPORT_C CCalDataExchange *NewL(CCalSession &aSession)[static]

Allocates and constructs a CCalDataExchange object. capability

None

A pointer to the new synchronisation object.

Parameters

CCalSession & aSessionThe handle to the calender session.

Member Data Documentation

CCalDataExchangeImpl * iImpl

CCalDataExchangeImpl *iImpl[private]