diff -r 4816d766a08a -r f345bda72bc4 Symbian3/PDK/Source/GUID-7BCA8B7A-E250-5452-9837-26C60F71F14F.dita --- a/Symbian3/PDK/Source/GUID-7BCA8B7A-E250-5452-9837-26C60F71F14F.dita Tue Mar 30 11:42:04 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-7BCA8B7A-E250-5452-9837-26C60F71F14F.dita Tue Mar 30 11:56:28 2010 +0100 @@ -1,114 +1,114 @@ - - - - - -Alarm -Properties Reference -

This section provides a summary of mandatory and optional Alarm -properties that must be set before adding an alarm to the Alarm Server.

The -following Alarm property is mandatory:

- - - - -

Property

-

Description

-
- - - -

NextDueTime

-

Indicates the time that the alarm will expire.

The KErrArgument error -is returned when an alarm is added without the next due time being set.

-
- - -
-

The following Alarm properties are optional:

- - - - -

Property

-

Description

-
- - - -

RepeatDefinition

-

Indicates the alarm repeat definition.

    -
  • RepeatOnce – -The alarm expires once and then deleted from the Alarm Server. This is the -default value.

  • -
  • Next24hours – -The alarm is scheduled to notify at the given time, within the next 24 hours. -The alarm is then deleted from the Alarm Server.

  • -
  • Daily – The -alarm repeats every day at the same time.

  • -
  • WorkDay – The -alarm repeats on workdays at the same time.

  • -
  • Weekly – The -alarm repeats at the same time, on the same day, every week.

  • -
  • DailyOnGivenDays – -The alarm repeats at the same time on the specified days of the week.

  • -
-
- -

Message

-

Indicates the message displayed by the UI when the alarm expires. -The maximum allowable length of the message is defined by KMaxAlarmMessageLength. -The KErrArgument error is returned when an alarm is added -to the server with a message exceeding this length.

-
- -

SoundName

-

Indicates the name of the sound file that must be played when the -alarm expires. The maximum allowable length of the sound name is defined by KMaxAlarmSoundNameLength. -The KErrArgument error is returned when an alarm is added -with a sound name exceeding this length. The Alarm Server does not check the -validity of the sound name. The UI must handle the scenarios where neither -sound name is provided nor valid.

-
- -

Category

-

It is an UID provided by a client to group the alarms registered -with the Alarm Server. This allows the Alarm Server to perform specific operations -on particular group of alarms, on behalf of the client.

-
- -

Characteristics

-

A flag that indicates whether:

    -
  • the caller is notified -when the alarm expires and

  • -
  • the UI is asked to display -an alarm dialog when the alarm notifies.

  • -

By default, the caller is not notified when an alarm expires and the -UI is requested to display an alarm dialog when the alarm expires.

-
- -

DayOrTimed

-

A flag that indicates whether the alarm is associated with a day -or timed appointment. The default is Timed. This flag is for the client’s -use only, and is not used by the Alarm Server.

-
- -

WakeUp

-

A flag that indicates whether the device must be made activate at -the next due time of this alarm. By default, alarms do not cause a device -wakeup.

-
- -

Continuous

-

A flag that indicates whether or not the alarm must play continuously -when it expires. If this flag is set, it overrides the alarm play intervals.

-
- - + + + + + +Alarm +Properties Reference +

This section provides a summary of mandatory and optional Alarm +properties that must be set before adding an alarm to the Alarm Server.

The +following Alarm property is mandatory:

+
+ + + +

Property

+

Description

+
+ + + +

NextDueTime

+

Indicates the time that the alarm will expire.

The KErrArgument error +is returned when an alarm is added without the next due time being set.

+
+ + +
+

The following Alarm properties are optional:

+ + + + +

Property

+

Description

+
+ + + +

RepeatDefinition

+

Indicates the alarm repeat definition.

    +
  • RepeatOnce – +The alarm expires once and then deleted from the Alarm Server. This is the +default value.

  • +
  • Next24hours – +The alarm is scheduled to notify at the given time, within the next 24 hours. +The alarm is then deleted from the Alarm Server.

  • +
  • Daily – The +alarm repeats every day at the same time.

  • +
  • WorkDay – The +alarm repeats on workdays at the same time.

  • +
  • Weekly – The +alarm repeats at the same time, on the same day, every week.

  • +
  • DailyOnGivenDays – +The alarm repeats at the same time on the specified days of the week.

  • +
+
+ +

Message

+

Indicates the message displayed by the UI when the alarm expires. +The maximum allowable length of the message is defined by KMaxAlarmMessageLength. +The KErrArgument error is returned when an alarm is added +to the server with a message exceeding this length.

+
+ +

SoundName

+

Indicates the name of the sound file that must be played when the +alarm expires. The maximum allowable length of the sound name is defined by KMaxAlarmSoundNameLength. +The KErrArgument error is returned when an alarm is added +with a sound name exceeding this length. The Alarm Server does not check the +validity of the sound name. The UI must handle the scenarios where neither +sound name is provided nor valid.

+
+ +

Category

+

It is an UID provided by a client to group the alarms registered +with the Alarm Server. This allows the Alarm Server to perform specific operations +on particular group of alarms, on behalf of the client.

+
+ +

Characteristics

+

A flag that indicates whether:

    +
  • the caller is notified +when the alarm expires and

  • +
  • the UI is asked to display +an alarm dialog when the alarm notifies.

  • +

By default, the caller is not notified when an alarm expires and the +UI is requested to display an alarm dialog when the alarm expires.

+
+ +

DayOrTimed

+

A flag that indicates whether the alarm is associated with a day +or timed appointment. The default is Timed. This flag is for the client’s +use only, and is not used by the Alarm Server.

+
+ +

WakeUp

+

A flag that indicates whether the device must be made activate at +the next due time of this alarm. By default, alarms do not cause a device +wakeup.

+
+ +

Continuous

+

A flag that indicates whether or not the alarm must play continuously +when it expires. If this flag is set, it overrides the alarm play intervals.

+
+ +
\ No newline at end of file