-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.Location.Geofence</name>
- </assembly>
- <members>
- <member name="T:Tizen.Location.Geofence.Fence">
- <summary>
- Geofence defines a virtual perimeter for a real-world geographic area.
- If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you.
- You can create a geofence with the information of the Geopoint, Wi-Fi, or BT.
- <list>
- <item>Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius.</item>
- <item>WIFI: Geofence is specified by the BSSID of the Wi-Fi access point.</item>
- <item>BT: Geofence is specified by the Bluetooth address.</item>
- </list>
- 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)
- and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.Type">
- <summary>
- Gets the type of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.PlaceId">
- <summary>
- Gets the ID of the place.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.Longitude">
- <summary>
- Gets the longitude of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.Latitude">
- <summary>
- Gets the latitude of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.Radius">
- <summary>
- Gets the radius of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.Address">
- <summary>
- Gets the address of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.Bssid">
- <summary>
- Gets the BSSID of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.Fence.Ssid">
- <summary>
- Gets the SSID of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.Fence.CreateGPSFence(System.Int32,System.Int32,System.Int32,System.Int32,System.String)">
- <summary>
- Creates a geopoint type of the new geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId">The current place ID.</param>
- <param name="latitude">Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees).</param>
- <param name="longitude">Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees).</param>
- <param name="radius">Specifies the value of radius of the geofence [100 ~ 500](meter).</param>
- <param name="address">Specifies the value of the address.</param>
- <returns>The newly created geofence instance.</returns>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.Fence.CreateWifiFence(System.Int32,System.String,System.String)">
- <summary>
- Creates a Wi-Fi type of the new geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId">The current place ID.</param>
- <param name="bssid">Specifies the value of BSSID of the Wi-Fi MAC address.</param>
- <param name="ssid"> Specifies the value of SSID of the Wi-Fi device.</param>
- <returns>The newly created geofence instance.</returns>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.Fence.CreateBTFence(System.Int32,System.String,System.String)">
- <summary>
- Creates a Bluetooth type of the new geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId">The current place ID.</param>
- <param name="bssid">Specifies the value of BSSID of BT MAC address.</param>
- <param name="ssid"> Specifies the value of SSID of BT Device.</param>
- <returns>The newly created geofence instance.</returns>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.Fence.Dispose">
- <summary>
- The overloaded Dispose API for destroying the fence handle.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.FenceData">
- <summary>
- Represents the geofence list item data.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.FenceData.Fence">
- <summary>
- The geofence instance.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.FenceData.GeofenceId">
- <summary>
- The geofence ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.FenceData.Index">
- <summary>
- The index number of fences in the list.
- </summary>
- <since_tizen> 3 </since_tizen>
- <value>The index value starts from 1.</value>
- </member>
- <member name="P:Tizen.Location.Geofence.FenceData.Count">
- <summary>
- The total number of fences that exists for the requester.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.PlaceData">
- <summary>
- Represents the place list item data.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.PlaceData.PlaceId">
- <summary>
- The current place ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.PlaceData.Name">
- <summary>
- The current place name.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.PlaceData.Index">
- <summary>
- The index number of places in the list.
- </summary>
- <since_tizen> 3 </since_tizen>
- <value>The index value starts from 1.</value>
- </member>
- <member name="P:Tizen.Location.Geofence.PlaceData.Count">
- <summary>
- The total number of places that exists for the requester.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.FenceStatus">
- <summary>
- The geofence status describes the current state and duration of a geofence.
- <list>
- <item>State: The state is specified by the current state of the fence.</item>
- <item>Duration: Geofence is specified by the duration of the current state.</item>
- </list>
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.FenceStatus.#ctor(System.Int32)">
- <summary>
- Creates a new geofence status.
- </summary>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.NotSupportedException">In case of geofence is not supported.</exception>
- </member>
- <member name="P:Tizen.Location.Geofence.FenceStatus.State">
- <summary>
- Gets the state of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="P:Tizen.Location.Geofence.FenceStatus.Duration">
- <summary>
- Gets the amount of seconds, the geofence is in the current state.
- </summary>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.FenceStatus.Dispose">
- <summary>
- The overloaded Dispose API for destroying the fence handle.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.FenceType">
- <summary>
- Enumeration for the geofence types.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.FenceType.GeoPoint">
- <summary>
- Geofence is specified by the geospatial coordinate.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.FenceType.Wifi">
- <summary>
- Geofence is specified by the Wi-Fi access point.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.FenceType.Bluetooth">
- <summary>
- Geofence is specified by the Bluetooth device.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.GeofenceState">
- <summary>
- Enumeration for the state of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceState.Uncertain">
- <summary>
- Uncertain state of geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceState.In">
- <summary>
- Geofence In state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceState.Out">
- <summary>
- Geofence Out state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.GeofenceEventType">
- <summary>
- Enumeration for the geofence management events.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceAdded">
- <summary>
- Geofence is added.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceRemoved">
- <summary>
- Geofence is removed.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStarted">
- <summary>
- Geofencing is started.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStopped">
- <summary>
- Geofencing is stopped.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceAdded">
- <summary>
- Place is added.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceRemoved">
- <summary>
- Place is removed.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceUpdated">
- <summary>
- Place is updated.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingEnabled">
- <summary>
- Setting for geofencing is enabled.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingDisabled">
- <summary>
- Setting for geofencing is disabled.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.ProximityProvider">
- <summary>
- Enumeration for the provider of proximity.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityProvider.Location">
- <summary>
- Proximity is specified by the geospatial coordinate.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityProvider.Wifi">
- <summary>
- Proximity is specified by the Wi-Fi access point.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityProvider.Bluetooth">
- <summary>
- Proximity is specified by the Bluetooth device.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityProvider.BLE">
- <summary>
- Proximity is specified by the Bluetooth low-energy device.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityProvider.Sensor">
- <summary>
- Proximity is specified by the sensor.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.ProximityState">
- <summary>
- Enumeration for the state of proximity.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityState.Uncertain">
- <summary>
- Uncertain state of proximity.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityState.Far">
- <summary>
- Far state of proximity.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityState.Near">
- <summary>
- Far state of proximity.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.ProximityState.Immediate">
- <summary>
- Immediate state of proximity.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.GeofenceError">
- <summary>
- Enumeration for the types of error occured, if any.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.None">
- <summary>
- Successful.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.OutOfMemory">
- <summary>
- Out of memory.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidParameter">
- <summary>
- Invalid parameter.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.PermissionDenied">
- <summary>
- Permission denied.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.NotSupported">
- <summary>
- Not Supported.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.NotInitialized">
- <summary>
- Geofence manager is not initialized.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidID">
- <summary>
- Invalid geofence ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.Exception">
- <summary>
- Exception occurs.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.AlreadyStarted">
- <summary>
- Geofencing is already started.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.TooManyGeofence">
- <summary>
- Too many geofence.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.IPC">
- <summary>
- Error in GPS, Wi-Fi, or BT.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.DBFailed">
- <summary>
- DB error in the server side.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.PlaceAccessDenied">
- <summary>
- Access to the specified place is denied.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.Location.Geofence.GeofenceError.GeofenceAccessDenied">
- <summary>
- Access to the specified geofence is denied.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.ProximityStateEventArgs">
- <summary>
- Event arguments are passed when an event is triggered to notify the proximity state change.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.ProximityStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.ProximityState,Tizen.Location.Geofence.ProximityProvider)">
- <summary>
- The internal constructor.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="id">The geofence ID.</param>
- <param name="state">The proximity state.</param>
- <param name="provider">The proximity provider.</param>
- </member>
- <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.GeofenceId">
- <summary>
- The geofence ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.State">
- <summary>
- The proximity state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.Provider">
- <summary>
- The proximity provider.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.GeofenceStateEventArgs">
- <summary>
- Event arguments are passed when an event is triggered to notify the geofence state change.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.GeofenceStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.GeofenceState)">
- <summary>
- The internal constructor.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="fenceId">The specified geofence ID.</param>
- <param name="state">The geofence state.</param>
- </member>
- <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.GeofenceId">
- <summary>
- The specified geofence ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.State">
- <summary>
- The geofence state.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.GeofenceResponseEventArgs">
- <summary>
- Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc..
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.GeofenceResponseEventArgs.#ctor(System.Int32,System.Int32,Tizen.Location.Geofence.GeofenceError,Tizen.Location.Geofence.GeofenceEventType)">
- <summary>
- The internal constructor.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId">The place ID.</param>
- <param name="fenceId">The specified geofence ID.</param>
- <param name="error">The error code for the particular action.</param>
- <param name="eventType">The result code for the particular place and geofence management.</param>
- </member>
- <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.PlaceId">
- <summary>
- The place ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.FenceId">
- <summary>
- The specified geofence ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.ErrorCode">
- <summary>
- The error code for the particular action.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.EventType">
- <summary>
- The result code for the particular place and geofence management.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.GeofenceManager">
- <summary>
- The Geofence Manager API provides service related to geofence (geo-fence).
- Geofence is a virtual perimeter for a real-world geographic area.
- This API provides functions to set geofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.
- Also, notifications on events like changing in service status are provided.
- There are two kinds of places and fences:
- <list>
- <item>Public places and fences are created by the MyPlace application that can be used by all applications.</item>
- <item>Private places and fences are created by the specified application that can be used by the same application.</item>
- </list>
- Notifications can be received about the following events:
- <list>
- <item>Zone in when a device enters a specific area.</item>
- <item>Zone out when a device exits a specific area.</item>
- <item>Results and errors for each event requested to the geofence module.</item>
- </list>
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.GeofenceManager.#ctor">
- <summary>
- Creates a new Geofence manager.
- </summary>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.OutOfMemoryException">In case of out of memory condition.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="P:Tizen.Location.Geofence.GeofenceManager.IsSupported">
- <summary>
- Checks whether the Geofence manager is available or not.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.GeofenceManager.Start(System.Int32)">
- <summary>
- Starts the geofencing service.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="geofenceId">The specified geofence ID.</param>
- <privilege>http://tizen.org/privilege/location</privilege>
- <remarks>
- When the location service is enabled, the StateChanged event is invoked and the service starts.
- </remarks>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.GeofenceManager.Stop(System.Int32)">
- <summary>
- Stops the geofenceing service.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="geofenceId">The specified geofence ID.</param>
- <privilege>http://tizen.org/privilege/location</privilege>
- <remarks>
- This function initiates the process of stopping the service.
- You can stop and start the Geofence manager as needed.
- </remarks>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="E:Tizen.Location.Geofence.GeofenceManager.StateChanged">
- <summary>
- Invokes when a device enters or exits the given geofence if this event is registered.
- </summary>
- <since_tizen> 3 </since_tizen>
- <remarks>
- Call to Start() will invoke this event.
- </remarks>
- <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>
- </member>
- <member name="E:Tizen.Location.Geofence.GeofenceManager.ProximityChanged">
- <summary>
- Called when the proximity state of a device is changed.
- </summary>
- <since_tizen> 3 </since_tizen>
- <remarks>
- Call to Start() will invoke this event.
- </remarks>
- <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>
- </member>
- <member name="E:Tizen.Location.Geofence.GeofenceManager.GeofenceEventChanged">
- <summary>
- Called when some event occurs in the geofence and the place, such as add, update, etc..
- The events of public geofence is also received if there are public geofences.
- </summary>
- <since_tizen> 3 </since_tizen>
- <remarks>
- Call to Start() will invoke this event.
- The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.
- </remarks>
- <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.GeofenceManager.Dispose">
- <summary>
- The overloaded Dispose API for destroying the GeofenceManager handle.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="T:Tizen.Location.Geofence.VirtualPerimeter">
- <summary>
- Allows to create a virtual fence as geofence using the GeofenceManager instance.
- A user can manage all the geofence or place related data and events.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.#ctor(Tizen.Location.Geofence.GeofenceManager)">
- <summary>
- Creates a VirtualPerimeter which can be used to create a virtual fence.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="manager">The GeofenceManager instance.</param>
- <exception cref="T:System.ArgumentException"> In case of an invalid parameter.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddPlaceName(System.String)">
- <summary>
- Creates a new place for the geofencing service.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="name">A place name to be created.</param>
- <returns>The place ID to be newly created on success.</returns>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.UpdatePlace(System.Int32,System.String)">
- <summary>
- Updates the place name of a given place ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId">The specified place ID.</param>
- <param name="name">A new place name of the place ID.</param>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any System error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemovePlace(System.Int32)">
- <summary>
- Removes the specific place for the geofencing service.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId">The specified place ID.</param>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.ArgumentException">Incase of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddGeofence(Tizen.Location.Geofence.Fence)">
- <summary>
- Adds the geofence for a given Geofence manager.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="fence">The geofence instance to be added.</param>
- <returns>The geofence ID to be newly created on success.</returns>
- <remarks> The return value will always be a number greater than zero.</remarks>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemoveGeofence(System.Int32)">
- <summary>
- Removes the geofence with a given geofence ID.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="fenceId">The specified geofence ID.</param>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceName(System.Int32)">
- <summary>
- Gets the name of place.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId">The place ID.</param>
- <returns>The name of the place.</returns>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceDataList">
- <summary>
- Retrieves a list of places registered in the specified Geofence manager.
- </summary>
- <since_tizen> 3 </since_tizen>
- <returns>List of places registered as the PlaceData instance list.</returns>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetFenceDataList">
- <summary>
- Retrieves a list of fences registered in the specified Geofence manager.
- </summary>
- <since_tizen> 3 </since_tizen>
- <returns>List of FenceData instances registered for each geofence.</returns>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case geofence is not supported.</exception>
- </member>
- <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetGeofenceDataListByPlaceId(System.Int32)">
- <summary>
- Retrieves a list of fences registered in the specified place.
- </summary>
- <since_tizen> 3 </since_tizen>
- <param name="placeId"> The place ID.</param>
- <returns>The list of FenceData instances registered for each geofence for the specified place.</returns>
- <privilege>http://tizen.org/privilege/location</privilege>
- <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
- <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>
- <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>
- </member>
- </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Tizen.Location.Geofence</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Tizen.Location.Geofence.Fence">\r
+ <summary>\r
+ Geofence defines a virtual perimeter for a real-world geographic area.\r
+ If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you.\r
+ You can create a geofence with the information of the Geopoint, Wi-Fi, or BT.\r
+ <list>\r
+ <item>Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius.</item>\r
+ <item>WIFI: Geofence is specified by the BSSID of the Wi-Fi access point.</item>\r
+ <item>BT: Geofence is specified by the Bluetooth address.</item>\r
+ </list>\r
+ 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
+ and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.Type">\r
+ <summary>\r
+ Gets the type of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.PlaceId">\r
+ <summary>\r
+ Gets the ID of the place.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.Longitude">\r
+ <summary>\r
+ Gets the longitude of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.Latitude">\r
+ <summary>\r
+ Gets the latitude of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.Radius">\r
+ <summary>\r
+ Gets the radius of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.Address">\r
+ <summary>\r
+ Gets the address of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.Bssid">\r
+ <summary>\r
+ Gets the BSSID of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.Fence.Ssid">\r
+ <summary>\r
+ Gets the SSID of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.Fence.CreateGPSFence(System.Int32,System.Int32,System.Int32,System.Int32,System.String)">\r
+ <summary>\r
+ Creates a geopoint type of the new geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId">The current place ID.</param>\r
+ <param name="latitude">Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees).</param>\r
+ <param name="longitude">Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees).</param>\r
+ <param name="radius">Specifies the value of radius of the geofence [100 ~ 500](meter).</param>\r
+ <param name="address">Specifies the value of the address.</param>\r
+ <returns>The newly created geofence instance.</returns>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.Fence.CreateWifiFence(System.Int32,System.String,System.String)">\r
+ <summary>\r
+ Creates a Wi-Fi type of the new geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId">The current place ID.</param>\r
+ <param name="bssid">Specifies the value of BSSID of the Wi-Fi MAC address.</param>\r
+ <param name="ssid"> Specifies the value of SSID of the Wi-Fi device.</param>\r
+ <returns>The newly created geofence instance.</returns>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.Fence.CreateBTFence(System.Int32,System.String,System.String)">\r
+ <summary>\r
+ Creates a Bluetooth type of the new geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId">The current place ID.</param>\r
+ <param name="bssid">Specifies the value of BSSID of BT MAC address.</param>\r
+ <param name="ssid"> Specifies the value of SSID of BT Device.</param>\r
+ <returns>The newly created geofence instance.</returns>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.Fence.Dispose">\r
+ <summary>\r
+ The overloaded Dispose API for destroying the fence handle.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.FenceData">\r
+ <summary>\r
+ Represents the geofence list item data.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.FenceData.Fence">\r
+ <summary>\r
+ The geofence instance.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.FenceData.GeofenceId">\r
+ <summary>\r
+ The geofence ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.FenceData.Index">\r
+ <summary>\r
+ The index number of fences in the list.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <value>The index value starts from 1.</value>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.FenceData.Count">\r
+ <summary>\r
+ The total number of fences that exists for the requester.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.PlaceData">\r
+ <summary>\r
+ Represents the place list item data.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.PlaceData.PlaceId">\r
+ <summary>\r
+ The current place ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.PlaceData.Name">\r
+ <summary>\r
+ The current place name.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.PlaceData.Index">\r
+ <summary>\r
+ The index number of places in the list.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <value>The index value starts from 1.</value>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.PlaceData.Count">\r
+ <summary>\r
+ The total number of places that exists for the requester.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.FenceStatus">\r
+ <summary>\r
+ The geofence status describes the current state and duration of a geofence.\r
+ <list>\r
+ <item>State: The state is specified by the current state of the fence.</item>\r
+ <item>Duration: Geofence is specified by the duration of the current state.</item>\r
+ </list>\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.FenceStatus.#ctor(System.Int32)">\r
+ <summary>\r
+ Creates a new geofence status.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case of geofence is not supported.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.FenceStatus.State">\r
+ <summary>\r
+ Gets the state of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.FenceStatus.Duration">\r
+ <summary>\r
+ Gets the amount of seconds, the geofence is in the current state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.FenceStatus.Dispose">\r
+ <summary>\r
+ The overloaded Dispose API for destroying the fence handle.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.FenceType">\r
+ <summary>\r
+ Enumeration for the geofence types.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.FenceType.GeoPoint">\r
+ <summary>\r
+ Geofence is specified by the geospatial coordinate.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.FenceType.Wifi">\r
+ <summary>\r
+ Geofence is specified by the Wi-Fi access point.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.FenceType.Bluetooth">\r
+ <summary>\r
+ Geofence is specified by the Bluetooth device.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.GeofenceState">\r
+ <summary>\r
+ Enumeration for the state of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceState.Uncertain">\r
+ <summary>\r
+ Uncertain state of geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceState.In">\r
+ <summary>\r
+ Geofence In state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceState.Out">\r
+ <summary>\r
+ Geofence Out state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.GeofenceEventType">\r
+ <summary>\r
+ Enumeration for the geofence management events.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceAdded">\r
+ <summary>\r
+ Geofence is added.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceRemoved">\r
+ <summary>\r
+ Geofence is removed.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStarted">\r
+ <summary>\r
+ Geofencing is started.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.FenceStopped">\r
+ <summary>\r
+ Geofencing is stopped.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceAdded">\r
+ <summary>\r
+ Place is added.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceRemoved">\r
+ <summary>\r
+ Place is removed.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.PlaceUpdated">\r
+ <summary>\r
+ Place is updated.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingEnabled">\r
+ <summary>\r
+ Setting for geofencing is enabled.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceEventType.SettingDisabled">\r
+ <summary>\r
+ Setting for geofencing is disabled.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.ProximityProvider">\r
+ <summary>\r
+ Enumeration for the provider of proximity.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityProvider.Location">\r
+ <summary>\r
+ Proximity is specified by the geospatial coordinate.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityProvider.Wifi">\r
+ <summary>\r
+ Proximity is specified by the Wi-Fi access point.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityProvider.Bluetooth">\r
+ <summary>\r
+ Proximity is specified by the Bluetooth device.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityProvider.BLE">\r
+ <summary>\r
+ Proximity is specified by the Bluetooth low-energy device.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityProvider.Sensor">\r
+ <summary>\r
+ Proximity is specified by the sensor.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.ProximityState">\r
+ <summary>\r
+ Enumeration for the state of proximity.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityState.Uncertain">\r
+ <summary>\r
+ Uncertain state of proximity.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityState.Far">\r
+ <summary>\r
+ Far state of proximity.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityState.Near">\r
+ <summary>\r
+ Far state of proximity.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.ProximityState.Immediate">\r
+ <summary>\r
+ Immediate state of proximity.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.GeofenceError">\r
+ <summary>\r
+ Enumeration for the types of error occured, if any.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.None">\r
+ <summary>\r
+ Successful.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.OutOfMemory">\r
+ <summary>\r
+ Out of memory.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidParameter">\r
+ <summary>\r
+ Invalid parameter.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.PermissionDenied">\r
+ <summary>\r
+ Permission denied.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.NotSupported">\r
+ <summary>\r
+ Not Supported.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.NotInitialized">\r
+ <summary>\r
+ Geofence manager is not initialized.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.InvalidID">\r
+ <summary>\r
+ Invalid geofence ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.Exception">\r
+ <summary>\r
+ Exception occurs.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.AlreadyStarted">\r
+ <summary>\r
+ Geofencing is already started.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.TooManyGeofence">\r
+ <summary>\r
+ Too many geofence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.IPC">\r
+ <summary>\r
+ Error in GPS, Wi-Fi, or BT.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.DBFailed">\r
+ <summary>\r
+ DB error in the server side.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.PlaceAccessDenied">\r
+ <summary>\r
+ Access to the specified place is denied.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.Location.Geofence.GeofenceError.GeofenceAccessDenied">\r
+ <summary>\r
+ Access to the specified geofence is denied.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.ProximityStateEventArgs">\r
+ <summary>\r
+ Event arguments are passed when an event is triggered to notify the proximity state change.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.ProximityStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.ProximityState,Tizen.Location.Geofence.ProximityProvider)">\r
+ <summary>\r
+ The internal constructor.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="id">The geofence ID.</param>\r
+ <param name="state">The proximity state.</param>\r
+ <param name="provider">The proximity provider.</param>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.GeofenceId">\r
+ <summary>\r
+ The geofence ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.State">\r
+ <summary>\r
+ The proximity state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.ProximityStateEventArgs.Provider">\r
+ <summary>\r
+ The proximity provider.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.GeofenceStateEventArgs">\r
+ <summary>\r
+ Event arguments are passed when an event is triggered to notify the geofence state change.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.GeofenceStateEventArgs.#ctor(System.Int32,Tizen.Location.Geofence.GeofenceState)">\r
+ <summary>\r
+ The internal constructor.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="fenceId">The specified geofence ID.</param>\r
+ <param name="state">The geofence state.</param>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.GeofenceId">\r
+ <summary>\r
+ The specified geofence ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.GeofenceStateEventArgs.State">\r
+ <summary>\r
+ The geofence state.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.GeofenceResponseEventArgs">\r
+ <summary>\r
+ Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc..\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.GeofenceResponseEventArgs.#ctor(System.Int32,System.Int32,Tizen.Location.Geofence.GeofenceError,Tizen.Location.Geofence.GeofenceEventType)">\r
+ <summary>\r
+ The internal constructor.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId">The place ID.</param>\r
+ <param name="fenceId">The specified geofence ID.</param>\r
+ <param name="error">The error code for the particular action.</param>\r
+ <param name="eventType">The result code for the particular place and geofence management.</param>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.PlaceId">\r
+ <summary>\r
+ The place ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.FenceId">\r
+ <summary>\r
+ The specified geofence ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.ErrorCode">\r
+ <summary>\r
+ The error code for the particular action.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.GeofenceResponseEventArgs.EventType">\r
+ <summary>\r
+ The result code for the particular place and geofence management.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.GeofenceManager">\r
+ <summary>\r
+ The Geofence Manager API provides service related to geofence (geo-fence).\r
+ Geofence is a virtual perimeter for a real-world geographic area.\r
+ This API provides functions to set geofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.\r
+ Also, notifications on events like changing in service status are provided.\r
+ There are two kinds of places and fences:\r
+ <list>\r
+ <item>Public places and fences are created by the MyPlace application that can be used by all applications.</item>\r
+ <item>Private places and fences are created by the specified application that can be used by the same application.</item>\r
+ </list>\r
+ Notifications can be received about the following events:\r
+ <list>\r
+ <item>Zone in when a device enters a specific area.</item>\r
+ <item>Zone out when a device exits a specific area.</item>\r
+ <item>Results and errors for each event requested to the geofence module.</item>\r
+ </list>\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.GeofenceManager.#ctor">\r
+ <summary>\r
+ Creates a new Geofence manager.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.OutOfMemoryException">In case of out of memory condition.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Location.Geofence.GeofenceManager.IsSupported">\r
+ <summary>\r
+ Checks whether the Geofence manager is available or not.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.GeofenceManager.Start(System.Int32)">\r
+ <summary>\r
+ Starts the geofencing service.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="geofenceId">The specified geofence ID.</param>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <remarks>\r
+ When the location service is enabled, the StateChanged event is invoked and the service starts.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.GeofenceManager.Stop(System.Int32)">\r
+ <summary>\r
+ Stops the geofenceing service.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="geofenceId">The specified geofence ID.</param>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <remarks>\r
+ This function initiates the process of stopping the service.\r
+ You can stop and start the Geofence manager as needed.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="E:Tizen.Location.Geofence.GeofenceManager.StateChanged">\r
+ <summary>\r
+ Invokes when a device enters or exits the given geofence if this event is registered.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <remarks>\r
+ Call to Start() will invoke this event.\r
+ </remarks>\r
+ <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
+ </member>\r
+ <member name="E:Tizen.Location.Geofence.GeofenceManager.ProximityChanged">\r
+ <summary>\r
+ Called when the proximity state of a device is changed.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <remarks>\r
+ Call to Start() will invoke this event.\r
+ </remarks>\r
+ <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
+ </member>\r
+ <member name="E:Tizen.Location.Geofence.GeofenceManager.GeofenceEventChanged">\r
+ <summary>\r
+ Called when some event occurs in the geofence and the place, such as add, update, etc..\r
+ The events of public geofence is also received if there are public geofences.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <remarks>\r
+ Call to Start() will invoke this event.\r
+ The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.\r
+ </remarks>\r
+ <exception cref="T:System.NotSupportedException">In case the feature is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.GeofenceManager.Dispose">\r
+ <summary>\r
+ The overloaded Dispose API for destroying the GeofenceManager handle.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="T:Tizen.Location.Geofence.VirtualPerimeter">\r
+ <summary>\r
+ Allows to create a virtual fence as geofence using the GeofenceManager instance.\r
+ A user can manage all the geofence or place related data and events.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.#ctor(Tizen.Location.Geofence.GeofenceManager)">\r
+ <summary>\r
+ Creates a VirtualPerimeter which can be used to create a virtual fence.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="manager">The GeofenceManager instance.</param>\r
+ <exception cref="T:System.ArgumentException"> In case of an invalid parameter.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddPlaceName(System.String)">\r
+ <summary>\r
+ Creates a new place for the geofencing service.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="name">A place name to be created.</param>\r
+ <returns>The place ID to be newly created on success.</returns>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.UpdatePlace(System.Int32,System.String)">\r
+ <summary>\r
+ Updates the place name of a given place ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId">The specified place ID.</param>\r
+ <param name="name">A new place name of the place ID.</param>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any System error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemovePlace(System.Int32)">\r
+ <summary>\r
+ Removes the specific place for the geofencing service.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId">The specified place ID.</param>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.ArgumentException">Incase of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.AddGeofence(Tizen.Location.Geofence.Fence)">\r
+ <summary>\r
+ Adds the geofence for a given Geofence manager.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="fence">The geofence instance to be added.</param>\r
+ <returns>The geofence ID to be newly created on success.</returns>\r
+ <remarks> The return value will always be a number greater than zero.</remarks>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.RemoveGeofence(System.Int32)">\r
+ <summary>\r
+ Removes the geofence with a given geofence ID.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="fenceId">The specified geofence ID.</param>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceName(System.Int32)">\r
+ <summary>\r
+ Gets the name of place.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId">The place ID.</param>\r
+ <returns>The name of the place.</returns>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetPlaceDataList">\r
+ <summary>\r
+ Retrieves a list of places registered in the specified Geofence manager.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <returns>List of places registered as the PlaceData instance list.</returns>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetFenceDataList">\r
+ <summary>\r
+ Retrieves a list of fences registered in the specified Geofence manager.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <returns>List of FenceData instances registered for each geofence.</returns>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case geofence is not supported.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Location.Geofence.VirtualPerimeter.GetGeofenceDataListByPlaceId(System.Int32)">\r
+ <summary>\r
+ Retrieves a list of fences registered in the specified place.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="placeId"> The place ID.</param>\r
+ <returns>The list of FenceData instances registered for each geofence for the specified place.</returns>\r
+ <privilege>http://tizen.org/privilege/location</privilege>\r
+ <exception cref="T:System.ArgumentException">In case of an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">In case privileges are not defined.</exception>\r
+ <exception cref="T:System.NotSupportedException">In case the geofence is not supported.</exception>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / platform / core / csapi / tizenfx.git / blobdiff