|
1 <?xml version="1.0" encoding="UTF-8"?> |
|
2 <?mso-infoPathSolution PIVersion="1.0.0.0" href="http://www.aptana.com/forms/types.xsn" language="en-us" name="urn:schemas-microsoft-com:office:infopath:types:" productVersion="11.0.6357" solutionVersion="1.0.0.46" ?><?mso-application progid="InfoPath.Document"?> |
|
3 <javascript xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xd="http://schemas.microsoft.com/office/infopath/2003"> |
|
4 |
|
5 <class type="widget" superclass="Object" visibility="basic"> |
|
6 <description>The widget engine provides a set of system information (SystemInfo) API services. The SystemInfo Service API allows a widget to access a device's properties and to control certain device features. The API is implemented in a plug-in module and it is integrated into the WRT environment. |
|
7 To use the SystemInfo APIs, each widget must load the plug-in module explicitly by defining the following HTML code in its main HTML document</description> |
|
8 <browsers> |
|
9 <browser platform="Nokia WRT" version="1.0+"/> |
|
10 </browsers> |
|
11 <constructors> |
|
12 <constructor scope="instance"> |
|
13 <description>The widget object is a built-in JavaScript object in the widget engine. |
|
14 </description> |
|
15 <browsers> |
|
16 <browser platform="Nokia WRT" version="1.0+"/> |
|
17 </browsers> |
|
18 <parameters/> |
|
19 <return-types> |
|
20 <return-type type="widget"/> |
|
21 </return-types> |
|
22 </constructor> |
|
23 </constructors> |
|
24 |
|
25 <properties> |
|
26 <property name="identifier" type="String" scope="" access="read" visibility="basic"> |
|
27 <description>This is a read-only property that returns an integer indicating the current battery level. |
|
28 The returned value is in the range of 0 to 100 as a percentage of the maximum battery level. |
|
29 </description> |
|
30 <browsers> |
|
31 <browser platform="Nokia WRT" version="1.0+"/> |
|
32 </browsers> |
|
33 </property> |
|
34 |
|
35 <property name="onshow" type="void" scope="" access="read-write" visibility="basic"> |
|
36 <description>The onshow property is an event handler for the event of when a widget is switching from the background to the foreground. In other words, when an opened widget gains focus, the assigned callback function will be called. |
|
37 </description> |
|
38 <browsers> |
|
39 <browser platform="Nokia WRT" version="1.0+"/> |
|
40 </browsers> |
|
41 <availability> |
|
42 <specification name="Nokia WRT" version="1.0+"/> |
|
43 </availability> |
|
44 </property> |
|
45 <property name="onhide" type="void" scope="" access="read-write" visibility="basic"> |
|
46 <description>The onhide property is an event handler for the event of when a widget is switching from the foreground to the background. In other words, when a running widget loses focus, the assigned callback function will be called. |
|
47 </description> |
|
48 <browsers> |
|
49 <browser platform="Nokia WRT" version="1.0+"/> |
|
50 </browsers> |
|
51 <availability> |
|
52 <specification name="Nokia WRT" version="1.0+"/> |
|
53 </availability> |
|
54 </property> |
|
55 |
|
56 <property name="isrotationsupported" type="Boolean" scope="" access="read-write" visibility="basic"> |
|
57 <description>isrotationsupported is a read-only property that returns a Boolean value determining if the device supports landscape and portrait screen orientations. |
|
58 If the value is true, the device supports both landscape and portrait screen orientations. |
|
59 </description> |
|
60 <browsers> |
|
61 <browser platform="Nokia WRT" version="1.0+"/> |
|
62 </browsers> |
|
63 <availability> |
|
64 <specification name="Nokia WRT" version="ert 1.0+"/> |
|
65 </availability> |
|
66 </property> |
|
67 </properties> |
|
68 |
|
69 <methods> |
|
70 |
|
71 <method name="openURL" scope="" visibility="basic"> |
|
72 <return-types> |
|
73 <return-type type="void"/> |
|
74 </return-types> |
|
75 <description>The openURL method opens a specified link in the Web Browser for S60 in the stand-alone mode. The widget remains open but is sent to the background. </description> |
|
76 <parameters> |
|
77 <parameter name="url" type="String" usage="required"> |
|
78 <description>A compact string specifying a link to a resource to be opened. The URL string format is compliant with the RFC-1738 specification and must be encoded if it contains non-ASCII characters.</description> |
|
79 </parameter> |
|
80 </parameters> |
|
81 <browsers> |
|
82 <browser platform="Nokia WRT Webruntime" version="1.0+" /> |
|
83 </browsers> |
|
84 </method> |
|
85 <method name="setPreferenceForKey" scope="" visibility="basic"> |
|
86 <return-types> |
|
87 <return-type type="void"/> |
|
88 </return-types> |
|
89 <description>The setPreferenceForKey method allows a key to be stored along with its associated preference. The arguments are like name and value pairs. The preference value for the key is stored persistently, so if the widget or device is restarted, the value is retained. However, the values stored by a widget are removed when a widget is uninstalled from the device. This includes the case when a widget is reinstalled; where the old widget is uninstalled, the new widget is installed. |
|
90 An existing preference can be overwritten with a new value by simply calling the method with the same key and new value. |
|
91 </description> |
|
92 <parameters> |
|
93 <parameter name="preference" type="String" usage="required"> |
|
94 <description>A short text string defined as the name of the preference to be stored.</description> |
|
95 </parameter> |
|
96 <parameter name="key" type="String" usage="required"> |
|
97 <description>A compact string specifying a link to a resource to be opened. The URL string format is compliant with the RFC-1738 specification and must be encoded if it contains non-ASCII characters.</description> |
|
98 </parameter> |
|
99 </parameters> |
|
100 <browsers> |
|
101 <browser platform="Nokia WRT Webruntime" version="1.0+" /> |
|
102 </browsers> |
|
103 </method> |
|
104 |
|
105 <method name="preferenceForKey" scope="" visibility="basic"> |
|
106 <return-types> |
|
107 <return-type type="String"/> |
|
108 </return-types> |
|
109 <description>The preferenceForKey method allows a previously stored preference to be restored. |
|
110 </description> |
|
111 <parameters> |
|
112 <parameter name="key" type="String" usage="required"> |
|
113 <description>A text string specifying the name that represents the preference to be restored. |
|
114 </description> |
|
115 </parameter> |
|
116 </parameters> |
|
117 <browsers> |
|
118 <browser platform="Nokia WRT" version="1.0+" /> |
|
119 </browsers> |
|
120 </method> |
|
121 |
|
122 <method name="prepareForTransition" scope="" visibility="basic"> |
|
123 <return-types> |
|
124 <return-type type="void"/> |
|
125 </return-types> |
|
126 <description>The widget's view is composed by HTML elements such as text display area, buttons, edit fields, and so on. The appearance of these HTML elements can be dynamically changed. For example, they can be shown or hidden dynamically using the HTML DOM style object to set the display property to "block" or "none" respectively. </description> |
|
127 <parameters> |
|
128 <parameter name="transitionMode" type="String" usage="required"> |
|
129 <description>A text string defining a desired transition mode. Currently the only supported transition mode is "fade", which causes the widget's view changing in fading mode. |
|
130 </description> |
|
131 </parameter> |
|
132 </parameters> |
|
133 <browsers> |
|
134 <browser platform="Nokia WRT" version="1.0+" /> |
|
135 </browsers> |
|
136 </method> |
|
137 |
|
138 <method name="performTransition" scope="" visibility="basic"> |
|
139 <return-types> |
|
140 <return-type type="void"/> |
|
141 </return-types> |
|
142 <description>The performTransition method operates as a screen update command, which tells the widget UI framework to update the widget screen. It performs the animation while the widget's view is being changed. Currently, only fading animation mode is supported. </description> |
|
143 <browsers> |
|
144 <browser platform="Nokia WRT" version="1.0+" /> |
|
145 </browsers> |
|
146 </method> |
|
147 |
|
148 <method name="setNavigationEnabled" scope="" visibility="basic"> |
|
149 <return-types> |
|
150 <return-type type="void"/> |
|
151 </return-types> |
|
152 <description>The navigation mode in a widget can be toggled between a cursor and a tabbed navigation mode. By default, the browsing mode of a widget is set to use a cursor (pointer). The setNavigationEnabled method is used for changing the widget's navigation mode. |
|
153 The argument navigationType is of Boolean type and can be set to true or false to toggle the navigation mode between the cursor mode and the tab mode respectively. |
|
154 </description> |
|
155 <parameters> |
|
156 <parameter name="navigationMode" type="Boolean" usage="required"> |
|
157 <description>Set to true to enable the cursor navigation mode, and set to false to enable the tabbed navigation mode. |
|
158 </description> |
|
159 </parameter> |
|
160 </parameters> |
|
161 <browsers> |
|
162 <browser platform="Nokia WRT" version="1.0+" /> |
|
163 </browsers> |
|
164 </method> |
|
165 |
|
166 <method name="setDisplayLandscape" scope="" visibility="basic"> |
|
167 <return-types> |
|
168 <return-type type="void"/> |
|
169 </return-types> |
|
170 <description>The setDisplayLandscape method changes the orientation of a widget's screen to the landscape mode. |
|
171 </description> |
|
172 <browsers> |
|
173 <browser platform="Nokia WRT" version="1.0+" /> |
|
174 </browsers> |
|
175 </method> |
|
176 |
|
177 <method name="openApplication" scope="" visibility="basic"> |
|
178 <description>The openApplication method enables a widget to launch an S60 mobile application in the stand-alone mode. |
|
179 </description> |
|
180 <parameters> |
|
181 |
|
182 <parameter name="Uid" type="Number" usage="required"> |
|
183 <description>A hexadecimal number that specifies the UID of the S60 application to be activated. See the table below for example application UIDs.</description> |
|
184 </parameter> |
|
185 |
|
186 <parameter name="param" type="String" usage="required"> |
|
187 <description>A text string defining a possible argument string that is accepted by the S60 application to be activated.</description> |
|
188 </parameter> |
|
189 |
|
190 </parameters> |
|
191 |
|
192 <browsers> |
|
193 <browser platform="Nokia WRT" version="1.0+" /> |
|
194 </browsers> |
|
195 </method> |
|
196 |
|
197 <method name="setDisplayPortrait" scope="" visibility="basic"> |
|
198 <return-types> |
|
199 <return-type type="void"/> |
|
200 </return-types> |
|
201 <description>The setDisplayPortrait method changes the orientation of a widget's screen to the portrait mode. |
|
202 </description> |
|
203 <browsers> |
|
204 <browser platform="Nokia WRT" version="1.0+" /> |
|
205 </browsers> |
|
206 </method> |
|
207 </methods> |
|
208 </class> |
|
209 |
|
210 <class type="menu" superclass="Object" visibility="basic"> |
|
211 <description> |
|
212 The menu object is supported since WRT version 1.0. |
|
213 </description> |
|
214 |
|
215 <browsers> |
|
216 <browser platform="Nokia WRT" version="1.0+" /> |
|
217 </browsers> |
|
218 |
|
219 <constructors> |
|
220 <constructor scope="instance"> |
|
221 <description>The menu object is a built-in object in the widget engine. It is extended from the window object to |
|
222 provide widget-specific APIs for manipulating widget's options menu and softkeys. |
|
223 The menu object can be accessed via the window object window.menu or just simply menu. Thus, in the |
|
224 WRT environment, the term menu is a reserved keyword and should not be used as a user-defined global |
|
225 variable name for other type of objects. |
|
226 A widget's options menu can be constructed using the menu object. The options menu is automatically |
|
227 associated with the device's left softkey and it cannot be reassigned to associate with another |
|
228 softkey (for example, the right softkey). The label of the options menu (the left softkey) is the |
|
229 system-defined term in the current used system language (for example, Options for English). |
|
230 Thus, the left softkey label cannot be changed.</description> |
|
231 <browsers> |
|
232 <browser platform="Nokia WRT" version="1.0+"/> |
|
233 </browsers> |
|
234 <parameters/> |
|
235 <exceptions/> |
|
236 </constructor> |
|
237 </constructors> |
|
238 |
|
239 <properties> |
|
240 <property name="onShow" type="Void" scope="" access="read-write" visibility="basic"> |
|
241 <description> The onShow property of the menu object is an event handler for the event of when the options menu is open. In other words, when the end user presses the left softkey, the system will fire an event and a widget can catch the event by providing a callback function. |
|
242 </description> |
|
243 <browsers> |
|
244 <browser platform="Nokia WRT" version="1.0+"/> |
|
245 </browsers> |
|
246 |
|
247 </property> |
|
248 |
|
249 </properties> |
|
250 <methods> |
|
251 |
|
252 <method name="append" scope="" visibility="basic"> |
|
253 <return-types> |
|
254 <return-type type="void"/> |
|
255 </return-types> |
|
256 <description>Call the append method to add a menu item to the top level of the options menu list. |
|
257 Menu items are shown on the options menu list in the order in which they are appended. |
|
258 For more general information on constructing an options menu. |
|
259 </description> |
|
260 <parameters> |
|
261 <parameter name="MenuItem" type="menuItem" usage="required"> |
|
262 <description>This is an instance of the MenuItem object which is being added to the top level of the options menu |
|
263 </description> |
|
264 </parameter> |
|
265 </parameters> |
|
266 <browsers> |
|
267 <browser platform="Nokia WRT" version="1.0+" /> |
|
268 </browsers> |
|
269 </method> |
|
270 |
|
271 |
|
272 <method name="remove" scope="" visibility="basic"> |
|
273 <return-types> |
|
274 <return-type type="void"/> |
|
275 </return-types> |
|
276 <description>Call the remove method to remove a menu item from the top level of the options menu list. If the removed menu item has a cascading submenu in it, the submenu will also be removed. |
|
277 </description> |
|
278 <parameters> |
|
279 <parameter name="MenuItem" type="menuItem" usage="required"> |
|
280 <description>This is an instance of the MenuItem object which is being removed from the top level of the options menu list. |
|
281 </description> |
|
282 </parameter> |
|
283 </parameters> |
|
284 <browsers> |
|
285 <browser platform="Nokia WRT" version="1.0+" /> |
|
286 </browsers> |
|
287 </method> |
|
288 |
|
289 <method name="getMenuItemById" scope="" visibility="basic"> |
|
290 <return-types> |
|
291 <return-type type="MenuItem"/> |
|
292 </return-types> |
|
293 <description>Call the getMenuItemById method with a specified menu item's identifier to retrieve the handle of the menu item instance. |
|
294 </description> |
|
295 <parameters> |
|
296 <parameter name="id" type="Number" usage="required"> |
|
297 <description>This is the identifier of an existing menu item whose handle is being retrieved. |
|
298 </description> |
|
299 </parameter> |
|
300 </parameters> |
|
301 <browsers> |
|
302 <browser platform="Nokia WRT" version="1.0+" /> |
|
303 </browsers> |
|
304 </method> |
|
305 |
|
306 <method name="getMenuItemByName" scope="" visibility="basic"> |
|
307 <return-types> |
|
308 <return-type type="MenuItem"/> |
|
309 </return-types> |
|
310 <description>Call the getMenuItemByName method with a specified menu item's label to retrieve the handle of the menu item instance. |
|
311 </description> |
|
312 <parameters> |
|
313 <parameter name="menuItemLabel" type="String" usage="required"> |
|
314 <description>This is the identifier of an existing menu item whose handle is being retrieved. |
|
315 </description> |
|
316 </parameter> |
|
317 </parameters> |
|
318 <browsers> |
|
319 <browser platform="Nokia WRT" version="1.0+" /> |
|
320 </browsers> |
|
321 </method> |
|
322 |
|
323 <method name="setRightSoftkeyLabel" scope="" visibility="basic"> |
|
324 <return-types> |
|
325 <return-type type="void"/> |
|
326 </return-types> |
|
327 <description>Call the setRightSoftkeyLabel method to customize the label and the operation associated with the right softkey. |
|
328 By default, the right softkey of a device is assigned to the "Exit" function, which terminates a running widget. The default label depends on the current used system language (Exit for English). |
|
329 </description> |
|
330 <parameters> |
|
331 <parameter name="label" type="String" usage="required"> |
|
332 <description>A text string specifies the label to be shown on the right softkey. |
|
333 </description> |
|
334 </parameter> |
|
335 <parameter name="callbackfunc" type="Function" usage="required"> |
|
336 <description>A reference to the callback function, which will be called by the system when the right softkey is pressed. |
|
337 </description> |
|
338 </parameter> |
|
339 </parameters> |
|
340 <browsers> |
|
341 <browser platform="Nokia WRT" version="1.0+" /> |
|
342 </browsers> |
|
343 </method> |
|
344 |
|
345 <method name="showSoftkeys" scope="" visibility="basic"> |
|
346 <return-types> |
|
347 <return-type type="void"/> |
|
348 </return-types> |
|
349 <description>Call the showSoftkeys method to display the softkey pane at all times. |
|
350 By default, the device's softkey pane is hidden. The softkey pane is shown either by programmatically calling the showSoftkeys method or when the end user presses one of the softkeys. |
|
351 </description> |
|
352 <browsers> |
|
353 <browser platform="Nokia WRT" version="1.0+" /> |
|
354 </browsers> |
|
355 </method> |
|
356 |
|
357 <method name="hideSoftkeys" scope="" visibility="basic"> |
|
358 <return-types> |
|
359 <return-type type="void"/> |
|
360 </return-types> |
|
361 <description>Call the hideSoftkeys method to hide the softkey pane. |
|
362 By default, the device's softkey pane is hidden. The softkey pane is shown automatically when the end user presses one of the softkeys. |
|
363 </description> |
|
364 <browsers> |
|
365 <browser platform="Nokia WRT" version="1.0+" /> |
|
366 </browsers> |
|
367 </method> |
|
368 |
|
369 <method name="clear" scope="" visibility="basic"> |
|
370 <return-types> |
|
371 <return-type type="void"/> |
|
372 </return-types> |
|
373 <description>Call the clear method to delete all the menu items in the options menu pane. This operation will also clear all submenus if such exist |
|
374 </description> |
|
375 <browsers> |
|
376 <browser platform="Nokia WRT" version="1.0+" /> |
|
377 </browsers> |
|
378 </method> |
|
379 </methods> |
|
380 </class> |
|
381 |
|
382 <!-- MenuItem Object --> |
|
383 <class type="MenuItem" superclass="Object" visibility="basic"> |
|
384 <description> |
|
385 The MenuItem object is supported since WRT version 1.0. |
|
386 </description> |
|
387 |
|
388 <browsers> |
|
389 <browser platform="Nokia WRT" version="1.0+" /> |
|
390 </browsers> |
|
391 |
|
392 <constructors> |
|
393 <constructor scope="instance"> |
|
394 <description>Creates a new instance of an Enumerator object.</description> |
|
395 <browsers> |
|
396 <browser platform="Nokia WRT" version="1.0+"/> |
|
397 </browsers> |
|
398 |
|
399 <parameters> |
|
400 <parameter name="label" type="String" usage="required"> |
|
401 <description>A text string that defines the label for the menu item.</description> |
|
402 </parameter> |
|
403 <parameter name="id" type="Integer" usage="required"> |
|
404 <description>A unique integer that identifies the menu item.</description> |
|
405 </parameter> |
|
406 </parameters> |
|
407 |
|
408 <return-types> |
|
409 <return-type type="MenuItem"/> |
|
410 </return-types> |
|
411 </constructor> |
|
412 </constructors> |
|
413 |
|
414 <properties> |
|
415 <property name="onSelect" type="void" scope="instance" access="read-write" visibility="basic"> |
|
416 <description> The onSelect property of the MenuItem object is an event handler for the event of when the menu item is selected. In other words, when the end user opens the options menu and selects a menu item either from the top-level menu list or from a submenu list, the system will fire an event and a widget can catch the event by providing a callback function. |
|
417 </description> |
|
418 <browsers> |
|
419 <browser platform="Nokia WRT" version="1.0+"/> |
|
420 </browsers> |
|
421 </property> |
|
422 </properties> |
|
423 |
|
424 <methods> |
|
425 <method name="append" scope="instance" visibility="basic"> |
|
426 <return-types> |
|
427 <return-type type="void"/> |
|
428 </return-types> |
|
429 <description>Call the append method to add a child menu item to the parent menu item in the options menu list. This results in the creation of a submenu list in the menu tree. Use this method to create a cascading submenu when needed. |
|
430 Menu items are shown on the options menu list in the order in which they are appended. |
|
431 </description> |
|
432 <parameters> |
|
433 <parameter name="childMenuItem" type="MenuItem" usage="required"> |
|
434 <description>This is an instance of the MenuItem object which is being added to the parent menu item. See also the menu.append method description for instructions on how to append a menu item to the top level of the options menu list. |
|
435 </description> |
|
436 </parameter> |
|
437 </parameters> |
|
438 <browsers> |
|
439 <browser platform="Nokia WRT" version="1.0+" /> |
|
440 </browsers> |
|
441 </method> |
|
442 |
|
443 <method name="remove" scope="instance" visibility="basic"> |
|
444 <return-types> |
|
445 <return-type type="void"/> |
|
446 </return-types> |
|
447 <description>Call the remove method to remove a child menu item and its children (if any) from the parent menu item. |
|
448 </description> |
|
449 <parameters> |
|
450 <parameter name="childMenuItem" type="MenuItem" usage="required"> |
|
451 <description>This is an instance of the MenuItem object which is being removed from the parent menu item. See also the menu.remove method description for instructions on how to remove a menu item from the top level of the options menu list. |
|
452 </description> |
|
453 </parameter> |
|
454 </parameters> |
|
455 <browsers> |
|
456 <browser platform="Nokia WRT" version="1.0+" /> |
|
457 </browsers> |
|
458 </method> |
|
459 |
|
460 <method name="setDimmed" scope="instance" visibility="basic"> |
|
461 <return-types> |
|
462 <return-type type="void"/> |
|
463 </return-types> |
|
464 <description>Call the setDimmed method to show or hide an existing menu item. By default, a menu item is shown when it is appended to the options menu. |
|
465 </description> |
|
466 <parameters> |
|
467 <parameter name="flag" type="Boolean" usage="required"> |
|
468 <description>true to show the menu item, and false to hide the menu item. |
|
469 </description> |
|
470 </parameter> |
|
471 </parameters> |
|
472 <browsers> |
|
473 <browser platform="Nokia WRT" version="1.0+" /> |
|
474 </browsers> |
|
475 </method> |
|
476 <!-- End Menu Item object functions --> |
|
477 </methods> |
|
478 </class> |
|
479 <!-- end of MenuItem Object --> |
|
480 |
|
481 <!-- System API document.embeds[0]; --> |
|
482 |
|
483 <!-- <class type="SystemInfo" superclass="Object" visibility="basic"> --> |
|
484 |
|
485 <!-- |
|
486 |
|
487 <class type="systemInfo" superclass="Object" visibility="basic"> |
|
488 <description>The widget engine provides a set of system information (SystemInfo) API services. The SystemInfo Service API allows a widget to access a device's properties and to control certain device features. The API is implemented in a plug-in module and it is integrated into the WRT environment. |
|
489 To use the SystemInfo APIs, each widget must load the plug-in module explicitly by defining the following HTML code in its main HTML document: |
|
490 </description> |
|
491 <browsers> |
|
492 <browser platform="Nokia WRT" version="1.0+"/> |
|
493 </browsers> |
|
494 |
|
495 <constructors> |
|
496 <constructor scope="instance"> |
|
497 <description>Creates a new instance of an Enumerator object.</description> |
|
498 <parameters> |
|
499 <parameter name="group" type="Object" usage="required"> |
|
500 <description>Group of items to be iterated over.</description> |
|
501 </parameter> |
|
502 </parameters> |
|
503 <return-types> |
|
504 <return-type type="Enumerator"/> |
|
505 </return-types> |
|
506 </constructor> |
|
507 </constructors> |
|
508 |
|
509 <properties> |
|
510 <property name="chargelevel" type="Integer" scope="instance" access="read" visibility="basic"> |
|
511 <description>This is a read-only property that returns an integer indicating the current battery level. |
|
512 The returned value is in the range of 0 to 100 as a percentage of the maximum battery level. |
|
513 </description> |
|
514 <browsers> |
|
515 <browser platform="Nokia WRT" version="1.0+"/> |
|
516 </browsers> |
|
517 </property> |
|
518 |
|
519 <property name="onchargelevel" type="" scope="instance" access="read-write" visibility="basic"> |
|
520 <description>The onchargelevel property is an event handler for the event of when the battery level is changed. The callback function is assigned by providing the function's name wrapped in a string.</description> |
|
521 <browsers> |
|
522 <browser platform="Nokia WRT" version="1.0+"/> |
|
523 </browsers> |
|
524 </property> |
|
525 |
|
526 <property name="chargerconnected" type="Boolean" scope="instance" access="read" visibility="basic"> |
|
527 <description>This is a read-only property that returns a Boolean value indicating the status of the changer. |
|
528 If the charger is connected, the returned value is 1; otherwise it is 0. </description> |
|
529 <browsers> |
|
530 <browser platform="Nokia WRT" version="1.0+"/> |
|
531 </browsers> |
|
532 </property> |
|
533 <property name="onchargerconnected" type="void" scope="instance" access="read-write" visibility="basic"> |
|
534 <description>The onchargerconnected property is an event handler for the event of when the charger is plugged to or unplugged from the device. |
|
535 Since the event is fired off much faster than the value is updated, it is recommended to read the value after a small delay.</description> |
|
536 <browsers> |
|
537 <browser platform="Nokia WRT" version="1.0+"/> |
|
538 </browsers> |
|
539 </property> |
|
540 |
|
541 |
|
542 <property name="signalbars" type="Integer" scope="instance" access="read" visibility="basic"> |
|
543 <description>This is a read-only property that returns an integer indicating the network signal strength. |
|
544 The returned value is in the range of 0 to 7, where 0 represents no signal and 7 represents the maximum signal strength. |
|
545 For more information on network connection related aspects that you should take into account in your widget. |
|
546 </description> |
|
547 |
|
548 <browsers> |
|
549 <browser platform="Nokia WRT" version="1.0+"/> |
|
550 </browsers> |
|
551 </property> |
|
552 <property name="networkname" type="String" scope="instance" access="read" visibility="basic"> |
|
553 <description>This is a read-only property that returns a string containing the current registered mobile network name defined by the network provider. |
|
554 This information is only available on GSM/WCDMA networks. |
|
555 For more information on network connection related aspects that you should take into account in your widget.</description> |
|
556 <browsers> |
|
557 <browser platform="Nokia WRT" version="1.0+"/> |
|
558 </browsers> |
|
559 </property> |
|
560 <property name="lightminintensity" type="void" scope="instance" access="read" visibility="basic"> |
|
561 <description>This is a read-only property that returns a constant value determining the minimum light intensity (lowest brightness) supported by a device. |
|
562 </description> |
|
563 <browsers> |
|
564 <browser platform="Nokia WRT" version="1.0+"/> |
|
565 </browsers> |
|
566 </property> |
|
567 |
|
568 |
|
569 <property name="networkregistrationstatus" type="Integer" scope="" access="read-write" visibility="basic"> |
|
570 <description>The networkregistrationstatus property is an integer indicating the current network registration status. |
|
571 </description> |
|
572 <browsers> |
|
573 <browser platform="Nokia WRT" version="1.0+"/> |
|
574 </browsers> |
|
575 </property> |
|
576 <property name="lightdefaultintensity" type="" scope="instance" access="read" visibility="basic"> |
|
577 <description>This is a read-only property that returns a constant value determining the default light intensity (default brightness) preset for a device. |
|
578 </description> |
|
579 <browsers> |
|
580 <browser platform="Nokia WRT" version="1.0+"/> |
|
581 </browsers> |
|
582 </property> |
|
583 |
|
584 <property name="lightinfiniteduration" type="Integer" scope="instance" access="read" visibility="basic"> |
|
585 <description>This is a read-only property that returns a constant value determining the infinite time duration. |
|
586 </description> |
|
587 <browsers> |
|
588 <browser platform="Nokia WRT" version="1.0+"/> |
|
589 </browsers> |
|
590 </property> |
|
591 |
|
592 <property name="lightmaxduration" type="Integer" scope="instance" access="read-write" visibility="basic"> |
|
593 <description>This is a read-only property that returns an integer value determining the maximum allowed time duration that a device supports. The time duration unit is measured in milliseconds. |
|
594 </description> |
|
595 <browsers> |
|
596 <browser platform="Nokia WRT" version="1.0+"/> |
|
597 </browsers> |
|
598 </property> |
|
599 |
|
600 |
|
601 <property name="lightdefaultcycletime" type="Integer" scope="instance" access="read" visibility="basic"> |
|
602 <description>This is a read-only property that returns a constant value indicating the default cycle time of when the light is blinking. |
|
603 </description> |
|
604 <browsers> |
|
605 <browser platform="Nokia WRT" version="1.0+"/> |
|
606 </browsers> |
|
607 </property> |
|
608 |
|
609 <property name="lighttargetprimarydisplayandkeyboard" type="Integer" scope="instance" access="read-write" visibility="basic"> |
|
610 <description>This is a read-only property that returns a constant value defining the target light to be both the primary display and the keyboard illuminator. |
|
611 </description> |
|
612 <browsers> |
|
613 <browser platform="Nokia WRT" version="1.0+"/> |
|
614 </browsers> |
|
615 </property> |
|
616 <property name="lighttargetsystem" type="Integer" scope="instance" access="read" visibility="basic"> |
|
617 <description>This is a read-only property that returns a constant value defining the target light to be all displays (primary and secondary if exists) and the keyboard illuminator. |
|
618 </description> |
|
619 <browsers> |
|
620 <browser platform="Nokia WRT" version="1.0+"/> |
|
621 </browsers> |
|
622 </property> |
|
623 |
|
624 |
|
625 <property name="vibraminintensity" type="Integer" scope="instance" access="read" visibility="basic"> |
|
626 <description>This is a read-only property that returns a constant value determining the minimum vibration intensity (lowest vibration frequency). |
|
627 </description> |
|
628 <browsers> |
|
629 <browser platform="Nokia WRT" version="1.0+"/> |
|
630 </browsers> |
|
631 </property> |
|
632 |
|
633 <property name="vibramaxintensity" type="Integer" scope="instance" access="read" visibility="basic"> |
|
634 <description>This is a read-only property that returns a constant value determining the maximum vibration intensity (highest vibration frequency). |
|
635 </description> |
|
636 <browsers> |
|
637 <browser platform="Nokia WRT" version="1.0+"/> |
|
638 </browsers> |
|
639 </property> |
|
640 <property name="vibramaxduration" type="Integer" scope="instance" access="read" visibility="basic"> |
|
641 <description>This is a read-only property that returns a constant value determining the maximum allowed time duration of vibration. |
|
642 </description> |
|
643 <browsers> |
|
644 <browser platform="Nokia WRT" version="1.0+"/> |
|
645 </browsers> |
|
646 </property> |
|
647 <property name="vibrasettings" type="Integer" scope="instance" access="read" visibility="basic"> |
|
648 <description>This is a read-only property that returns the current settings of the vibration mode set in the active user profile. |
|
649 </description> |
|
650 <browsers> |
|
651 <browser platform="Nokia WRT" version="1.0+"/> |
|
652 </browsers> |
|
653 </property> |
|
654 |
|
655 |
|
656 <property name="totalram" type="Integer" scope="instance" access="read" visibility="basic"> |
|
657 <description>This is a read-only property that returns an integer value indicating the total amount of RAM of a device, measured in bytes. |
|
658 </description> |
|
659 <browsers> |
|
660 <browser platform="Nokia WRT" version="1.0+"/> |
|
661 </browsers> |
|
662 </property> |
|
663 <property name="freeram" type="Integer" scope="instance" access="read" visibility="basic"> |
|
664 <description>This is a read-only property that returns an integer value indicating the amount of free RAM of a device, measured in bytes. |
|
665 </description> |
|
666 <browsers> |
|
667 <browser platform="Nokia WRT" version="1.0+"/> |
|
668 </browsers> |
|
669 </property> |
|
670 <property name="drivelist" type="Integer" scope="instance" access="read" visibility="basic"> |
|
671 <description>This is a read-only property that returns a text string containing all the user's existing drive names separated by a space. |
|
672 </description> |
|
673 <browsers> |
|
674 <browser platform="Nokia WRT" version="1.0+"/> |
|
675 </browsers> |
|
676 </property> |
|
677 <property name="language" type="Integer" scope="instance" access="read" visibility="basic"> |
|
678 <description>This is a read-only property that returns a text string containing the two-letter ISO 639-1 code that represents an international language. For a list of ISO 639-1 language codes, see the Language code table in the Symbian OS Library. |
|
679 </description> |
|
680 <browsers> |
|
681 <browser platform="Nokia WRT" version="1.0+"/> |
|
682 </browsers> |
|
683 </property> |
|
684 </properties> |
|
685 |
|
686 |
|
687 <methods> |
|
688 |
|
689 <method name="lighton" scope="instance" visibility="basic"> |
|
690 <return-types> |
|
691 <return-type type="void"/> |
|
692 </return-types> |
|
693 <description>The lighton method switches the specified target light on for a specified duration with the brightness defined by a specified light intensity. |
|
694 </description> |
|
695 <parameters> |
|
696 <parameter name="lighttarget" type="Integer" usage="required"> |
|
697 <description>Defines which target light should be turned on. Use one of the supported target light properties to specify a target light. |
|
698 </description> |
|
699 </parameter> |
|
700 <parameter name="duration" type="Integer" usage="required"> |
|
701 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
702 </description> |
|
703 </parameter> |
|
704 <parameter name="intensity" type="Integer" usage="required"> |
|
705 <description>Defines the intensity (brightness) of the light. If intensity is lightdefaultintensity, the device default intensity will be used. |
|
706 </description> |
|
707 </parameter> |
|
708 <parameter name="fadein" type="Boolean" usage="required"> |
|
709 <description>If true, target lights will not turn on instantly but fade-in smoothly instead. if false, target lights will be turned on without the fading effect. |
|
710 </description> |
|
711 </parameter> |
|
712 </parameters> |
|
713 <browsers> |
|
714 <browser platform="Nokia WRT" version="1.0+" /> |
|
715 </browsers> |
|
716 </method> |
|
717 |
|
718 |
|
719 <method name="lightoff" scope="instance" visibility="basic"> |
|
720 <return-types> |
|
721 <return-type type="void"/> |
|
722 </return-types> |
|
723 <description>The lightoff method switches the specified target light off for the specified duration. |
|
724 </description> |
|
725 <parameters> |
|
726 <parameter name="lighttarget" type="String" usage="required"> |
|
727 <description>Defines which target light should be turned on. Use one of the supported target light properties to specify a target light. |
|
728 </description> |
|
729 </parameter> |
|
730 <parameter name="duration" type="Integer" usage="required"> |
|
731 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
732 </description> |
|
733 </parameter> |
|
734 <parameter name="fadeout" type="Integer" usage="required"> |
|
735 <description>If true, target lights will not turn on instantly but fade-in smoothly instead. if false, target lights will be turned on without the fading effect. |
|
736 </description> |
|
737 </parameter> |
|
738 </parameters> |
|
739 <browsers> |
|
740 <browser platform="Nokia WRT" version="1.0+" /> |
|
741 </browsers> |
|
742 </method> |
|
743 |
|
744 |
|
745 <method name="lightblink" scope="instance" visibility="basic"> |
|
746 <return-types> |
|
747 <return-type type="void"/> |
|
748 </return-types> |
|
749 <description>The lightblink method switches the specified target light on and off (blinking) for the specified duration with the brightness defined by a specified light intensity. |
|
750 |
|
751 </description> |
|
752 <parameters> |
|
753 <parameter name="lighttarget" type="String" usage="required"> |
|
754 <description>Defines which target light should be turned on. Use one of the supported target light properties to specify a target light. |
|
755 </description> |
|
756 </parameter> |
|
757 <parameter name="duration" type="Integer" usage="required"> |
|
758 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
759 </description> |
|
760 </parameter> |
|
761 <parameter name="onduration" type="Integer" usage="required"> |
|
762 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
763 </description> |
|
764 </parameter> |
|
765 <parameter name="offduration" type="Integer" usage="required"> |
|
766 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
767 </description> |
|
768 </parameter> |
|
769 <parameter name="intensity" type="Integer" usage="required"> |
|
770 <description>If true, target lights will not turn on instantly but fade-in smoothly instead. if false, target lights will be turned on without the fading effect. |
|
771 </description> |
|
772 </parameter> |
|
773 </parameters> |
|
774 <browsers> |
|
775 <browser platform="Nokia WRT" version="1.0+" /> |
|
776 </browsers> |
|
777 </method> |
|
778 |
|
779 |
|
780 <method name="startvibra" scope="instance" visibility="basic"> |
|
781 <return-types> |
|
782 <return-type type="void"/> |
|
783 </return-types> |
|
784 <description>The startvibra method turns the device vibration on for the specified duration with the specified intensity (frequency). |
|
785 </description> |
|
786 <parameters> |
|
787 <parameter name="duration" type="Integer" usage="required"> |
|
788 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
789 </description> |
|
790 </parameter> |
|
791 <parameter name="intensity" type="Integer" usage="required"> |
|
792 <description>Defines the intensity (brightness) of the light. If intensity is lightdefaultintensity, the device default intensity will be used. |
|
793 </description> |
|
794 </parameter> |
|
795 |
|
796 </parameters> |
|
797 <browsers> |
|
798 <browser platform="Nokia WRT" version="1.0+" /> |
|
799 </browsers> |
|
800 </method> |
|
801 |
|
802 |
|
803 <method name="stopvibra" scope="instance" visibility="basic"> |
|
804 <return-types> |
|
805 <return-type type="void"/> |
|
806 </return-types> |
|
807 <description>The stopvibra method immediately interrupts the device vibration. |
|
808 </description> |
|
809 <browsers> |
|
810 <browser platform="Nokia WRT" version="1.0+" /> |
|
811 </browsers> |
|
812 </method> |
|
813 |
|
814 <method name="beep" scope="instance" visibility="basic"> |
|
815 <return-types> |
|
816 <return-type type="void"/> |
|
817 </return-types> |
|
818 <description>The beep method produces a beep tone in a specified frequency for a specified duration. |
|
819 </description> |
|
820 <parameters> |
|
821 <parameter name="frequency" type="Integer" usage="required"> |
|
822 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
823 </description> |
|
824 </parameter> |
|
825 <parameter name="duration" type="Integer" usage="required"> |
|
826 <description>Defines the intensity (brightness) of the light. If intensity is lightdefaultintensity, the device default intensity will be used. |
|
827 </description> |
|
828 </parameter> |
|
829 |
|
830 </parameters> |
|
831 <browsers> |
|
832 <browser platform="Nokia WRT" version="1.0+" /> |
|
833 </browsers> |
|
834 </method> |
|
835 |
|
836 <method name="drivesize" scope="instance" visibility="basic"> |
|
837 <return-types> |
|
838 <return-type type="void"/> |
|
839 </return-types> |
|
840 <description>The drivesize method can be used to detect the total size of an existing memory storage in a device. |
|
841 </description> |
|
842 <parameters> |
|
843 <parameter name="drivename" type="String" usage="required"> |
|
844 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
845 </description> |
|
846 </parameter> |
|
847 </parameters> |
|
848 <browsers> |
|
849 <browser platform="Nokia WRT" version="1.0+" /> |
|
850 </browsers> |
|
851 </method> |
|
852 |
|
853 <method name="drivefree" scope="instance" visibility="basic"> |
|
854 <return-types> |
|
855 <return-type type="void"/> |
|
856 </return-types> |
|
857 <description>The drivesize method can be used to detect the total size of an existing memory storage in a device. |
|
858 </description> |
|
859 <parameters> |
|
860 <parameter name="drivename" type="String" usage="required"> |
|
861 <description>Defines the period during which the target light is switched on. The period is measured in milliseconds. |
|
862 </description> |
|
863 </parameter> |
|
864 </parameters> |
|
865 <browsers> |
|
866 <browser platform="Nokia WRT" version="1.0+" /> |
|
867 </browsers> |
|
868 </method> |
|
869 |
|
870 |
|
871 |
|
872 </methods> |
|
873 |
|
874 |
|
875 </class> |
|
876 --> |
|
877 |
|
878 |
|
879 <!-- key --> |
|
880 <class type="key" > |
|
881 <description> |
|
882 Each key represents one piece of contact information, such as first name, last name, home phone number, or email address. For each contact, GetList returns as many keys as has been defined for that contact. |
|
883 </description> |
|
884 |
|
885 <browsers> |
|
886 <browser platform="Nokia WRT" version="1.1+" /> |
|
887 </browsers> |
|
888 <!-- |
|
889 <constructors> |
|
890 <constructor scope="instance"> |
|
891 <description></description> |
|
892 <browsers> |
|
893 <browser platform="Nokia WRT" version="1.1+"/> |
|
894 </browsers> |
|
895 <parameters/> |
|
896 <return-types> |
|
897 <return-type type="key"/> |
|
898 </return-types> |
|
899 </constructor> |
|
900 </constructors> |
|
901 --> |
|
902 <properties> |
|
903 |
|
904 <property name="Label" type="String" scope="instance" access="read-write" visibility="basic"> |
|
905 <description> |
|
906 Label |
|
907 </description> |
|
908 <browsers> |
|
909 <browser platform="Nokia WRT" version="1.1+"/> |
|
910 </browsers> |
|
911 </property> |
|
912 |
|
913 <property name="Value" type="String" scope="instance" access="read-write" visibility="basic"> |
|
914 <description> |
|
915 Value |
|
916 </description> |
|
917 <browsers> |
|
918 <browser platform="Nokia WRT" version="1.1+"/> |
|
919 </browsers> |
|
920 </property> |
|
921 |
|
922 <property name="FirstName" type="String" scope="instance" access="read-write" visibility="basic"> |
|
923 <description> |
|
924 FirstName |
|
925 </description> |
|
926 <browsers> |
|
927 <browser platform="Nokia WRT" version="1.1+"/> |
|
928 </browsers> |
|
929 </property> |
|
930 |
|
931 <property name="LastName" type="String" scope="instance" access="read-write" visibility="basic"> |
|
932 <description> |
|
933 LastName |
|
934 </description> |
|
935 <browsers> |
|
936 <browser platform="Nokia WRT" version="1.1+"/> |
|
937 </browsers> |
|
938 </property> |
|
939 |
|
940 |
|
941 </properties> |
|
942 |
|
943 </class> |
|
944 <!-- end of key --> |
|
945 |
|
946 <!-- Item --> |
|
947 <class type="Item" > |
|
948 <description> |
|
949 Item |
|
950 </description> |
|
951 |
|
952 <browsers> |
|
953 <browser platform="Nokia WRT" version="1.1+" /> |
|
954 </browsers> |
|
955 <!-- |
|
956 <constructors> |
|
957 <constructor scope="instance"> |
|
958 <description></description> |
|
959 <browsers> |
|
960 <browser platform="Nokia WRT" version="1.1+"/> |
|
961 </browsers> |
|
962 <parameters/> |
|
963 <return-types> |
|
964 <return-type type="Item"/> |
|
965 </return-types> |
|
966 </constructor> |
|
967 </constructors> |
|
968 --> |
|
969 <properties> |
|
970 |
|
971 <property name="CalendarName" type="String" scope="instance" access="read-write" visibility="basic"> |
|
972 <description> |
|
973 CalendarName |
|
974 </description> |
|
975 <browsers> |
|
976 <browser platform="Nokia WRT" version="1.1+"/> |
|
977 </browsers> |
|
978 </property> |
|
979 |
|
980 <property name="LocalId" type="String" scope="instance" access="read-write" visibility="basic"> |
|
981 <description> |
|
982 LocalId |
|
983 </description> |
|
984 <browsers> |
|
985 <browser platform="Nokia WRT" version="1.1+"/> |
|
986 </browsers> |
|
987 </property> |
|
988 |
|
989 <property name="InstanceStartTime" type="Date" scope="instance" access="read-write" visibility="basic"> |
|
990 <description> |
|
991 InstanceStartTime |
|
992 </description> |
|
993 <browsers> |
|
994 <browser platform="Nokia WRT" version="1.1+"/> |
|
995 </browsers> |
|
996 </property> |
|
997 |
|
998 <!-- Contacts specific --> |
|
999 |
|
1000 <property name="id" type="Staring" scope="instance" access="read-write" visibility="basic"> |
|
1001 <description> |
|
1002 Unique identifier of the contact. |
|
1003 </description> |
|
1004 <browsers> |
|
1005 <browser platform="Nokia WRT" version="1.1+"/> |
|
1006 </browsers> |
|
1007 </property> |
|
1008 |
|
1009 <property name="key" type="key" scope="instance" access="read-write" visibility="basic"> |
|
1010 <description> |
|
1011 Each key represents one piece of contact information, such as first name, last name, home phone number, or email address. For each contact, GetList returns as many keys as has been defined for that contact. |
|
1012 </description> |
|
1013 <browsers> |
|
1014 <browser platform="Nokia WRT" version="1.1+"/> |
|
1015 </browsers> |
|
1016 </property> |
|
1017 |
|
1018 <property name="GroupLabel" type="String" scope="instance" access="read-write" visibility="basic"> |
|
1019 <description> |
|
1020 Name of the group. |
|
1021 </description> |
|
1022 <browsers> |
|
1023 <browser platform="Nokia WRT" version="1.1+"/> |
|
1024 </browsers> |
|
1025 </property> |
|
1026 |
|
1027 <property name="Contents" type="Array" scope="instance" access="read-write" visibility="basic"> |
|
1028 <description> |
|
1029 Contains the IDs of the contacts that belong to the group. |
|
1030 </description> |
|
1031 <browsers> |
|
1032 <browser platform="Nokia WRT" version="1.1+"/> |
|
1033 </browsers> |
|
1034 </property> |
|
1035 |
|
1036 <property name="DBUri" type="String" scope="instance" access="read-write" visibility="basic"> |
|
1037 <description> |
|
1038 URI of the database. |
|
1039 </description> |
|
1040 <browsers> |
|
1041 <browser platform="Nokia WRT" version="1.1+"/> |
|
1042 </browsers> |
|
1043 </property> |
|
1044 |
|
1045 <!-- AppManager specific --> |
|
1046 |
|
1047 <property name="Uid" type="String" scope="instance" access="read" visibility="basic"> |
|
1048 <description> |
|
1049 AppManager: |
|
1050 Contains a unique ID for the application binary (EXE or DLL). |
|
1051 </description> |
|
1052 <browsers> |
|
1053 <browser platform="Nokia WRT" version="1.1+"/> |
|
1054 </browsers> |
|
1055 </property> |
|
1056 |
|
1057 <property name="Path" type="String" scope="instance" access="read" visibility="basic"> |
|
1058 <description> |
|
1059 AppManager: |
|
1060 Contains the path of the application. For example, c:\sys\bin\calculator.exe. |
|
1061 </description> |
|
1062 <browsers> |
|
1063 <browser platform="Nokia WRT" version="1.1+"/> |
|
1064 </browsers> |
|
1065 </property> |
|
1066 |
|
1067 <property name="Caption" type="String" scope="instance" access="read" visibility="basic"> |
|
1068 <description> |
|
1069 AppManager: |
|
1070 Contains the title of the application. |
|
1071 </description> |
|
1072 <browsers> |
|
1073 <browser platform="Nokia WRT" version="1.1+"/> |
|
1074 </browsers> |
|
1075 </property> |
|
1076 |
|
1077 <property name="ShortCaption" type="String" scope="instance" access="read" visibility="basic"> |
|
1078 <description> |
|
1079 AppManager: |
|
1080 Contains the short title of the application. For example, the short caption may be displayed beneath an icon on the mobile device. |
|
1081 </description> |
|
1082 <browsers> |
|
1083 <browser platform="Nokia WRT" version="1.1+"/> |
|
1084 </browsers> |
|
1085 </property> |
|
1086 |
|
1087 <property name="PackageName" type="String" scope="instance" access="read" visibility="basic"> |
|
1088 <description> |
|
1089 AppManager: |
|
1090 Contains the name of the application. For example, the package name may be displayed in a menu on the mobile device. |
|
1091 </description> |
|
1092 <browsers> |
|
1093 <browser platform="Nokia WRT" version="1.1+"/> |
|
1094 </browsers> |
|
1095 </property> |
|
1096 |
|
1097 <property name="Version" type="String" scope="instance" access="read" visibility="basic"> |
|
1098 <description> |
|
1099 AppManager: |
|
1100 Contains the version of the application. The version consists of two parts: Major, Minor. |
|
1101 For example, 1.01, where 1 is the major part and .02 is the minor part. |
|
1102 </description> |
|
1103 <browsers> |
|
1104 <browser platform="Nokia WRT" version="1.1+"/> |
|
1105 </browsers> |
|
1106 </property> |
|
1107 |
|
1108 <property name="Vendor" type="String" scope="instance" access="read" visibility="basic"> |
|
1109 <description> |
|
1110 AppManager: |
|
1111 Contains the vendor of the application. |
|
1112 </description> |
|
1113 <browsers> |
|
1114 <browser platform="Nokia WRT" version="1.1+"/> |
|
1115 </browsers> |
|
1116 </property> |
|
1117 |
|
1118 <property name="Drive" type="String" scope="instance" access="read" visibility="basic"> |
|
1119 <description> |
|
1120 AppManager: |
|
1121 Contains the drive where the application is installed. |
|
1122 </description> |
|
1123 <browsers> |
|
1124 <browser platform="Nokia WRT" version="1.1+"/> |
|
1125 </browsers> |
|
1126 </property> |
|
1127 |
|
1128 </properties> |
|
1129 |
|
1130 </class> |
|
1131 <!-- end of Item --> |
|
1132 |
|
1133 <!-- Iterator --> |
|
1134 <class type="Iterator" > |
|
1135 <description> |
|
1136 Iterator |
|
1137 </description> |
|
1138 |
|
1139 <browsers> |
|
1140 <browser platform="Nokia WRT" version="1.1+" /> |
|
1141 </browsers> |
|
1142 <!-- |
|
1143 <constructors> |
|
1144 <constructor scope="instance"> |
|
1145 <description></description> |
|
1146 <browsers> |
|
1147 <browser platform="Nokia WRT" version="1.1+"/> |
|
1148 </browsers> |
|
1149 <parameters/> |
|
1150 <return-types> |
|
1151 <return-type type="Iterator"/> |
|
1152 </return-types> |
|
1153 </constructor> |
|
1154 </constructors> |
|
1155 --> |
|
1156 <methods> |
|
1157 |
|
1158 <method name="reset" scope="instance" visibility="basic"> |
|
1159 |
|
1160 <return-types> |
|
1161 <return-type type="void"/> |
|
1162 </return-types> |
|
1163 |
|
1164 <description> |
|
1165 reset |
|
1166 </description> |
|
1167 |
|
1168 <browsers> |
|
1169 <browser platform="Nokia WRT" version="1.1+"/> |
|
1170 </browsers> |
|
1171 |
|
1172 </method> |
|
1173 |
|
1174 <method name="getNext" scope="instance" visibility="basic"> |
|
1175 |
|
1176 <return-types> |
|
1177 <return-type type="Item"/> |
|
1178 </return-types> |
|
1179 |
|
1180 <description> |
|
1181 getNext |
|
1182 </description> |
|
1183 |
|
1184 <browsers> |
|
1185 <browser platform="Nokia WRT" version="1.1+"/> |
|
1186 </browsers> |
|
1187 |
|
1188 </method> |
|
1189 </methods> |
|
1190 |
|
1191 </class> |
|
1192 <!-- end of Iterator --> |
|
1193 |
|
1194 <!-- result --> |
|
1195 <class type="result" > |
|
1196 <description> |
|
1197 result |
|
1198 </description> |
|
1199 |
|
1200 <browsers> |
|
1201 <browser platform="Nokia WRT" version="1.1+" /> |
|
1202 </browsers> |
|
1203 |
|
1204 <properties> |
|
1205 <!-- |
|
1206 <property name="ReturnValue" type="Iterator" scope="instance" access="read" visibility="basic"> |
|
1207 <description> |
|
1208 AppManager |
|
1209 |
|
1210 GetList: |
|
1211 This is an iterator that contains the requested application information. |
|
1212 |
|
1213 LaunchApp/LaunchDoc: |
|
1214 This is a string that contains the name of the newly created document, if any. |
|
1215 This property is optional. |
|
1216 |
|
1217 A new document is created only when both of the following are true: |
|
1218 criteria.MIMEType is specified as input. |
|
1219 The launched application creates a new document. |
|
1220 A document name is never returned when criteria.Document is specified as input. |
|
1221 |
|
1222 Calendar |
|
1223 GetList: |
|
1224 This is an iterator that contains the requested calendar information. |
|
1225 |
|
1226 Add: |
|
1227 This is a text string that contains the id of the entry that was added or updated. |
|
1228 If a new calendar was created, this property is not included in the result object. |
|
1229 |
|
1230 Import: |
|
1231 This is an iterator that contains an ordered list of objects. The objects contain the ids (strings) of the entries that were successfully imported to the calendar. The same id may be repeated multiple times in case of child entries. |
|
1232 |
|
1233 Export: |
|
1234 This is a text string that contains the exported entries in the specified format. |
|
1235 This property is only included if Data.FileName was not specified in the input. This property serves as a buffer that contains the same data as the target file would have had it been specified. |
|
1236 |
|
1237 Contact: |
|
1238 GetList: |
|
1239 This is an iterator that contains the requested contact information |
|
1240 </description> |
|
1241 <browsers> |
|
1242 <browser platform="Nokia WRT" version="1.1+"/> |
|
1243 </browsers> |
|
1244 </property> |
|
1245 --> |
|
1246 |
|
1247 <property name="ReturnValue" type="Object" scope="instance" access="read" visibility="basic"> |
|
1248 <description> |
|
1249 Return value |
|
1250 </description> |
|
1251 <browsers> |
|
1252 <browser platform="Nokia WRT" version="1.1+"/> |
|
1253 </browsers> |
|
1254 </property> |
|
1255 |
|
1256 <property name="ErrorCode" type="Integer" scope="instance" access="read" visibility="basic"> |
|
1257 <description> |
|
1258 This is a number that specifies a predefined error code. |
|
1259 </description> |
|
1260 <browsers> |
|
1261 <browser platform="Nokia WRT" version="1.1+"/> |
|
1262 </browsers> |
|
1263 </property> |
|
1264 |
|
1265 <property name="ErrorMessage" type="String" scope="instance" access="read" visibility="basic"> |
|
1266 <description> |
|
1267 This is a text string that describes the error. |
|
1268 </description> |
|
1269 <browsers> |
|
1270 <browser platform="Nokia WRT" version="1.1+"/> |
|
1271 </browsers> |
|
1272 </property> |
|
1273 |
|
1274 <property name="TransactionID" type="Integer" scope="instance" access="read" visibility="basic"> |
|
1275 <description> |
|
1276 This is a number used as an identification to match transactions started with an asynchronous call to one or more calls it generates to callback. This is only valid for Asynchronous invocations. |
|
1277 </description> |
|
1278 <browsers> |
|
1279 <browser platform="Nokia WRT" version="1.1+"/> |
|
1280 </browsers> |
|
1281 </property> |
|
1282 |
|
1283 </properties> |
|
1284 |
|
1285 </class> |
|
1286 <!-- end of result --> |
|
1287 |
|
1288 <!-- IDataSource --> |
|
1289 <class type="IDataSource"> |
|
1290 |
|
1291 <description> |
|
1292 This Service API allows widgets to: |
|
1293 <p> |
|
1294 <ul> |
|
1295 <li>access, create, and manage calendars/calendar entries,</li> |
|
1296 <li>access and manage information about contacts,</li> |
|
1297 <li>access and manage information about landmarks and landmark categories,</li> |
|
1298 <li>add, read, and delete logging events such as call logs, messaging logs, and so forth,</li> |
|
1299 <li>retrieve information (metadata) about the media files stored in the Media Gallery of a device.</li> |
|
1300 </ul> |
|
1301 </p> |
|
1302 <p> |
|
1303 To use the <code>IDataSource</code> Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. |
|
1304 </p> |
|
1305 <p> |
|
1306 Use <code>Service.Calendar</code> or <code>Service.Contact</code> or <code>Service.Landmarks</code> or <code>Service.Logging</code> or <code>Service.MediaManagement</code> to identify the service provider and <code>IDataSource</code> to identify the supported interface: |
|
1307 </p> |
|
1308 |
|
1309 <pre>var so = device.getServiceObject("Service.Calendar", "IDataSource");</pre> |
|
1310 </description> |
|
1311 |
|
1312 <browsers> |
|
1313 <browser platform="Nokia WRT" version="1.1+" /> |
|
1314 </browsers> |
|
1315 |
|
1316 <methods> |
|
1317 |
|
1318 <!-- GetList(criteria) --> |
|
1319 <method name="GetList" scope="instance" visibility="basic"> |
|
1320 <return-types> |
|
1321 <return-type type="result"/> |
|
1322 </return-types> |
|
1323 |
|
1324 <description> |
|
1325 <p><b>Calendar:</b> |
|
1326 The <code>GetList</code> method retrieves a list of available calendars or calendar entries. Calendar entries are retrieved from the specified calendar or, if no calendar is specified, from the default one. |
|
1327 This is a synchronous method.</p> |
|
1328 |
|
1329 <p><b>Contacts:</b> |
|
1330 The <code>GetList</code> method retrieves a list of contacts, contact groups, or contacts databases. Contacts and contact groups are retrieved from the specified contacts database or, if no database is specified, from the default one. |
|
1331 This method can be called both synchronously and asynchronously.</p> |
|
1332 |
|
1333 <p>Note: Calls that retrieve a list of databases must always be synchronous.</p> |
|
1334 |
|
1335 <p><b>Landmarks:</b> |
|
1336 The <code>GetList</code> method retrieves information about landmarks, landmark categories, or landmark databases. Landmarks and landmark categories are retrieved from the specified landmark database or, if no database is specified, from the default one. |
|
1337 This method can be called both synchronously and asynchronously.</p> |
|
1338 |
|
1339 <p>Note: For retrieving information about databases, only synchronous GetList is supported.<p/> |
|
1340 |
|
1341 <p><b>Logging:</b> |
|
1342 The <code>GetList</code> method retrieves an iterable list of entries from the log event database. The database contains two types of entries, log entries (all entries) and recent log entries (a subset of all log entries). |
|
1343 This method can be called both synchronously and asynchronously.</p> |
|
1344 |
|
1345 <p><b>Media Management:</b> |
|
1346 The <code>GetList</code> method retrieves a list of media information objects from the Media Gallery of the S60 device. Each object contains information about a single media file. |
|
1347 This is an asynchronous method.</p> |
|
1348 </description> |
|
1349 |
|
1350 <parameters> |
|
1351 <parameter name="criteria" type="Object" usage="required"> |
|
1352 <description> |
|
1353 This is an object that specifies what type of calendar/location/landmark/log event information is returned and how the returned information is sorted. |
|
1354 </description> |
|
1355 </parameter> |
|
1356 |
|
1357 <parameter name="callback" type="Function" usage="optional"> |
|
1358 <description> |
|
1359 The callback argument is the name of the method that is executed when an asynchronous GetList call has results or status information to return. You must define this method separately. |
|
1360 </description> |
|
1361 </parameter> |
|
1362 |
|
1363 </parameters> |
|
1364 <browsers> |
|
1365 <browser platform="Nokia WRT" version="1.1+" /> |
|
1366 </browsers> |
|
1367 </method> |
|
1368 |
|
1369 <!-- Add(criteria) --> |
|
1370 <method name="Add" scope="instance" visibility="basic"> |
|
1371 <return-types> |
|
1372 <return-type type="result"/> |
|
1373 </return-types> |
|
1374 |
|
1375 <description> |
|
1376 <p><b>Calendar:</b> |
|
1377 The <code>Add</code> method creates a new calendar on the device or adds an entry to a calendar. In the latter case, if an entry with the same LocalId already exists in the calendar, it is modified accordingly. You can thus use this method to both add and update calendar entries. The entry is added to the specified calendar or, if no calendar is specified, to the default one. If the default calendar does not exist, it is created. |
|
1378 This is a synchronous method.</p> |
|
1379 |
|
1380 <p><b>Contact:</b> |
|
1381 The <code>Add</code> method adds a contact or contact group to a contacts database. If the contact or contact group already exists in the database, it is replaced with the new entry. You can thus use this method to both add and edit contacts and contact groups. The information is added to the specified database or, if no database is specified, to the default one. If the default database does not exist, it is created. |
|
1382 This method can be called both synchronously and asynchronously.</p> |
|
1383 |
|
1384 <p><b>Landmarks:</b> |
|
1385 The <code>Add</code> method adds a new landmark or landmark category to a landmark database. You can also use this method to edit an existing landmark or landmark category. |
|
1386 This is a synchronous method.</p> |
|
1387 |
|
1388 <p><b>Logging:</b> |
|
1389 The <code>Add</code> method adds an event (entry) to the event log database. |
|
1390 This method can be called both synchronously and asynchronously.</p> |
|
1391 </description> |
|
1392 |
|
1393 <parameters> |
|
1394 <parameter name="criteria" type="criteria" usage="required"> |
|
1395 <description> |
|
1396 This is an object that specifies the calendar/contact/landmark/log to create or to add or update. |
|
1397 </description> |
|
1398 </parameter> |
|
1399 |
|
1400 <parameter name="callback" type="Function" usage="optional"> |
|
1401 <description> |
|
1402 The callback argument is the name of the method that is executed when an asynchronous Add call has results or status information to return. You must define this method separately. |
|
1403 </description> |
|
1404 </parameter> |
|
1405 |
|
1406 </parameters> |
|
1407 <browsers> |
|
1408 <browser platform="Nokia WRT" version="1.1+" /> |
|
1409 </browsers> |
|
1410 </method> |
|
1411 |
|
1412 <!-- Delete(criteria) --> |
|
1413 <method name="Delete" scope="instance" visibility="basic"> |
|
1414 <return-types> |
|
1415 <return-type type="result"/> |
|
1416 </return-types> |
|
1417 |
|
1418 <description> |
|
1419 <p><b>Calendar:</b> |
|
1420 The <code>Delete</code> method deletes a calendar from the device or one or more entries from a calendar. Entries are deleted from the specified calendar or, if no calendar is specified, from the default one. |
|
1421 For deleting a calendar, this method is called synchronously. For deleting calendar entries, this method can be called both synchronously and asynchronously.</p> |
|
1422 |
|
1423 <p><b>Contacts:</b> |
|
1424 The <code>Delete</code> method deletes one or more contacts or contact groups from a contacts database. The information is deleted from the specified database or, if no database is specified, from the default one. |
|
1425 This method can be called both synchronously and asynchronously</p> |
|
1426 |
|
1427 <p><b>Landmark:</b> |
|
1428 The <code>Delete</code> method deletes a landmark or landmark category from a landmark database. |
|
1429 Note: You cannot delete landmark databases. |
|
1430 This is a synchronous method.</p> |
|
1431 |
|
1432 <p><b>Logging:</b> |
|
1433 The <code>Delete</code> method deletes an event (entry) from the event log database. |
|
1434 This method can be called both synchronously and asynchronously.</p> |
|
1435 </description> |
|
1436 |
|
1437 <parameters> |
|
1438 <parameter name="criteria" type="criteria" usage="required"> |
|
1439 <description> |
|
1440 This is an object that specifies which calendar/calendar entries/contacts/contact groups/landmark/landmark category/event to delete from the database. |
|
1441 </description> |
|
1442 </parameter> |
|
1443 |
|
1444 <parameter name="callback" type="Function" usage="optional"> |
|
1445 <description> |
|
1446 The callback argument is the name of the method that is executed when an asynchronous Delete call has results or status information to return. You must define this method separately. |
|
1447 </description> |
|
1448 </parameter> |
|
1449 </parameters> |
|
1450 <browsers> |
|
1451 <browser platform="Nokia WRT" version="1.1+" /> |
|
1452 </browsers> |
|
1453 </method> |
|
1454 |
|
1455 <!-- Import(criteria) --> |
|
1456 <method name="Import" scope="instance" visibility="basic"> |
|
1457 <return-types> |
|
1458 <return-type type="result"/> |
|
1459 </return-types> |
|
1460 |
|
1461 <description> |
|
1462 <p><b>Calendar:</b> |
|
1463 The <code>Import</code> method imports entries into a calendar. The information must be imported from an iCal or vCal file. For more information about these two formats, see the Calendar Service overview page. |
|
1464 This method can be called both synchronously and asynchronously.</p> |
|
1465 |
|
1466 <p><b>Contact:</b> |
|
1467 The <code>Import</code> method imports a contact to a contacts database. The information must be imported from a vCard file. |
|
1468 This method can be called both synchronously and asynchronously.</p> |
|
1469 |
|
1470 <p><b>Landmark:</b> |
|
1471 The <code>Import</code> method imports a set of landmarks to a landmark database. |
|
1472 This is a synchronous method.</p> |
|
1473 |
|
1474 </description> |
|
1475 |
|
1476 <parameters> |
|
1477 <parameter name="criteria" type="criteria" usage="required"> |
|
1478 <description> |
|
1479 This is an object that specifies the calendar entries/contacts/landmarks to import. |
|
1480 </description> |
|
1481 </parameter> |
|
1482 |
|
1483 <parameter name="callback" type="Function" usage="optional"> |
|
1484 <description> |
|
1485 The callback argument is the name of the method that is executed when an asynchronous Import call has results or status information to return. You must define this method separately. |
|
1486 </description> |
|
1487 </parameter> |
|
1488 |
|
1489 </parameters> |
|
1490 <browsers> |
|
1491 <browser platform="Nokia WRT" version="1.1+" /> |
|
1492 </browsers> |
|
1493 </method> |
|
1494 |
|
1495 <!-- Export(criteria) --> |
|
1496 <method name="Export" scope="instance" visibility="basic"> |
|
1497 <return-types> |
|
1498 <return-type type="result"/> |
|
1499 </return-types> |
|
1500 |
|
1501 <description> |
|
1502 <p><b>Calendar:</b> |
|
1503 The <code>Export</code> method exports entries from a calendar. The information is exported to an iCal or vCal file. For more information about these two formats, see the Calendar Service overview page. |
|
1504 This method can be called both synchronously and asynchronously.</p> |
|
1505 |
|
1506 <p><b>Contact:</b> |
|
1507 The <code>Export</code> method exports a contact from a contacts database. The information is exported to a vCard file. |
|
1508 This method can be called both synchronously and asynchronously</p> |
|
1509 |
|
1510 <p><b>Landmark:</b> |
|
1511 The <code>Export</code> method exports a set of landmarks from a landmark database. |
|
1512 This is a synchronous method.</p> |
|
1513 </description> |
|
1514 |
|
1515 <parameters> |
|
1516 <parameter name="criteria" type="criteria" usage="required"> |
|
1517 <description> |
|
1518 This is an object that specifies the calendar/contacts/landmarks entries to export. |
|
1519 </description> |
|
1520 </parameter> |
|
1521 |
|
1522 <parameter name="callback" type="Function" usage="optional"> |
|
1523 <description> |
|
1524 The callback argument is the name of the method that is executed when an asynchronous Export call has results or status information to return. You must define this method separately. |
|
1525 </description> |
|
1526 </parameter> |
|
1527 |
|
1528 </parameters> |
|
1529 <browsers> |
|
1530 <browser platform="Nokia WRT" version="1.1+" /> |
|
1531 </browsers> |
|
1532 </method> |
|
1533 |
|
1534 <!-- RequestNotification(criteria, callback); --> |
|
1535 <method name="RequestNotification" scope="instance" visibility="basic"> |
|
1536 <return-types> |
|
1537 <return-type type="result"/> |
|
1538 </return-types> |
|
1539 |
|
1540 <description> |
|
1541 <p><b>Calendar:</b> |
|
1542 The <code>RequestNotification</code> method notifies the client when entries are created, updated, or deleted in the specified calendar. If no calendar is specified, the default calendar is used. |
|
1543 This is an asynchronous method.</p> |
|
1544 |
|
1545 <p><b>Logging:</b> |
|
1546 The <code>RequestNotification</code> method registers the widget to receive notifications of changes to the event log. |
|
1547 This is an asynchronous method.</p> |
|
1548 </description> |
|
1549 |
|
1550 <parameters> |
|
1551 <parameter name="criteria" type="criteria" usage="required"> |
|
1552 <description> |
|
1553 This is an object that specifies which calendar, calendar entries and event log to monitor for changes and when. |
|
1554 </description> |
|
1555 </parameter> |
|
1556 |
|
1557 <parameter name="Callback" type="Function" usage="required"> |
|
1558 <description> |
|
1559 The callback argument is the name of the method that is executed when an asynchronous 'RequestNotification' call has results or status information to return. You must define this method separately. |
|
1560 </description> |
|
1561 </parameter> |
|
1562 |
|
1563 </parameters> |
|
1564 <browsers> |
|
1565 <browser platform="Nokia WRT" version="1.1+" /> |
|
1566 </browsers> |
|
1567 </method> |
|
1568 |
|
1569 <!-- Cancel(criteria); --> |
|
1570 <method name="Cancel" scope="instance" visibility="basic"> |
|
1571 <return-types> |
|
1572 <return-type type="result"/> |
|
1573 </return-types> |
|
1574 |
|
1575 <description> |
|
1576 <p><b>Calendar:</b> |
|
1577 The <code>Cancel</code> method cancels an ongoing asynchronous call made with a Calendar Service API method. |
|
1578 This is a synchronous method.</p> |
|
1579 |
|
1580 <p><b>Contact:</b> |
|
1581 The <code>Cancel</code> method cancels an outstanding asynchronous call made with a Contacts Service API method. |
|
1582 This is a synchronous method.</p> |
|
1583 |
|
1584 <p><b>LandMark:</b> |
|
1585 The <code>Cancel</code> method cancels an ongoing asynchronous call made with a Landmarks Service API method. |
|
1586 This is a synchronous method.</p> |
|
1587 |
|
1588 <p><b>Logging:</b> |
|
1589 The <code>Cancel</code> method cancels an ongoing asynchronous call made with a Landmarks Service API method. |
|
1590 This is a synchronous method.</p> |
|
1591 </description> |
|
1592 |
|
1593 <parameters> |
|
1594 <parameter name="criteria" type="criteria" usage="required"> |
|
1595 <description> |
|
1596 This is an object with the TransactionID property (number). criteria.TransactionID specifies the transaction ID of the asynchronous call to cancel. The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. |
|
1597 </description> |
|
1598 </parameter> |
|
1599 |
|
1600 </parameters> |
|
1601 <browsers> |
|
1602 <browser platform="Nokia WRT" version="1.1+" /> |
|
1603 </browsers> |
|
1604 </method> |
|
1605 |
|
1606 <!-- Organise(criteria); --> |
|
1607 <method name="Organise" scope="instance" visibility="basic"> |
|
1608 <return-types> |
|
1609 <return-type type="result"/> |
|
1610 </return-types> |
|
1611 |
|
1612 <description> |
|
1613 <p><b>Calendar:</b> |
|
1614 The <code>Organise</code> method adds contacts to a contact group (association) or removes contacts from a contact group (disassociation). The operation is performed on the specified database or, if no database is specified, on the default one. |
|
1615 This method can be called both synchronously and asynchronously.</p> |
|
1616 |
|
1617 <p><b>Landmark:</b> |
|
1618 The <code>Organise</code> method adds landmarks to a landmark category (association) or removes landmarks from a landmark category (disassociation). The same landmark can belong to multiple categories or to no category. |
|
1619 This is a synchronous method.</p> |
|
1620 </description> |
|
1621 |
|
1622 <parameters> |
|
1623 <parameter name="criteria" type="criteria" usage="required"> |
|
1624 <description> |
|
1625 This is an object that specifies which contact group/landmarks to organize and how. |
|
1626 </description> |
|
1627 </parameter> |
|
1628 |
|
1629 <parameter name="Callback" type="Function" usage="optional"> |
|
1630 <description> |
|
1631 The callback argument is the name of the method that is executed when an asynchronous Organise call has results or status information to return. You must define this method separately. |
|
1632 </description> |
|
1633 </parameter> |
|
1634 |
|
1635 </parameters> |
|
1636 <browsers> |
|
1637 <browser platform="Nokia WRT" version="1.1+" /> |
|
1638 </browsers> |
|
1639 </method> |
|
1640 |
|
1641 <!-- New(criteria); --> |
|
1642 <method name="New" scope="instance" visibility="basic"> |
|
1643 <return-types> |
|
1644 <return-type type="result"/> |
|
1645 </return-types> |
|
1646 |
|
1647 <description> |
|
1648 The <code>New</code> method creates an empty landmark or landmark category item. You can use the new item as a template. |
|
1649 This is a synchronous method. |
|
1650 </description> |
|
1651 |
|
1652 <parameters> |
|
1653 <parameter name="criteria" type="criteria" usage="required"> |
|
1654 <description> |
|
1655 This is an object that specifies the type of item to create |
|
1656 </description> |
|
1657 </parameter> |
|
1658 </parameters> |
|
1659 |
|
1660 <browsers> |
|
1661 <browser platform="Nokia WRT" version="1.1+" /> |
|
1662 </browsers> |
|
1663 |
|
1664 </method> |
|
1665 |
|
1666 </methods> |
|
1667 |
|
1668 </class> |
|
1669 <!-- end of IDataSoure --> |
|
1670 |
|
1671 <!-- IAppManager --> |
|
1672 <class type="IAppManager"> |
|
1673 |
|
1674 <description> |
|
1675 <p>The AppManager Service API allows widgets to access and launch applications on a mobile device.</p> |
|
1676 <p>The API is integrated with WRT through the <code>device</code> object.</p> |
|
1677 <p>To use the AppManager Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
1678 <p>Use <code>Service.AppManager</code> to identify the service provider and <code>IAppManager</code> to identify the supported interface:</p> |
|
1679 |
|
1680 <pre>var so = device.getServiceObject("Service.AppManager", "IAppManager");</pre> |
|
1681 </description> |
|
1682 |
|
1683 <browsers> |
|
1684 <browser platform="Nokia WRT" version="1.1+" /> |
|
1685 </browsers> |
|
1686 |
|
1687 <methods> |
|
1688 |
|
1689 <!-- GetList(criteria) --> |
|
1690 <method name="GetList" scope="instance" visibility="basic"> |
|
1691 <return-types> |
|
1692 <return-type type="result"/> |
|
1693 </return-types> |
|
1694 |
|
1695 <description> |
|
1696 The <code>GetList</code> method retrieves an iterable list of either user-installed applications or all applications on the mobile device, regardless of whether they were preinstalled or installed by the user. |
|
1697 This is a synchronous method. |
|
1698 </description> |
|
1699 |
|
1700 <parameters> |
|
1701 <parameter name="criteria" type="criteria" usage="required"> |
|
1702 <description> |
|
1703 This is an object that specifies what information is returned about the applications on the device. |
|
1704 </description> |
|
1705 </parameter> |
|
1706 </parameters> |
|
1707 <browsers> |
|
1708 <browser platform="Nokia WRT" version="1.1+" /> |
|
1709 </browsers> |
|
1710 </method> |
|
1711 |
|
1712 <!-- Cancel(criteria); --> |
|
1713 <method name="Cancel" scope="instance" visibility="basic"> |
|
1714 <return-types> |
|
1715 <return-type type="result"/> |
|
1716 </return-types> |
|
1717 |
|
1718 <description> |
|
1719 The <code>Cancel</code> method cancels an outstanding asynchronous call. |
|
1720 If a cancel is sent, but the asynchronous call has already been completed, then <code>result.Errorcode</code> is set to 0 (success). |
|
1721 This is a synchronous method. |
|
1722 </description> |
|
1723 |
|
1724 <parameters> |
|
1725 <parameter name="criteria" type="criteria" usage="required"> |
|
1726 <description> |
|
1727 This is an object with the <code>TransactionID</code> property (number). |
|
1728 <code>criteria.TransactionID</code> specifies the transaction ID of the asynchronous call to cancel. |
|
1729 The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. |
|
1730 </description> |
|
1731 </parameter> |
|
1732 |
|
1733 </parameters> |
|
1734 <browsers> |
|
1735 <browser platform="Nokia WRT" version="1.1+" /> |
|
1736 </browsers> |
|
1737 </method> |
|
1738 |
|
1739 <!-- LaunchApp(criteria); --> |
|
1740 <method name="LaunchApp" scope="instance" visibility="basic"> |
|
1741 <return-types> |
|
1742 <return-type type="result"/> |
|
1743 </return-types> |
|
1744 |
|
1745 <description> |
|
1746 The <code>LaunchApp</code> method launches an application based on a unique ID for the application (UID). |
|
1747 It also provides a way to open a specific document (by specifying a document path), even if it is not the default file type for the application being launched. |
|
1748 For example, you can specify a path to a document with a .txt extension to open in WordPad, even though Notepad is the default application for .txt files. |
|
1749 The application can be launched as chained (embedded) or stand-alone. |
|
1750 |
|
1751 This method can be called both synchronously and asynchronously. |
|
1752 </description> |
|
1753 |
|
1754 <parameters> |
|
1755 |
|
1756 <parameter name="criteria" type="criteria" usage="required"> |
|
1757 <description> |
|
1758 The criteria object specifies the application to launch. |
|
1759 The criteria object has three main properties: ApplicationID, CmdLine, and Options |
|
1760 </description> |
|
1761 </parameter> |
|
1762 |
|
1763 <parameter name="callback" type="Function" usage="optional"> |
|
1764 <description> |
|
1765 The callback argument is the name of the method that is executed when an asynchronous LaunchApp call has status information to return. You must define this method separately. |
|
1766 This argument is used only with an asynchronous LaunchApp call. |
|
1767 </description> |
|
1768 </parameter> |
|
1769 |
|
1770 |
|
1771 </parameters> |
|
1772 <browsers> |
|
1773 <browser platform="Nokia WRT" version="1.1+" /> |
|
1774 </browsers> |
|
1775 </method> |
|
1776 |
|
1777 <!-- LaunchDoc(criteria);--> |
|
1778 <method name="LaunchDoc" scope="instance" visibility="basic"> |
|
1779 <return-types> |
|
1780 <return-type type="result"/> |
|
1781 </return-types> |
|
1782 |
|
1783 <description> |
|
1784 The <code>LaunchDoc</code> method launches an application based on a given document. |
|
1785 This method automatically determines which application to launch for the specified document. |
|
1786 The application can be launched as chained (embedded) or stand-alone. |
|
1787 |
|
1788 This method can be called both synchronously and asynchronously. |
|
1789 </description> |
|
1790 |
|
1791 <parameters> |
|
1792 |
|
1793 <parameter name="criteria" type="criteria" usage="required"> |
|
1794 <description> |
|
1795 This is an object that specifies which application to launch. |
|
1796 </description> |
|
1797 </parameter> |
|
1798 |
|
1799 <parameter name="callback" type="Function" usage="optional"> |
|
1800 <description> |
|
1801 The callback argument is the name of the method that is executed when an asynchronous LaunchDoc call has status information to return. You must define this method separately. |
|
1802 This argument is used only with an asynchronous LaunchDoc call. |
|
1803 </description> |
|
1804 </parameter> |
|
1805 |
|
1806 </parameters> |
|
1807 <browsers> |
|
1808 <browser platform="Nokia WRT" version="1.1+" /> |
|
1809 </browsers> |
|
1810 </method> |
|
1811 |
|
1812 </methods> |
|
1813 |
|
1814 </class> |
|
1815 <!-- end of IAppManager --> |
|
1816 |
|
1817 <!-- IMessaging interface --> |
|
1818 <class type="IMessaging"> |
|
1819 |
|
1820 <description> |
|
1821 <p>The Messaging Service API allows widgets to send, retrieve, and manage messages using the Messaging Center of a device.</p> |
|
1822 <p>The API is integrated into WRT through the <code>device</code> object.</p> |
|
1823 |
|
1824 <p>To use the Messaging Service API, your widget must first createa service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
1825 <p>Use <code>Service.Messaging</code> to identify the service provider and <code>IMessaging</code> to identify the supported interface:</p> |
|
1826 |
|
1827 <pre>var so = device.getServiceObject("Service.Messaging", "IMessaging");</pre> |
|
1828 </description> |
|
1829 |
|
1830 <browsers> |
|
1831 <browser platform="Nokia WRT" version="1.1+" /> |
|
1832 </browsers> |
|
1833 |
|
1834 <constructors/> |
|
1835 |
|
1836 <methods> |
|
1837 <!-- GetList(criteria)--> |
|
1838 <method name="GetList" scope="instance" visibility="basic"> |
|
1839 <return-types> |
|
1840 <return-type type="result"/> |
|
1841 </return-types> |
|
1842 |
|
1843 <description> |
|
1844 The <code>GetList</code> method retrieves a list of messaging objects from the Messaging Center of the S60 device. |
|
1845 Each object contains messaging information, that is, header and content data for a single message. |
|
1846 This is a synchronous method. |
|
1847 The criteria object specifies what messaging information is returned and how the returned information is sorted. |
|
1848 The GetList method returns an object that contains the requested messaging information, an error code, and an error message. |
|
1849 To access information about individual messages, iterate through the list of objects contained in ReturnValue attribute of the returned object. |
|
1850 </description> |
|
1851 |
|
1852 <parameters> |
|
1853 <parameter name="criteria" type="object" usage="required"> |
|
1854 <description> |
|
1855 This is an object that specifies the search criteria. |
|
1856 </description> |
|
1857 </parameter> |
|
1858 </parameters> |
|
1859 <browsers> |
|
1860 <browser platform="Nokia WRT" version="1.1+" /> |
|
1861 </browsers> |
|
1862 </method> |
|
1863 |
|
1864 <!-- RegisterNotification(criteria, callback)--> |
|
1865 <method name="RegisterNotification" scope="instance" visibility="basic"> |
|
1866 <return-types> |
|
1867 <return-type type="result"/> |
|
1868 </return-types> |
|
1869 |
|
1870 <description> |
|
1871 <p> |
|
1872 The <code>RegisterNotification</code> method registers the widget to receive notifications of new incoming messages. |
|
1873 For each new message, the method returns the header information of that message. |
|
1874 This is an asynchronous method. |
|
1875 </p> |
|
1876 |
|
1877 <pre>result = so.IMessaging.RegisterNotification(criteria, callback);</pre> |
|
1878 |
|
1879 <p> |
|
1880 Criteria object that specifies the request for notification of new messages. |
|
1881 The object must contain the Type property (string), and this property must contain the value <code>NewMessage</code>. |
|
1882 The callback argument is the name of the method that is executed when <code>RegisterNotification</code> has results or status information to return. |
|
1883 You must define this method separately. |
|
1884 The <code>RegisterNotification</code> method returns an object that contains the initial return value for the asynchronous call it started. |
|
1885 The actual notification information is returned by the callback method in the ReturnValue property of its result object. |
|
1886 <code>RegisterNotification</code> retrieves new message updates until cancelled with <code>CancelNotification</code> (or <code>Cancel</code>). |
|
1887 You can therefore have only one <code>RegisterNotification</code> call (one instance) pending or in use at any given time. |
|
1888 </p> |
|
1889 </description> |
|
1890 |
|
1891 <parameters> |
|
1892 <parameter name="criteria" type="object" usage="required"> |
|
1893 <description> |
|
1894 Criteria object specifies the type and details of the message to send. |
|
1895 </description> |
|
1896 </parameter> |
|
1897 <parameter name="callback" type="function" usage="required"> |
|
1898 <description> |
|
1899 The callback argument is the name of the method that is executed when an asynchronous Send call has status information to return. You must define this method separately. |
|
1900 </description> |
|
1901 </parameter> |
|
1902 </parameters> |
|
1903 <browsers> |
|
1904 <browser platform="Nokia WRT" version="1.1+" /> |
|
1905 </browsers> |
|
1906 </method> |
|
1907 |
|
1908 <!-- CancelNotification(criteria) --> |
|
1909 <method name="CancelNotification" scope="instance" visibility="basic"> |
|
1910 <return-types> |
|
1911 <return-type type="result"/> |
|
1912 </return-types> |
|
1913 |
|
1914 <description> |
|
1915 <p> |
|
1916 The <code>CancelNotification</code> method cancels notification of new incoming messages. |
|
1917 This is a synchronous method. |
|
1918 </p> |
|
1919 |
|
1920 <pre>result = so.IMessaging.CancelNotification(criteria);</pre> |
|
1921 |
|
1922 <p> |
|
1923 The criteria object specifies the request for cancelling notification of new messages. |
|
1924 The object must contain the Type property (string), and this property must contain the value <code>NewMessage</code>. |
|
1925 The <code>CancelNotification</code> method returns an object that contains an error code and an error message. |
|
1926 </p> |
|
1927 </description> |
|
1928 |
|
1929 <parameters> |
|
1930 <parameter name="criteria" type="object" usage="required"> |
|
1931 <description> |
|
1932 The criteria object specifies the request for cancelling notification of new messages. The object must contain the Type property (string), and this property must contain the value "NewMessage". |
|
1933 </description> |
|
1934 </parameter> |
|
1935 </parameters> |
|
1936 <browsers> |
|
1937 <browser platform="Nokia WRT" version="1.1+" /> |
|
1938 </browsers> |
|
1939 </method> |
|
1940 |
|
1941 <!-- Send(criteria, callback)--> |
|
1942 <method name="Send" scope="instance" visibility="basic"> |
|
1943 <return-types> |
|
1944 <return-type type="result"/> |
|
1945 </return-types> |
|
1946 |
|
1947 <description> |
|
1948 <p> |
|
1949 The <code>Send</code> method sends an SMS or MMS message. |
|
1950 This method can be called both synchronously and asynchronously. |
|
1951 </p> |
|
1952 |
|
1953 <p> |
|
1954 For synchronous calls: |
|
1955 </p> |
|
1956 |
|
1957 <pre>result = so.IMessaging.Send(criteria);</pre> |
|
1958 |
|
1959 <p> |
|
1960 For asynchronous calls: |
|
1961 </p> |
|
1962 |
|
1963 <pre>result = so.IMessaging.Send(criteria, callback);</pre> |
|
1964 |
|
1965 <p> |
|
1966 Criteria object specifies the type and details of the message to send. |
|
1967 The callback argument is the name of the method that is executed when an asynchronous <code>Send</code> call has status information to return. |
|
1968 You must define this method separately. |
|
1969 If synchronous, the method returns an object that contains an error code and an error message. |
|
1970 If asynchronous, the method returns an object that contains a transaction ID for the callback instance, an error code, and an error message. |
|
1971 When the asynchronous call has completed, callback returns an object that contains an error code and an error message. |
|
1972 </p> |
|
1973 </description> |
|
1974 |
|
1975 <parameters> |
|
1976 <parameter name="criteria" type="object" usage="required"> |
|
1977 <description> |
|
1978 Criteria object specifies the type and details of the message to send. |
|
1979 </description> |
|
1980 </parameter> |
|
1981 <parameter name="callback" type="function" usage="optional"> |
|
1982 <description> |
|
1983 The callback argument is the name of the method that is executed when an asynchronous Send call has status information to return. You must define this method separately. |
|
1984 </description> |
|
1985 </parameter> |
|
1986 </parameters> |
|
1987 <browsers> |
|
1988 <browser platform="Nokia WRT" version="1.1+" /> |
|
1989 </browsers> |
|
1990 </method> |
|
1991 |
|
1992 <!-- Cancel(criteria) --> |
|
1993 <method name="Cancel" scope="instance" visibility="basic"> |
|
1994 <return-types> |
|
1995 <return-type type="result"/> |
|
1996 </return-types> |
|
1997 |
|
1998 <description> |
|
1999 The <code>Cancel</code> method cancels an outstanding asynchronous <code>Send</code> or <code>RegisterNotification</code> call. |
|
2000 To cancel a <code>RegisterNotification</code> call, use <code>CancelNotification</code> instead, as it provides a more convenient way of doing this. |
|
2001 This is a synchronous method. |
|
2002 The criteria object has <code>TransactionID</code> property which specifies the transaction ID of the <code>Send</code> or <code>RegisterNotification</code> call to cancel. |
|
2003 The transaction ID is the same <code>TransactionID</code> value that was returned as part of the result of the initial call. |
|
2004 The <code>Cancel</code> method returns an object that contains an error code and an error message. |
|
2005 </description> |
|
2006 |
|
2007 <parameters> |
|
2008 <parameter name="criteria" type="object" usage="required"> |
|
2009 <description> |
|
2010 The criteria object has TransactionID property which specifies the transaction ID of the Send or RegisterNotification call to cancel. The transaction ID is the same TransactionID value that was returned as part of the result of the initial call. |
|
2011 </description> |
|
2012 </parameter> |
|
2013 </parameters> |
|
2014 <browsers> |
|
2015 <browser platform="Nokia WRT" version="1.1+" /> |
|
2016 </browsers> |
|
2017 </method> |
|
2018 |
|
2019 <!-- ChangeStatus(criteria) --> |
|
2020 <method name="ChangeStatus" scope="instance" visibility="basic"> |
|
2021 |
|
2022 <return-types> |
|
2023 <return-type type="result"/> |
|
2024 </return-types> |
|
2025 |
|
2026 <description> |
|
2027 <p> |
|
2028 The <code>ChangeStatus</code> method changes the read status of a message. |
|
2029 The status can be "Read", "Unread", "Replied", or "Forwarded". |
|
2030 This is a synchronous method. |
|
2031 </p> |
|
2032 |
|
2033 <pre>result = so.IMessaging.ChangeStatus(criteria);</pre> |
|
2034 |
|
2035 <p> |
|
2036 Criteria object specifies the message whose status to change and the new status. |
|
2037 The <code>ChangeStatus</code> method returns an object that contains an error code and an error message. |
|
2038 </p> |
|
2039 </description> |
|
2040 |
|
2041 <parameters> |
|
2042 <parameter name="criteria" type="object" usage="required"> |
|
2043 <description> |
|
2044 Criteria object specifies the message whose status to change and the new status. The ChangeStatus method returns an object that contains an error code and an error message. |
|
2045 </description> |
|
2046 </parameter> |
|
2047 </parameters> |
|
2048 |
|
2049 <browsers> |
|
2050 <browser platform="Nokia WRT" version="1.1+" /> |
|
2051 </browsers> |
|
2052 |
|
2053 </method> |
|
2054 |
|
2055 <!-- Delete (criteria)--> |
|
2056 <method name="Delete" scope="instance" visibility="basic"> |
|
2057 |
|
2058 <return-types> |
|
2059 <return-type type="result"/> |
|
2060 </return-types> |
|
2061 |
|
2062 <description> |
|
2063 <p> |
|
2064 The <code>Delete</code> method deletes a message. |
|
2065 This is a synchronous method. |
|
2066 </p> |
|
2067 |
|
2068 <pre>result = so.IMessaging.Delete(criteria);</pre> |
|
2069 |
|
2070 <p> |
|
2071 The criteria object has <code>messageId</code> attribute that specifies the message to delete. |
|
2072 The <code>Delete</code> method returns an object that contains an error code and an error message. |
|
2073 </p> |
|
2074 </description> |
|
2075 |
|
2076 <parameters> |
|
2077 <parameter name="criteria" type="object" usage="required"> |
|
2078 <description> |
|
2079 The criteria object has messageId attribute that specifies the message to delete. |
|
2080 </description> |
|
2081 </parameter> |
|
2082 </parameters> |
|
2083 |
|
2084 <browsers> |
|
2085 <browser platform="Nokia WRT" version="1.1+" /> |
|
2086 </browsers> |
|
2087 </method> |
|
2088 </methods> |
|
2089 |
|
2090 </class> |
|
2091 <!-- end of IMessaging --> |
|
2092 |
|
2093 <!-- ISysInfo interface --> |
|
2094 <class type="ISysInfo"> |
|
2095 |
|
2096 <description> |
|
2097 <p>The SystemInfo Service API allows widgets to access and modify system information on a device.</p> |
|
2098 <p>The API is integrated into WRT through the <code>device</code> object.</p> |
|
2099 <p>To use the SystemInfo Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
2100 <p>Use <code>Service.SysInfo</code> to identify the service provider and <code>ISysInfo</code> to identify the supported interface:</p> |
|
2101 <pre>var so = device.getServiceObject("Service.SysInfo", "ISysInfo");</pre> |
|
2102 </description> |
|
2103 |
|
2104 <browsers> |
|
2105 <browser platform="Nokia WRT" version="1.1+" /> |
|
2106 </browsers> |
|
2107 |
|
2108 <constructors/> |
|
2109 |
|
2110 <methods> |
|
2111 <!-- GetInfo(criteria, callback); --> |
|
2112 <method name="GetInfo" scope="instance" visibility="basic"> |
|
2113 <return-types> |
|
2114 <return-type type="result"/> |
|
2115 </return-types> |
|
2116 |
|
2117 <description> |
|
2118 The <code>GetInfo</code> method retrieves information about a system attribute. |
|
2119 This method can be called both synchronously and asynchronously. |
|
2120 </description> |
|
2121 |
|
2122 <parameters> |
|
2123 <parameter name="criteria" type="object" usage="required"> |
|
2124 <description> |
|
2125 This is an object that specifies the search criteria. |
|
2126 </description> |
|
2127 </parameter> |
|
2128 |
|
2129 <parameter name="callback" type="function" usage="optional"> |
|
2130 <description> |
|
2131 The callback argument is the name of the method that is executed when an asynchronous Send call has status information to return. You must define this method separately. |
|
2132 </description> |
|
2133 </parameter> |
|
2134 |
|
2135 </parameters> |
|
2136 <browsers> |
|
2137 <browser platform="Nokia WRT" version="1.1+" /> |
|
2138 </browsers> |
|
2139 </method> |
|
2140 |
|
2141 <!-- SetInfo(criteria); --> |
|
2142 <method name="SetInfo" scope="instance" visibility="basic"> |
|
2143 <return-types> |
|
2144 <return-type type="result"/> |
|
2145 </return-types> |
|
2146 |
|
2147 <description> |
|
2148 The <code>SetInfo</code> method modifies the value of a system attribute. |
|
2149 This is a synchronous method. |
|
2150 </description> |
|
2151 |
|
2152 <parameters> |
|
2153 <parameter name="criteria" type="object" usage="required"> |
|
2154 <description> |
|
2155 This is an object that specifies the new value for the system attribute. |
|
2156 </description> |
|
2157 </parameter> |
|
2158 </parameters> |
|
2159 <browsers> |
|
2160 <browser platform="Nokia WRT" version="1.1+" /> |
|
2161 </browsers> |
|
2162 </method> |
|
2163 |
|
2164 <!-- GetNotification(criteria, callback); --> |
|
2165 <method name="GetNotification" scope="instance" visibility="basic"> |
|
2166 <return-types> |
|
2167 <return-type type="result"/> |
|
2168 </return-types> |
|
2169 |
|
2170 <description> |
|
2171 The <code>GetNotification</code> method notifies the client when the value of a system attribute is changed. |
|
2172 This is an asynchronous method. |
|
2173 </description> |
|
2174 |
|
2175 <parameters> |
|
2176 <parameter name="criteria" type="object" usage="required"> |
|
2177 <description> |
|
2178 This is an object that specifies the system attribute to monitor for changes. |
|
2179 </description> |
|
2180 </parameter> |
|
2181 |
|
2182 <parameter name="callback" type="function" usage="required"> |
|
2183 <description> |
|
2184 The callback argument is the name of the method that is executed when a GetNotification call has results or status information to return. |
|
2185 </description> |
|
2186 </parameter> |
|
2187 </parameters> |
|
2188 <browsers> |
|
2189 <browser platform="Nokia WRT" version="1.1+" /> |
|
2190 </browsers> |
|
2191 </method> |
|
2192 |
|
2193 <!-- Cancel(criteria) --> |
|
2194 <method name="Cancel" scope="instance" visibility="basic"> |
|
2195 |
|
2196 <return-types> |
|
2197 <return-type type="result"/> |
|
2198 </return-types> |
|
2199 |
|
2200 <description> |
|
2201 The <code>Cancel</code> method cancels an ongoing asynchronous call made with a SystemInfo Service API method. |
|
2202 This is a synchronous method. |
|
2203 </description> |
|
2204 |
|
2205 <parameters> |
|
2206 <parameter name="criteria" type="object" usage="required"> |
|
2207 <description> |
|
2208 This is an object with the TransactionID property (number). criteria.TransactionID specifies the transaction ID of the asynchronous call to cancel. The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. |
|
2209 </description> |
|
2210 </parameter> |
|
2211 </parameters> |
|
2212 <browsers> |
|
2213 <browser platform="Nokia WRT" version="1.1+" /> |
|
2214 </browsers> |
|
2215 </method> |
|
2216 </methods> |
|
2217 </class> |
|
2218 <!-- end of ISysInfo --> |
|
2219 |
|
2220 <!-- ILocation API --> |
|
2221 <class type="ILocation"> |
|
2222 |
|
2223 <description> |
|
2224 <p>The Location Service API allows widgets to retrieve information about the physical location of a device and to perform calculations based on location information.</p> |
|
2225 <p>The API is integrated into WRT through the <code>device</code> object.</p> |
|
2226 |
|
2227 <p>To use the Location Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
2228 <p>Use <code>Service.Location</code> to identify the service provider and <code>ILocation</code> to identify the supported interface:</p> |
|
2229 |
|
2230 <pre>var so = device.getServiceObject("Service.Location", "ILocation");</pre> |
|
2231 </description> |
|
2232 |
|
2233 <browsers> |
|
2234 <browser platform="Nokia WRT" version="1.1+" /> |
|
2235 </browsers> |
|
2236 |
|
2237 <constructors/> |
|
2238 |
|
2239 <methods> |
|
2240 |
|
2241 <!-- GetLocation(criteria, callback) --> |
|
2242 <method name="GetLocation" scope="instance" visibility="basic"> |
|
2243 <return-types> |
|
2244 <return-type type="result"/> |
|
2245 </return-types> |
|
2246 |
|
2247 <description> |
|
2248 <p> |
|
2249 The <code>GetLocation</code> method retrieves the current location of the device. |
|
2250 This method can be called both synchronously and asynchronously. |
|
2251 </p> |
|
2252 |
|
2253 <p> |
|
2254 For synchronous calls: |
|
2255 </p> |
|
2256 <pre>result = so.ILocation.GetLocation(criteria);</pre> |
|
2257 |
|
2258 <p> |
|
2259 For asynchronous calls: |
|
2260 </p> |
|
2261 <pre>result = so.ILocation.GetLocation(criteria, callback);</pre> |
|
2262 |
|
2263 <p> |
|
2264 If synchronous, the <code>GetLocation</code> method returns an object that contains the requested location information, an error code, and an error message. |
|
2265 If asynchronous, the <code>GetLocation</code> method returns an object that contains the initial return value for the asynchronous call it started. |
|
2266 The actual location information is returned by the callback method in the ReturnValue property of its result object. |
|
2267 The availability of specific location information depends on the underlying GPS technology. |
|
2268 Other factors, such as the number of satellites available for a location fix, also affect what information can be returned. |
|
2269 You can change the positioning system used by an S60 device from the Settings > General > Positioning > Positioning methods menu. |
|
2270 It takes time to retrieve the initial position fix. Subsequent requests are faster. |
|
2271 This criteria object specifies what type of device location information is returned and how. |
|
2272 The callback argument is the name of the method that is executed when an asynchronous GetLocation call has results or status information to return. |
|
2273 You must define this method separately. |
|
2274 This argument is used only with an asynchronous <code>GetLocation</code> call. |
|
2275 For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. |
|
2276 </p> |
|
2277 </description> |
|
2278 |
|
2279 <parameters> |
|
2280 <parameter name="criteria" type="object" usage="required"> |
|
2281 <description> |
|
2282 This is an object that specifies what type of device location information is returned and how. |
|
2283 </description> |
|
2284 </parameter> |
|
2285 <parameter name="callback" type="function" usage="optional"> |
|
2286 <description> |
|
2287 The callback argument is the name of the method that is executed when an asynchronous GetLocation call has results or status information to return. You must define this method separately. This argument is used only with an asynchronous GetLocation call. |
|
2288 </description> |
|
2289 </parameter> |
|
2290 </parameters> |
|
2291 <browsers> |
|
2292 <browser platform="Nokia WRT" version="1.1+" /> |
|
2293 </browsers> |
|
2294 </method> |
|
2295 |
|
2296 <!--Trace(criteria, callback)--> |
|
2297 <method name="Trace" scope="instance" visibility="basic"> |
|
2298 <return-types> |
|
2299 <return-type type="result"/> |
|
2300 </return-types> |
|
2301 |
|
2302 <description> |
|
2303 <p> |
|
2304 The <code>Trace</code> method retrieves periodic updates about the current location of the device based on a predefined update interval. |
|
2305 This is an asynchronous method. |
|
2306 </p> |
|
2307 |
|
2308 <pre>result = so.ILocation.Trace(criteria, callback);</pre> |
|
2309 |
|
2310 <p> |
|
2311 The <code>Trace</code> method returns an object that contains the initial return value for the asynchronous call it started. |
|
2312 The actual location information is returned by the callback method in the ReturnValue property of its result object. |
|
2313 </p> |
|
2314 |
|
2315 <p> |
|
2316 <code>Trace</code> retrieves location updates until cancelled with <code>CancelNotification</code>. |
|
2317 You can therefore have only one <code>Trace</code> call (one instance) pending or in use at any given time. |
|
2318 The availability of specific location information depends on the underlying GPS technology. |
|
2319 Other factors, such as the number of satellites available for a location fix, also affect what information can be returned. |
|
2320 You can change the positioning system used by an S60 device from the Settings > General > Positioning > Positioning methods menu. |
|
2321 It takes time to retrieve the initial position fix. Subsequent requests are faster. |
|
2322 The criteria object specifies what type of device location information is returned and how. Note that these input properties are similar to what the GetLocation method uses. |
|
2323 The callback argument is the name of the method that is executed when Trace has results or status information to return. You must define this method separately. |
|
2324 For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. |
|
2325 </p> |
|
2326 </description> |
|
2327 |
|
2328 <parameters> |
|
2329 <parameter name="criteria" type="object" usage="required"> |
|
2330 <description> |
|
2331 This is an object that specifies what type of device location information is returned and how. Note that these input properties are similar to what the GetLocation method uses.</description> |
|
2332 </parameter> |
|
2333 <parameter name="callback" type="function" usage="required"> |
|
2334 <description> |
|
2335 The callback argument is the name of the method that is executed when Trace has results or status information to return. You must define this method separately. |
|
2336 </description> |
|
2337 </parameter> |
|
2338 </parameters> |
|
2339 <browsers> |
|
2340 <browser platform="Nokia WRT" version="1.1+" /> |
|
2341 </browsers> |
|
2342 </method> |
|
2343 |
|
2344 <!-- Calculate(criteria) --> |
|
2345 <method name="Calculate" scope="instance" visibility="basic"> |
|
2346 <return-types> |
|
2347 <return-type type="result"/> |
|
2348 </return-types> |
|
2349 |
|
2350 <description> |
|
2351 <p> |
|
2352 The <code>Calculate</code> method performs mathematical calculations based on a source location and a target location. |
|
2353 This is a synchronous method. |
|
2354 </p> |
|
2355 |
|
2356 <pre>result = so.ILocation.Calculate(criteria);</pre> |
|
2357 |
|
2358 <p> |
|
2359 The <code>Calculate</code> method returns an object that contains the calculation results, an error code, and an error message. |
|
2360 The criteria object specifies the mathematical operation to perform and the input values to use in the operation. |
|
2361 For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. |
|
2362 </p> |
|
2363 </description> |
|
2364 |
|
2365 <parameters> |
|
2366 <parameter name="criteria" type="Object" usage="required"> |
|
2367 <description> |
|
2368 This is an object that specifies the mathematical operation to perform and the input values to use in the operation. |
|
2369 </description> |
|
2370 </parameter> |
|
2371 </parameters> |
|
2372 <browsers> |
|
2373 <browser platform="Nokia WRT" version="1.1+" /> |
|
2374 </browsers> |
|
2375 </method> |
|
2376 |
|
2377 <!-- CancelNotification(criteria) --> |
|
2378 <method name="CancelNotification" scope="instance" visibility="basic"> |
|
2379 <return-types> |
|
2380 <return-type type="result"/> |
|
2381 </return-types> |
|
2382 |
|
2383 <description> |
|
2384 <p> |
|
2385 The <code>CancelNotification</code> method cancels an outstanding asynchronous call. |
|
2386 This is a synchronous method. |
|
2387 </p> |
|
2388 |
|
2389 <pre>result = so.ILocation.CancelNotification(criteria);</pre> |
|
2390 |
|
2391 <p> |
|
2392 The criteria object specifies whether to cancel a GetLocation call or a Trace call. |
|
2393 The object must contain the <code>CancelRequestType</code> property (string) that is used to specify the type of call to cancel. |
|
2394 </p> |
|
2395 |
|
2396 <p> |
|
2397 The possible values for <code>criteria.CancelRequestType</code> are: |
|
2398 <ul> |
|
2399 <li><code>GetLocCancel</code> cancels an asynchronous <code>GetLocation</code> call.</li> |
|
2400 <li><code>TraceCancel</code> cancels a <code>Trace</code> call.</li> |
|
2401 </ul> |
|
2402 </p> |
|
2403 |
|
2404 <p> |
|
2405 The <code>CancelNotification</code> method returns an object that contains an error code and an error message. |
|
2406 For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. |
|
2407 </p> |
|
2408 </description> |
|
2409 |
|
2410 <parameters> |
|
2411 <parameter name="criteria" type="object" usage="required"> |
|
2412 <description> |
|
2413 This is an object that specifies whether to cancel a GetLocation call or a Trace call. The object must contain the CancelRequestType property (string) that is used to specify the type of call to cancel. The possible values for criteria.CancelRequestType are: "GetLocCancel" cancels an asynchronous GetLocation call. "TraceCancel" cancels a Trace call. |
|
2414 </description> |
|
2415 </parameter> |
|
2416 </parameters> |
|
2417 <browsers> |
|
2418 <browser platform="Nokia WRT" version="1.1+" /> |
|
2419 </browsers> |
|
2420 </method> |
|
2421 |
|
2422 </methods> |
|
2423 |
|
2424 </class> |
|
2425 <!-- end of ILocation API --> |
|
2426 |
|
2427 <!-- ISensor interface --> |
|
2428 <class type="ISensor"> |
|
2429 |
|
2430 <description> |
|
2431 <p> |
|
2432 The Sensor Service API allows widgets to access data provided by the physical sensors of a device. |
|
2433 </p> |
|
2434 <p> |
|
2435 The data from a given sensor is mapped to one or more sensor channels, which the API can listen to. |
|
2436 The available sensors depend on the device. |
|
2437 </p> |
|
2438 <p> |
|
2439 The API is integrated into WRT through the <code>device</code> object. |
|
2440 </p> |
|
2441 <p> |
|
2442 To use the Sensor Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. |
|
2443 </p> |
|
2444 <p> |
|
2445 Use <code>Service.Sensor</code> to identify the service provider and <code>ISensor</code> to identify the supported interface: |
|
2446 </p> |
|
2447 |
|
2448 <pre>so = device.getServiceObject("Service.Sensor", "ISensor");</pre> |
|
2449 </description> |
|
2450 |
|
2451 <browsers> |
|
2452 <browser platform="Nokia WRT" version="1.1+" /> |
|
2453 </browsers> |
|
2454 |
|
2455 <constructors/> |
|
2456 |
|
2457 <methods> |
|
2458 |
|
2459 <!-- FindSensorChannel (criteria)--> |
|
2460 <method name="FindSensorChannel" scope="instance" visibility="basic"> |
|
2461 <return-types> |
|
2462 <return-type type="result"/> |
|
2463 </return-types> |
|
2464 |
|
2465 <description> |
|
2466 <p> |
|
2467 The <code>FindSensorChannel</code> method searches for sensor channels available on the device. |
|
2468 This is a synchronous method. |
|
2469 </p> |
|
2470 |
|
2471 <pre>result = so.ISensor.FindSensorChannel(criteria);</pre> |
|
2472 |
|
2473 <p> |
|
2474 The criteria object specifies the search criteria. |
|
2475 The <code>FindSensorChannel</code> method returns an object that contains the requested sensor channel information, an error code, and an error message. |
|
2476 </p> |
|
2477 </description> |
|
2478 |
|
2479 <parameters> |
|
2480 <parameter name="criteria" type="object" usage="required"> |
|
2481 <description> |
|
2482 This is an object that specifies the search criteria. |
|
2483 </description> |
|
2484 </parameter> |
|
2485 </parameters> |
|
2486 |
|
2487 <browsers> |
|
2488 <browser platform="Nokia WRT" version="1.1+" /> |
|
2489 </browsers> |
|
2490 |
|
2491 </method> |
|
2492 |
|
2493 <!-- RegisterForNotification(criteria, callback)--> |
|
2494 <method name="RegisterForNotification" scope="instance" visibility="basic"> |
|
2495 <return-types> |
|
2496 <return-type type="result"/> |
|
2497 </return-types> |
|
2498 |
|
2499 <description> |
|
2500 <p> |
|
2501 The <code>RegisterForNotification</code> method registers the client to receive data from one sensor channel. |
|
2502 This is an asynchronous method. |
|
2503 </p> |
|
2504 |
|
2505 <pre>result = so.ISensor.RegisterForNotification(criteria, callback);</pre> |
|
2506 |
|
2507 <p> |
|
2508 The <code>RegisterForNotification</code> method returns an object that contains the initial return value for the asynchronous call it started. |
|
2509 The actual sensor data is returned by the callback method in the ReturnValue property of its result object. |
|
2510 </p> |
|
2511 </description> |
|
2512 |
|
2513 <parameters> |
|
2514 <parameter name="criteria" type="object" usage="required"> |
|
2515 <description> |
|
2516 This is an object that specifies the sensor channel to listen for data. |
|
2517 </description> |
|
2518 </parameter> |
|
2519 <parameter name="callback" type="function" usage="required"> |
|
2520 <description> |
|
2521 The callback argument is the name of the method that is executed when a RegisterForNotification call has results or status information to return. You must define this method separately. |
|
2522 </description> |
|
2523 </parameter> |
|
2524 </parameters> |
|
2525 <browsers> |
|
2526 <browser platform="Nokia WRT" version="1.1+" /> |
|
2527 </browsers> |
|
2528 </method> |
|
2529 |
|
2530 <!-- Cancel(criteria) --> |
|
2531 <method name="Cancel" scope="instance" visibility="basic"> |
|
2532 <return-types> |
|
2533 <return-type type="result"/> |
|
2534 </return-types> |
|
2535 |
|
2536 <description> |
|
2537 <p> |
|
2538 The <code>Cancel</code> method stops an ongoing <code>RegisterForNotification</code> call. |
|
2539 This is a synchronous method. |
|
2540 </p> |
|
2541 |
|
2542 <pre>result = so.ISensor.Cancel(criteria);</pre> |
|
2543 |
|
2544 <p> |
|
2545 The criteria object has the <code>TransactionID</code> property which specifies the transaction ID of the <code>RegisterForNotification</code> call to cancel. |
|
2546 The transaction ID is the value that was returned as part of the result of the initial call. |
|
2547 The <code>Cancel</code> method returns an object that contains an error code and an error message. |
|
2548 </p> |
|
2549 </description> |
|
2550 |
|
2551 <parameters> |
|
2552 <parameter name="criteria" type="object" usage="required"> |
|
2553 <description> |
|
2554 This is an object with the TransactionID property (number). criteria.TransactionID specifies the transaction ID of the RegisterForNotification call to cancel. The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. |
|
2555 </description> |
|
2556 </parameter> |
|
2557 </parameters> |
|
2558 <browsers> |
|
2559 <browser platform="Nokia WRT" version="1.1+" /> |
|
2560 </browsers> |
|
2561 </method> |
|
2562 |
|
2563 <!-- GetChannelProperty (criteria)--> |
|
2564 <method name="GetChannelProperty" scope="instance" visibility="basic"> |
|
2565 <return-types> |
|
2566 <return-type type="result"/> |
|
2567 </return-types> |
|
2568 |
|
2569 <description> |
|
2570 <p> |
|
2571 The <code>GetChannelProperty</code> method retrieves information about a sensor channel property. |
|
2572 This is a synchronous method. |
|
2573 </p> |
|
2574 |
|
2575 <pre>result = so.ISensor.GetChannelProperty(criteria);</pre> |
|
2576 |
|
2577 <p> |
|
2578 This is an object that specifies which sensor channel property to retrieve information about. |
|
2579 The <code>GetChannelProperty</code> method returns an object that contains the requested channel property information, an error code, and an error message. |
|
2580 </p> |
|
2581 |
|
2582 </description> |
|
2583 |
|
2584 <parameters> |
|
2585 <parameter name="criteria" type="object" usage="required"> |
|
2586 <description> |
|
2587 This is an object that specifies which sensor channel property to retrieve information about. |
|
2588 </description> |
|
2589 </parameter> |
|
2590 </parameters> |
|
2591 <browsers> |
|
2592 <browser platform="Nokia WRT" version="1.1+" /> |
|
2593 </browsers> |
|
2594 </method> |
|
2595 |
|
2596 </methods> |
|
2597 |
|
2598 </class> |
|
2599 <!-- end of ISensor --> |
|
2600 |
|
2601 <!-- serviceObject --> |
|
2602 <class type="serviceObject"> |
|
2603 <description> |
|
2604 Service Object |
|
2605 </description> |
|
2606 |
|
2607 <browsers> |
|
2608 <browser platform="Nokia WRT" version="1.1+" /> |
|
2609 </browsers> |
|
2610 |
|
2611 <constructors> |
|
2612 <constructor scope="instance"> |
|
2613 <description>Service Object</description> |
|
2614 <browsers> |
|
2615 <browser platform="Nokia WRT" version="1.1+"/> |
|
2616 </browsers> |
|
2617 <parameters/> |
|
2618 <return-types> |
|
2619 <return-type type="serviceObject"/> |
|
2620 </return-types> |
|
2621 </constructor> |
|
2622 </constructors> |
|
2623 |
|
2624 <properties> |
|
2625 |
|
2626 <property name="IDataSource" type="IDataSource" scope="instance" access="read-write" visibility="basic"> |
|
2627 <description> |
|
2628 This Service API allows widgets to: |
|
2629 <p> |
|
2630 <ul> |
|
2631 <li>access, create, and manage calendars/calendar entries,</li> |
|
2632 <li>access and manage information about contacts,</li> |
|
2633 <li>access and manage information about landmarks and landmark categories,</li> |
|
2634 <li>add, read, and delete logging events such as call logs, messaging logs, and so forth,</li> |
|
2635 <li>retrieve information (metadata) about the media files stored in the Media Gallery of a device.</li> |
|
2636 </ul> |
|
2637 </p> |
|
2638 <p> |
|
2639 To use the <code>IDataSource</code> Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. |
|
2640 </p> |
|
2641 <p> |
|
2642 Use <code>Service.Calendar</code> or <code>Service.Contact</code> or <code>Service.Landmarks</code> or <code>Service.Logging</code> or <code>Service.MediaManagement</code> to identify the service provider and <code>IDataSource</code> to identify the supported interface: |
|
2643 </p> |
|
2644 |
|
2645 <pre>var so = device.getServiceObject("Service.Calendar", "IDataSource");</pre> |
|
2646 </description> |
|
2647 <browsers> |
|
2648 <browser platform="Nokia WRT" version="1.1+"/> |
|
2649 </browsers> |
|
2650 </property> |
|
2651 |
|
2652 <property name="IAppManager" type="IAppManager" scope="instance" access="read-write" visibility="basic"> |
|
2653 <description> |
|
2654 <p>The AppManager Service API allows widgets to access and launch applications on a mobile device.</p> |
|
2655 <p>The API is integrated with WRT through the <code>device</code> object.</p> |
|
2656 <p>To use the AppManager Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
2657 <p>Use <code>Service.AppManager</code> to identify the service provider and <code>IAppManager</code> to identify the supported interface:</p> |
|
2658 |
|
2659 <pre>var so = device.getServiceObject("Service.AppManager", "IAppManager");</pre> |
|
2660 </description> |
|
2661 <browsers> |
|
2662 <browser platform="Nokia WRT" version="1.1+"/> |
|
2663 </browsers> |
|
2664 </property> |
|
2665 |
|
2666 <property name="IMessaging" type="IMessaging" scope="instance" access="read-write" visibility="basic"> |
|
2667 <description> |
|
2668 <p>The Messaging Service API allows widgets to send, retrieve, and manage messages using the Messaging Center of a device.</p> |
|
2669 <p>The API is integrated into WRT through the <code>device</code> object.</p> |
|
2670 |
|
2671 <p>To use the Messaging Service API, your widget must first createa service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
2672 <p>Use <code>Service.Messaging</code> to identify the service provider and <code>IMessaging</code> to identify the supported interface:</p> |
|
2673 |
|
2674 <pre>var so = device.getServiceObject("Service.Messaging", "IMessaging");</pre> |
|
2675 |
|
2676 </description> |
|
2677 <browsers> |
|
2678 <browser platform="Nokia WRT" version="1.1+"/> |
|
2679 </browsers> |
|
2680 </property> |
|
2681 |
|
2682 <property name="ISysInfo" type="ISysInfo" scope="instance" access="read-write" visibility="basic"> |
|
2683 <description> |
|
2684 <p>The SystemInfo Service API allows widgets to access and modify system information on a device.</p> |
|
2685 <p>The API is integrated into WRT through the <code>device</code> object.</p> |
|
2686 <p>To use the SystemInfo Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
2687 <p>Use <code>Service.SysInfo</code> to identify the service provider and <code>ISysInfo</code> to identify the supported interface:</p> |
|
2688 <pre>var so = device.getServiceObject("Service.SysInfo", "ISysInfo");</pre> |
|
2689 </description> |
|
2690 <browsers> |
|
2691 <browser platform="Nokia WRT" version="1.1+"/> |
|
2692 </browsers> |
|
2693 </property> |
|
2694 |
|
2695 <property name="ILocation" type="ILocation" scope="instance" access="read-write" visibility="basic"> |
|
2696 <description> |
|
2697 <p>The Location Service API allows widgets to retrieve information about the physical location of a device and to perform calculations based on location information.</p> |
|
2698 <p>The API is integrated into WRT through the <code>device</code> object.</p> |
|
2699 |
|
2700 <p>To use the Location Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
2701 <p>Use <code>Service.Location</code> to identify the service provider and <code>ILocation</code> to identify the supported interface:</p> |
|
2702 |
|
2703 <pre>var so = device.getServiceObject("Service.Location", "ILocation");</pre> |
|
2704 |
|
2705 </description> |
|
2706 <browsers> |
|
2707 <browser platform="Nokia WRT" version="1.1+"/> |
|
2708 </browsers> |
|
2709 </property> |
|
2710 |
|
2711 <property name="ISensor" type="ISensor" scope="instance" access="read-write" visibility="basic"> |
|
2712 <description> |
|
2713 <p>The Sensor Service API allows widgets to access data provided by the physical sensors of a device.</p> |
|
2714 <p>The data from a given sensor is mapped to one or more sensor channels, which the API can listen to. |
|
2715 The available sensors depend on the device.</p> |
|
2716 <p>The API is integrated into WRT through the <code>device</code> object.</p> |
|
2717 <p>To use the Sensor Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method.</p> |
|
2718 <p>Use <code>Service.Sensor</code> to identify the service provider and <code>ISensor</code> to identify the supported interface:</p> |
|
2719 |
|
2720 <pre>so = device.getServiceObject("Service.Sensor", "ISensor");</pre> |
|
2721 </description> |
|
2722 <browsers> |
|
2723 <browser platform="Nokia WRT" version="1.1+"/> |
|
2724 </browsers> |
|
2725 </property> |
|
2726 |
|
2727 </properties> |
|
2728 </class> |
|
2729 <!-- end of serviceObject --> |
|
2730 |
|
2731 <!-- Device --> |
|
2732 <class type="device"> |
|
2733 |
|
2734 <description> |
|
2735 The <code>device</code> object is a built-in JavaScript object in the widget engine. |
|
2736 It was introduced in WRT 1.1 to allow widgets access to S60 Platform Services through Service APIs. |
|
2737 The <code>device</code> object is used to create service objects for specific Service APIs. |
|
2738 These service objects can then be used to access the services made available through the Service APIs. |
|
2739 </description> |
|
2740 |
|
2741 <browsers> |
|
2742 <browser platform="Nokia WRT" version="1.1+" /> |
|
2743 </browsers> |
|
2744 |
|
2745 |
|
2746 <constructors> |
|
2747 <constructor scope="instance"> |
|
2748 <description> |
|
2749 The <code>device</code> object is a built-in JavaScript object in the widget engine. |
|
2750 It was introduced in WRT 1.1 to allow widgets access to S60 Platform Services through Service APIs. |
|
2751 The <code>device</code> object is used to create service objects for specific Service APIs. |
|
2752 These service objects can then be used to access the services made available through the Service APIs. |
|
2753 </description> |
|
2754 <browsers> |
|
2755 <browser platform="Nokia WRT" version="1.1+"/> |
|
2756 </browsers> |
|
2757 <parameters/> |
|
2758 <return-types> |
|
2759 <return-type type="device"/> |
|
2760 </return-types> |
|
2761 </constructor> |
|
2762 </constructors> |
|
2763 |
|
2764 <methods> |
|
2765 |
|
2766 <method name="getServiceObject" scope="" visibility="basic"> |
|
2767 |
|
2768 <return-types> |
|
2769 <return-type type="serviceObject"/> |
|
2770 </return-types> |
|
2771 |
|
2772 <description> |
|
2773 The <code>getServiceObject</code> method creates an object that is used to access the services made available through a Service API. |
|
2774 This object is referred to as a <b>service object</b>. |
|
2775 </description> |
|
2776 |
|
2777 <parameters> |
|
2778 |
|
2779 <parameter name="provider" type="String" usage="required"> |
|
2780 |
|
2781 <values> |
|
2782 <value name="Service.AppManager" description="Application Manager." /> |
|
2783 <value name="Service.SysInfo" description="System Information." /> |
|
2784 <value name="Service.Sensor" description="Sensor." /> |
|
2785 <value name="Service.Messaging" description="Messaging." /> |
|
2786 <value name="Service.MediaManagement" description="Media Management." /> |
|
2787 <value name="Service.Logging" description="Logging." /> |
|
2788 <value name="Service.Location" description="Location." /> |
|
2789 <value name="Service.Calendar" description="Calendar." /> |
|
2790 <value name="Service.Contact" description="Contact." /> |
|
2791 </values> |
|
2792 |
|
2793 <description> |
|
2794 This is a text string that defines the service provider name, that is, the name of the type of service object to create. |
|
2795 Possible values : "Service.AppManager", |
|
2796 "Service.SysInfo", |
|
2797 "Service.Sensor", |
|
2798 "Service.Messaging", |
|
2799 "Service.MediaManagement", |
|
2800 "Service.Logging", |
|
2801 "Service.Location", |
|
2802 "Service.Calendar", |
|
2803 "Service.Contact" |
|
2804 </description> |
|
2805 |
|
2806 </parameter> |
|
2807 |
|
2808 <parameter name="interface" type="String" usage="required"> |
|
2809 <description> |
|
2810 This is a text string that defines the supported interface for the specified service provider. |
|
2811 Possible values : "IAppManager", |
|
2812 "ISysInfo", |
|
2813 "ISensor", |
|
2814 "IMessaging", |
|
2815 "IDataSource", |
|
2816 "ILocation" |
|
2817 </description> |
|
2818 <values> |
|
2819 <value name = "IAppManager" description = "Application Manager."/> |
|
2820 <value name = "ISysInfo" description = "System Information."/> |
|
2821 <value name = "ISensor" description = "Sensor."/> |
|
2822 <value name = "IMessaging" description = "Messaging."/> |
|
2823 <value name = "IDataSource" description = "Media Management, Logging, Calendar, Contact"/> |
|
2824 <value name = "ILocation" description = "Location."/> |
|
2825 </values> |
|
2826 </parameter> |
|
2827 </parameters> |
|
2828 |
|
2829 <browsers> |
|
2830 <browser platform="Nokia WRT" version="1.1+" /> |
|
2831 </browsers> |
|
2832 |
|
2833 <example> |
|
2834 <p> |
|
2835 The following example creates a service object for the Media Management Service API: |
|
2836 </p> |
|
2837 |
|
2838 <pre>var so = device.getServiceObject("Service.MediaManagement", "IDataSource");</pre> |
|
2839 </example> |
|
2840 |
|
2841 </method> |
|
2842 </methods> |
|
2843 |
|
2844 </class> |
|
2845 <!-- end of Device --> |
|
2846 |
|
2847 </javascript> |