CVersitExtendedAlarm Class Reference

#include <app/vcal.h>

Link against: vcal.lib

class CVersitExtendedAlarm : public CBase

Inherits from

CVersitExtendedAlarm

Public Attributes
HBufC8 *	iContent
CVersitExtendedAlarm::TDisposition	iDisposition
HBufC8 *	iMimeType

Public Member Enumerations
enum	TDisposition { EDispositionUrl, EDispositionInline, EDispositionUnknown }

Public Member Functions
	~CVersitExtendedAlarm()
IMPORT_C CVersitExtendedAlarm *	NewL(const TDesC8 &, const TDesC8 &, CVersitExtendedAlarm::TDisposition)

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

An extended alarm for a vEvent or a vTodo.

Specifies the date/time for the alarm, the amount of time the alarm will be snoozed (optional), the number of times that the alarm will repeat, and the action for the alarm. An object of this class is owned by the CParserPropertyValueAlarm class.

This class supports the following types of alarm:

X-EPOCALARM

Member Attribute Documentation

iContent

HBufC8 *

iContent

The data describing the action for the alarm.

iDisposition

CVersitExtendedAlarm::TDisposition

iDisposition

The disposition of the data for the alarm action (i.e whether it is inline or an URI).

iMimeType

HBufC8 *

iMimeType

The MIME type of the data describing the action for the alarm.

Member Enumeration Documentation

Enum TDisposition

Extended Alarm's disposition types.

Enumerator	Value	Description
EDispositionUrl	0	URL disposition
EDispositionInline	1	Inline disposition
EDispositionUnknown	15	Unknown disposition

Constructor & Destructor Documentation

~CVersitExtendedAlarm ( )

IMPORT_C

~CVersitExtendedAlarm

(

)

Frees all resources owned by the alarm, prior to its destruction.

Member Function Documentation

NewL ( const TDesC8 &, const TDesC8 &, CVersitExtendedAlarm::TDisposition )

IMPORT_C CVersitExtendedAlarm *	NewL	(	const TDesC8 &	aContent,
			const TDesC8 &	aContentMimeType,
			CVersitExtendedAlarm::TDisposition	aDisposition
		)	[static]

Allocates and constructs a new extended alarm (X-EPOCALARM).

Parameter	Description
aContent	A binary buffer containing the assocaited data for the alarm. Should not be empty descriptor.
aContentMimeType	The MIME type of the data describing the action for the alarm.
aDisposition	The disposition of the data for the alarm action.

Returns: Pointer to the newly created extended alarm.