![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
ASShdAlarm.h
Link against: alarmshared.lib
class TASShdAlarm;
A client-side alarm object.
It contains all of the information needed to create an alarm in the Alarm Server.
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
IMPORT_C TASShdAlarm();
Default constructor.
Initiializes all member data to default values.
|
|
IMPORT_C void InternalizeL(RReadStream &aStream);
Internalizes the alarm's data from a read stream.
|
IMPORT_C void ExternalizeL(RWriteStream &aStream) const;
Externalizes the alarm's member data to a write stream.
|
inline TAlarmStatus Status() const;
Returns the alarm status.
|
inline TAlarmState State() const;
Returns the alarm state.
|
inline TBool HasAssociatedData() const;
Tests whether the alarm has any associated data.
|
inline TBool HasOwningSession() const;
Tests whether the alarm has an active owning session.
|
inline TBool HasBecomeOrphaned() const;
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.
|
inline TAlarmId &Id();
Returns a writable version of the alarm's unique identifier.
|
inline TAlarmId Id() const;
Return the alarm's unique identifier.
|
inline TTime &NextDueTime();
Returns a writable version of the next time the alarm is scheduled to expire.
|
inline const TTime &NextDueTime() const;
Returns the next time that the alarm is scheduled to expire.
|
inline TTime &OriginalExpiryTime();
Returns a writable version of the alarm's original expiry time.
|
inline const TTime &OriginalExpiryTime() const;
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.
|
inline TAlarmCategory &Category();
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.
|
inline TAlarmCategory Category() const;
Return this alarm's category.
|
inline TAlarmCharacteristicsFlags &Characteristics();
Returns a writable version of the alarm's characteristics.
|
inline TAlarmCharacteristicsFlags Characteristics() const;
Returns the alarm's characteristics
|
inline TAlarmRepeatDefinition &RepeatDefinition();
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.
|
inline TAlarmRepeatDefinition RepeatDefinition() const;
Returns the repeat definition for the alarm.
|
inline TAlarmMessage &Message();
Returns a writable version of the alarm's message.
The message is usually displayed in the application UI when the alarm expires.
|
inline const TAlarmMessage &Message() const;
Returns the alarm's message.
The message is usually displayed in the application UI when the alarm expires.
|
inline TAlarmSoundName &SoundName();
Return a writable version of the alarm sound's filename.
|
inline const TAlarmSoundName &SoundName() const;
Returns the alarm's sound filename.
|
inline TAlarmDayOrTimed DayOrTimed() const;
Returns the alarm session type.
|
inline TAlarmDayOrTimed &DayOrTimed();
Returns a writable version of the alarm type, i.e. day, timed
|
IMPORT_C void SetUtcNextDueTime(TTime aUtcTime);
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.
|
IMPORT_C void SetDeQueueIfDueTimeInPast();
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.
inline TBitFlags16 &ClientFlags();
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.
|
inline TBitFlags16 ClientFlags() const;
Returns this alarm's client flags.
|
inline TInt ClientData1() const;
Returns the client data from slot 1 for this alarm.
|
inline TInt &ClientData1();
Returns a writable version of the client data from slot 1 for this alarm.
|
inline TInt ClientData2() const;
Returns the client data from slot 2 for this alarm.
|
inline TInt &ClientData2();
Returns the client data from slot 2 for this alarm.
|
inline TBool IsFloating() const;
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.
|
|
|
protected: TASShdAlarmFlags
|
|
|
protected: TInt iClientData2;
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}