Release 4.0.0-preview1-00201
[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.Int32,System.Int32,System.Int32,System.String)">\r
71             <summary>\r
72             Creates a geopoint type of the new geofence.\r
73             </summary>\r
74             <since_tizen> 3 </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             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
195             <exception cref="T:System.NotSupportedException">In case of geofence is not supported.</exception>\r
196         </member>\r
197         <member name="P:Tizen.Location.Geofence.FenceStatus.State">\r
198             <summary>\r
199             Gets the state of geofence.\r
200             </summary>\r
201             <since_tizen> 3 </since_tizen>\r
202             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
203         </member>\r
204         <member name="P:Tizen.Location.Geofence.FenceStatus.Duration">\r
205             <summary>\r
206             Gets the amount of seconds, the geofence is in the current state.\r
207             </summary>\r
208             <since_tizen> 3 </since_tizen>\r
209             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
210         </member>\r
211         <member name="M:Tizen.Location.Geofence.FenceStatus.Dispose">\r
212             <summary>\r
213             The overloaded Dispose API for destroying the fence handle.\r
214             </summary>\r
215             <since_tizen> 3 </since_tizen>\r
216         </member>\r
217         <member name="T:Tizen.Location.Geofence.FenceType">\r
218             <summary>\r
219             Enumeration for the geofence types.\r
220             </summary>\r
221             <since_tizen> 3 </since_tizen>\r
222         </member>\r
223         <member name="F:Tizen.Location.Geofence.FenceType.GeoPoint">\r
224             <summary>\r
225             Geofence is specified by the geospatial coordinate.\r
226             </summary>\r
227             <since_tizen> 3 </since_tizen>\r
228         </member>\r
229         <member name="F:Tizen.Location.Geofence.FenceType.Wifi">\r
230             <summary>\r
231             Geofence is specified by the Wi-Fi access point.\r
232             </summary>\r
233             <since_tizen> 3 </since_tizen>\r
234         </member>\r
235         <member name="F:Tizen.Location.Geofence.FenceType.Bluetooth">\r
236             <summary>\r
237             Geofence is specified by the Bluetooth device.\r
238             </summary>\r
239             <since_tizen> 3 </since_tizen>\r
240         </member>\r
241         <member name="T:Tizen.Location.Geofence.GeofenceState">\r
242             <summary>\r
243             Enumeration for the state of geofence.\r
244             </summary>\r
245             <since_tizen> 3 </since_tizen>\r
246         </member>\r
247         <member name="F:Tizen.Location.Geofence.GeofenceState.Uncertain">\r
248             <summary>\r
249             Uncertain state of geofence.\r
250             </summary>\r
251             <since_tizen> 3 </since_tizen>\r
252         </member>\r
253         <member name="F:Tizen.Location.Geofence.GeofenceState.In">\r
254             <summary>\r
255             Geofence In state.\r
256             </summary>\r
257             <since_tizen> 3 </since_tizen>\r
258         </member>\r
259         <member name="F:Tizen.Location.Geofence.GeofenceState.Out">\r
260             <summary>\r
261             Geofence Out state.\r
262             </summary>\r
263             <since_tizen> 3 </since_tizen>\r
264         </member>\r
265         <member name="T:Tizen.Location.Geofence.GeofenceEventType">\r
266             <summary>\r
267             Enumeration for the geofence management events.\r
268             </summary>\r
269             <since_tizen> 3 </since_tizen>\r
270         </member>\r
271         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceAdded">\r
272             <summary>\r
273             Geofence is added.\r
274             </summary>\r
275             <since_tizen> 3 </since_tizen>\r
276         </member>\r
277         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceRemoved">\r
278             <summary>\r
279             Geofence is removed.\r
280             </summary>\r
281             <since_tizen> 3 </since_tizen>\r
282         </member>\r
283         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStarted">\r
284             <summary>\r
285             Geofencing is started.\r
286             </summary>\r
287             <since_tizen> 3 </since_tizen>\r
288         </member>\r
289         <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStopped">\r
290             <summary>\r
291             Geofencing is stopped.\r
292             </summary>\r
293             <since_tizen> 3 </since_tizen>\r
294         </member>\r
295         <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceAdded">\r
296             <summary>\r
297             Place is added.\r
298             </summary>\r
299             <since_tizen> 3 </since_tizen>\r
300         </member>\r
301         <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceRemoved">\r
302             <summary>\r
303             Place is removed.\r
304             </summary>\r
305             <since_tizen> 3 </since_tizen>\r
306         </member>\r
307         <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceUpdated">\r
308             <summary>\r
309             Place is updated.\r
310             </summary>\r
311             <since_tizen> 3 </since_tizen>\r
312         </member>\r
313         <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingEnabled">\r
314             <summary>\r
315             Setting for geofencing is enabled.\r
316             </summary>\r
317             <since_tizen> 3 </since_tizen>\r
318         </member>\r
319         <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingDisabled">\r
320             <summary>\r
321             Setting for geofencing is disabled.\r
322             </summary>\r
323             <since_tizen> 3 </since_tizen>\r
324         </member>\r
325         <member name="T:Tizen.Location.Geofence.ProximityProvider">\r
326             <summary>\r
327             Enumeration for the provider of proximity.\r
328             </summary>\r
329             <since_tizen> 3 </since_tizen>\r
330         </member>\r
331         <member name="F:Tizen.Location.Geofence.ProximityProvider.Location">\r
332             <summary>\r
333             Proximity is specified by the geospatial coordinate.\r
334             </summary>\r
335             <since_tizen> 3 </since_tizen>\r
336         </member>\r
337         <member name="F:Tizen.Location.Geofence.ProximityProvider.Wifi">\r
338             <summary>\r
339             Proximity is specified by the Wi-Fi access point.\r
340             </summary>\r
341             <since_tizen> 3 </since_tizen>\r
342         </member>\r
343         <member name="F:Tizen.Location.Geofence.ProximityProvider.Bluetooth">\r
344             <summary>\r
345             Proximity is specified by the Bluetooth device.\r
346             </summary>\r
347             <since_tizen> 3 </since_tizen>\r
348         </member>\r
349         <member name="F:Tizen.Location.Geofence.ProximityProvider.BLE">\r
350             <summary>\r
351             Proximity is specified by the Bluetooth low-energy device.\r
352             </summary>\r
353             <since_tizen> 3 </since_tizen>\r
354         </member>\r
355         <member name="F:Tizen.Location.Geofence.ProximityProvider.Sensor">\r
356             <summary>\r
357             Proximity is specified by the sensor.\r
358             </summary>\r
359             <since_tizen> 3 </since_tizen>\r
360         </member>\r
361         <member name="T:Tizen.Location.Geofence.ProximityState">\r
362             <summary>\r
363             Enumeration for the state of proximity.\r
364             </summary>\r
365             <since_tizen> 3 </since_tizen>\r
366         </member>\r
367         <member name="F:Tizen.Location.Geofence.ProximityState.Uncertain">\r
368             <summary>\r
369             Uncertain state of proximity.\r
370             </summary>\r
371             <since_tizen> 3 </since_tizen>\r
372         </member>\r
373         <member name="F:Tizen.Location.Geofence.ProximityState.Far">\r
374             <summary>\r
375             Far state of proximity.\r
376             </summary>\r
377             <since_tizen> 3 </since_tizen>\r
378         </member>\r
379         <member name="F:Tizen.Location.Geofence.ProximityState.Near">\r
380             <summary>\r
381             Far state of proximity.\r
382             </summary>\r
383             <since_tizen> 3 </since_tizen>\r
384         </member>\r
385         <member name="F:Tizen.Location.Geofence.ProximityState.Immediate">\r
386             <summary>\r
387             Immediate state of proximity.\r
388             </summary>\r
389             <since_tizen> 3 </since_tizen>\r
390         </member>\r
391         <member name="T:Tizen.Location.Geofence.GeofenceError">\r
392             <summary>\r
393             Enumeration for the types of error occured, if any.\r
394             </summary>\r
395             <since_tizen> 3 </since_tizen>\r
396         </member>\r
397         <member name="F:Tizen.Location.Geofence.GeofenceError.None">\r
398             <summary>\r
399             Successful.\r
400             </summary>\r
401             <since_tizen> 3 </since_tizen>\r
402         </member>\r
403         <member name="F:Tizen.Location.Geofence.GeofenceError.OutOfMemory">\r
404             <summary>\r
405             Out of memory.\r
406             </summary>\r
407             <since_tizen> 3 </since_tizen>\r
408         </member>\r
409         <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidParameter">\r
410             <summary>\r
411             Invalid parameter.\r
412             </summary>\r
413             <since_tizen> 3 </since_tizen>\r
414         </member>\r
415         <member name="F:Tizen.Location.Geofence.GeofenceError.PermissionDenied">\r
416             <summary>\r
417             Permission denied.\r
418             </summary>\r
419             <since_tizen> 3 </since_tizen>\r
420         </member>\r
421         <member name="F:Tizen.Location.Geofence.GeofenceError.NotSupported">\r
422             <summary>\r
423             Not Supported.\r
424             </summary>\r
425             <since_tizen> 3 </since_tizen>\r
426         </member>\r
427         <member name="F:Tizen.Location.Geofence.GeofenceError.NotInitialized">\r
428             <summary>\r
429             Geofence manager is not initialized.\r
430             </summary>\r
431             <since_tizen> 3 </since_tizen>\r
432         </member>\r
433         <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidID">\r
434             <summary>\r
435             Invalid geofence ID.\r
436             </summary>\r
437             <since_tizen> 3 </since_tizen>\r
438         </member>\r
439         <member name="F:Tizen.Location.Geofence.GeofenceError.Exception">\r
440             <summary>\r
441             Exception occurs.\r
442             </summary>\r
443             <since_tizen> 3 </since_tizen>\r
444         </member>\r
445         <member name="F:Tizen.Location.Geofence.GeofenceError.AlreadyStarted">\r
446             <summary>\r
447             Geofencing is already started.\r
448             </summary>\r
449             <since_tizen> 3 </since_tizen>\r
450         </member>\r
451         <member name="F:Tizen.Location.Geofence.GeofenceError.TooManyGeofence">\r
452             <summary>\r
453             Too many geofence.\r
454             </summary>\r
455             <since_tizen> 3 </since_tizen>\r
456         </member>\r
457         <member name="F:Tizen.Location.Geofence.GeofenceError.IPC">\r
458             <summary>\r
459             Error in GPS, Wi-Fi, or BT.\r
460             </summary>\r
461             <since_tizen> 3 </since_tizen>\r
462         </member>\r
463         <member name="F:Tizen.Location.Geofence.GeofenceError.DBFailed">\r
464             <summary>\r
465             DB error in the server side.\r
466             </summary>\r
467             <since_tizen> 3 </since_tizen>\r
468         </member>\r
469         <member name="F:Tizen.Location.Geofence.GeofenceError.PlaceAccessDenied">\r
470             <summary>\r
471             Access to the specified place is denied.\r
472             </summary>\r
473             <since_tizen> 3 </since_tizen>\r
474         </member>\r
475         <member name="F:Tizen.Location.Geofence.GeofenceError.GeofenceAccessDenied">\r
476             <summary>\r
477             Access to the specified geofence is denied.\r
478             </summary>\r
479             <since_tizen> 3 </since_tizen>\r
480         </member>\r
481         <member name="T:Tizen.Location.Geofence.ProximityStateEventArgs">\r
482             <summary>\r
483             Event arguments are passed when an event is triggered to notify the proximity state change.\r
484             </summary>\r
485             <since_tizen> 3 </since_tizen>\r
486         </member>\r
487         <member name="M:Tizen.Location.Geofence.ProximityStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.ProximityState,Tizen.Location.Geofence.ProximityProvider)">\r
488             <summary>\r
489             The internal constructor.\r
490             </summary>\r
491             <since_tizen> 3 </since_tizen>\r
492             <param name="id">The geofence ID.</param>\r
493             <param name="state">The proximity state.</param>\r
494             <param name="provider">The proximity provider.</param>\r
495         </member>\r
496         <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.GeofenceId">\r
497             <summary>\r
498             The geofence ID.\r
499             </summary>\r
500             <since_tizen> 3 </since_tizen>\r
501         </member>\r
502         <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.State">\r
503             <summary>\r
504             The proximity state.\r
505             </summary>\r
506             <since_tizen> 3 </since_tizen>\r
507         </member>\r
508         <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.Provider">\r
509             <summary>\r
510             The proximity provider.\r
511             </summary>\r
512             <since_tizen> 3 </since_tizen>\r
513         </member>\r
514         <member name="T:Tizen.Location.Geofence.GeofenceStateEventArgs">\r
515             <summary>\r
516             Event arguments are passed when an event is triggered to notify the geofence state change.\r
517             </summary>\r
518             <since_tizen> 3 </since_tizen>\r
519         </member>\r
520         <member name="M:Tizen.Location.Geofence.GeofenceStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.GeofenceState)">\r
521             <summary>\r
522             The internal constructor.\r
523             </summary>\r
524             <since_tizen> 3 </since_tizen>\r
525             <param name="fenceId">The specified geofence ID.</param>\r
526             <param name="state">The geofence state.</param>\r
527         </member>\r
528         <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.GeofenceId">\r
529             <summary>\r
530             The specified geofence ID.\r
531             </summary>\r
532             <since_tizen> 3 </since_tizen>\r
533         </member>\r
534         <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.State">\r
535             <summary>\r
536             The geofence state.\r
537             </summary>\r
538             <since_tizen> 3 </since_tizen>\r
539         </member>\r
540         <member name="T:Tizen.Location.Geofence.GeofenceResponseEventArgs">\r
541             <summary>\r
542             Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc..\r
543             </summary>\r
544             <since_tizen> 3 </since_tizen>\r
545         </member>\r
546         <member name="M:Tizen.Location.Geofence.GeofenceResponseEventArgs.#ctor(System.Int32,System.Int32,Tizen.Location.Geofence.GeofenceError,Tizen.Location.Geofence.GeofenceEventType)">\r
547             <summary>\r
548             The internal constructor.\r
549             </summary>\r
550             <since_tizen> 3 </since_tizen>\r
551             <param name="placeId">The place ID.</param>\r
552             <param name="fenceId">The specified geofence ID.</param>\r
553             <param name="error">The error code for the particular action.</param>\r
554             <param name="eventType">The result code for the particular place and geofence management.</param>\r
555         </member>\r
556         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.PlaceId">\r
557             <summary>\r
558             The place ID.\r
559             </summary>\r
560             <since_tizen> 3 </since_tizen>\r
561         </member>\r
562         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.FenceId">\r
563             <summary>\r
564             The specified geofence ID.\r
565             </summary>\r
566             <since_tizen> 3 </since_tizen>\r
567         </member>\r
568         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.ErrorCode">\r
569             <summary>\r
570             The error code for the particular action.\r
571             </summary>\r
572             <since_tizen> 3 </since_tizen>\r
573         </member>\r
574         <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.EventType">\r
575             <summary>\r
576             The result code for the particular place and geofence management.\r
577             </summary>\r
578             <since_tizen> 3 </since_tizen>\r
579         </member>\r
580         <member name="T:Tizen.Location.Geofence.GeofenceManager">\r
581             <summary>\r
582             The Geofence Manager API provides service related to geofence (geo-fence).\r
583             Geofence is a virtual perimeter for a real-world geographic area.\r
584             This API provides functions to set geofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.\r
585             Also, notifications on events like changing in service status are provided.\r
586             There are two kinds of places and fences:\r
587             <list>\r
588             <item>Public places and fences are created by the MyPlace application that can be used by all applications.</item>\r
589             <item>Private places and fences are created by the specified application that can be used by the same application.</item>\r
590             </list>\r
591             Notifications can be received about the following events:\r
592             <list>\r
593             <item>Zone in when a device enters a specific area.</item>\r
594             <item>Zone out when a device exits a specific area.</item>\r
595             <item>Results and errors for each event requested to the geofence module.</item>\r
596             </list>\r
597             </summary>\r
598             <since_tizen> 3 </since_tizen>\r
599         </member>\r
600         <member name="M:Tizen.Location.Geofence.GeofenceManager.#ctor">\r
601             <summary>\r
602             Creates a new Geofence manager.\r
603             </summary>\r
604             <since_tizen> 3 </since_tizen>\r
605             <exception cref="T:System.OutOfMemoryException">In case of out of memory condition.</exception>\r
606             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
607             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
608         </member>\r
609         <member name="P:Tizen.Location.Geofence.GeofenceManager.IsSupported">\r
610             <summary>\r
611             Checks whether the Geofence manager is available or not.\r
612             </summary>\r
613             <since_tizen> 3 </since_tizen>\r
614         </member>\r
615         <member name="M:Tizen.Location.Geofence.GeofenceManager.Start(System.Int32)">\r
616             <summary>\r
617             Starts the geofencing service.\r
618             </summary>\r
619             <since_tizen> 3 </since_tizen>\r
620             <param name="geofenceId">The specified geofence ID.</param>\r
621             <privilege>http://tizen.org/privilege/location</privilege>\r
622             <remarks>\r
623             When the location service is enabled, the StateChanged event is invoked and the service starts.\r
624             </remarks>\r
625             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
626             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
627             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
628             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
629         </member>\r
630         <member name="M:Tizen.Location.Geofence.GeofenceManager.Stop(System.Int32)">\r
631             <summary>\r
632             Stops the geofenceing service.\r
633             </summary>\r
634             <since_tizen> 3 </since_tizen>\r
635             <param name="geofenceId">The specified geofence ID.</param>\r
636             <privilege>http://tizen.org/privilege/location</privilege>\r
637             <remarks>\r
638             This function initiates the process of stopping the service.\r
639             You can stop and start the Geofence manager as needed.\r
640             </remarks>\r
641             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
642             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
643             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
644             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
645         </member>\r
646         <member name="E:Tizen.Location.Geofence.GeofenceManager.StateChanged">\r
647             <summary>\r
648             Invokes when a device enters or exits the given geofence if this event is registered.\r
649             </summary>\r
650             <since_tizen> 3 </since_tizen>\r
651             <remarks>\r
652             Call to Start() will invoke this event.\r
653             </remarks>\r
654             <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
655         </member>\r
656         <member name="E:Tizen.Location.Geofence.GeofenceManager.ProximityChanged">\r
657             <summary>\r
658             Called when the proximity state of a device is changed.\r
659             </summary>\r
660             <since_tizen> 3 </since_tizen>\r
661             <remarks>\r
662             Call to Start() will invoke this event.\r
663             </remarks>\r
664             <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
665         </member>\r
666         <member name="E:Tizen.Location.Geofence.GeofenceManager.GeofenceEventChanged">\r
667             <summary>\r
668             Called when some event occurs in the geofence and the place, such as add, update, etc..\r
669             The events of public geofence is also received if there are public geofences.\r
670             </summary>\r
671             <since_tizen> 3 </since_tizen>\r
672             <remarks>\r
673             Call to Start() will invoke this event.\r
674             The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.\r
675             </remarks>\r
676             <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
677         </member>\r
678         <member name="M:Tizen.Location.Geofence.GeofenceManager.Dispose">\r
679             <summary>\r
680             The overloaded Dispose API for destroying the GeofenceManager handle.\r
681             </summary>\r
682             <since_tizen> 3 </since_tizen>\r
683         </member>\r
684         <member name="T:Tizen.Location.Geofence.VirtualPerimeter">\r
685             <summary>\r
686             Allows to create a virtual fence as geofence using the GeofenceManager instance.\r
687             A user can manage all the geofence or place related data and events.\r
688             </summary>\r
689             <since_tizen> 3 </since_tizen>\r
690         </member>\r
691         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.#ctor(Tizen.Location.Geofence.GeofenceManager)">\r
692             <summary>\r
693             Creates a VirtualPerimeter which can be used to create a virtual fence.\r
694             </summary>\r
695             <since_tizen> 3 </since_tizen>\r
696             <param name="manager">The GeofenceManager instance.</param>\r
697             <exception cref="T:System.ArgumentException"> In case of an invalid parameter.</exception>\r
698         </member>\r
699         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddPlaceName(System.String)">\r
700             <summary>\r
701             Creates a new place for the geofencing service.\r
702             </summary>\r
703             <since_tizen> 3 </since_tizen>\r
704             <param name="name">A place name to be created.</param>\r
705             <returns>The place ID to be newly created on success.</returns>\r
706             <privilege>http://tizen.org/privilege/location</privilege>\r
707             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
708             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
709             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
710             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
711         </member>\r
712         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.UpdatePlace(System.Int32,System.String)">\r
713             <summary>\r
714             Updates the place name of a given place ID.\r
715             </summary>\r
716             <since_tizen> 3 </since_tizen>\r
717             <param name="placeId">The specified place ID.</param>\r
718             <param name="name">A new place name of the place ID.</param>\r
719             <privilege>http://tizen.org/privilege/location</privilege>\r
720             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
721             <exception cref="T:System.InvalidOperationException">In case of any System error.</exception>\r
722             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
723             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
724         </member>\r
725         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemovePlace(System.Int32)">\r
726             <summary>\r
727             Removes the specific place for the geofencing service.\r
728             </summary>\r
729             <since_tizen> 3 </since_tizen>\r
730             <param name="placeId">The specified place ID.</param>\r
731             <privilege>http://tizen.org/privilege/location</privilege>\r
732             <exception cref="T:System.ArgumentException">Incase of an invalid parameter.</exception>\r
733             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
734             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
735             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
736         </member>\r
737         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddGeofence(Tizen.Location.Geofence.Fence)">\r
738             <summary>\r
739             Adds the geofence for a given Geofence manager.\r
740             </summary>\r
741             <since_tizen> 3 </since_tizen>\r
742             <param name="fence">The geofence instance to be added.</param>\r
743             <returns>The geofence ID to be newly created on success.</returns>\r
744             <remarks> The return value will always be a number greater than zero.</remarks>\r
745             <privilege>http://tizen.org/privilege/location</privilege>\r
746             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
747             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
748             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
749             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
750         </member>\r
751         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemoveGeofence(System.Int32)">\r
752             <summary>\r
753             Removes the geofence with a given geofence ID.\r
754             </summary>\r
755             <since_tizen> 3 </since_tizen>\r
756             <param name="fenceId">The specified geofence ID.</param>\r
757             <privilege>http://tizen.org/privilege/location</privilege>\r
758             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
759             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
760             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
761             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
762         </member>\r
763         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceName(System.Int32)">\r
764             <summary>\r
765             Gets the name of place.\r
766             </summary>\r
767             <since_tizen> 3 </since_tizen>\r
768             <param name="placeId">The place ID.</param>\r
769             <returns>The name of the place.</returns>\r
770             <privilege>http://tizen.org/privilege/location</privilege>\r
771             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
772             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
773             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
774             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
775         </member>\r
776         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceDataList">\r
777             <summary>\r
778             Retrieves a list of places registered in the specified Geofence manager.\r
779             </summary>\r
780             <since_tizen> 3 </since_tizen>\r
781             <returns>List of places registered as the PlaceData instance list.</returns>\r
782             <privilege>http://tizen.org/privilege/location</privilege>\r
783             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
784             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
785             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
786         </member>\r
787         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetFenceDataList">\r
788             <summary>\r
789             Retrieves a list of fences registered in the specified Geofence manager.\r
790             </summary>\r
791             <since_tizen> 3 </since_tizen>\r
792             <returns>List of FenceData instances registered for each geofence.</returns>\r
793             <privilege>http://tizen.org/privilege/location</privilege>\r
794             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
795             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
796             <exception cref="T:System.NotSupportedException">In case geofence is not supported.</exception>\r
797         </member>\r
798         <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetGeofenceDataListByPlaceId(System.Int32)">\r
799             <summary>\r
800             Retrieves a list of fences registered in the specified place.\r
801             </summary>\r
802             <since_tizen> 3 </since_tizen>\r
803             <param name="placeId"> The place ID.</param>\r
804             <returns>The list of FenceData instances registered for each geofence for the specified place.</returns>\r
805             <privilege>http://tizen.org/privilege/location</privilege>\r
806             <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
807             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
808             <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
809             <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
810         </member>\r
811     </members>\r
812 </doc>\r