Release 4.0.0-preview1-00213
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Location.Geofence.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Location.Geofence</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Tizen.Location.Geofence.Fence">\r
8             <summary>\r
9             Geofence defines a virtual perimeter for a real-world geographic area.\r
10             If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you.\r
11             You can create a geofence with the information of the Geopoint, Wi-Fi, or BT.\r
12             <list>\r
13             <item>Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius.</item>\r
14             <item>WIFI: Geofence is specified by the BSSID of the Wi-Fi access point.</item>\r
15             <item>BT: Geofence is specified by the Bluetooth address.</item>\r
16             </list>\r
17             The Basic service set identifier (BSSID) is the MAC address of the wireless access point (WAP) generated by combining the 24-bit Organization Unique Identifier (the manufacturer's identity)\r
18             and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP.\r
19             </summary>\r
20             <since_tizen> 3 </since_tizen>\r
21         </member>\r
22         <member name="P:Tizen.Location.Geofence.Fence.Type">\r
23             <summary>\r
24             Gets the type of geofence.\r
25             </summary>\r
26             <since_tizen> 3 </since_tizen>\r
27         </member>\r
28         <member name="P:Tizen.Location.Geofence.Fence.PlaceId">\r
29             <summary>\r
30             Gets the ID of the place.\r
31             </summary>\r
32             <since_tizen> 3 </since_tizen>\r
33         </member>\r
34         <member name="P:Tizen.Location.Geofence.Fence.Longitude">\r
35             <summary>\r
36             Gets the longitude of geofence.\r
37             </summary>\r
38             <since_tizen> 3 </since_tizen>\r
39         </member>\r
40         <member name="P:Tizen.Location.Geofence.Fence.Latitude">\r
41             <summary>\r
42             Gets the latitude of geofence.\r
43             </summary>\r
44             <since_tizen> 3 </since_tizen>\r
45         </member>\r
46         <member name="P:Tizen.Location.Geofence.Fence.Radius">\r
47             <summary>\r
48             Gets the radius of geofence.\r
49             </summary>\r
50             <since_tizen> 3 </since_tizen>\r
51         </member>\r
52         <member name="P:Tizen.Location.Geofence.Fence.Address">\r
53             <summary>\r
54             Gets the address of geofence.\r
55             </summary>\r
56             <since_tizen> 3 </since_tizen>\r
57         </member>\r
58         <member name="P:Tizen.Location.Geofence.Fence.Bssid">\r
59             <summary>\r
60             Gets the BSSID of geofence.\r
61             </summary>\r
62             <since_tizen> 3 </since_tizen>\r
63         </member>\r
64         <member name="P:Tizen.Location.Geofence.Fence.Ssid">\r
65             <summary>\r
66             Gets the SSID of geofence.\r
67             </summary>\r
68             <since_tizen> 3 </since_tizen>\r
69         </member>\r
70         <member name="M:Tizen.Location.Geofence.Fence.CreateGPSFence(System.Int32,System.Double,System.Double,System.Int32,System.String)">\r
71             <summary>\r
72             Creates a geopoint type of the new geofence.\r
73             </summary>\r
74             <since_tizen> 4 </since_tizen>\r
75             <param name="placeId">The current place ID.</param>\r
76             <param name="latitude">Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees).</param>\r
77             <param name="longitude">Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees).</param>\r
78             <param name="radius">Specifies the value of radius of the geofence [100 ~ 500](meter).</param>\r
79             <param name="address">Specifies the value of the address.</param>\r
80             <returns>The newly created geofence instance.</returns>\r
81             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
82             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
83             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
84         </member>\r
85         <member name="M:Tizen.Location.Geofence.Fence.CreateWifiFence(System.Int32,System.String,System.String)">\r
86             <summary>\r
87             Creates a Wi-Fi type of the new geofence.\r
88             </summary>\r
89             <since_tizen> 3 </since_tizen>\r
90             <param name="placeId">The current place ID.</param>\r
91             <param name="bssid">Specifies the value of BSSID of the Wi-Fi MAC address.</param>\r
92             <param name="ssid"> Specifies the value of SSID of the Wi-Fi device.</param>\r
93             <returns>The newly created geofence instance.</returns>\r
94             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
95             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
96             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
97         </member>\r
98         <member name="M:Tizen.Location.Geofence.Fence.CreateBTFence(System.Int32,System.String,System.String)">\r
99             <summary>\r
100             Creates a Bluetooth type of the new geofence.\r
101             </summary>\r
102             <since_tizen> 3 </since_tizen>\r
103             <param name="placeId">The current place ID.</param>\r
104             <param name="bssid">Specifies the value of BSSID of BT MAC address.</param>\r
105             <param name="ssid"> Specifies the value of SSID of BT Device.</param>\r
106             <returns>The newly created geofence instance.</returns>\r
107             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
108             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
109             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
110         </member>\r
111         <member name="M:Tizen.Location.Geofence.Fence.Dispose">\r
112             <summary>\r
113             The overloaded Dispose API for destroying the fence handle.\r
114             </summary>\r
115             <since_tizen> 3 </since_tizen>\r
116         </member>\r
117         <member name="T:Tizen.Location.Geofence.FenceData">\r
118             <summary>\r
119             Represents the geofence list item data.\r
120             </summary>\r
121             <since_tizen> 3 </since_tizen>\r
122         </member>\r
123         <member name="P:Tizen.Location.Geofence.FenceData.Fence">\r
124             <summary>\r
125             The geofence instance.\r
126             </summary>\r
127             <since_tizen> 3 </since_tizen>\r
128         </member>\r
129         <member name="P:Tizen.Location.Geofence.FenceData.GeofenceId">\r
130             <summary>\r
131             The geofence ID.\r
132             </summary>\r
133             <since_tizen> 3 </since_tizen>\r
134         </member>\r
135         <member name="P:Tizen.Location.Geofence.FenceData.Index">\r
136             <summary>\r
137             The index number of fences in the list.\r
138             </summary>\r
139             <since_tizen> 3 </since_tizen>\r
140             <value>The index value starts from 1.</value>\r
141         </member>\r
142         <member name="P:Tizen.Location.Geofence.FenceData.Count">\r
143             <summary>\r
144             The total number of fences that exists for the requester.\r
145             </summary>\r
146             <since_tizen> 3 </since_tizen>\r
147         </member>\r
148         <member name="T:Tizen.Location.Geofence.PlaceData">\r
149             <summary>\r
150             Represents the place list item data.\r
151             </summary>\r
152             <since_tizen> 3 </since_tizen>\r
153         </member>\r
154         <member name="P:Tizen.Location.Geofence.PlaceData.PlaceId">\r
155             <summary>\r
156             The current place ID.\r
157             </summary>\r
158             <since_tizen> 3 </since_tizen>\r
159         </member>\r
160         <member name="P:Tizen.Location.Geofence.PlaceData.Name">\r
161             <summary>\r
162             The current place name.\r
163             </summary>\r
164             <since_tizen> 3 </since_tizen>\r
165         </member>\r
166         <member name="P:Tizen.Location.Geofence.PlaceData.Index">\r
167             <summary>\r
168             The index number of places in the list.\r
169             </summary>\r
170             <since_tizen> 3 </since_tizen>\r
171             <value>The index value starts from 1.</value>\r
172         </member>\r
173         <member name="P:Tizen.Location.Geofence.PlaceData.Count">\r
174             <summary>\r
175             The total number of places that exists for the requester.\r
176             </summary>\r
177             <since_tizen> 3 </since_tizen>\r
178         </member>\r
179         <member name="T:Tizen.Location.Geofence.FenceStatus">\r
180             <summary>\r
181             The geofence status describes the current state and duration of a geofence.\r
182             <list>\r
183             <item>State: The state is specified by the current state of the fence.</item>\r
184             <item>Duration: Geofence is specified by the duration of the current state.</item>\r
185             </list>\r
186             </summary>\r
187             <since_tizen> 3 </since_tizen>\r
188         </member>\r
189         <member name="M:Tizen.Location.Geofence.FenceStatus.#ctor(System.Int32)">\r
190             <summary>\r
191             Creates a new geofence status.\r
192             </summary>\r
193             <since_tizen> 3 </since_tizen>\r
194             <param name="fenceId">The geofence ID.</param>\r
195             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
196             <exception cref="T:System.NotSupportedException">In case of geofence is not supported.</exception>\r
197         </member>\r
198         <member name="P:Tizen.Location.Geofence.FenceStatus.State">\r
199             <summary>\r
200             Gets the state of geofence.\r
201             </summary>\r
202             <since_tizen> 3 </since_tizen>\r
203             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
204         </member>\r
205         <member name="P:Tizen.Location.Geofence.FenceStatus.Duration">\r
206             <summary>\r
207             Gets the amount of seconds, the geofence is in the current state.\r
208             </summary>\r
209             <since_tizen> 3 </since_tizen>\r
210             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
211         </member>\r
212         <member name="M:Tizen.Location.Geofence.FenceStatus.Dispose">\r
213             <summary>\r
214             The overloaded Dispose API for destroying the fence handle.\r
215             </summary>\r
216             <since_tizen> 3 </since_tizen>\r
217         </member>\r
218         <member name="T:Tizen.Location.Geofence.FenceType">\r
219             <summary>\r
220             Enumeration for the geofence types.\r
221             </summary>\r
222             <since_tizen> 3 </since_tizen>\r
223         </member>\r
224         <member name="F:Tizen.Location.Geofence.FenceType.GeoPoint">\r
225             <summary>\r
226             Geofence is specified by the geospatial coordinate.\r
227             </summary>\r
228             <since_tizen> 3 </since_tizen>\r
229         </member>\r
230         <member name="F:Tizen.Location.Geofence.FenceType.Wifi">\r
231             <summary>\r
232             Geofence is specified by the Wi-Fi access point.\r
233             </summary>\r
234             <since_tizen> 3 </since_tizen>\r
235         </member>\r
236         <member name="F:Tizen.Location.Geofence.FenceType.Bluetooth">\r
237             <summary>\r
238             Geofence is specified by the Bluetooth device.\r
239             </summary>\r
240             <since_tizen> 3 </since_tizen>\r
241         </member>\r
242         <member name="T:Tizen.Location.Geofence.GeofenceState">\r
243             <summary>\r
244             Enumeration for the state of geofence.\r
245             </summary>\r
246             <since_tizen> 3 </since_tizen>\r
247         </member>\r
248         <member name="F:Tizen.Location.Geofence.GeofenceState.Uncertain">\r
249             <summary>\r
250             Uncertain state of geofence.\r
251             </summary>\r
252             <since_tizen> 3 </since_tizen>\r
253         </member>\r
254         <member name="F:Tizen.Location.Geofence.GeofenceState.In">\r
255             <summary>\r
256             Geofence In state.\r
257             </summary>\r
258             <since_tizen> 3 </since_tizen>\r
259         </member>\r
260         <member name="F:Tizen.Location.Geofence.GeofenceState.Out">\r
261             <summary>\r
262             Geofence Out state.\r
263             </summary>\r
264             <since_tizen> 3 </since_tizen>\r
265         </member>\r
266         <member name="T:Tizen.Location.Geofence.GeofenceEventType">\r
267             <summary>\r
268             Enumeration for the geofence management events.\r
269             </summary>\r
270             <since_tizen> 3 </since_tizen>\r
271         </member>\r
272         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceAdded">\r
273             <summary>\r
274             Geofence is added.\r
275             </summary>\r
276             <since_tizen> 3 </since_tizen>\r
277         </member>\r
278         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceRemoved">\r
279             <summary>\r
280             Geofence is removed.\r
281             </summary>\r
282             <since_tizen> 3 </since_tizen>\r
283         </member>\r
284         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStarted">\r
285             <summary>\r
286             Geofencing is started.\r
287             </summary>\r
288             <since_tizen> 3 </since_tizen>\r
289         </member>\r
290         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStopped">\r
291             <summary>\r
292             Geofencing is stopped.\r
293             </summary>\r
294             <since_tizen> 3 </since_tizen>\r
295         </member>\r
296         <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceAdded">\r
297             <summary>\r
298             Place is added.\r
299             </summary>\r
300             <since_tizen> 3 </since_tizen>\r
301         </member>\r
302         <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceRemoved">\r
303             <summary>\r
304             Place is removed.\r
305             </summary>\r
306             <since_tizen> 3 </since_tizen>\r
307         </member>\r
308         <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceUpdated">\r
309             <summary>\r
310             Place is updated.\r
311             </summary>\r
312             <since_tizen> 3 </since_tizen>\r
313         </member>\r
314         <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingEnabled">\r
315             <summary>\r
316             Setting for geofencing is enabled.\r
317             </summary>\r
318             <since_tizen> 3 </since_tizen>\r
319         </member>\r
320         <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingDisabled">\r
321             <summary>\r
322             Setting for geofencing is disabled.\r
323             </summary>\r
324             <since_tizen> 3 </since_tizen>\r
325         </member>\r
326         <member name="T:Tizen.Location.Geofence.ProximityProvider">\r
327             <summary>\r
328             Enumeration for the provider of proximity.\r
329             </summary>\r
330             <since_tizen> 3 </since_tizen>\r
331         </member>\r
332         <member name="F:Tizen.Location.Geofence.ProximityProvider.Location">\r
333             <summary>\r
334             Proximity is specified by the geospatial coordinate.\r
335             </summary>\r
336             <since_tizen> 3 </since_tizen>\r
337         </member>\r
338         <member name="F:Tizen.Location.Geofence.ProximityProvider.Wifi">\r
339             <summary>\r
340             Proximity is specified by the Wi-Fi access point.\r
341             </summary>\r
342             <since_tizen> 3 </since_tizen>\r
343         </member>\r
344         <member name="F:Tizen.Location.Geofence.ProximityProvider.Bluetooth">\r
345             <summary>\r
346             Proximity is specified by the Bluetooth device.\r
347             </summary>\r
348             <since_tizen> 3 </since_tizen>\r
349         </member>\r
350         <member name="F:Tizen.Location.Geofence.ProximityProvider.BLE">\r
351             <summary>\r
352             Proximity is specified by the Bluetooth low-energy device.\r
353             </summary>\r
354             <since_tizen> 3 </since_tizen>\r
355         </member>\r
356         <member name="F:Tizen.Location.Geofence.ProximityProvider.Sensor">\r
357             <summary>\r
358             Proximity is specified by the sensor.\r
359             </summary>\r
360             <since_tizen> 3 </since_tizen>\r
361         </member>\r
362         <member name="T:Tizen.Location.Geofence.ProximityState">\r
363             <summary>\r
364             Enumeration for the state of proximity.\r
365             </summary>\r
366             <since_tizen> 3 </since_tizen>\r
367         </member>\r
368         <member name="F:Tizen.Location.Geofence.ProximityState.Uncertain">\r
369             <summary>\r
370             Uncertain state of proximity.\r
371             </summary>\r
372             <since_tizen> 3 </since_tizen>\r
373         </member>\r
374         <member name="F:Tizen.Location.Geofence.ProximityState.Far">\r
375             <summary>\r
376             Far state of proximity.\r
377             </summary>\r
378             <since_tizen> 3 </since_tizen>\r
379         </member>\r
380         <member name="F:Tizen.Location.Geofence.ProximityState.Near">\r
381             <summary>\r
382             Far state of proximity.\r
383             </summary>\r
384             <since_tizen> 3 </since_tizen>\r
385         </member>\r
386         <member name="F:Tizen.Location.Geofence.ProximityState.Immediate">\r
387             <summary>\r
388             Immediate state of proximity.\r
389             </summary>\r
390             <since_tizen> 3 </since_tizen>\r
391         </member>\r
392         <member name="T:Tizen.Location.Geofence.GeofenceError">\r
393             <summary>\r
394             Enumeration for the types of error occured, if any.\r
395             </summary>\r
396             <since_tizen> 3 </since_tizen>\r
397         </member>\r
398         <member name="F:Tizen.Location.Geofence.GeofenceError.None">\r
399             <summary>\r
400             Successful.\r
401             </summary>\r
402             <since_tizen> 3 </since_tizen>\r
403         </member>\r
404         <member name="F:Tizen.Location.Geofence.GeofenceError.OutOfMemory">\r
405             <summary>\r
406             Out of memory.\r
407             </summary>\r
408             <since_tizen> 3 </since_tizen>\r
409         </member>\r
410         <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidParameter">\r
411             <summary>\r
412             Invalid parameter.\r
413             </summary>\r
414             <since_tizen> 3 </since_tizen>\r
415         </member>\r
416         <member name="F:Tizen.Location.Geofence.GeofenceError.PermissionDenied">\r
417             <summary>\r
418             Permission denied.\r
419             </summary>\r
420             <since_tizen> 3 </since_tizen>\r
421         </member>\r
422         <member name="F:Tizen.Location.Geofence.GeofenceError.NotSupported">\r
423             <summary>\r
424             Not Supported.\r
425             </summary>\r
426             <since_tizen> 3 </since_tizen>\r
427         </member>\r
428         <member name="F:Tizen.Location.Geofence.GeofenceError.NotInitialized">\r
429             <summary>\r
430             Geofence manager is not initialized.\r
431             </summary>\r
432             <since_tizen> 3 </since_tizen>\r
433         </member>\r
434         <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidID">\r
435             <summary>\r
436             Invalid geofence ID.\r
437             </summary>\r
438             <since_tizen> 3 </since_tizen>\r
439         </member>\r
440         <member name="F:Tizen.Location.Geofence.GeofenceError.Exception">\r
441             <summary>\r
442             Exception occurs.\r
443             </summary>\r
444             <since_tizen> 3 </since_tizen>\r
445         </member>\r
446         <member name="F:Tizen.Location.Geofence.GeofenceError.AlreadyStarted">\r
447             <summary>\r
448             Geofencing is already started.\r
449             </summary>\r
450             <since_tizen> 3 </since_tizen>\r
451         </member>\r
452         <member name="F:Tizen.Location.Geofence.GeofenceError.TooManyGeofence">\r
453             <summary>\r
454             Too many geofence.\r
455             </summary>\r
456             <since_tizen> 3 </since_tizen>\r
457         </member>\r
458         <member name="F:Tizen.Location.Geofence.GeofenceError.IPC">\r
459             <summary>\r
460             Error in GPS, Wi-Fi, or BT.\r
461             </summary>\r
462             <since_tizen> 3 </since_tizen>\r
463         </member>\r
464         <member name="F:Tizen.Location.Geofence.GeofenceError.DBFailed">\r
465             <summary>\r
466             DB error in the server side.\r
467             </summary>\r
468             <since_tizen> 3 </since_tizen>\r
469         </member>\r
470         <member name="F:Tizen.Location.Geofence.GeofenceError.PlaceAccessDenied">\r
471             <summary>\r
472             Access to the specified place is denied.\r
473             </summary>\r
474             <since_tizen> 3 </since_tizen>\r
475         </member>\r
476         <member name="F:Tizen.Location.Geofence.GeofenceError.GeofenceAccessDenied">\r
477             <summary>\r
478             Access to the specified geofence is denied.\r
479             </summary>\r
480             <since_tizen> 3 </since_tizen>\r
481         </member>\r
482         <member name="T:Tizen.Location.Geofence.ProximityStateEventArgs">\r
483             <summary>\r
484             Event arguments are passed when an event is triggered to notify the proximity state change.\r
485             </summary>\r
486             <since_tizen> 3 </since_tizen>\r
487         </member>\r
488         <member name="M:Tizen.Location.Geofence.ProximityStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.ProximityState,Tizen.Location.Geofence.ProximityProvider)">\r
489             <summary>\r
490             The internal constructor.\r
491             </summary>\r
492             <since_tizen> 3 </since_tizen>\r
493             <param name="id">The geofence ID.</param>\r
494             <param name="state">The proximity state.</param>\r
495             <param name="provider">The proximity provider.</param>\r
496         </member>\r
497         <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.GeofenceId">\r
498             <summary>\r
499             The geofence ID.\r
500             </summary>\r
501             <since_tizen> 3 </since_tizen>\r
502         </member>\r
503         <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.State">\r
504             <summary>\r
505             The proximity state.\r
506             </summary>\r
507             <since_tizen> 3 </since_tizen>\r
508         </member>\r
509         <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.Provider">\r
510             <summary>\r
511             The proximity provider.\r
512             </summary>\r
513             <since_tizen> 3 </since_tizen>\r
514         </member>\r
515         <member name="T:Tizen.Location.Geofence.GeofenceStateEventArgs">\r
516             <summary>\r
517             Event arguments are passed when an event is triggered to notify the geofence state change.\r
518             </summary>\r
519             <since_tizen> 3 </since_tizen>\r
520         </member>\r
521         <member name="M:Tizen.Location.Geofence.GeofenceStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.GeofenceState)">\r
522             <summary>\r
523             The internal constructor.\r
524             </summary>\r
525             <since_tizen> 3 </since_tizen>\r
526             <param name="fenceId">The specified geofence ID.</param>\r
527             <param name="state">The geofence state.</param>\r
528         </member>\r
529         <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.GeofenceId">\r
530             <summary>\r
531             The specified geofence ID.\r
532             </summary>\r
533             <since_tizen> 3 </since_tizen>\r
534         </member>\r
535         <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.State">\r
536             <summary>\r
537             The geofence state.\r
538             </summary>\r
539             <since_tizen> 3 </since_tizen>\r
540         </member>\r
541         <member name="T:Tizen.Location.Geofence.GeofenceResponseEventArgs">\r
542             <summary>\r
543             Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc..\r
544             </summary>\r
545             <since_tizen> 3 </since_tizen>\r
546         </member>\r
547         <member name="M:Tizen.Location.Geofence.GeofenceResponseEventArgs.#ctor(System.Int32,System.Int32,Tizen.Location.Geofence.GeofenceError,Tizen.Location.Geofence.GeofenceEventType)">\r
548             <summary>\r
549             The internal constructor.\r
550             </summary>\r
551             <since_tizen> 3 </since_tizen>\r
552             <param name="placeId">The place ID.</param>\r
553             <param name="fenceId">The specified geofence ID.</param>\r
554             <param name="error">The error code for the particular action.</param>\r
555             <param name="eventType">The result code for the particular place and geofence management.</param>\r
556         </member>\r
557         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.PlaceId">\r
558             <summary>\r
559             The place ID.\r
560             </summary>\r
561             <since_tizen> 3 </since_tizen>\r
562         </member>\r
563         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.FenceId">\r
564             <summary>\r
565             The specified geofence ID.\r
566             </summary>\r
567             <since_tizen> 3 </since_tizen>\r
568         </member>\r
569         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.ErrorCode">\r
570             <summary>\r
571             The error code for the particular action.\r
572             </summary>\r
573             <since_tizen> 3 </since_tizen>\r
574         </member>\r
575         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.EventType">\r
576             <summary>\r
577             The result code for the particular place and geofence management.\r
578             </summary>\r
579             <since_tizen> 3 </since_tizen>\r
580         </member>\r
581         <member name="T:Tizen.Location.Geofence.GeofenceManager">\r
582             <summary>\r
583             The Geofence Manager API provides service related to geofence (geo-fence).\r
584             Geofence is a virtual perimeter for a real-world geographic area.\r
585             This API provides functions to set geofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.\r
586             Also, notifications on events like changing in service status are provided.\r
587             There are two kinds of places and fences:\r
588             <list>\r
589             <item>Public places and fences are created by the MyPlace application that can be used by all applications.</item>\r
590             <item>Private places and fences are created by the specified application that can be used by the same application.</item>\r
591             </list>\r
592             Notifications can be received about the following events:\r
593             <list>\r
594             <item>Zone in when a device enters a specific area.</item>\r
595             <item>Zone out when a device exits a specific area.</item>\r
596             <item>Results and errors for each event requested to the geofence module.</item>\r
597             </list>\r
598             </summary>\r
599             <since_tizen> 3 </since_tizen>\r
600         </member>\r
601         <member name="M:Tizen.Location.Geofence.GeofenceManager.#ctor">\r
602             <summary>\r
603             Creates a new Geofence manager.\r
604             </summary>\r
605             <since_tizen> 3 </since_tizen>\r
606             <exception cref="T:System.OutOfMemoryException">In case of out of memory condition.</exception>\r
607             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
608             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
609         </member>\r
610         <member name="P:Tizen.Location.Geofence.GeofenceManager.IsSupported">\r
611             <summary>\r
612             Checks whether the Geofence manager is available or not.\r
613             </summary>\r
614             <since_tizen> 3 </since_tizen>\r
615         </member>\r
616         <member name="M:Tizen.Location.Geofence.GeofenceManager.Start(System.Int32)">\r
617             <summary>\r
618             Starts the geofencing service.\r
619             </summary>\r
620             <since_tizen> 3 </since_tizen>\r
621             <param name="geofenceId">The specified geofence ID.</param>\r
622             <privilege>http://tizen.org/privilege/location</privilege>\r
623             <remarks>\r
624             When the location service is enabled, the StateChanged event is invoked and the service starts.\r
625             </remarks>\r
626             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
627             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
628             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
629             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
630         </member>\r
631         <member name="M:Tizen.Location.Geofence.GeofenceManager.Stop(System.Int32)">\r
632             <summary>\r
633             Stops the geofenceing service.\r
634             </summary>\r
635             <since_tizen> 3 </since_tizen>\r
636             <param name="geofenceId">The specified geofence ID.</param>\r
637             <privilege>http://tizen.org/privilege/location</privilege>\r
638             <remarks>\r
639             This function initiates the process of stopping the service.\r
640             You can stop and start the Geofence manager as needed.\r
641             </remarks>\r
642             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
643             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
644             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
645             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
646         </member>\r
647         <member name="E:Tizen.Location.Geofence.GeofenceManager.StateChanged">\r
648             <summary>\r
649             Invokes when a device enters or exits the given geofence if this event is registered.\r
650             </summary>\r
651             <since_tizen> 3 </since_tizen>\r
652             <remarks>\r
653             Call to Start() will invoke this event.\r
654             </remarks>\r
655             <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
656         </member>\r
657         <member name="E:Tizen.Location.Geofence.GeofenceManager.ProximityChanged">\r
658             <summary>\r
659             Called when the proximity state of a device is changed.\r
660             </summary>\r
661             <since_tizen> 3 </since_tizen>\r
662             <remarks>\r
663             Call to Start() will invoke this event.\r
664             </remarks>\r
665             <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
666         </member>\r
667         <member name="E:Tizen.Location.Geofence.GeofenceManager.GeofenceEventChanged">\r
668             <summary>\r
669             Called when some event occurs in the geofence and the place, such as add, update, etc..\r
670             The events of public geofence is also received if there are public geofences.\r
671             </summary>\r
672             <since_tizen> 3 </since_tizen>\r
673             <remarks>\r
674             Call to Start() will invoke this event.\r
675             The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.\r
676             </remarks>\r
677             <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
678         </member>\r
679         <member name="M:Tizen.Location.Geofence.GeofenceManager.Dispose">\r
680             <summary>\r
681             The overloaded Dispose API for destroying the GeofenceManager handle.\r
682             </summary>\r
683             <since_tizen> 3 </since_tizen>\r
684         </member>\r
685         <member name="T:Tizen.Location.Geofence.VirtualPerimeter">\r
686             <summary>\r
687             Allows to create a virtual fence as geofence using the GeofenceManager instance.\r
688             A user can manage all the geofence or place related data and events.\r
689             </summary>\r
690             <since_tizen> 3 </since_tizen>\r
691         </member>\r
692         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.#ctor(Tizen.Location.Geofence.GeofenceManager)">\r
693             <summary>\r
694             Creates a VirtualPerimeter which can be used to create a virtual fence.\r
695             </summary>\r
696             <since_tizen> 3 </since_tizen>\r
697             <param name="manager">The GeofenceManager instance.</param>\r
698             <exception cref="T:System.ArgumentException"> In case of an invalid parameter.</exception>\r
699         </member>\r
700         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddPlaceName(System.String)">\r
701             <summary>\r
702             Creates a new place for the geofencing service.\r
703             </summary>\r
704             <since_tizen> 3 </since_tizen>\r
705             <param name="name">A place name to be created.</param>\r
706             <returns>The place ID to be newly created on success.</returns>\r
707             <privilege>http://tizen.org/privilege/location</privilege>\r
708             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
709             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
710             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
711             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
712         </member>\r
713         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.UpdatePlace(System.Int32,System.String)">\r
714             <summary>\r
715             Updates the place name of a given place ID.\r
716             </summary>\r
717             <since_tizen> 3 </since_tizen>\r
718             <param name="placeId">The specified place ID.</param>\r
719             <param name="name">A new place name of the place ID.</param>\r
720             <privilege>http://tizen.org/privilege/location</privilege>\r
721             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
722             <exception cref="T:System.InvalidOperationException">In case of any System error.</exception>\r
723             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
724             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
725         </member>\r
726         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemovePlace(System.Int32)">\r
727             <summary>\r
728             Removes the specific place for the geofencing service.\r
729             </summary>\r
730             <since_tizen> 3 </since_tizen>\r
731             <param name="placeId">The specified place ID.</param>\r
732             <privilege>http://tizen.org/privilege/location</privilege>\r
733             <exception cref="T:System.ArgumentException">Incase of an invalid parameter.</exception>\r
734             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
735             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
736             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
737         </member>\r
738         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddGeofence(Tizen.Location.Geofence.Fence)">\r
739             <summary>\r
740             Adds the geofence for a given Geofence manager.\r
741             </summary>\r
742             <since_tizen> 3 </since_tizen>\r
743             <param name="fence">The geofence instance to be added.</param>\r
744             <returns>The geofence ID to be newly created on success.</returns>\r
745             <remarks> The return value will always be a number greater than zero.</remarks>\r
746             <privilege>http://tizen.org/privilege/location</privilege>\r
747             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
748             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
749             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
750             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
751         </member>\r
752         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemoveGeofence(System.Int32)">\r
753             <summary>\r
754             Removes the geofence with a given geofence ID.\r
755             </summary>\r
756             <since_tizen> 3 </since_tizen>\r
757             <param name="fenceId">The specified geofence ID.</param>\r
758             <privilege>http://tizen.org/privilege/location</privilege>\r
759             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
760             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
761             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
762             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
763         </member>\r
764         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceName(System.Int32)">\r
765             <summary>\r
766             Gets the name of place.\r
767             </summary>\r
768             <since_tizen> 3 </since_tizen>\r
769             <param name="placeId">The place ID.</param>\r
770             <returns>The name of the place.</returns>\r
771             <privilege>http://tizen.org/privilege/location</privilege>\r
772             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
773             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
774             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
775             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
776         </member>\r
777         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceDataList">\r
778             <summary>\r
779             Retrieves a list of places registered in the specified Geofence manager.\r
780             </summary>\r
781             <since_tizen> 3 </since_tizen>\r
782             <returns>List of places registered as the PlaceData instance list.</returns>\r
783             <privilege>http://tizen.org/privilege/location</privilege>\r
784             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
785             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
786             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
787         </member>\r
788         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetFenceDataList">\r
789             <summary>\r
790             Retrieves a list of fences registered in the specified Geofence manager.\r
791             </summary>\r
792             <since_tizen> 3 </since_tizen>\r
793             <returns>List of FenceData instances registered for each geofence.</returns>\r
794             <privilege>http://tizen.org/privilege/location</privilege>\r
795             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
796             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
797             <exception cref="T:System.NotSupportedException">In case geofence is not supported.</exception>\r
798         </member>\r
799         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetGeofenceDataListByPlaceId(System.Int32)">\r
800             <summary>\r
801             Retrieves a list of fences registered in the specified place.\r
802             </summary>\r
803             <since_tizen> 3 </since_tizen>\r
804             <param name="placeId"> The place ID.</param>\r
805             <returns>The list of FenceData instances registered for each geofence for the specified place.</returns>\r
806             <privilege>http://tizen.org/privilege/location</privilege>\r
807             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
808             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
809             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
810             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
811         </member>\r
812     </members>\r
813 </doc>\r