Class CVersitAlarm

CVersitAlarm

Support

Supported from 5.0

Description

An audio reminder for a vEvent or 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 audio 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.

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

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

Description

Allocates and constructs a new audio reminder.

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 audio reminder.

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

Description

Allocates and constructs a new audio reminder — leaving the object on the cleanup stack.

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 audio reminder.

~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 of the audio sound to play when the alarm runs (optional).

HBufC* iNote

Description

A text string to associate with the alarm (optional).