Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: ASShdAlarm.h
Link against: alarmshared.lib

Class TASShdAlarm

class TASShdAlarm;

Description

A client-side alarm object.

It contains all of the information needed to create an alarm in the Alarm Server.

Members

Defined in TASShdAlarm:
Category(), Category(), Characteristics(), Characteristics(), ClientData1(), ClientData1(), ClientData2(), ClientData2(), ClientFlags(), ClientFlags(), DayOrTimed(), DayOrTimed(), EASShdAlarmFlagsHasAssociatedData, EASShdAlarmFlagsHasBecomeOrphaned, EASShdAlarmFlagsHasOwningSession, EASShdAlarmFlagsPermanentDisabled, ExternalizeL(), GetSid(), HasAssociatedData(), HasBecomeOrphaned(), HasOwningSession(), Id(), Id(), InternalizeL(), IsFloating(), Message(), Message(), NextDueTime(), NextDueTime(), OriginalExpiryTime(), OriginalExpiryTime(), RepeatDefinition(), RepeatDefinition(), Reset(), SetDeQueueIfDueTimeInPast(), SetSid(), SetUtcNextDueTime(), SoundName(), SoundName(), State(), Status(), TASShdAlarm(), TASShdAlarmFlags, iAlarmId, iCategory, iCharacteristics, iClientData1, iClientData2, iClientFlags, iDayOrTimed, iFlags, iMessage, iNextDueTime, iOriginalExpiryTime, iRepeatDefinition, iSoundName, iState, iStatus


Construction and destruction


TASShdAlarm()

IMPORT_C TASShdAlarm();

Description

Default constructor.

Initiializes all member data to default values.

[Top]


Member functions


InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalizes the alarm's data from a read stream.

Parameters

RReadStream &aStream

The stream to read from.


ExternalizeL()

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalizes the alarm's member data to a write stream.

Parameters

RWriteStream &aStream

The stream to write to.


Status()

inline TAlarmStatus Status() const;

Description

Returns the alarm status.

Return value

TAlarmStatus

Alarm status.


State()

inline TAlarmState State() const;

Description

Returns the alarm state.

Return value

TAlarmState

Alarm state.


HasAssociatedData()

inline TBool HasAssociatedData() const;

Description

Tests whether the alarm has any associated data.

Return value

TBool

True if the alarm has associated data.


HasOwningSession()

inline TBool HasOwningSession() const;

Description

Tests whether the alarm has an active owning session.

Return value

TBool

True if the alarm has an active owning session.


HasBecomeOrphaned()

inline TBool HasBecomeOrphaned() const;

Description

Tests whether the alarm is orphaned.

An alarm is ophaned if it used to have an owning session, but no longer does. If an alarm is owned by a session, it is removed from the queue when the session disconnects. However, orphaned alarms stay in the queue.

Return value

TBool

True if the alarm has becomed orphaned.


Reset()

IMPORT_C void Reset();

Description

Resets the alarm back to a default, uninitialized state.


Id()

inline TAlarmId &Id();

Description

Returns a writable version of the alarm's unique identifier.

Return value

TAlarmId &

Reference to the unique identifier.


Id()

inline TAlarmId Id() const;

Description

Return the alarm's unique identifier.

Return value

TAlarmId

The unique identifier.


SetSid()

inline void SetSid(const TSecureId &aSecureID);

Description

Parameters

const TSecureId &aSecureID


GetSid()

inline TSecureId GetSid() const;

Description

Return value

TSecureId


NextDueTime()

inline TTime &NextDueTime();

Description

Returns a writable version of the next time the alarm is scheduled to expire.

Return value

TTime &

Next expiry time.


NextDueTime()

inline const TTime &NextDueTime() const;

Description

Returns the next time that the alarm is scheduled to expire.

Return value

const TTime &

Next expiry time.


OriginalExpiryTime()

inline TTime &OriginalExpiryTime();

Description

Returns a writable version of the alarm's original expiry time.

Return value

TTime &

Original expiry time.


OriginalExpiryTime()

inline const TTime &OriginalExpiryTime() const;

Description

Returns the alarm's original expiry time.

The original expiry time is the same as the next due time, unless the alarm has been snoozed. In that case, the original expiry time is the time when the alarm first expired, and the next due time is when it is to re-awaken after the snooze.

Return value

const TTime &

Original expiry time.


Category()

inline TAlarmCategory &Category();

Description

Returns a writable version of the alarm's category.

Clients can use the category to tag each alarm with a specific code. This allows clients to identify all related alarms, such as all alarms associated with a particular application or application engine.

Return value

TAlarmCategory &

Alarm category.


Category()

inline TAlarmCategory Category() const;

Description

Return this alarm's category.

Return value

TAlarmCategory

Alarm category.


Characteristics()

inline TAlarmCharacteristicsFlags &Characteristics();

Description

Returns a writable version of the alarm's characteristics.

Return value

TAlarmCharacteristicsFlags &

Alarm characteristics bit flags.


Characteristics()

inline TAlarmCharacteristicsFlags Characteristics() const;

Description

Returns the alarm's characteristics

Return value

TAlarmCharacteristicsFlags

