/// The time interval between callback updates.
/// Should be in the range [1~120] seconds.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int Interval
{
get
/// <summary>
/// The NMEAData from the Satellite.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public string Nmea
{
get
/// <summary>
/// The Count of Active satellites.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int ActiveCount
{
get
/// <summary>
/// The Count of satellites in view.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int InViewCount
{
get
/// <summary>
/// The list of satellites/last recorded satellites in view.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public IList<SatelliteInformation> Satellites
{
get
/// <summary>
/// The constructor of GpsSatellite class.
- /// <param name="locator"> Locator object initilized using Gps.</param>
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
+ /// <param name="locator"> Locator object initilized using Gps.</param>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
public GpsSatellite(Locator locator)
{
Log.Info(Globals.LogTag, "Calling GpsSatellite constructor");
/// (event) SatelliteStatusUpdated is raised whenever satellite information is updated.
/// The callback will be invoked periodically (every Interval seconds).
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<SatelliteStatusChangedEventArgs> SatelliteStatusUpdated
{
add
/// <summary>
/// The overidden Dispose method of the IDisposable class.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void Dispose()
{
Log.Info(Globals.LogTag, "Dispose");
/// </summary>
/// <param name="topLeft"> The coordinate which constitute the top left handside of the rectangular boundary.</param>
/// <param name="bottomRight"> The coordinate which constitute the bottom right handside of the rectangular boundary.</param>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public RectangleBoundary(Coordinate topLeft, Coordinate bottomRight)
{
Log.Info(Globals.LogTag, "Calling RectangleBoundary constructor");
/// </summary>
/// <param name="coordinate"> The coordinates which constitute the center of the circular boundary.</param>
/// <param name="radius"> The radius value of the circular boundary.</param>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public CircleBoundary(Coordinate coordinate, double radius)
{
Log.Info(Globals.LogTag, "Calling CircleBoundary constructor");
/// <summary>
/// Gets the coordinate of the center of a circular boundary.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Coordinate Center
{
get
/// <summary>
/// Gets the radius of a circular boundary.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public double Radius
{
get
/// Constructor of the polygon boundary class.
/// </summary>
/// <param name="coordinates"> The coordinates which constitute the polgonal boundary.</param>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public PolygonBoundary(IList<Coordinate> coordinates)
{
Log.Info(Globals.LogTag, "Calling PolygonBoundary Constructor");
/// <summary>
/// Gets the list of coordinates which constitute a polygonal boundary
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public IList<Coordinate> Coordinates
{
get
/// The constructor of Locator class.
/// </summary>
/// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <feature>http://tizen.org/feature/location</feature>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Locator(LocationType locationType)
{
Log.Info(Globals.LogTag, "Locator Constructor");
/// The time interval between callback updates.
/// Should be in the range [1~120] seconds.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int Interval
{
get
/// The time interval between Distance based location callback updates.
/// Should be in the range [1~120] seconds.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public int StayInterval
{
get
/// The distance between callback updates.
/// Should be in the range [1-120] meters.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public double Distance
{
get
/// <summary>
/// Gets the status whether mock location is enabled or not.
/// </summary>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public bool EnableMock
{
get
/// <summary>
/// Starts the Location Manager which has been created using the specified method.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void Start()
{
Log.Info(Globals.LogTag, "Starting Location Manager");
/// Stops the Location Manager which has been activated using the specified method.
/// Does not destroy the manager.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void Stop()
{
Log.Info(Globals.LogTag, "Stopping Location Manager");
/// Sets a mock location for the given location method.
/// </summary>
/// <param name="location"> The location object containing the mock location details.</param>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void SetMockLocation(Location location)
{
Log.Info(Globals.LogTag, "Setting mock location");
/// <summary>
/// Clears a mock location for the given location method.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void ClearMock()
{
Log.Info(Globals.LogTag, "Clear mock location");
/// </summary>
/// <param name="timeout"> Timeout to stop requesting single location after(seconds).</param>
/// <returns> A task which contains the current location details</returns>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Task<Location> GetLocationAsync(int timeout)
{
var task = new TaskCompletionSource<Location>();
/// <summary>
/// Gets the details of the location.
/// </summary>
- /// <returns> which contains the current location details</returns>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <returns> which contains the current location details.</returns>
+ /// <privilege>http://tizen.org/privilege/location</privilege>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the location.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public Location GetLocation()
{
double latitude = 0;
/// Adds a bounds for a given locator.
/// </summary>
/// <param name="locationBoundary"> The boundary object to be added to the locator.</param>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void AddBoundary(LocationBoundary locationBoundary)
{
Log.Info(Globals.LogTag, "AddBoundary called");
/// Deletes a bounds for a given locator.
/// </summary>
/// <param name="locationBoundary"> The boundary object to be removed from the locator.</param>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void RemoveBoundary(LocationBoundary locationBoundary)
{
Log.Info(Globals.LogTag, "RemoveBoundary called");
/// <summary>
/// The overidden Dispose method of the IDisposable class.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public void Dispose()
{
Dispose(true);
/// <summary>
/// (event) ServiceStateChanged Event is invoked when the location service state is changed.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<ServiceStateChangedEventArgs> ServiceStateChanged
{
add
/// <summary>
/// (event) ZoneChanged is invoked when the previously set boundary area is entered or left.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<ZoneChangedEventArgs> ZoneChanged
{
add
/// <summary>
/// (event) SetttingChanged is raised when the location setting is changed.
/// </summary>
- /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<SettingChangedEventArgs> SettingChanged
{
add
/// (event) DistanceBasedLocationChanged is raised with updated location information.
/// The callback will be invoked at minimum interval or minimum distance with updated position information.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<LocationChangedEventArgs> DistanceBasedLocationChanged
{
add
/// (event)LocationUpdated is raised at defined intervals of time with updated location information.
/// The callback will be invoked periodically.
/// </summary>
- /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
- /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
public event EventHandler<LocationChangedEventArgs> LocationChanged
{
add