Release 4.0.0-preview1-00138
[platform/core/csapi/tizenfx.git] / Artifacts / bin / Tizen.Location.xml
1 <?xml version="1.0"?>
2 <doc>
3     <assembly>
4         <name>Tizen.Location</name>
5     </assembly>
6     <members>
7         <member name="T:Tizen.Location.GpsSatellite">
8             <summary>
9             This class contains the functionality for obtaining information about GPS satellites in the range and in use.
10             </summary>
11             <since_tizen> 3 </since_tizen>
12         </member>
13         <member name="P:Tizen.Location.GpsSatellite.Interval">
14             <summary>
15             The time interval between callback updates.
16             Should be in the range of 1~120 seconds.
17             </summary>
18             <since_tizen> 3 </since_tizen>
19             <exception cref="T:System.ArgumentException">Thrown when an an invalid argument is used.</exception>
20         </member>
21         <member name="P:Tizen.Location.GpsSatellite.Nmea">
22             <summary>
23             The NMEA data from the satellite.
24             </summary>
25             <since_tizen> 3 </since_tizen>
26             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
27             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
28             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
29             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
30         </member>
31         <member name="P:Tizen.Location.GpsSatellite.ActiveCount">
32             <summary>
33             The count of active satellites.
34             </summary>
35             <since_tizen> 3 </since_tizen>
36             <privilege>http://tizen.org/privilege/location</privilege>
37             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
38             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
39             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
40             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
41         </member>
42         <member name="P:Tizen.Location.GpsSatellite.InViewCount">
43             <summary>
44             The count of satellites in view.
45             </summary>
46             <since_tizen> 3 </since_tizen>
47             <privilege>http://tizen.org/privilege/location</privilege>
48             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
49             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
50             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
51             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
52         </member>
53         <member name="P:Tizen.Location.GpsSatellite.Satellites">
54             <summary>
55             The list of satellites or last recorded satellites in view.
56             </summary>
57             <since_tizen> 3 </since_tizen>
58             <privilege>http://tizen.org/privilege/location</privilege>
59             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
60             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
61             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
62             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
63         </member>
64         <member name="M:Tizen.Location.GpsSatellite.#ctor(Tizen.Location.Locator)">
65             <summary>
66             The constructor of the GpsSatellite class.
67             </summary>
68             <since_tizen> 3 </since_tizen>
69             <param name="locator">The locator object initilized using GPS.</param>
70             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
71         </member>
72         <member name="E:Tizen.Location.GpsSatellite.SatelliteStatusUpdated">
73             <summary>
74             The SatelliteStatusUpdated event is raised whenever the satellite information is updated.
75             The callback will be invoked periodically (every Interval seconds).
76             </summary>
77             <since_tizen> 3 </since_tizen>
78             <privilege>http://tizen.org/privilege/location</privilege>
79             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
80             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
81             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
82         </member>
83         <member name="T:Tizen.Location.SatelliteInformation">
84             <summary>
85             This class contains the information of the satellite under consideration.
86             </summary>
87             <since_tizen> 3 </since_tizen>
88         </member>
89         <member name="M:Tizen.Location.SatelliteInformation.#ctor(System.UInt32,System.UInt32,System.UInt32,System.UInt32,System.Boolean)">
90             <summary>
91             The Class constructor for the SatelliteInformation class.
92             </summary>
93             <since_tizen> 3 </since_tizen>
94             <param name="azimuth">The azimuth value of the satellite in degrees.</param>
95             <param name="elevation">The elevation of the satellite in meters.</param>
96             <param name="prn">The PRN value of the satellite.</param>
97             <param name="snr">The SNR value of the satellite in dB.</param>
98             <param name="active">The flag signaling if the satellite is in use.</param>
99         </member>
100         <member name="P:Tizen.Location.SatelliteInformation.Azimuth">
101             <summary>
102             The azimuth information of the satellite.
103             </summary>
104             <since_tizen> 3 </since_tizen>
105             <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
106         </member>
107         <member name="P:Tizen.Location.SatelliteInformation.Elevation">
108             <summary>
109             The elevation information of the satellite.
110             </summary>
111             <since_tizen> 3 </since_tizen>
112             <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
113         </member>
114         <member name="P:Tizen.Location.SatelliteInformation.Prn">
115             <summary>
116             The PRN of the satellite.
117             </summary>
118             <since_tizen> 3 </since_tizen>
119             <param name="azimuth"> The azimuth value of the satellite in degrees.</param>
120         </member>
121         <member name="P:Tizen.Location.SatelliteInformation.Snr">
122             <summary>
123             The SNR of the satellite.
124             </summary>
125             <since_tizen> 3 </since_tizen>
126         </member>
127         <member name="P:Tizen.Location.SatelliteInformation.Active">
128             <summary>
129             The operational status of the satellite.
130             </summary>
131             <since_tizen> 3 </since_tizen>
132         </member>
133         <member name="T:Tizen.Location.Location">
134             <summary>
135             This class contains details of the location requested.
136             Includes the functionality to get the distance between locations.
137             </summary>
138             <since_tizen> 3 </since_tizen>
139         </member>
140         <member name="M:Tizen.Location.Location.#ctor">
141             <summary>
142             The default constructor of the Location class.
143             </summary>
144             <since_tizen> 3 </since_tizen>
145         </member>
146         <member name="M:Tizen.Location.Location.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Int32)">
147             <summary>
148             The parameterized constructor of the Location class.
149             </summary>
150             <since_tizen> 3 </since_tizen>
151             <param name="latitude">The latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees).</param>
152             <param name="longitude">The longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees).</param>
153             <param name="altitude">The altitude value.</param>
154             <param name="accuracy">The accuracy in meters.</param>
155             <param name="speed">The device speed.</param>
156             <param name="direction">The device direction with respect to the north.</param>
157             <param name="timestamp"> Time when the measurement took place.</param>
158             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
159         </member>
160         <member name="P:Tizen.Location.Location.Latitude">
161             <summary>
162             The current latitude [-90.0 ~ 90.0] (degrees).
163             </summary>
164             <since_tizen> 3 </since_tizen>
165         </member>
166         <member name="P:Tizen.Location.Location.Longitude">
167             <summary>
168             The current longitude [-180.0 ~ 180.0] (degrees).
169             </summary>
170             <since_tizen> 3 </since_tizen>
171         </member>
172         <member name="P:Tizen.Location.Location.Altitude">
173             <summary>
174             The current altitude (meters).
175             </summary>
176             <since_tizen> 3 </since_tizen>
177         </member>
178         <member name="P:Tizen.Location.Location.Speed">
179             <summary>
180             The device speed (km/h).
181             </summary>
182             <since_tizen> 3 </since_tizen>
183         </member>
184         <member name="P:Tizen.Location.Location.Direction">
185             <summary>
186             The direction and degrees from the north.
187             </summary>
188             <since_tizen> 3 </since_tizen>
189         </member>
190         <member name="P:Tizen.Location.Location.Accuracy">
191             <summary>
192             The accuracy.
193             </summary>
194             <since_tizen> 3 </since_tizen>
195         </member>
196         <member name="P:Tizen.Location.Location.Timestamp">
197             <summary>
198             The time value when the measurement was done.
199             </summary>
200             <since_tizen> 3 </since_tizen>
201         </member>
202         <member name="M:Tizen.Location.Location.GetDistanceBetween(System.Double,System.Double,System.Double,System.Double)">
203             <summary>
204             Gets the distance between the two given coordinates.
205             </summary>
206             <since_tizen> 3 </since_tizen>
207             <param name="startLatitude">The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
208             <param name="startLongitude">The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
209             <param name="endLatitude">The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
210             <param name="endLongitude">The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
211             <returns>Returns the distance between the source and the destination.</returns>
212             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
213             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
214         </member>
215         <member name="M:Tizen.Location.Location.GetDistanceTo(Tizen.Location.Location)">
216             <summary>
217             Gets the distance between the current and the specified location.
218             </summary>
219             <since_tizen> 3 </since_tizen>
220             <param name="location"> The location object to which distance is to be calculated.</param>
221             <returns>Returns the distance to the specified location.</returns>
222             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
223             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
224         </member>
225         <member name="T:Tizen.Location.LocationBoundary">
226             <summary>
227             The LocationBoundary class is an abstract class that provides functions related to the geographic bounds information.
228             </summary>
229             <since_tizen> 3 </since_tizen>
230         </member>
231         <member name="P:Tizen.Location.LocationBoundary.BoundaryType">
232             <summary>
233             Gets the location boundary type.
234             </summary>
235             <since_tizen> 3 </since_tizen>
236         </member>
237         <member name="M:Tizen.Location.LocationBoundary.Finalize">
238             <summary>
239             The destructor of the LocationBoundary class.
240             </summary>
241             <since_tizen> 3 </since_tizen>
242         </member>
243         <member name="M:Tizen.Location.LocationBoundary.BoundaryContainsCoordinates(Tizen.Location.Coordinate)">
244             <summary>
245             Checks if the boundary contains the specified geographical coordinates.
246             </summary>
247             <since_tizen> 3 </since_tizen>
248             <param name="coordinate"> The coordinate which needs to be checked.</param>
249             <returns>Returns a boolean value indicating whether or not the specified coordinate lies in the geographical area.</returns>
250         </member>
251         <member name="M:Tizen.Location.LocationBoundary.Dispose">
252             <summary>
253             The overidden Dispose method of the IDisposable class.
254             </summary>
255             <since_tizen> 3 </since_tizen>
256             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
257             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
258         </member>
259         <member name="T:Tizen.Location.RectangleBoundary">
260             <summary>
261             This class represents a rectangular location boundary.
262             Inherits the Abstract LocationBoundary class.
263             </summary>
264             <since_tizen> 3 </since_tizen>
265         </member>
266         <member name="M:Tizen.Location.RectangleBoundary.#ctor(Tizen.Location.Coordinate,Tizen.Location.Coordinate)">
267             <summary>
268             The constructor of the Rectangle boundary class.
269             </summary>
270             <since_tizen> 3 </since_tizen>
271             <param name="topLeft"> The coordinate which constitutes the top-left handside of the rectangular boundary.</param>
272             <param name="bottomRight"> The coordinate which constitutes the bottom-right handside of the rectangular boundary.</param>
273             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
274             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
275             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
276         </member>
277         <member name="P:Tizen.Location.RectangleBoundary.TopLeft">
278             <summary>
279             Gets the top-left handside coordinate of a rectangular boundary.
280             </summary>
281             <since_tizen> 3 </since_tizen>
282         </member>
283         <member name="P:Tizen.Location.RectangleBoundary.BottomRight">
284             <summary>
285             Gets the bottom-right handside coordinate of a rectangular boundary.
286             </summary>
287             <since_tizen> 3 </since_tizen>
288         </member>
289         <member name="T:Tizen.Location.CircleBoundary">
290             <summary>
291             This class represents a circular location boundary.
292             Inherits the Abstract LocationBoundary class.
293             </summary>
294             <since_tizen> 3 </since_tizen>
295         </member>
296         <member name="M:Tizen.Location.CircleBoundary.#ctor(Tizen.Location.Coordinate,System.Double)">
297             <summary>
298             The constructor of the Circular boundary class.
299             </summary>
300             <since_tizen> 3 </since_tizen>
301             <param name="coordinate"> The coordinates which constitute the center of the circular boundary.</param>
302             <param name="radius"> The radius value of the circular boundary.</param>
303             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
304             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
305             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
306         </member>
307         <member name="P:Tizen.Location.CircleBoundary.Center">
308             <summary>
309             Gets the coordinate of the center of a circular boundary.
310             </summary>
311             <since_tizen> 3 </since_tizen>
312             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
313             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
314             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
315         </member>
316         <member name="P:Tizen.Location.CircleBoundary.Radius">
317             <summary>
318             Gets the radius of a circular boundary.
319             </summary>
320             <since_tizen> 3 </since_tizen>
321             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
322             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
323             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
324         </member>
325         <member name="T:Tizen.Location.PolygonBoundary">
326             <summary>
327             This class represents a polygonal location boundary.
328             Inherits the Abstract LocationBoundary class.
329             </summary>
330             <since_tizen> 3 </since_tizen>
331         </member>
332         <member name="M:Tizen.Location.PolygonBoundary.#ctor(System.Collections.Generic.IList{Tizen.Location.Coordinate})">
333             <summary>
334             The constructor of the Polygon Boundary class.
335             </summary>
336             <since_tizen> 3 </since_tizen>
337             <param name="coordinates"> The coordinates which constitute the polgonal boundary.</param>
338             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
339             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
340             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
341         </member>
342         <member name="P:Tizen.Location.PolygonBoundary.Coordinates">
343             <summary>
344             Gets the list of coordinates which constitute a polygonal boundary.
345             </summary>
346             <since_tizen> 3 </since_tizen>
347             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
348             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
349             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
350         </member>
351         <member name="T:Tizen.Location.Coordinate">
352             <summary>
353             This structure represents the coordinates of a geographical location.
354             </summary>
355             <since_tizen> 3 </since_tizen>
356         </member>
357         <member name="F:Tizen.Location.Coordinate.Latitude">
358             <summary>
359             Latitude component of the coordinate.
360             Should have a value between [-90.0 ~ 90.0] (degrees).
361             </summary>
362             <since_tizen> 3 </since_tizen>
363         </member>
364         <member name="F:Tizen.Location.Coordinate.Longitude">
365             <summary>
366             Longitude component of the coordinate.
367             Should have a value between [-180.0 ~ 180.0] (degrees).
368             </summary>
369             <since_tizen> 3 </since_tizen>
370         </member>
371         <member name="T:Tizen.Location.LocationChangedEventArgs">
372             <summary>
373             An extended EventArgs class which contains the changed location information.
374             </summary>
375             <since_tizen> 3 </since_tizen>
376         </member>
377         <member name="M:Tizen.Location.LocationChangedEventArgs.#ctor(Tizen.Location.Location)">
378             <summary>
379             The class constructor for the LocationUpdatedEventArgs class.
380             </summary>
381             <since_tizen> 3 </since_tizen>
382             <param name="location"> Object of the Location class.</param>
383         </member>
384         <member name="P:Tizen.Location.LocationChangedEventArgs.Location">
385             <summary>
386             Gets the location update information.
387             </summary>
388             <since_tizen> 3 </since_tizen>
389         </member>
390         <member name="T:Tizen.Location.LocationError">
391             <summary>
392             Location Manager error codes.
393             </summary>
394             <since_tizen> 3 </since_tizen>
395         </member>
396         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.OutOfMemory" -->
397         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.InvalidParameter" -->
398         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.AcessibilityNotallowed" -->
399         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.NotSupported" -->
400         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.IncorrectMethod" -->
401         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.NetworkFailed" -->
402         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.ServiceNotAvailable" -->
403         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.SettingOff" -->
404         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationError.SecuirtyRestricted" -->
405         <member name="T:Tizen.Location.LocationBoundError">
406             <summary>
407             Location Boundary error codes.
408             </summary>
409             <since_tizen> 3 </since_tizen>
410         </member>
411         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationBoundError.OutOfMemory" -->
412         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationBoundError.InvalidParameter" -->
413         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationBoundError.NotSupported" -->
414         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationBoundError.IncorrectType" -->
415         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationBoundError.IsAdded" -->
416         <member name="T:Tizen.Location.Locator">
417             <summary>
418             This class contains the functionality for obtaining the geographical infomation and setting the boundary condition.
419             Notifications on events like service becoming enabled or disabled, new position data being available,
420             and others can also be acquired.
421             </summary>
422             <since_tizen> 3 </since_tizen>
423         </member>
424         <member name="M:Tizen.Location.Locator.#ctor(Tizen.Location.LocationType)">
425             <summary>
426             The constructor of the Locator class.
427             </summary>
428             <since_tizen> 3 </since_tizen>
429             <param name="locationType"> The back-end positioning method to be used for LBS.</param>
430             <feature>http://tizen.org/feature/location</feature>
431             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
432             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
433             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
434         </member>
435         <member name="M:Tizen.Location.Locator.Finalize">
436             <summary>
437             The destructor of the Locator class.
438             </summary>
439             <since_tizen> 3 </since_tizen>
440         </member>
441         <member name="P:Tizen.Location.Locator.Interval">
442             <summary>
443             The time interval between callback updates.
444             Should be in the range of 1~120 seconds.
445             </summary>
446             <since_tizen> 3 </since_tizen>
447             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
448         </member>
449         <member name="P:Tizen.Location.Locator.StayInterval">
450             <summary>
451             The time interval between the distance-based location callback updates.
452             Should be in the range of 1~120 seconds.
453             </summary>
454             <since_tizen> 3 </since_tizen>
455             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
456         </member>
457         <member name="P:Tizen.Location.Locator.BatchInterval">
458             <summary>
459             The time interval between the position collection in batch mode.
460             Should be in the range of 1~255 seconds.
461             </summary>
462             <since_tizen> 3 </since_tizen>
463             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
464         </member>
465         <member name="P:Tizen.Location.Locator.BatchPeriod">
466             <summary>
467             The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If the BatchPeriod is zero or smaller than the BatchInterval, then the batch mode will not work. In addition, sometimes the period may not work as you intended, the maximum permissible value for the batch period is device specific.
468             Should be in the range of 0~60000 seconds.
469             </summary>
470             <since_tizen> 3 </since_tizen>
471             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
472         </member>
473         <member name="P:Tizen.Location.Locator.Distance">
474             <summary>
475             The distance between callback updates.
476             Should be in the range of 1-120 meters.
477             </summary>
478             <since_tizen> 3 </since_tizen>
479             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
480         </member>
481         <member name="P:Tizen.Location.Locator.Location">
482             <summary>
483             Gets the location object.
484             </summary>
485             <since_tizen> 3 </since_tizen>
486         </member>
487         <member name="P:Tizen.Location.Locator.LocationType">
488             <summary>
489             Gets the type used to obtain the location data.
490             </summary>
491             <since_tizen> 3 </since_tizen>
492         </member>
493         <member name="P:Tizen.Location.Locator.EnableMock">
494             <summary>
495             Gets the status whether the mock location is enabled or not.
496             </summary>
497             <since_tizen> 3 </since_tizen>
498             <privilege>http://tizen.org/privilege/location</privilege>
499             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
500             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
501         </member>
502         <member name="M:Tizen.Location.Locator.Start">
503             <summary>
504             Starts the Location Manager which has been created using the specified method.
505             </summary>
506             <since_tizen> 3 </since_tizen>
507             <privilege>http://tizen.org/privilege/location</privilege>
508             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
509             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
510             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
511             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
512         </member>
513         <member name="M:Tizen.Location.Locator.Stop">
514             <summary>
515             Stops the Location Manager which has been activated using the specified method.
516             Does not destroy the manager.
517             </summary>
518             <since_tizen> 3 </since_tizen>
519             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
520             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
521             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
522         </member>
523         <member name="M:Tizen.Location.Locator.SetMockLocation(Tizen.Location.Location)">
524             <summary>
525             Sets a mock location for the given location method.
526             </summary>
527             <since_tizen> 3 </since_tizen>
528             <param name="location"> The location object containing the mock location details.</param>
529             <privilege>http://tizen.org/privilege/location</privilege>
530             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
531             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
532             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
533             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
534         </member>
535         <member name="M:Tizen.Location.Locator.ClearMock">
536             <summary>
537             Clears a mock location for the given location method.
538             </summary>
539             <since_tizen> 3 </since_tizen>
540             <privilege>http://tizen.org/privilege/location</privilege>
541             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
542             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
543             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
544             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
545         </member>
546         <member name="M:Tizen.Location.Locator.GetLocationAsync(System.Int32)">
547             <summary>
548             Gets the details of the location asynchronously.
549             </summary>
550             <since_tizen> 3 </since_tizen>
551             <param name="timeout"> Timeout to stop requesting a single location after (seconds).</param>
552             <returns> A task which contains the current location details.</returns>
553             <privilege>http://tizen.org/privilege/location</privilege>
554             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
555             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
556             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
557             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
558         </member>
559         <member name="M:Tizen.Location.Locator.GetLocation">
560             <summary>
561             Gets the details of the location.
562             </summary>
563             <since_tizen> 3 </since_tizen>
564             <returns> Which contains the current location details.</returns>
565             <privilege>http://tizen.org/privilege/location</privilege>
566             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
567             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
568             <exception cref="!:UnauthroizedAccessException">Thrown when the application has no privilege to use the location.</exception>
569             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
570         </member>
571         <member name="M:Tizen.Location.Locator.AddBoundary(Tizen.Location.LocationBoundary)">
572             <summary>
573             Adds a bound for a given locator.
574             </summary>
575             <since_tizen> 3 </since_tizen>
576             <param name="locationBoundary">The boundary object to be added to the locator.</param>
577             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
578             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
579             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
580         </member>
581         <member name="M:Tizen.Location.Locator.RemoveBoundary(Tizen.Location.LocationBoundary)">
582             <summary>
583             Deletes a bound for a given locator.
584             </summary>
585             <since_tizen> 3 </since_tizen>
586             <param name="locationBoundary"> The boundary object to be removed from the locator.</param>
587             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
588             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
589             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
590         </member>
591         <member name="M:Tizen.Location.Locator.Dispose">
592             <summary>
593             The overidden Dispose method of the IDisposable class.
594             </summary>
595             <since_tizen> 3 </since_tizen>
596             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
597         </member>
598         <member name="E:Tizen.Location.Locator.ServiceStateChanged">
599             <summary>
600             The ServiceStateChanged event is invoked when the location service state is changed.
601             </summary>
602             <since_tizen> 3 </since_tizen>
603             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
604             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
605         </member>
606         <member name="E:Tizen.Location.Locator.ZoneChanged">
607             <summary>
608             The ZoneChanged event is invoked when the previously set boundary area is entered or left.
609             </summary>
610             <since_tizen> 3 </since_tizen>
611             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
612             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
613         </member>
614         <member name="E:Tizen.Location.Locator.SettingChanged">
615             <summary>
616             The SetttingChanged event is raised when the location setting is changed.
617             </summary>
618             <since_tizen> 3 </since_tizen>
619             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
620             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
621             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
622         </member>
623         <member name="E:Tizen.Location.Locator.DistanceBasedLocationChanged">
624             <summary>
625             The DistanceBasedLocationChanged event is raised with the updated location information.
626             The callback will be invoked at a minimum interval or minimum distance with the updated position information.
627             </summary>
628             <since_tizen> 3 </since_tizen>
629             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
630             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
631         </member>
632         <member name="E:Tizen.Location.Locator.LocationChanged">
633             <summary>
634             The LocationUpdated event is raised at defined intervals of time with the updated location information.
635             The callback will be invoked periodically.
636             </summary>
637             <since_tizen> 3 </since_tizen>
638             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
639             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
640         </member>
641         <member name="T:Tizen.Location.ServiceState">
642             <summary>
643             Enumeration for the state of the location service.
644             </summary>
645             <since_tizen> 3 </since_tizen>
646         </member>
647         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.ServiceState.Enabled" -->
648         <member name="T:Tizen.Location.LocationType">
649             <summary>
650             Enumeration for the type of connection used in acquiring the location data.
651             </summary>
652             <since_tizen> 3 </since_tizen>
653         </member>
654         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationType.Gps" -->
655         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationType.Wps" -->
656         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.LocationType.Passive" -->
657         <member name="T:Tizen.Location.BoundaryType">
658             <summary>
659             Enumeration for the created boundary type.
660             </summary>
661             <since_tizen> 3 </since_tizen>
662         </member>
663         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.BoundaryType.Circle" -->
664         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.BoundaryType.Polygon" -->
665         <member name="T:Tizen.Location.BoundaryState">
666             <summary>
667             Enumeration for the error code for location manager.
668             </summary>
669             <since_tizen> 3 </since_tizen>
670         </member>
671         <!-- Badly formed XML comment ignored for member "F:Tizen.Location.BoundaryState.Out" -->
672         <member name="M:Tizen.Location.LocatorHelper.IsSupportedType(Tizen.Location.LocationType)">
673             <summary>
674             Checks if the specified geographical positioning type is supported or not.
675             </summary>
676             <since_tizen> 3 </since_tizen>
677             <param name="locationType">The back-end positioning method to be used for LBS.</param>
678             <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
679         </member>
680         <member name="M:Tizen.Location.LocatorHelper.IsEnabledType(Tizen.Location.LocationType)">
681             <summary>
682             Checks if the specified geographical positioning type is enabled or not.
683             </summary>
684             <since_tizen> 3 </since_tizen>
685             <param name="locationType">The back-end positioning method to be used for LBS.</param>
686             <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
687             <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
688             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>
689             <exception cref="T:System.NotSupportedException">Thrown when the location is not supported.</exception>
690         </member>
691         <member name="M:Tizen.Location.SatelliteStatusChangedEventArgs.#ctor(System.UInt32,System.UInt32,System.DateTime)">
692             <summary>
693             The class constructor for the SatelliteStatusChangedEventArgs class.
694             </summary>
695             <since_tizen> 3 </since_tizen>
696             <param name="activeCount">The number of active satellites.</param>
697             <param name="inviewCount">The number of satellites in view.</param>
698             <param name="timestamp">The time at which the data has been extracted.</param>
699         </member>
700         <member name="P:Tizen.Location.SatelliteStatusChangedEventArgs.ActiveCount">
701             <summary>
702             Gets the number of active satellites.
703             </summary>
704             <since_tizen> 3 </since_tizen>
705         </member>
706         <member name="P:Tizen.Location.SatelliteStatusChangedEventArgs.InViewCount">
707             <summary>
708             Gets the number of satellites in view.
709             </summary>
710             <since_tizen> 3 </since_tizen>
711         </member>
712         <member name="P:Tizen.Location.SatelliteStatusChangedEventArgs.Timestamp">
713             <summary>
714             Get the timestamp.
715             </summary>
716             <since_tizen> 3 </since_tizen>
717         </member>
718         <member name="T:Tizen.Location.ServiceStateChangedEventArgs">
719             <summary>
720             An extended EventArgs class contains the changed location service state.
721             </summary>
722         </member>
723         <member name="M:Tizen.Location.ServiceStateChangedEventArgs.#ctor(Tizen.Location.ServiceState)">
724             <summary>
725             The class constructor for the ServiceStateChangedEventArgs class.
726             </summary>
727             <since_tizen> 3 </since_tizen>
728             <param name="state"> An enumeration of type LocationServiceState.</param>
729         </member>
730         <member name="P:Tizen.Location.ServiceStateChangedEventArgs.ServiceState">
731             <summary>
732             Get the service state.
733             </summary>
734             <since_tizen> 3 </since_tizen>
735         </member>
736         <member name="M:Tizen.Location.SettingChangedEventArgs.#ctor(Tizen.Location.LocationType,System.Boolean)">
737             <summary>
738             The class constructor for the SettingChangedEventArgs class.
739             </summary>
740             <since_tizen> 3 </since_tizen>
741             <param name="method">The positioing method used for the location information.</param>
742             <param name="enable">The status of the method.</param>
743         </member>
744         <member name="P:Tizen.Location.SettingChangedEventArgs.LocationType">
745             <summary>
746             Gets the currently used location method.
747             </summary>
748             <since_tizen> 3 </since_tizen>
749         </member>
750         <member name="P:Tizen.Location.SettingChangedEventArgs.IsEnabled">
751             <summary>
752             Method to get the setting value changed.
753             </summary>
754             <since_tizen> 3 </since_tizen>
755         </member>
756         <member name="M:Tizen.Location.ZoneChangedEventArgs.#ctor(Tizen.Location.BoundaryState,System.Double,System.Double,System.Double,System.DateTime)">
757             <summary>
758             The class constructor for the ZoneChangedEventArgs class.
759             </summary>
760             <since_tizen> 3 </since_tizen>
761             <param name="state"> An enumeration of type BoundaryState.</param>
762             <param name="latitude">The latitude value [-90.0 ~ 90.0] (degrees).</param>
763             <param name="longitude">The longitude value [-180.0 ~ 180.0] (degrees).</param>
764             <param name="altitude"> The altitude value.</param>
765             <param name="timestamp"> The timestamp value.</param>
766         </member>
767         <member name="P:Tizen.Location.ZoneChangedEventArgs.BoundState">
768             <summary>
769             Gets the boundary state.
770             </summary>
771             <since_tizen>3</since_tizen>
772         </member>
773         <member name="P:Tizen.Location.ZoneChangedEventArgs.Latitude">
774             <summary>
775             Gets the latitude.
776             </summary>
777             <since_tizen> 3 </since_tizen>
778         </member>
779         <member name="P:Tizen.Location.ZoneChangedEventArgs.Longitude">
780             <summary>
781             Gets the longitude.
782             </summary>
783             <since_tizen>3</since_tizen>
784         </member>
785         <member name="P:Tizen.Location.ZoneChangedEventArgs.Altitude">
786             <summary>
787             Gets the altitude.
788             </summary>
789             <since_tizen> 3 </since_tizen>
790         </member>
791         <member name="P:Tizen.Location.ZoneChangedEventArgs.Timestamp">
792             <summary>
793             Method to get the timestamp.
794             </summary>
795             <since_tizen> 3 </since_tizen>
796         </member>
797     </members>
798 </doc>