CVersitAlarm Class Reference

#include <app/vcal.h>

Link against: vcal.lib

class CVersitAlarm : public CBase

Inherits from

  • CVersitAlarm
    Public Attributes
    HBufC *iAudioContent
    HBufC *iNote
    TInt iRepeatCount
    TVersitDateTime *iRunTime
    TTime *iSnoozeTime
    Public Member Functions
    ~CVersitAlarm()
    IMPORT_C CVersitAlarm *NewL(TVersitDateTime *, TTime *, TInt, const TDesC &, const TDesC &)
    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 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).

    Member Attribute Documentation

    iAudioContent

    HBufC *iAudioContent

    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.

    iNote

    HBufC *iNote

    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.

    iRepeatCount

    TInt iRepeatCount

    The number of times that the alarm will repeat.

    iRunTime

    TVersitDateTime *iRunTime

    The date/time for the alarm.

    iSnoozeTime

    TTime *iSnoozeTime

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

    Constructor & Destructor Documentation

    ~CVersitAlarm ( )

    IMPORT_C~CVersitAlarm()

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

    Member Function Documentation

    NewL ( TVersitDateTime *, TTime *, TInt, const TDesC &, const TDesC & )

    IMPORT_C CVersitAlarm *NewL(TVersitDateTime *aRunTime,
    TTime *aSnoozeTime,
    TIntaRepeatCount,
    const TDesC &aAudioContent,
    const TDesC &aNote
    )[static]

    Allocates and constructs a new alarm.

    Ownership of aRunTime and aSnoozeTime is taken in the end.

    ParameterDescription
    aRunTimePointer to the alarm time.
    aSnoozeTimePointer to the snooze time (may be NULL).
    aRepeatCountThe repeat count.
    aAudioContentA binary buffer containing the sound data. May be an empty descriptor.
    aNoteA descriptor containing text to display when the alarm is executing. May be an empty descriptor.

    Returns: Pointer to the newly created alarm.

    © Nokia 2011.