#include <mw/asshdalarm.h>
Link against: alarmshared.lib
| class TASShdAlarm |
| Protected Member Enumerations | |
|---|---|
| enum | TASShdAlarmFlags { EASShdAlarmFlagsHasAssociatedData, EASShdAlarmFlagsHasOwningSession, EASShdAlarmFlagsHasBecomeOrphaned, EASShdAlarmFlagsPermanentDisabled } |
A client-side alarm object.
It contains all of the information needed to create an alarm in the Alarm Server.
| TAlarmId | iAlarmId | [protected] |
The unique identifier assoicated with each alarm maintained by the alarm world server.
| TAlarmCategory | iCategory | [protected] |
This UID is supplied by the client and is used to indicate the category that this alarm is part of. The Alarm Server is category-agnostic, that is, this information is for the client's use only
| TAlarmCharacteristicsFlags | iCharacteristics | [protected] |
This represents the desired behaviour for a given alarm. The Alarm Server uses this information to control the behaviour of the alarm.
See also: TAlarmCharacteristics
| TBitFlags16 | iClientFlags | [protected] |
Flags for use by any particular client. These will only be relevant to a client who can interpret them.
| TAlarmMessage | iMessage | [protected] |
The message associated with this alarm, typically used in an application UI to inform the user as to the reason for the alarm.
| TTime | iNextDueTime | [protected] |
The date and time at which this alarm is next due. For alarms that haven't been snoozed, then this is the original due time.
For alarms that have been snoozed, this is the time at which the alarm will reawaken.
| TTime | iOriginalExpiryTime | [protected] |
This attribute is only used in the instance whereby an alarm is snoozed. It represents the time at which the alarm first expired.
| TAlarmRepeatDefinition | iRepeatDefinition | [protected] |
Controls how the alarm repeats after it has expired. Note that session alarms are not allowed to repeat (they must be "once only").
| TAlarmSoundName | iSoundName | [protected] |
A descriptor which holds the name of the sound file which should be played when the alarm expires.
| TAlarmState | iState | [protected] |
The state of this alarm (e.g. queued, notifying, notified, snoozed etc)
| Enumerator | Value | Description |
|---|---|---|
| EASShdAlarmFlagsHasAssociatedData | 0 | |
| EASShdAlarmFlagsHasOwningSession | 1 | |
| EASShdAlarmFlagsHasBecomeOrphaned | 2 | |
| EASShdAlarmFlagsPermanentDisabled | 4 |
Set if alarm is disabled manually so that can not be enabled when locale changes. |
| IMPORT_C | TASShdAlarm | ( | ) |
Default constructor.
Initializes all member data to default values.
| TAlarmCategory & | Category | ( | ) | [inline] |
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.
| TAlarmCharacteristicsFlags & | Characteristics | ( | ) | [inline] |
Returns a writable version of the alarm's characteristics.
| TAlarmCharacteristicsFlags | Characteristics | ( | ) | const [inline] |
Returns the alarm's characteristics
| TInt | ClientData1 | ( | ) | const [inline] |
Returns the client data from slot 1 for this alarm.
| TInt & | ClientData1 | ( | ) | [inline] |
Returns a writable version of the client data from slot 1 for this alarm.
| TInt | ClientData2 | ( | ) | const [inline] |
Returns the client data from slot 2 for this alarm.
| TInt & | ClientData2 | ( | ) | [inline] |
Returns the client data from slot 2 for this alarm.
| TBitFlags16 & | ClientFlags | ( | ) | [inline] |
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.
| TBitFlags16 | ClientFlags | ( | ) | const [inline] |
Returns this alarm's client flags.
| TAlarmDayOrTimed | DayOrTimed | ( | ) | const [inline] |
Returns the alarm session type.
| TAlarmDayOrTimed & | DayOrTimed | ( | ) | [inline] |
Returns a writable version of the alarm type, i.e. day, timed
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
Externalizes the alarm's member data to a write stream.
| Parameters | |
|---|---|
| aStream | The stream to write to. |
| TSecureId | GetSid | ( | ) | const [inline] |
| IMPORT_C TBool | HasAssociatedData | ( | ) | const |
Tests whether the alarm has any associated data.
| IMPORT_C 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.
| IMPORT_C TBool | HasOwningSession | ( | ) | const |
Tests whether the alarm has an active owning session.
| TAlarmId & | Id | ( | ) | [inline] |
Returns a writable version of the alarm's unique identifier.
| TAlarmId | Id | ( | ) | const [inline] |
Return the alarm's unique identifier.
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
Internalizes the alarm's data from a read stream.
| Parameters | |
|---|---|
| aStream | The stream to read from. |
| TBool | IsFloating | ( | ) | const [inline] |
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.
| TAlarmMessage & | Message | ( | ) | [inline] |
Returns a writable version of the alarm's message.
The message is usually displayed in the application UI when the alarm expires.
| const TAlarmMessage & | Message | ( | ) | const [inline] |
Returns the alarm's message.
The message is usually displayed in the application UI when the alarm expires.
| TTime & | NextDueTime | ( | ) | [inline] |
Returns a writable version of the next time the alarm is scheduled to expire.
| const TTime & | NextDueTime | ( | ) | const [inline] |
Returns the next time that the alarm is scheduled to expire.
| TTime & | OriginalExpiryTime | ( | ) | [inline] |
Returns a writable version of the alarm's original expiry time.
| const TTime & | OriginalExpiryTime | ( | ) | const [inline] |
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.
| TAlarmRepeatDefinition & | RepeatDefinition | ( | ) | [inline] |
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.
| TAlarmRepeatDefinition | RepeatDefinition | ( | ) | const [inline] |
Returns the repeat definition for the alarm.
| 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.
| 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.
| Parameters | |
|---|---|
| aUtcTime | The due time of the alarm should be given in UTC. |
| TAlarmSoundName & | SoundName | ( | ) | [inline] |
Return a writable version of the alarm sound's filename.
| const TAlarmSoundName & | SoundName | ( | ) | const [inline] |
Returns the alarm's sound filename.