2. Add exceptions for doxygen
Change-Id: I19820ccaea06feb1013e9a1e294c4c1097d1e052
Signed-off-by: kj7.sung <kj7.sung@samsung.com>
Name: csapi-location
Summary: Tizen Location API for C#
Name: csapi-location
Summary: Tizen Location API for C#
Release: 1
Group: Development/Libraries
License: Apache-2.0
Release: 1
Group: Development/Libraries
License: Apache-2.0
/// The time interval between callback updates.
/// Should be in the range [1~120] seconds.
/// </summary>
/// 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>
public int Interval
{
get
public int Interval
{
get
/// <summary>
/// The NMEAData from the Satellite.
/// </summary>
/// <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>
/// <summary>
/// The Count of Active satellites.
/// </summary>
/// <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>
public int ActiveCount
{
get
public int ActiveCount
{
get
/// <summary>
/// The Count of satellites in view.
/// </summary>
/// <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>
public int InViewCount
{
get
public int InViewCount
{
get
/// <summary>
/// The list of satellites/last recorded satellites in view.
/// </summary>
/// <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>
public IList<SatelliteInformation> Satellites
{
get
public IList<SatelliteInformation> Satellites
{
get
/// The constructor of GpsSatellite class.
/// <param name="locator"> Locator object initilized using Gps.</param>
/// </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>
public GpsSatellite(Locator locator)
{
Log.Info(Globals.LogTag, "Calling GpsSatellite constructor");
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>
/// (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>
public event EventHandler<SatelliteStatusChangedEventArgs> SatelliteStatusUpdated
{
add
public event EventHandler<SatelliteStatusChangedEventArgs> SatelliteStatusUpdated
{
add
/// <param name="endLatitude"> The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
/// <param name="endLongitude"> The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
/// <returns>Returns the distance between source and destination.</returns>
/// <param name="endLatitude"> The latitude of the source location [-90.0 ~ 90.0] (degrees).</param>
/// <param name="endLongitude"> The longitude of the source location[-180.0 ~ 180.0] (degrees).</param>
/// <returns>Returns the distance between source and destination.</returns>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
public static double GetDistanceBetween(double startLatitude, double startLongitude, double endLatitude, double endLongitude)
{
double result;
public static double GetDistanceBetween(double startLatitude, double startLongitude, double endLatitude, double endLongitude)
{
double result;
/// </summary>
/// <param name="location"> The location object to which distance is to be calculated.</param>
/// <returns>Returns the distance to the specified location.</returns>
/// </summary>
/// <param name="location"> The location object to which distance is to be calculated.</param>
/// <returns>Returns the distance to the specified location.</returns>
+ /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
+ /// <exception cref="NotSupportedException">Thrown when the location is not supported</exception>
public double GetDistanceTo(Location location)
{
double result;
public double GetDistanceTo(Location location)
{
double result;
/// <summary>
/// The overidden Dispose method of the IDisposable class.
/// </summary>
/// <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>
public void Dispose()
{
Log.Info(Globals.LogTag, "Dispose");
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>
/// </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>
public RectangleBoundary(Coordinate topLeft, Coordinate bottomRight)
{
Log.Info(Globals.LogTag, "Calling RectangleBoundary constructor");
public RectangleBoundary(Coordinate topLeft, Coordinate bottomRight)
{
Log.Info(Globals.LogTag, "Calling RectangleBoundary constructor");
if ((LocationBoundError)ret != LocationBoundError.None)
{
Log.Error(Globals.LogTag, "Error Creating Rectangular Boundary," + (LocationBoundError)ret);
if ((LocationBoundError)ret != LocationBoundError.None)
{
Log.Error(Globals.LogTag, "Error Creating Rectangular Boundary," + (LocationBoundError)ret);
- LocationErrorFactory.ThrowLocationBoundaryException(ret);
+ throw LocationErrorFactory.ThrowLocationBoundaryException(ret);
}
handle = boundsHandle;
}
}
handle = boundsHandle;
}
/// </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>
/// </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>
public CircleBoundary(Coordinate coordinate, double radius)
{
Log.Info(Globals.LogTag, "Calling CircleBoundary constructor");
public CircleBoundary(Coordinate coordinate, double radius)
{
Log.Info(Globals.LogTag, "Calling CircleBoundary constructor");
if ((LocationBoundError)ret != LocationBoundError.None)
{
Log.Error(Globals.LogTag, "Error Creating Circular Boundary," + (LocationBoundError)ret);
if ((LocationBoundError)ret != LocationBoundError.None)
{
Log.Error(Globals.LogTag, "Error Creating Circular Boundary," + (LocationBoundError)ret);
- LocationErrorFactory.ThrowLocationBoundaryException(ret);
+ throw LocationErrorFactory.ThrowLocationBoundaryException(ret);
}
handle = boundsHandle;
}
}
handle = boundsHandle;
}
/// <summary>
/// Gets the coordinate of the center of a circular boundary.
/// </summary>
/// <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>
public Coordinate Center
{
get
public Coordinate Center
{
get
/// <summary>
/// Gets the radius of a circular boundary.
/// </summary>
/// <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>
public double Radius
{
get
public double Radius
{
get
Log.Info(Globals.LogTag, "Calling to get CoordinateItem Center");
Coordinate center;
double radius;
Log.Info(Globals.LogTag, "Calling to get CoordinateItem Center");
Coordinate center;
double radius;
- Interop.LocationBoundary.GetCircleCoordinates(handle, out center, out radius);
+ int ret = Interop.LocationBoundary.GetCircleCoordinates(handle, out center, out radius);
+ if ((LocationBoundError)ret != LocationBoundError.None)
+ {
+ Log.Error(Globals.LogTag, "Error Get Circle Center," + (LocationBoundError)ret);
+ throw LocationErrorFactory.ThrowLocationBoundaryException(ret);
+ }
{
Coordinate center;
double radius = 0;
{
Coordinate center;
double radius = 0;
- Interop.LocationBoundary.GetCircleCoordinates(handle, out center, out radius);
+ int ret = Interop.LocationBoundary.GetCircleCoordinates(handle, out center, out radius);
+ if ((LocationBoundError)ret != LocationBoundError.None)
+ {
+ Log.Error(Globals.LogTag, "Error Get Radius," + (LocationBoundError)ret);
+ throw LocationErrorFactory.ThrowLocationBoundaryException(ret);
+ }
/// Constructor of the polygon boundary class.
/// </summary>
/// <param name="coordinates"> The coordinates which constitute the polgonal boundary.</param>
/// 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>
public PolygonBoundary(IList<Coordinate> coordinates)
{
Log.Info(Globals.LogTag, "Calling PolygonBoundary Constructor");
public PolygonBoundary(IList<Coordinate> coordinates)
{
Log.Info(Globals.LogTag, "Calling PolygonBoundary Constructor");
if ((LocationBoundError)ret != LocationBoundError.None)
{
Log.Error(Globals.LogTag, "Error Creating Polygon Boundary," + (LocationBoundError)ret);
if ((LocationBoundError)ret != LocationBoundError.None)
{
Log.Error(Globals.LogTag, "Error Creating Polygon Boundary," + (LocationBoundError)ret);
- LocationErrorFactory.ThrowLocationBoundaryException(ret);
+ throw LocationErrorFactory.ThrowLocationBoundaryException(ret);
}
handle = boundsHandle;
}
}
handle = boundsHandle;
}
/// <summary>
/// Gets the list of coordinates which constitute a polygonal boundary
/// </summary>
/// <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>
public IList<Coordinate> Coordinates
{
get
public IList<Coordinate> Coordinates
{
get
- Interop.LocationBoundary.GetForEachPolygonCoordinates(handle, callback, IntPtr.Zero);
+ int ret = Interop.LocationBoundary.GetForEachPolygonCoordinates(handle, callback, IntPtr.Zero);
+ if ((LocationBoundError)ret != LocationBoundError.None)
+ {
+ Log.Error(Globals.LogTag, "Error Get foreach Boundary," + (LocationBoundError)ret);
+ throw LocationErrorFactory.ThrowLocationBoundaryException(ret);
+ }
return coordinateList;
}
}
return coordinateList;
}
}
/// Notifications on events like service becoming enabled or disabled, new position data being available
/// and others can also be acquired.
/// </summary>
/// Notifications on events like service becoming enabled or disabled, new position data being available
/// and others can also be acquired.
/// </summary>
- public class Locator:IDisposable
+ public class Locator : IDisposable
{
private int _interval = 1;
private int _stayInterval = 120;
{
private int _interval = 1;
private int _stayInterval = 120;
/// The constructor of Locator class.
/// </summary>
/// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
/// 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>
public Locator(LocationType locationType)
{
Log.Info(Globals.LogTag, "Locator Constructor");
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>
/// 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>
public int Interval
{
get
public int Interval
{
get
/// The time interval between Distance based location callback updates.
/// Should be in the range [1~120] seconds.
/// </summary>
/// 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>
public int StayInterval
{
get
public int StayInterval
{
get
/// The distance between callback updates.
/// Should be in the range [1-120] meters.
/// </summary>
/// 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>
public double Distance
{
get
public double Distance
{
get
/// <summary>
/// Gets the status whether mock location is enabled or not.
/// </summary>
/// <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>
public bool EnableMock
{
get
public bool EnableMock
{
get
/// <summary>
/// Starts the Location Manager which has been created using the specified method.
/// </summary>
/// <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>
public void Start()
{
Log.Info(Globals.LogTag, "Starting Location Manager");
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>
/// 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>
public void Stop()
{
Log.Info(Globals.LogTag, "Stopping Location Manager");
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>
/// 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>
public void SetMockLocation(Location location)
{
Log.Info(Globals.LogTag, "Setting mock location");
public void SetMockLocation(Location location)
{
Log.Info(Globals.LogTag, "Setting mock location");
/// <summary>
/// Clears a mock location for the given location method.
/// </summary>
/// <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>
public void ClearMock()
{
Log.Info(Globals.LogTag, "Clear mock location");
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>
/// </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>
public Task<Location> GetLocationAsync(int timeout)
{
var task = new TaskCompletionSource<Location>();
public Task<Location> GetLocationAsync(int timeout)
{
var task = new TaskCompletionSource<Location>();
/// Gets the details of the location.
/// </summary>
/// <returns> which contains the current location details</returns>
/// 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>
public Location GetLocation()
{
double altitude = 0;
public Location GetLocation()
{
double altitude = 0;
/// Adds a bounds for a given locator.
/// </summary>
/// <param name="locationBoundary"> The boundary object to be added to the locator.</param>
/// 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>
public void AddBoundary(LocationBoundary locationBoundary)
{
Log.Info(Globals.LogTag, "AddBoundary called");
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>
/// 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>
public void RemoveBoundary(LocationBoundary locationBoundary)
{
Log.Info(Globals.LogTag, "RemoveBoundary called");
public void RemoveBoundary(LocationBoundary locationBoundary)
{
Log.Info(Globals.LogTag, "RemoveBoundary called");
/// <summary>
/// The overidden Dispose method of the IDisposable class.
/// </summary>
/// <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>
public void Dispose()
{
Dispose(true);
public void Dispose()
{
Dispose(true);
+ if (disposing)
+ DestroyHandle();
+
int ret = Interop.Locator.Destroy(_handle);
if (((LocationError)ret != LocationError.None))
{
int ret = Interop.Locator.Destroy(_handle);
if (((LocationError)ret != LocationError.None))
{
- Log.Error(Globals.LogTag, "Error in Destroy handle" + (LocationError)ret);
+ Log.Error(Globals.LogTag, "Error in Destroy handle, " + (LocationError)ret);
throw LocationErrorFactory.ThrowLocationException(ret);
}
}
throw LocationErrorFactory.ThrowLocationException(ret);
}
}
/// <summary>
/// (event) ServiceStateChanged Event is invoked when the location service state is changed.
/// </summary>
/// <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>
public event EventHandler<ServiceStateChangedEventArgs> ServiceStateChanged
{
add
public event EventHandler<ServiceStateChangedEventArgs> ServiceStateChanged
{
add
/// <summary>
/// (event) ZoneChanged is invoked when the previously set boundary area is entered or left.
/// </summary>
/// <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>
public event EventHandler<ZoneChangedEventArgs> ZoneChanged
{
add
public event EventHandler<ZoneChangedEventArgs> ZoneChanged
{
add
/// <summary>
/// (event) SetttingChanged is raised when the location setting is changed.
/// </summary>
/// <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>
public event EventHandler<SettingChangedEventArgs> SettingChanged
{
add
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>
/// (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>
public event EventHandler<LocationChangedEventArgs> DistanceBasedLocationChanged
{
add
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>
/// (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>
public event EventHandler<LocationChangedEventArgs> LocationChanged
{
add
public event EventHandler<LocationChangedEventArgs> LocationChanged
{
add
/// </summary>
/// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
/// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
/// </summary>
/// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
/// <returns>Returns a boolean value indicating whether or not the specified method is supported.</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="NotSupportedException">Thrown when the location is not supported</exception>
public static bool IsEnabledType(LocationType locationType)
{
Log.Info(Globals.LogTag, "Checking if the Location Manager type is Enabled");
public static bool IsEnabledType(LocationType locationType)
{
Log.Info(Globals.LogTag, "Checking if the Location Manager type is Enabled");