Alarm characteristics bit flags.


RepeatDefinition()

inline TAlarmRepeatDefinition &RepeatDefinition();

Description

Returns a writable version of the alarm's repeat definition.

The repeat definition controls the alarm's behaviour after it has expired. For example, you can set the repeat definition so that the server automatically queues the alarm to expire again in exactly 24 hours time.

Return value

TAlarmRepeatDefinition &

Alarm repeat definition.


RepeatDefinition()

inline TAlarmRepeatDefinition RepeatDefinition() const;

Description

Returns the repeat definition for the alarm.

Return value

TAlarmRepeatDefinition

The alarm's repeat definition.


Message()

inline TAlarmMessage &Message();

Description

Returns a writable version of the alarm's message.

The message is usually displayed in the application UI when the alarm expires.

Return value

TAlarmMessage &

Reference to the alarm's associated message.


Message()

inline const TAlarmMessage &Message() const;

Description

Returns the alarm's message.

The message is usually displayed in the application UI when the alarm expires.

Return value

const TAlarmMessage &

Reference to the alarm's associated message.


SoundName()

inline TAlarmSoundName &SoundName();

Description

Return a writable version of the alarm sound's filename.

Return value

TAlarmSoundName &

Reference to the alarm's sound filename.


SoundName()

inline const TAlarmSoundName &SoundName() const;

Description

Returns the alarm's sound filename.

Return value

const TAlarmSoundName &

Sound filename.


DayOrTimed()

inline TAlarmDayOrTimed DayOrTimed() const;

Description

Returns the alarm session type.

Return value

TAlarmDayOrTimed

Alarm session type.


DayOrTimed()

inline TAlarmDayOrTimed &DayOrTimed();

Description

Returns a writable version of the alarm type, i.e. day, timed

Return value

TAlarmDayOrTimed &

iDayOrTimed.


SetUtcNextDueTime()

IMPORT_C void SetUtcNextDueTime(TTime aUtcTime);

Description

Using this API to set the next due time of an alarm will make it a fixed alarm, that is going to expire at the given UTC time. The alarm will not be rescheduled when the UTC offset is changed.

Parameters

TTime aUtcTime

The due time of the alarm should be given in UTC.


SetDeQueueIfDueTimeInPast()

IMPORT_C void SetDeQueueIfDueTimeInPast();

Description

Using this API to tell the alarmserver not to notify the Agenda alarms if its due time is in the past after system time has been changed.


ClientFlags()

inline TBitFlags16 &ClientFlags();

Description

Returns a writable version of the alarm's client flags.

The client flags may be used for any client-specific data - the alarm server does not use them.

Return value

TBitFlags16 &

Reference to the alarm's bit flags.


ClientFlags()

inline TBitFlags16 ClientFlags() const;

Description

Returns this alarm's client flags.

Return value

TBitFlags16

Reference to the alarm's bit flags.


ClientData1()

inline TInt ClientData1() const;

Description

Returns the client data from slot 1 for this alarm.

Return value

TInt

The first client-specific integer.


ClientData1()

inline TInt &ClientData1();

Description

Returns a writable version of the client data from slot 1 for this alarm.

Return value

TInt &

Reference to the first client-specific integer.


ClientData2()

inline TInt ClientData2() const;

Description

Returns the client data from slot 2 for this alarm.

Return value

TInt

The second client-specific integer.


ClientData2()

inline TInt &ClientData2();

Description

Returns the client data from slot 2 for this alarm.

Return value

TInt &

The second client-specific integer.


IsFloating()

inline TBool IsFloating() const;

Description

Tests whether the alarm is floating.

Floating alarms expire at a given wall-clock time regardless of the current locale and whether any daylight saving time rules are in force.

Return value

TBool

True if the alarm is floating.

[Top]


Member enumerations


Enum TASShdAlarmFlags

protected: TASShdAlarmFlags

Description

EASShdAlarmFlagsHasAssociatedData

EASShdAlarmFlagsHasOwningSession

EASShdAlarmFlagsHasBecomeOrphaned

EASShdAlarmFlagsPermanentDisabled

[Top]


Member data


iFlags

protected: TBitFlags8 iFlags;

Description


iCharacteristics

protected: TAlarmCharacteristicsFlags iCharacteristics;

Description


iAlarmId

protected: TAlarmId iAlarmId;

Description


iStatus

protected: TAlarmStatus iStatus;

Description


iState

protected: TAlarmState iState;

Description


iDayOrTimed

protected: TAlarmDayOrTimed iDayOrTimed;

Description


iRepeatDefinition

protected: TAlarmRepeatDefinition iRepeatDefinition;

Description


iCategory

protected: TAlarmCategory iCategory;

Description


iNextDueTime

protected: TTime iNextDueTime;

Description


iOriginalExpiryTime

protected: TTime iOriginalExpiryTime;

Description


iMessage

protected: TAlarmMessage iMessage;

Description


iSoundName

protected: TAlarmSoundName iSoundName;

Description


iClientFlags

protected: TBitFlags16 iClientFlags;

Description


iClientData1

protected: TInt iClientData1;

Description


iClientData2

protected: TInt iClientData2;

Description