namespace Tizen.Location.Geofence
{
/// <summary>
- /// Geo-fence 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 Geopoint, Wi-Fi, or BT.
+ /// 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 coordinates (Latitude and Longitude) and Radius</item>
- /// <item>WIFI: Geofence is specified by BSSID of Wi-Fi access point</item>
- /// <item>BT: Geofence is specified by Bluetooth address</item>
+ /// <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>
- /// Basic service set identification(BSSID) The BSSID is the MAC address of the wireless access point(WAP) generated by combining the 24 bit Organization Unique Identifier(the manufacturer's identity)
+ /// 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>
+ /// <since_tizen> 3 </since_tizen>
public class Fence : IDisposable
{
private bool _disposed = false;
/// <summary>
/// Gets the type of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FenceType Type
{
get
}
/// <summary>
- /// Gets the id of place.
+ /// Gets the ID of the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int PlaceId
{
get
/// <summary>
/// Gets the longitude of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Longitude
{
get
/// <summary>
/// Gets the latitude of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Latitude
{
get
/// <summary>
/// Gets the radius of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Radius
{
get
/// <summary>
/// Gets the address of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Address
{
get
}
/// <summary>
- /// Gets the bssid of geofence.
+ /// Gets the BSSID of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Bssid
{
get
}
/// <summary>
- /// Gets the ssid of geofence.
+ /// Gets the SSID of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Ssid
{
get
}
/// <summary>
- /// Creates a geopoint type of new geofence.
+ /// 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 geofence [-90.0 ~ 90.0] (degrees).</param>
- /// <param name="longitude">Specifies the value of longitude of geofence [-180.0 ~ 180.0] (degrees).</param>
- /// <param name="radius">Specifies the value of radius of geofence [100 ~ 500](meter).</param>
- /// <param name="address">Specifies the value of address.</param>
- /// <returns>Newly created geofence instance.</returns>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <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="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public static Fence CreateGPSFence(int placeId, int latitude, int longitude, int radius, string address)
{
IntPtr handle = IntPtr.Zero;
}
/// <summary>
- /// Creates a Wi-Fi type of new geofence.
+ /// 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 Wi-Fi MAC address.</param>
- /// <param name="ssid"> Specifies the value of SSID of Wi-Fi Device.</param>
- /// <returns>Newly created geofence instance.</returns>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <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="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public static Fence CreateWifiFence(int placeId, string bssid, string ssid)
{
IntPtr handle = IntPtr.Zero;
}
/// <summary>
- /// Creates a bluetooth type of new geofence.
+ /// Creates a Bluetooth type of the new geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The current place id.</param>
+ /// <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>Newly created geofence instance.</returns>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <returns>The newly created geofence instance.</returns>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public static Fence CreateBTFence(int placeId, string bssid, string ssid)
{
IntPtr handle = IntPtr.Zero;
}
/// <summary>
- /// Overloaded Dispose API for destroying the fence Handle.
+ /// The overloaded Dispose API for destroying the fence handle.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Represents the Geofence list Item data.
+ /// Represents the geofence list item data.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FenceData
{
internal FenceData(int fenceId, IntPtr handle, int index, int count)
Count = count;
}
/// <summary>
- /// Geofence instance.
+ /// The geofence instance.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Fence Fence
{
get;
}
/// <summary>
- /// The geofence id.
+ /// The geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int GeofenceId
{
get;
}
/// <summary>
- /// The index number of the fences in the list.
+ /// The index number of fences in the list.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <value>Index value starts from 1.</value>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>The index value starts from 1.</value>
public int Index
{
get;
/// <summary>
/// The total number of fences that exists for the requester.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Count
{
get;
};
/// <summary>
- /// Represents the Place list Item data.
+ /// Represents the place list item data.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceData
{
internal PlaceData(int id, string name, int index, int count)
Count = count;
}
/// <summary>
- /// The current place id.
+ /// The current place ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int PlaceId
{
get;
/// <summary>
/// The current place name.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Name
{
get;
}
/// <summary>
- /// The index number of the places in the list.
+ /// The index number of places in the list.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <value>Index value starts from 1.</value>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>The index value starts from 1.</value>
public int Index
{
get;
/// <summary>
/// The total number of places that exists for the requester.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Count
{
get;
/// <summary>
/// The geofence status describes the current state and duration of a geofence.
/// <list>
- /// <item>State: State is specified by current state of fence</item>
- /// <item>Duration: Geofence is specified by duration of current state</item>
+ /// <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>
+ /// <since_tizen> 3 </since_tizen>
public class FenceStatus : IDisposable
{
private bool _disposed = false;
/// <summary>
/// Creates a new geofence status.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">In case of geofence is not supported.</exception>
public FenceStatus(int fenceId)
{
IntPtr handle;
/// <summary>
/// Gets the state of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public GeofenceState State
{
get
}
/// <summary>
- /// Gets the amount of seconds geofence is in the current state.
+ /// Gets the amount of seconds, the geofence is in the current state.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public int Duration
{
get
}
/// <summary>
- /// Overloaded Dispose API for destroying the fence Handle.
+ /// The overloaded Dispose API for destroying the fence handle.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Enumeration for geofence type.
+ /// Enumeration for the geofence types.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum FenceType
{
/// <summary>
- /// Geofence is specified by geospatial coordinate.
+ /// Geofence is specified by the geospatial coordinate.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
GeoPoint = 1,
/// <summary>
- /// Geofence is specified by Wi-Fi access point.
+ /// Geofence is specified by the Wi-Fi access point.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Wifi,
/// <summary>
- /// Geofence is specified by Bluetooth device.
+ /// Geofence is specified by the Bluetooth device.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Bluetooth
};
/// <summary>
- /// Enumerations for the state of geofence.
+ /// Enumeration for the state of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum GeofenceState
{
/// <summary>
/// Uncertain state of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Uncertain = 0,
/// <summary>
/// Geofence In state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
In,
/// <summary>
/// Geofence Out state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Out
};
/// <summary>
- /// Enumerations for geofence management events.
+ /// Enumeration for the geofence management events.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum GeofenceEventType
{
/// <summary>
/// Geofence is added.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceAdded = 0,
/// <summary>
/// Geofence is removed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceRemoved,
/// <summary>
/// Geofencing is started.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceStarted,
/// <summary>
/// Geofencing is stopped.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceStopped,
/// <summary>
/// Place is added.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceAdded = 0x10,
/// <summary>
/// Place is removed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceRemoved,
/// <summary>
/// Place is updated.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceUpdated,
/// <summary>
/// Setting for geofencing is enabled.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
SettingEnabled = 0x20,
/// <summary>
/// Setting for geofencing is disabled.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
SettingDisabled
};
/// <summary>
/// Enumeration for the provider of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ProximityProvider
{
/// <summary>
- /// Proximity is specified by geospatial coordinate.
+ /// Proximity is specified by the geospatial coordinate.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Location = 0,
/// <summary>
- /// Proximity is specified by Wi-Fi access point.
+ /// Proximity is specified by the Wi-Fi access point.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Wifi,
/// <summary>
- /// Proximity is specified by Bluetooth device.
+ /// Proximity is specified by the Bluetooth device.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Bluetooth,
/// <summary>
- /// Proximity is specified by Bluetooth low energy device.
+ /// Proximity is specified by the Bluetooth low-energy device.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
BLE,
/// <summary>
- /// Proximity is specified by Sensor.
+ /// Proximity is specified by the sensor.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Sensor
}
/// <summary>
/// Enumeration for the state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ProximityState
{
/// <summary>
/// Uncertain state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Uncertain = 0,
/// <summary>
/// Far state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Far,
/// <summary>
/// Far state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Near,
/// <summary>
/// Immediate state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Immediate
}
}
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Enum to give the type of error occured, if any.
+ /// Enumeration for the types of error occured, if any.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum GeofenceError
{
/// <summary>
/// Successful.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
None = Tizen.Internals.Errors.ErrorCode.None,
/// <summary>
/// Out of memory.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory,
/// <summary>
/// Invalid parameter.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
InvalidParameter = Tizen.Internals.Errors.ErrorCode.InvalidParameter,
/// <summary>
/// Permission denied.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied,
/// <summary>
/// Not Supported.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
NotSupported = Tizen.Internals.Errors.ErrorCode.NotSupported,
/// <summary>
- /// Geofence Manager is not initialized.
+ /// Geofence manager is not initialized.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
NotInitialized = -0x02C00000 | 0x100 | 0x01,
/// <summary>
/// Invalid geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
InvalidID = -0x02C00000 | 0x100 | 0x02,
/// <summary>
/// Exception occurs.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Exception = -0x02C00000 | 0x100 | 0x03,
/// <summary>
/// Geofencing is already started.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
AlreadyStarted = -0x02C00000 | 0x100 | 0x04,
/// <summary>
/// Too many geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
TooManyGeofence = -0x02C00000 | 0x100 | 0x05,
/// <summary>
/// Error in GPS, Wi-Fi, or BT.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
IPC = -0x02C00000 | 0x100 | 0x06,
/// <summary>
/// DB error in the server side.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
DBFailed = -0x02C00000 | 0x100 | 0x07,
/// <summary>
- /// Access to specified place is denied.
+ /// Access to the specified place is denied.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceAccessDenied = -0x02C00000 | 0x100 | 0x08,
/// <summary>
- /// Access to specified geofence is denied.
+ /// Access to the specified geofence is denied.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
GeofenceAccessDenied = -0x02C00000 | 0x100 | 0x09
};
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Event arguments passed when Event is triggered to notify proximity state change.
+ /// Event arguments are passed when an event is triggered to notify the proximity state change.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ProximityStateEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor.
+ /// The internal constructor.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="id">The geofence id.</param>
+ /// <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>
internal ProximityStateEventArgs(int id, ProximityState state, ProximityProvider provider)
}
/// <summary>
- /// The geofence id.
+ /// The geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int GeofenceId
{
get;
/// <summary>
/// The proximity state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ProximityState State
{
get;
/// <summary>
/// The proximity provider.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ProximityProvider Provider
{
get;
};
/// <summary>
- /// Event arguments passed when Event is triggered to notify Geofence state change.
+ /// Event arguments are passed when an event is triggered to notify the geofence state change.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class GeofenceStateEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor.
+ /// The internal constructor.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="fenceId">The specified geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="fenceId">The specified geofence ID.</param>
/// <param name="state">The geofence state.</param>
internal GeofenceStateEventArgs(int fenceId, GeofenceState state)
{
}
/// <summary>
- /// The specified geofence id.
+ /// The specified geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int GeofenceId
{
get;
/// <summary>
/// The geofence state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public GeofenceState State
{
get;
}
/// <summary>
- /// Event arguments passed when Event occurs in geofence and place such as add, update, etc..
+ /// Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc..
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class GeofenceResponseEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor.
+ /// The internal constructor.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The place id.</param>
- /// <param name="fenceId">The specified geofence id.</param>
+ /// <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>
internal GeofenceResponseEventArgs(int placeId, int fenceId, GeofenceError error, GeofenceEventType eventType)
}
/// <summary>
- /// The place id.
+ /// The place ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int PlaceId
{
get;
}
/// <summary>
- /// The specified geofence id.
+ /// The specified geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int FenceId
{
get;
/// <summary>
/// The error code for the particular action.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public GeofenceError ErrorCode
{
get;
/// <summary>
/// The result code for the particular place and geofence management.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public GeofenceEventType EventType
{
get;
namespace Tizen.Location.Geofence
{
/// <summary>
- /// This Geofence Manager API provides service related to geofence(geo-fence).
- /// A geofence is a virtual perimeter for a real-world geographic area.
- /// This API provides functions to set geofence with geopoint, MAC address of Wi-Fi and Bluetooth address.
- /// And, notifications on events like changing in service status are provided.
+ /// 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 that are created by MyPlace app can be used by all apps.</item>
- /// <item>Private places and fences that are created by specified app can be used by the same app.</item>
+ /// <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 geofence module</item>
+ /// <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>
+ /// <since_tizen> 3 </since_tizen>
public class GeofenceManager : IDisposable
{
private bool _disposed = false;
}
/// <summary>
- /// Creates a new geofence manager.
+ /// Creates a new Geofence manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="OutOfMemoryException">Incase of OutOfMemory condition.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="OutOfMemoryException">In case of out of memory condition.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public GeofenceManager()
{
IntPtr handle;
}
/// <summary>
- /// Checks whether the geofence manager is available or not.
+ /// Checks whether the Geofence manager is available or not.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static bool IsSupported
{
get
/// <summary>
/// Starts the geofencing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="geofenceId">The specified geofence id.</param>
+ /// <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="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void Start(int geofenceId)
{
GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Start(Handle, geofenceId);
/// <summary>
/// Stops the geofenceing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="geofenceId">The specified geofence id.</param>
+ /// <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.
+ /// You can stop and start the Geofence manager as needed.
/// </remarks>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void Stop(int geofenceId)
{
GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Stop(Handle, geofenceId);
private static event EventHandler<GeofenceStateEventArgs> s_stateChanged = null;
/// <summary>
- /// Invokes when a device enters or exits the given geofence, If this event is registered.
+ /// Invokes when a device enters or exits the given geofence if this event is registered.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
/// Call to Start() will invoke this event.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
+ /// <exception cref="NotSupportedException">In case the feature is not supported.</exception>
public event EventHandler<GeofenceStateEventArgs> StateChanged
{
add
private static event EventHandler<ProximityStateEventArgs> s_proximityChanged;
/// <summary>
- /// Called when a proximity state of device is changed.
+ /// Called when the proximity state of a device is changed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
/// Call to Start() will invoke this event.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
+ /// <exception cref="NotSupportedException">In case the feature is not supported.</exception>
public event EventHandler<ProximityStateEventArgs> ProximityChanged
{
add
private static event EventHandler<GeofenceResponseEventArgs> s_geofenceEventChanged;
/// <summary>
- /// Called when the some event occurs in geofence and place such as add, update, etc..
+ /// 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>
+ /// <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.
+ /// The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
+ /// <exception cref="NotSupportedException">In case the feature is not supported.</exception>
public event EventHandler<GeofenceResponseEventArgs> GeofenceEventChanged
{
add
}
/// <summary>
- /// Overloaded Dispose API for destroying the GeofenceManager Handle.
+ /// The overloaded Dispose API for destroying the GeofenceManager handle.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
<remarks>
<h2>Overview</h2>
<para>
-This API provides functions to set geofence with geopoint, MAC address of Wi-Fi, and Bluetooth address.
-A
nd notifications on events like changing in service status are provided.<p>
+This API provides functions to set the gofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.
+A
lso, notifications on events like changing in service status are provided.<p>
There are two kinds of places and fences:<br/>
-- Public places and fences that are created by MyPlace app can be used by all apps.<br/>
-- Private places and fences that are created by
specified app can be used by the same app.<p>
+- Public places and fences that are created by the MyPlace application can be used by all applications.<br/>
+- Private places and fences that are created by
the specified application can be used by the same application.<p>
Notifications can be received about the following events:<br/>
-- Zone in when a device enters a specific area<br/>
-- Zone out when a device exits a specific area<br/>
-- Results and errors for each event requested to geofence module<p>
+- Zone in when a device enters a specific area.<br/>
+- Zone out when a device exits a specific area.<br/>
+- Results and errors for each event requested to geofence module
.<p>
The Geofence manager has the following properties:<br/>
-- geofence type<br/>
-- status<br/>
+- The geofence type.<br/>
+- The status.<br/>
- 'Service state change' callback
</para>
<h2>Related Features</h2>
-<para>To guarantee that the Geofence application runs on a device with Geofence profile feature,
+<para>To guarantee that the geofence application runs on a device with the geofence profile feature,
declare the following feature requirements in the config file:<br/>
http://tizen.org/feature/location<br/>
-http://tizen.org/feature/location.geofence<br/>
+http://tizen.org/feature/location.Geofence<br/>
http://tizen.org/feature/location.wps
</para>
</remarks>
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Allows to create a virtual fence as Geofence using GeofenceManager instance.
- /// User can manage all the geofence/place related data and events.
+ /// 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>
+ /// <since_tizen> 3 </since_tizen>
public class VirtualPerimeter
{
private IntPtr Handle;
/// <summary>
- /// Creates a VirtualPerimeter which can be used to create virtual fence.
+ /// Creates a VirtualPerimeter which can be used to create a virtual fence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="manager">GeofenceManager instance.</param>
- /// <exception cref="ArgumentException"> Incase of invlid parameter.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="manager">The GeofenceManager instance.</param>
+ /// <exception cref="ArgumentException"> In case of an invalid parameter.</exception>
public VirtualPerimeter(GeofenceManager manager)
{
if (manager == null)
}
/// <summary>
- /// Creates a new place for geofencing service.
+ /// Creates a new place for the geofencing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <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>
+ /// <returns>The place ID to be newly created on success.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public int AddPlaceName(string name)
{
int placeId = 0;
}
/// <summary>
- /// Updates the place name of a given place id.
+ /// 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>
+ /// <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="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any System error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void UpdatePlace(int placeId, string name)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.UpdatePlace(Handle, placeId, name);
}
/// <summary>
- /// Removes the specific place for geofencing service.
+ /// Removes the specific place for the geofencing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The specified place id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The specified place ID.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">Incase of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void RemovePlace(int placeId)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemovePlace(Handle, placeId);
}
/// <summary>
- /// Adds a geofence for a given geofence manager.
+ /// 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 retun value will always be a number greater than zero.</remarks>
+ /// <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="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public int AddGeofence(Fence fence)
{
int fenceId = 0;
}
/// <summary>
- /// Removes a geofence with a given geofence id.
+ /// Removes the geofence with a given geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="fenceId">The specified geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="fenceId">The specified geofence ID.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void RemoveGeofence(int fenceId)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemoveFence(Handle, fenceId);
/// <summary>
/// Gets the name of place.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The place id.</param>
+ /// <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="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public string GetPlaceName(int placeId)
{
string name = "";
}
/// <summary>
- /// Retrieves a list of places registered in the specified geofence manager.
+ /// Retrieves a list of places registered in the specified Geofence manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <returns>list of places registered as PlaceData instance list.</returns>
+ /// <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="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public IEnumerable<PlaceData> GetPlaceDataList()
{
List<PlaceData> places = new List<PlaceData>();
}
/// <summary>
- /// Retrieves a list of fences registered in the specified geofence manager.
+ /// Retrieves a list of fences registered in the specified Geofence manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <returns>list of FenceData instances registred for each Geofence.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <returns>List of FenceData instances registered for each geofence.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case geofence is not supported.</exception>
public IEnumerable<FenceData> GetFenceDataList()
{
List<FenceData> fences = new List<FenceData>();
/// <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>list of FenceData instances registred for each Geofence for specified place.</returns>
+ /// <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="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public IEnumerable<FenceData> GetGeofenceDataListByPlaceId(int placeId)
{
List<FenceData> fences = new List<FenceData>();
projects / platform / core / csapi / geofence.git / commitdiff