|
1 |
|
2 <!DOCTYPE html |
|
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="Criteria for retrieving location information"/><meta name="DC.Relation" scheme="URI" content="GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-53CE4DE6-F065-4339-8C18-5C30A9540053"/><meta name="DC.Relation" scheme="URI" content="GUID-150E440F-56E4-4249-8739-A5A7A2050600"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-4541E532-CC1A-4115-8467-7FA1C4378307"/><title>Criteria for |
|
5 retrieving location information </title><script type="text/javascript"> |
|
6 function initPage() {} |
|
7 </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-4541E532-CC1A-4115-8467-7FA1C4378307"><span>Criteria</span> for |
|
8 retrieving location information</h1><div> |
|
9 <p/> |
|
10 <p>The <code>criteria</code> object specifies what type |
|
11 of device location information is returned and how.</p> |
|
12 <p>The Location Service supports two types of location information:</p> |
|
13 <ul> |
|
14 <li><p><strong>Basic</strong></p> |
|
15 |
|
16 <p>Basic location information includes longitude, latitude, and altitude |
|
17 estimates.</p> |
|
18 |
|
19 </li> |
|
20 <li><p><strong>Generic</strong></p> |
|
21 |
|
22 <p>Generic location information includes <a href="GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B.html#GUID-A6C9AF19-6694-478B-A9FE-7898A2091C4B">all |
|
23 possible location data</a>.</p> |
|
24 |
|
25 </li> |
|
26 </ul> |
|
27 <p>The <code>criteria</code> object has two main properties: <code>LocationInformationClass</code> and <code>Updateoptions</code>. These are described in the following table. Properties enclosed in brackets |
|
28 are optional.</p> |
|
29 <div class="tablenoborder"><a name="GUID-08CC49F0-2869-4994-82AF-B62DAC6A7934"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-08CC49F0-2869-4994-82AF-B62DAC6A7934" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption> |
|
30 |
|
31 <thead align="left"> |
|
32 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e47586"> |
|
33 <p>Property</p> |
|
34 </th><th class="cellrowborder" valign="top" width="25%" id="d0e47591"> |
|
35 <p>Description</p> |
|
36 </th><th class="cellrowborder" valign="top" width="25%" id="d0e47596"> |
|
37 <p>Type</p> |
|
38 </th><th class="cellrowborder" valign="top" width="25%" id="d0e47601"> |
|
39 <p>Value</p> |
|
40 </th></tr> |
|
41 </thead> |
|
42 <tbody> |
|
43 <tr class=""> |
|
44 <td class="cellrowborder" valign="top" width="25%" headers="d0e47586 "> |
|
45 <p><code>[criteria.LocationInformationClass]</code></p> |
|
46 </td> |
|
47 <td class="cellrowborder" valign="top" width="25%" headers="d0e47591 "> |
|
48 <p>Specifies the type of location information to retrieve. It has two possible |
|
49 values:</p> |
|
50 <ul> |
|
51 <li><p><code>BasicLocationInformation</code> includes longitude, |
|
52 latitude, and altitude estimates. This is the default value for this argument.</p> |
|
53 </li> |
|
54 <li><p><code>GenericLocationInfo</code> includes all possible |
|
55 location data.</p></li> |
|
56 </ul> |
|
57 <div class="note"><p><strong class="note_title">Note: </strong>There is no guarantee that all the requested information is returned, |
|
58 whether basic or generic. The availability of specific information depends |
|
59 on the positioning system used and on other factors such as the number of |
|
60 satellites that are available when a location fix is obtained.</p> |
|
61 <p>For information on how to ensure that you get at least certain information, |
|
62 see the <code>Updateoptions.PartialUpdates</code> property.</p> |
|
63 </div> |
|
64 </td> |
|
65 <td class="cellrowborder" valign="top" width="25%" headers="d0e47596 "> |
|
66 <p>string</p> |
|
67 </td> |
|
68 <td class="cellrowborder" valign="top" width="25%" headers="d0e47601 "> |
|
69 <p>Possible values:</p> |
|
70 <ul> |
|
71 <li><p><code>"BasicLocationInformation"</code></p></li> |
|
72 <li><p><code>"GenericLocationInfo"</code></p></li> |
|
73 </ul> |
|
74 </td> |
|
75 </tr> |
|
76 <tr class="bg "> |
|
77 <td class="cellrowborder" valign="top" width="25%" headers="d0e47586 "> |
|
78 <p><code>[criteria.Updateoptions]</code></p> |
|
79 </td> |
|
80 <td class="cellrowborder" valign="top" width="25%" headers="d0e47591 "> |
|
81 <p>Specifies the update options used while retrieving the location information.</p> |
|
82 <p>If you do not define a particular option, then its default value is |
|
83 used.</p> |
|
84 <div class="note"><p><strong class="note_title">Note: </strong>The option values must conform to the following order of magnitude:</p> |
|
85 <p><code>UpdateTimeOut</code> > <code>UpdateInterval</code> > <code>UpdateMaxAge</code></p> |
|
86 <p>If this order is not maintained, the method returns the <code>SErrArgument</code> error.</p> |
|
87 </div> |
|
88 </td> |
|
89 <td class="cellrowborder" valign="top" width="25%" headers="d0e47596 "> |
|
90 <p>object</p> |
|
91 </td> |
|
92 <td class="cellrowborder" valign="top" width="25%" headers="d0e47601 "> |
|
93 <p>Object with the properties specified below</p> |
|
94 </td> |
|
95 </tr> |
|
96 <tr class=""> |
|
97 <td class="cellrowborder" valign="top" width="25%" headers="d0e47586 "> |
|
98 <p><code>[criteria.Updateoptions.UpdateInterval]</code></p> |
|
99 </td> |
|
100 <td class="cellrowborder" valign="top" width="25%" headers="d0e47591 "> |
|
101 <p>Specifies the time interval (in microseconds) between two consecutive |
|
102 location estimates.</p> |
|
103 <p>This is only used with <a href="GUID-7A0190CB-545E-48D2-BAF0-D28E03CDFCA5.html#GUID-7A0190CB-545E-48D2-BAF0-D28E03CDFCA5"><code>Trace</code></a>, |
|
104 which requests location estimates until <a href="GUID-7A466B60-88DD-4A3A-B64C-E7300D42DA56.html#GUID-7A466B60-88DD-4A3A-B64C-E7300D42DA56">cancelled</a>. <a href="GUID-150E440F-56E4-4249-8739-A5A7A2050600.html#GUID-150E440F-56E4-4249-8739-A5A7A2050600"><code>GetLocation</code></a> only |
|
105 requests the location estimate once.</p> |
|
106 <p>The default value is <code>1000000</code> (= 1 second).</p> |
|
107 </td> |
|
108 <td class="cellrowborder" valign="top" width="25%" headers="d0e47596 "> |
|
109 <p>number</p> |
|
110 </td> |
|
111 <td class="cellrowborder" valign="top" width="25%" headers="d0e47601 "> |
|
112 <p><code>0</code> or a positive integer</p> |
|
113 </td> |
|
114 </tr> |
|
115 <tr class="bg "> |
|
116 <td class="cellrowborder" valign="top" width="25%" headers="d0e47586 "> |
|
117 <p><code>[criteria.Updateoptions.UpdateTimeOut]</code></p> |
|
118 </td> |
|
119 <td class="cellrowborder" valign="top" width="25%" headers="d0e47591 "> |
|
120 <p>If the location server does not provide location estimates within the |
|
121 time specified in <code>UpdateTimeOut</code> (in microseconds), the |
|
122 method returns the <code>SErrTimedOut</code> error.</p> |
|
123 <p>The default value is <code>15000000</code> (= 15 seconds).</p> |
|
124 </td> |
|
125 <td class="cellrowborder" valign="top" width="25%" headers="d0e47596 "> |
|
126 <p>number</p> |
|
127 </td> |
|
128 <td class="cellrowborder" valign="top" width="25%" headers="d0e47601 "> |
|
129 <p><code>0</code> or a positive integer</p> |
|
130 </td> |
|
131 </tr> |
|
132 <tr class=""> |
|
133 <td class="cellrowborder" valign="top" width="25%" headers="d0e47586 "> |
|
134 <p><code>[criteria.Updateoptions.UpdateMaxAge]</code></p> |
|
135 </td> |
|
136 <td class="cellrowborder" valign="top" width="25%" headers="d0e47591 "> |
|
137 <p>Specifies the expiry time for the location information cache (in microseconds). |
|
138 When a location request is made, the location information is returned from |
|
139 the cache (managed by the location server) as long as the cache is not older |
|
140 than <code>UpdateMaxAge</code>.</p> |
|
141 <p>The default value is <code>0</code>, meaning that the location |
|
142 information is never returned from the cache.</p> |
|
143 </td> |
|
144 <td class="cellrowborder" valign="top" width="25%" headers="d0e47596 "> |
|
145 <p>number</p> |
|
146 </td> |
|
147 <td class="cellrowborder" valign="top" width="25%" headers="d0e47601 "> |
|
148 <p><code>0</code> or a positive integer</p> |
|
149 </td> |
|
150 </tr> |
|
151 <tr class="bg "> |
|
152 <td class="cellrowborder" valign="top" width="25%" headers="d0e47586 "> |
|
153 <p><code>[criteria.Updateoptions.PartialUpdates]</code></p> |
|
154 </td> |
|
155 <td class="cellrowborder" valign="top" width="25%" headers="d0e47591 "> |
|
156 <p>Specifies whether longitude, latitude, and altitude information is always |
|
157 guaranteed.</p> |
|
158 <p>Setting <code>PartialUpdates</code> to <code>false</code> ensures |
|
159 that the user receives at least <code>BasicLocationInformation</code> (longitude, |
|
160 latitude, and altitude).</p> |
|
161 <div class="note"><p><strong class="note_title">Note: </strong>Altitude information is returned only if the positioning system supports |
|
162 it. You can change the positioning system used by an S60 device from the <strong>Settings |
|
163 > General > Positioning > Positioning methods</strong> menu.</p> |
|
164 </div> |
|
165 <p>If you set this property to <code>true</code>, there are no |
|
166 guarantees on any specific information being returned, including longitude, |
|
167 latitude, and altitude.</p> |
|
168 <p>The default value is <code>false</code>.</p> |
|
169 </td> |
|
170 <td class="cellrowborder" valign="top" width="25%" headers="d0e47596 "> |
|
171 <p>boolean</p> |
|
172 </td> |
|
173 <td class="cellrowborder" valign="top" width="25%" headers="d0e47601 "> |
|
174 <p>Possible values:</p> |
|
175 <ul> |
|
176 <li><p><code>true</code></p></li> |
|
177 <li><p><code>false</code></p></li> |
|
178 </ul> |
|
179 </td> |
|
180 </tr> |
|
181 </tbody> |
|
182 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |