Class CVersitAlarm

class CVersitAlarm : public CBase;

Description

An 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, the binary data of the sound to be played when the alarm runs (optional), and some text to associate with the alarm (optional).

An object of this class is owned by the CParserPropertyValueAlarm class.

This class supports the following types of alarm:

• Audible Alarm

• Display Alarm (displays message on the screen)

• Procedure Alarm (calls a procedure)

• Mail Alarm (sends an email).

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CVersitAlarm - An alarm for a vEvent or a vTodo

Members

Defined in CVersitAlarm:
NewL(), iAudioContent, iNote, iRepeatCount, iRunTime, iSnoozeTime, ~CVersitAlarm()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CVersitAlarm *NewL(TVersitDateTime *aRunTime, TTime *aSnoozeTime, TInt aRepeatCount, const TDesC &aAudioContent, const TDesC &aNote);

Description

Allocates and constructs a new alarm.

Ownership of aRunTime and aSnoozeTime is taken immediately.

Parameters

TVersitDateTime *aRunTime Pointer to the alarm time. TTime *aSnoozeTime Pointer to the snooze time (may be NULL). TInt aRepeatCount The repeat count. const TDesC &aAudioContent A binary buffer containing the sound data. May be an empty descriptor. const TDesC &aNote A descriptor containing text to display when the alarm is executing. May be an empty descriptor.

Return value

CVersitAlarm * Pointer to the newly created alarm.

IMPORT_C ~CVersitAlarm();

Description

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

TVersitDateTime * iRunTime;

Description

The date/time for the alarm.

TTime * iSnoozeTime;

Description

The amount of time the alarm will be snoozed (optional).

TInt iRepeatCount;

Description

The number of times that the alarm will repeat.

HBufC * iAudioContent;

Description

The binary data describing the sound to play for an AALARM (optional), or the string which specifies the address to send the e-mail to, for an MALARM.

HBufC * iNote;

Description

The mesage to display on the screen for a DALARM (optional), or the body of the e-mail to be sent for an MALARM, or the name of the procedure to call for a PALARM.