|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE reference |
|
11 PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> |
|
12 <reference id="GUID-7BCA8B7A-E250-5452-9837-26C60F71F14F" xml:lang="en"><title>Alarm |
|
13 Properties Reference</title><prolog><metadata><keywords/></metadata></prolog><refbody> |
|
14 <section><p>This section provides a summary of mandatory and optional Alarm |
|
15 properties that must be set before adding an alarm to the Alarm Server. </p> <p>The |
|
16 following Alarm property is <i>mandatory</i>: </p> </section> |
|
17 <table id="GUID-A097D4DD-A8FE-5E79-B90B-770D17104932"> |
|
18 <tgroup cols="2"><colspec colname="col0" colwidth="0.43*"/><colspec colname="col1" colwidth="1.57*"/> |
|
19 <thead> |
|
20 <row> |
|
21 <entry><p><b>Property</b></p></entry> |
|
22 <entry><p><b>Description</b></p></entry> |
|
23 </row> |
|
24 </thead> |
|
25 <tbody> |
|
26 <row> |
|
27 <entry><p> <b>NextDueTime</b> </p> </entry> |
|
28 <entry><p>Indicates the time that the alarm will expire. </p><p>The <codeph>KErrArgument</codeph> error |
|
29 is returned when an alarm is added without the next due time being set. </p></entry> |
|
30 </row> |
|
31 </tbody> |
|
32 </tgroup> |
|
33 </table> |
|
34 <section><p> </p> <p>The following Alarm properties are <i>optional</i>: </p> </section> |
|
35 <table id="GUID-E40B0108-874F-5CC6-9406-D3A9EB487FC1"> |
|
36 <tgroup cols="2"><colspec colname="col0" colwidth="0.58*"/><colspec colname="col1" colwidth="1.42*"/> |
|
37 <thead> |
|
38 <row> |
|
39 <entry><p><b>Property</b></p></entry> |
|
40 <entry><p><b>Description</b></p></entry> |
|
41 </row> |
|
42 </thead> |
|
43 <tbody> |
|
44 <row> |
|
45 <entry><p> <b>RepeatDefinition</b> </p> </entry> |
|
46 <entry><p>Indicates the alarm repeat definition. </p><ul> |
|
47 <li id="GUID-D64B190D-D97A-58CD-91B3-44FE3637FA71"><p> <b>RepeatOnce</b> – |
|
48 The alarm expires once and then deleted from the Alarm Server. This is the |
|
49 default value. </p> </li> |
|
50 <li id="GUID-32C0FAF5-96F9-5DC9-AFDD-29FB67F51417"><p> <b>Next24hours</b> – |
|
51 The alarm is scheduled to notify at the given time, within the next 24 hours. |
|
52 The alarm is then deleted from the Alarm Server. </p> </li> |
|
53 <li id="GUID-13FCA81D-FABF-5585-B093-2D9FC405721B"><p> <b>Daily</b> – The |
|
54 alarm repeats every day at the same time. </p> </li> |
|
55 <li id="GUID-C0FF139B-03C5-5756-B0A3-ED0C496E8A81"><p> <b>WorkDay</b> – The |
|
56 alarm repeats on workdays at the same time. </p> </li> |
|
57 <li id="GUID-33AC43FC-412E-557C-A9FB-B2063FDEF9EC"><p> <b>Weekly</b> – The |
|
58 alarm repeats at the same time, on the same day, every week. </p> </li> |
|
59 <li id="GUID-92BD2CFB-033C-5B3D-B1F5-D60987804814"><p> <b>DailyOnGivenDays</b> – |
|
60 The alarm repeats at the same time on the specified days of the week. </p> </li> |
|
61 </ul></entry> |
|
62 </row> |
|
63 <row> |
|
64 <entry><p> <b>Message</b> </p> </entry> |
|
65 <entry><p>Indicates the message displayed by the UI when the alarm expires. |
|
66 The maximum allowable length of the message is defined by <codeph>KMaxAlarmMessageLength</codeph>. |
|
67 The <codeph>KErrArgument</codeph> error is returned when an alarm is added |
|
68 to the server with a message exceeding this length. </p></entry> |
|
69 </row> |
|
70 <row> |
|
71 <entry><p> <b>SoundName </b> </p> </entry> |
|
72 <entry><p>Indicates the name of the sound file that must be played when the |
|
73 alarm expires. The maximum allowable length of the sound name is defined by <codeph>KMaxAlarmSoundNameLength</codeph>. |
|
74 The <codeph>KErrArgument</codeph> error is returned when an alarm is added |
|
75 with a sound name exceeding this length. The Alarm Server does not check the |
|
76 validity of the sound name. The UI must handle the scenarios where neither |
|
77 sound name is provided nor valid. </p></entry> |
|
78 </row> |
|
79 <row> |
|
80 <entry><p> <b>Category</b> </p> </entry> |
|
81 <entry><p>It is an UID provided by a client to group the alarms registered |
|
82 with the Alarm Server. This allows the Alarm Server to perform specific operations |
|
83 on particular group of alarms, on behalf of the client. </p></entry> |
|
84 </row> |
|
85 <row> |
|
86 <entry><p> <b>Characteristics</b> </p> </entry> |
|
87 <entry><p>A flag that indicates whether: </p><ul> |
|
88 <li id="GUID-BD57C6CE-B347-5942-90A9-3BE3C04D2ABB"><p>the caller is notified |
|
89 when the alarm expires and </p> </li> |
|
90 <li id="GUID-6ABFC447-6C24-51E6-973A-4994297D5C16"><p>the UI is asked to display |
|
91 an alarm dialog when the alarm notifies. </p> </li> |
|
92 </ul><p>By default, the caller is not notified when an alarm expires and the |
|
93 UI is requested to display an alarm dialog when the alarm expires. </p></entry> |
|
94 </row> |
|
95 <row> |
|
96 <entry><p> <b> DayOrTimed</b> </p> </entry> |
|
97 <entry><p>A flag that indicates whether the alarm is associated with a day |
|
98 or timed appointment. The default is Timed. This flag is for the client’s |
|
99 use only, and is not used by the Alarm Server. </p></entry> |
|
100 </row> |
|
101 <row> |
|
102 <entry><p> <b>WakeUp</b> </p> </entry> |
|
103 <entry><p>A flag that indicates whether the device must be made activate at |
|
104 the next due time of this alarm. By default, alarms do not cause a device |
|
105 wakeup. </p></entry> |
|
106 </row> |
|
107 <row> |
|
108 <entry><p> <b>Continuous</b> </p> </entry> |
|
109 <entry><p>A flag that indicates whether or not the alarm must play continuously |
|
110 when it expires. If this flag is set, it overrides the alarm play intervals. </p></entry> |
|
111 </row> |
|
112 </tbody> |
|
113 </tgroup> |
|
114 </table></refbody></reference> |