EPOC   SDK Home Glossary Indexes Previous Next Up

CVersitAlarm class


Contents


CVersitAlarm class — Audio reminder

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Defined in

vcal.h

Link against

versit.lib

Description

A CVersitAlarm is an audio reminder for a vCalendar entity. It 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).

It is used by the CParserPropertyValueAlarm class to specify the alarm value.


Construction and destruction


NewL() — Allocate and construct

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

Description

Use this function to allocate and construct a new audio reminder.

Arguments

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.


NewLC() — Allocate and construct

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

Description

Use this function to allocate and construct a new audio reminder.

The audio reminder object is left on the cleanup stack.

Arguments

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() — Destructor

~CVersitAlarm();

Description

The destructor frees all resources owned by the alarm, prior to its destruction.

EPOC       SDK Home Glossary Indexes Previous Next Up