| const TInt | KMaxAlarmMessageLength |
Maximum length of an alarm message. The message is usually displayed by the alarm UI.
| const TInt | KMaxAlarmSoundNameLength |
Maximum length of the filename of the sound played when an alarm expires.
| typedef TInt | TAlarmId |
A unique identifier allocated to each new alarm by the alarm server, so that the client can identify them. By default, KNullAlarmId.
| typedef TUid | TAlarmCategory |
A unique identifier that can optionally be used by clients to group alarms into categories, for instance alarms associated with a particular application or application engine. The alarm server ignores the category. It is relevant to the client alone.
| typedef TInt | TDeleteType |
A type to identify what kind of alarms should be deleted when using the API RASCliSession::AlarmDeleteByCategory()
See also: TTDeleteTypeEnum
| typedef TBuf< KMaxAlarmMessageLength > | TAlarmMessage |
Stores the text message associated with an alarm.
| typedef TBuf< KMaxAlarmSoundNameLength > | TAlarmSoundName |
Stores the name of a sound file which is played when an alarm activates.
| const TInt | KDefaultSoundPlayOffsetInSeconds |
Defines the length in seconds of an alarm sound offset.
| const TInt | KDefaultSoundPlayDurationInSeconds |
Defines the length in seconds of an alarm sound duration.
| const TAlarmCategory | KASCliCategoryClock |
A category that can be assigned to identify clock alarms to the client. The server does not distinguish between alarm types.
Defines whether an alarm is enabled or disabled:
An enabled alarm activates at a specified time.
A disabled alarm remains in the alarm server queue but is not active.
You can get or set an alarm's status using the RASCliSession class.
| Enumerator | Value | Description |
|---|---|---|
| EAlarmStatusEnabled | 0 |
The alarm is currently enabled. |
| EAlarmStatusDisabled |
The alarm is currently disabled, and will not expire. |
Represents an alarm's state. Alarms can have only one state.
| Enumerator | Value | Description |
|---|---|---|
| EAlarmStateInPreparation | -1 |
The alarm state is not currently known by the alarm server. |
| EAlarmStateQueued | 0 |
The alarm is waiting for its expiry time to be reached. |
| EAlarmStateSnoozed |
The alarm is snoozed. When the snooze period is over, the alarm expires again. | |
| EAlarmStateWaitingToNotify |
The alarm is waiting to be notified. This state occurs when an alarm expires while another is being notified. When this happens, the alarm being notified changes state to EAlarmStateWaitingToNotify. This means that if it is set to be the next alarm to be notified, notification will happen after the newly expired alarm has been notified and dismissed. | |
| EAlarmStateNotifying |
The alarm is currently notifying. | |
| EAlarmStateNotified |
The alarm has already notified and has been dismissed. Any alarm which remains in this state is dead. |
Defines an alarm session type as timed or untimed. This property is ignored by the alarm server, and is for use by the client only.
| Enumerator | Value | Description |
|---|---|---|
| EASShdAlarmTypeTimed | 0 |
Timed alarm type (default). This alarm belongs to a timed event. This is an event with a defined start and finish time. The alarm notification time is specified as an offset from the event's start time, so that when the event time changes, so does the alarm time. |
| EASShdAlarmTypeDay |
Day alarm type. This alarm belongs to untimed events; these do not have a defined start and finish time, but have an activation time. |
Defines the sound state of the global alarm server .
| Enumerator | Value | Description |
|---|---|---|
| EAlarmGlobalSoundStateOn | 0 |
When an alarm expires, the alarm sound is played. |
| EAlarmGlobalSoundStateOff |
When an alarm expires, no sound plays. |
Defines how an alarm is to be repeated.
| Enumerator | Value | Description |
|---|---|---|
| EAlarmRepeatDefintionRepeatOnce | 0 |
The alarm expires only once, and is then deleted from the alarm server. By default, all alarms behave this way. Standard repeat-once alarms are date relative, that is, they occur on a fixed date and point in time. If the user changes the system date or time so that the new time is in the future, and the new time is after the previously calculated expiry time: By less than 12 hours, the alarm expires immediately. By more than 12 horus, the alarm is silently discarded. If the user changes the system date or time so that the new time is before the next calculated expiry time, the alarm type continues to be a "Repeat once" alarm |
| EAlarmRepeatDefintionRepeatNext24Hours |
When initially scheduling the alarm, the date is always within the next 24 hours. For example: The current time is 15:00, and the alarm time specified is 14:00. The alarm expires tomorrow at 14:00. The current time is 15:00, and the alarm time specified is 16:00. The alarm expires today at 16:00. If the alarm is missed, i.e. because the alarm server is inactive, then the alarm changes its type from "Repeat in the next 24 Hours" to "Repeat once". If the user changes the system date or time so that the new time is in the future, and the new time is after the previously calculated expiry time: By less than 12 hours, the alarm expires immediately. By more than 12 horus, the alarm is silently discarded. If the user changes the system date or time so that the new time is before the next calculated expiry time: By less than 12 hours, no change in alarm type, and the alarm remains queued. By greater than 12 hours, the alarm changes its type from "Repeat in the next 24 Hours" to "Repeat once". Subsequent changes in system time result in the behaviour described by the EAlarmRepeatDefintionRepeatOnce characteristic. | |
| EAlarmRepeatDefintionRepeatDaily |
The alarm repeats every day at the same time. If the user changes the system date or time, this alarm behaves in the same way as a "Repeat once" alarm, except that the alarm is not deleted, but rescheduled for the next available time. If the user changes the system date or time to a point in the past, there are no phantom alarm expiries. | |
| EAlarmRepeatDefintionRepeatWorkday |
The alarm repeats every work day at the same time. If the user changes the system date or time, this alarm behaves in the same way as a "Repeat once" alarm, except that the alarm is not deleted, but rescheduled for the next available time. If the user changes the system date or time to a point in the past, there are no phantom alarm expiries. | |
| EAlarmRepeatDefintionRepeatWeekly |
The alarm repeats every week, on the same day at the same time. If the user changes the system date or time, this alarm behaves in the same way as a "Repeat once" alarm, except that the alarm is not deleted, but rescheduled for the next available time. If the user changes the system date or time to a point in the past, there are no phantom alarm expiries. |
Defines various alarm characteristics.
| Enumerator | Value | Description |
|---|---|---|
| EAlarmCharacteristicsSessionSpecific | 0 |
Sets an alarm to be session-only. This alarm only exists as long as a session is maintained with the alarm server. Session alarms are removed from the alarm queue when the originating session disconnects from the server. By default, all alarms are persistent and remain so, even after the initiating session has disconnected. |
| EAlarmCharacteristicsDoNotNotifyAlarmAlertServer | 1 |
Do not display a screen. By default, all alarms result in a suitable screen being displayed, depending on the device. Use this flag to disable this default behaviour. |
| EAlarmCharacteristicsIsFixed | 2 |
Sets an alarm to be floating - floating alarms expire at the current local time, regardless of the current locale or DST rules. |
| EAlarmCharacteristicsDeQueueIfDueTimeInPast | 3 |
Do not notify if its due time is in the past. |
| EAlarmCharacteristicsLast |
This enumeration defines the events that can be reported by the alarm server.
These events are channelled to the client using the RASCliSession::NotifyChange() method.
See also: TAlarmState
| Enumerator | Value | Description |
|---|---|---|
| EAlarmChangeEventState | 1 |
An alarm has changed state.
See also: TAlarmState |
| EAlarmChangeEventStatus | 2 |
An alarm has changed status.
See also: TAlarmStatus |
| EAlarmChangeEventCharacteristics | 3 |
An alarm has changed characteristics.
See also: TAlarmCharacteristics |
| EAlarmChangeEventAlarmDeletion | 4 |
An alarm has been deleted from the queue of alarms. |
| EAlarmChangeEventAlarmAddition | 5 |
An alarm has been added to the queue of alarms. |
| EAlarmChangeEventTimerExpired | 6 |
An alarm has expired. |
| EAlarmChangeEventSoundPlaying | 7 |
The sound for an alarm has just started playing. |
| EAlarmChangeEventSoundStopped | 8 |
The sound for an alarm has just stopped playing. |
| EAlarmChangeEventPlayIntervalsChanged | 9 |
The sound intervals associated with sound timing have changed. |
| EAlarmChangeEventGlobalSoundStateChanged | 10 |
The global sound state (on/off) has changed. |
| EAlarmChangeEventHeadQueueItemChanged | 11 |
The next alarm at the head of the alarm queue has changed. |
| EAlarmChangeEventSystemDateTimeChanged | 12 |
The system date or time has changed, or the days defined as workdays have changed. |
| EAlarmChangeEventAlarmUIVisible | 13 |
The alarm alert server has been instructed to show the 'alarm expired' display. |
| EAlarmChangeEventAlarmUIInvisible | 14 |
The alarm alert server has been instructed to hide the 'alarm expired' display. |
| EAlarmChangeEventSoundSilence | 15 |
Alarm sounds have been temporarily silenced, the current alarm has been paused or re-enabled. |
| EAlarmChangeEventAlarmData | 16 |
The data associated with an alarm has changed. |
| EAlarmChangeEventRestoreStarted | 17 |
A restore from backup of the alarm server has started. Alarms cannot be added/deleted until this has finished. |
| EAlarmChangeEventRestoreFailed | 18 |
A restore from backup of the alarm server has failed. Alarms can be added/deleted again. |
| EAlarmChangeEventRestoreCompleted | 19 |
A restore from backup of the alarm server has completed. The alarm queue has changed. |
| EAlarmChangeEventLast |
Last change event (anchor). This is always at the end of the list. | |
| EAlarmChangeEventUndefined | 0 |
An undefined alarm event has occurred. |
Identifies server-initiated panics relating to the client session.
| Enumerator | Value | Description |
|---|---|---|
| EAlarmServerInitiatedClientPanicInsufficientRoomForAlarmData | 0 |
This panic occurs when the client requests a copy of any data attached to an alarm, but does not supply enough buffer space to contain the data. |
| EAlarmServerInitiatedClientPanicBadDescriptor | 1 |
This panic usually occurs when a client method tries to write to a descriptor (sometimes asynchronously), and the client-supplied descriptor is not valid. |
| EAlarmServerInitiatedClientPanicChangeNotificationAlreadyOutstanding | 2 |
This panic occurs when a client already has an outstanding notification request, but attempts to request another. |
| EAlarmServerInitiatedClientPanicInvalidOperation | 3 |
This panic occurs when a client tries to perform an invalid operation. |
| EAlarmServerInitiatedClientPanicBadPreAllocatedAlarmId | 4 |
This panic occurs when a request to add an alarm contains a null alarm identiifer. In the case of alarms with notifications, the client should pre-allocate the alarm identifier before requesting the notification. |
Identifies what kind of alarms the client wants to delete.
| Enumerator | Value | Description |
|---|---|---|
| EAllAlarms | 0 |
All type of alarms. |
| EFuture | 1 |
Alarms future of the current time |
| EActive | 2 |
Alarms in the past of the current time but notifying, or waiting to notify, or snoozed by, the user |
| EExpired | 4 |
alarms that has been dismissed by the user |