/// 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.
- /// <list >
+ /// <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>
{
Dispose(false);
}
+
/// <summary>
- /// Gets the type of geofence
+ /// Gets the type of geofence.
/// </summary>
public FenceType Type
{
}
/// <summary>
- ///Gets the longitude of geofence.
+ /// Gets the longitude of geofence.
/// </summary>
public double Longitude
{
}
/// <summary>
- ///Gets the latitude of geofence.
+ /// Gets the latitude of geofence.
/// </summary>
public double Latitude
{
}
/// <summary>
- ///Gets the ssid of geofence.
+ /// Gets the ssid of geofence.
/// </summary>
public string Ssid
{
/// <summary>
/// Creates a geopoint type of new geofence.
/// </summary>
- /// <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="adsress">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="UnauthorizedAccessException">Incase of Privileges are not defined</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported</exception>
+ /// <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="adsress">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>
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.
/// </summary>
- /// <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="UnauthorizedAccessException">Incase of Privileges are not defined</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported</exception>
+ /// <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>
public static Fence CreateWifiFence(int placeId, string bssid, string ssid)
{
IntPtr handle = IntPtr.Zero;
/// <summary>
/// Creates a bluetooth type of new geofence.
/// </summary>
- /// <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="UnauthorizedAccessException">Incase of Privileges are not defined</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported</exception>
+ /// <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>
public static Fence CreateBTFence(int placeId, string bssid, string ssid)
{
IntPtr handle = IntPtr.Zero;
Count = count;
}
/// <summary>
- /// Geofence instance
+ /// Geofence instance.
/// </summary>
public Fence Fence
{
}
/// <summary>
- /// The geofence id
+ /// The geofence id.
/// </summary>
public int GeofenceId
{
/// <summary>
/// The index number of the fences in the list.
- /// Index value starts from 1.
/// </summary>
+ /// <value>Index value starts from 1.</value>
public int Index
{
get;
}
/// <summary>
- /// The total number of fences that exists for the requester
+ /// The total number of fences that exists for the requester.
/// </summary>
public int Count
{
Count = count;
}
/// <summary>
- /// The current place id
+ /// The current place id.
/// </summary>
public int PlaceId
{
}
/// <summary>
- /// The current place name
+ /// The current place name.
/// </summary>
public string Name
{
/// <summary>
/// The index number of the places in the list.
- /// Index value starts from 1.
/// </summary>
+ /// <value>Index value starts from 1.</value>
public int Index
{
get;
}
/// <summary>
- /// The total number of places that exists for the requester
+ /// The total number of places that exists for the requester.
/// </summary>
public int Count
{
/// <summary>
/// Creates a new geofence status.
/// </summary>
- /// <exception cref="ArgumentException">Incase of Invalid parameter</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported</exception>
+ /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
public FenceStatus(int fenceId)
{
IntPtr handle;
/// <summary>
/// Gets the state of geofence.
/// </summary>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported</exception>
+ /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
public GeofenceState State
{
get
/// <summary>
/// Gets the amount of seconds geofence is in the current state.
/// </summary>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported</exception>
+ /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
public int Duration
{
get
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Enumeration for geofence type
+ /// Enumeration for geofence type.
/// </summary>
public enum FenceType
{
/// <summary>
- /// Geofence is specified by geospatial coordinate
+ /// Geofence is specified by geospatial coordinate.
/// </summary>
GeoPoint = 1,
/// <summary>
- /// Geofence is specified by Wi-Fi access point
+ /// Geofence is specified by Wi-Fi access point.
/// </summary>
Wifi,
/// <summary>
- /// Geofence is specified by Bluetooth device
+ /// Geofence is specified by Bluetooth device.
/// </summary>
Bluetooth
};
public enum GeofenceState
{
/// <summary>
- /// Uncertain state of geofence
+ /// Uncertain state of geofence.
/// </summary>
Uncertain = 0,
/// <summary>
- /// Geofence In state
+ /// Geofence In state.
/// </summary>
In,
/// <summary>
- /// Geofence Out state
+ /// Geofence Out state.
/// </summary>
Out
};
public enum GeoFenceEventType
{
/// <summary>
- ///Geofence is added
+ /// Geofence is added.
/// </summary>
FenceAdded = 0,
/// <summary>
- /// Geofence is removed
+ /// Geofence is removed.
/// </summary>
FenceRemoved,
/// <summary>
- ///Geofencing is started
+ /// Geofencing is started.
/// </summary>
FenceStarted,
/// <summary>
- /// Geofencing is stopped
+ /// Geofencing is stopped.
/// </summary>
FenceStopped,
/// <summary>
- ///Place is added
+ /// Place is added.
/// </summary>
PlaceAdded = 0x10,
/// <summary>
- /// Place is removed
+ /// Place is removed.
/// </summary>
PlaceRemoved,
/// <summary>
- ///Place is updated
+ /// Place is updated.
/// </summary>
PlaceUpdated,
/// <summary>
- /// Setting for geofencing is enabled
+ /// Setting for geofencing is enabled.
/// </summary>
SettingEnabled = 0x20,
/// <summary>
- /// Setting for geofencing is disabled
+ /// Setting for geofencing is disabled.
/// </summary>
SettingDisabled
};
/// <summary>
- /// Enumeration for the provider of proximity
+ /// Enumeration for the provider of proximity.
/// </summary>
public enum ProximityProvider
{
/// <summary>
- /// Proximity is specified by geospatial coordinate
+ /// Proximity is specified by geospatial coordinate.
/// </summary>
Location = 0,
/// <summary>
- /// Proximity is specified by Wi-Fi access point
+ /// Proximity is specified by Wi-Fi access point.
/// </summary>
Wifi,
/// <summary>
- /// Proximity is specified by Bluetooth device
+ /// Proximity is specified by Bluetooth device.
/// </summary>
Bluetooth,
/// <summary>
- ///Proximity is specified by Bluetooth low energy device
+ /// Proximity is specified by Bluetooth low energy device.
/// </summary>
BLE,
/// <summary>
- /// Proximity is specified by Sensor
+ /// Proximity is specified by Sensor.
/// </summary>
Sensor
}
public enum ProximityState
{
/// <summary>
- /// Uncertain state of proximity
+ /// Uncertain state of proximity.
/// </summary>
Uncertain = 0,
/// <summary>
- /// Far state of proximity
+ /// Far state of proximity.
/// </summary>
Far,
/// <summary>
- /// Far state of proximity
+ /// Far state of proximity.
/// </summary>
Near,
/// <summary>
- /// Immediate state of proximity
+ /// Immediate state of proximity.
/// </summary>
Immediate
}
PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied,
/// <summary>
- /// Not Supported
+ /// Not Supported.
/// </summary>
NotSupported = Tizen.Internals.Errors.ErrorCode.NotSupported,
/// <summary>
- ///Geofence Manager is not initialized
+ /// Geofence Manager is not initialized.
/// </summary>
NotInitialized = -0x02C00000 | 0x100 | 0x01,
/// <summary>
- ///Invalid geofence ID
+ /// Invalid geofence ID.
/// </summary>
InvalidID = -0x02C00000 | 0x100 | 0x02,
/// <summary>
- /// Exception occurs
+ /// Exception occurs.
/// </summary>
Exception = -0x02C00000 | 0x100 | 0x03,
/// <summary>
- ///Geofencing is already started
+ /// Geofencing is already started.
/// </summary>
AlreadyStarted = -0x02C00000 | 0x100 | 0x04,
/// <summary>
- ///Too many geofence
+ /// Too many geofence.
/// </summary>
TooManyGeofence = -0x02C00000 | 0x100 | 0x05,
/// <summary>
- ///Error in GPS, Wi-Fi, or BT
+ /// Error in GPS, Wi-Fi, or BT.
/// </summary>
IPC = -0x02C00000 | 0x100 | 0x06,
/// <summary>
- ///DB error in the server side
+ /// DB error in the server side.
/// </summary>
DBFailed = -0x02C00000 | 0x100 | 0x07,
/// <summary>
- ///Access to specified place is denied
+ /// Access to specified place is denied.
/// </summary>
PlaceAccessDenied = -0x02C00000 | 0x100 | 0x08,
/// <summary>
- /// Access to specified geofence is denied
+ /// Access to specified geofence is denied.
/// </summary>
GeofenceAccessDenied = -0x02C00000 | 0x100 | 0x09
};
public class ProximityStateEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor
+ /// Internal constructor.
/// </summary>
- /// <param name="id">The geofence id </param>
- /// <param name="state">The proximity state</param>
- /// <param name="provider">The proximity provider</param>
+ /// <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)
{
GeofenceId = id;
}
/// <summary>
- /// The geofence id
+ /// The geofence id.
/// </summary>
public int GeofenceId
{
}
/// <summary>
- /// The proximity state
+ /// The proximity state.
/// </summary>
public ProximityState State
{
}
/// <summary>
- /// The proximity provider
+ /// The proximity provider.
/// </summary>
public ProximityProvider Provider
{
public class GeofenceStateEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor
+ /// Internal constructor.
/// </summary>
- /// <param name="fenceId">The specified geofence id</param>
- /// <param name="state">The geofence state</param>
+ /// <param name="fenceId">The specified geofence id.</param>
+ /// <param name="state">The geofence state.</param>
internal GeofenceStateEventArgs(int fenceId, GeofenceState state)
{
GeofenceId = fenceId;
}
/// <summary>
- /// The specified geofence id
+ /// The specified geofence id.
/// </summary>
public int GeofenceId
{
}
/// <summary>
- /// The geofence state
+ /// The geofence state.
/// </summary>
public GeofenceState State
{
public class GeofenceResponseEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor
+ /// Internal constructor.
/// </summary>
- /// <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>
+ /// <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)
{
PlaceId = placeId;
}
/// <summary>
- /// The place id
+ /// The place id.
/// </summary>
public int PlaceId
{
}
/// <summary>
- /// The specified geofence id
+ /// The specified geofence id.
/// </summary>
public int FenceId
{
}
/// <summary>
- /// The error code for the particular action
+ /// The error code for the particular action.
/// </summary>
public GeofenceError ErrorCode
{
}
/// <summary>
- /// The result code for the particular place and geofence management
+ /// The result code for the particular place and geofence management.
/// </summary>
public GeoFenceEventType EventType
{
/// <summary>
/// Creates a new geofence manager.
/// </summary>
- /// <exception cref="OutOfMemoryException">Incase of OutOfMemory condition</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="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>
public GeofenceManager()
{
IntPtr handle;
/// <summary>
/// Starts the geofencing service.
/// </summary>
- /// <param name="geofenceId">The specified geofence id </param>
+ /// <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
+ /// 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">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>
public void Start(int geofenceId)
{
GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Start(Handle, geofenceId);
/// <summary>
/// Stops the geofenceing service.
/// </summary>
- /// <param name="geofenceId">The specified geofence id </param>
+ /// <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.
+ /// This function initiates the process of stopping the service.
+ /// 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">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>
public void Stop(int geofenceId)
{
GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Stop(Handle, geofenceId);
/// <remarks>
/// Call to Start() will invoke this event.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported</exception>
+ /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
public event EventHandler<GeofenceStateEventArgs> StateChanged
{
add
/// <remarks>
/// Call to Start() will invoke this event.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported</exception>
+ /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
public event EventHandler<ProximityStateEventArgs> ProximityChanged
{
add
/// Call to Start() will invoke this event.
/// The value of place_id or geofence_id is -1 when the place id or geofence id is not assigned.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported</exception>
+ /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
public event EventHandler<GeofenceResponseEventArgs> GeoFenceEventChanged
{
add
/// <summary>
/// Creates a VirtualPerimeter which can be used to create virtual fence.
/// </summary>
- /// <param name="manager">GeofenceManager instance</param>
- /// <exception cref="ArgumentException"> Incase of invlid parameter</exception>
+ /// <param name="manager">GeofenceManager instance.</param>
+ /// <exception cref="ArgumentException"> Incase of invlid parameter.</exception>
public VirtualPerimeter(GeofenceManager manager)
{
if (manager == null)
/// <summary>
/// Creates a new place for geofencing service.
/// </summary>
- /// <param name="name">A place name to be created </param>
- /// <returns>The place id to be newly created on success</returns>
+ /// <param name="name">A place name to be created.</param>
+ /// <returns>The place id to be newly created on success.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="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 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>
public int AddPlaceName(string name)
{
int placeId = 0;
/// <summary>
/// Updates the place name of a given place id.
/// </summary>
- /// <param name="placeId">The specified place id</param>
- /// <param name="name">A new place name of the place id </param>
+ /// <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">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>
public void UpdatePlace(int placeId, string name)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.UpdatePlace(Handle, placeId, name);
/// <summary>
/// Removes the specific place for geofencing service.
/// </summary>
- /// <param name="placeId">The specified place id</param>
+ /// <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 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>
public void RemovePlace(int placeId)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemovePlace(Handle, placeId);
/// Adds a geofence for a given geofence manager.
/// </summary>
/// <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>
+ /// <returns>The geofence id to be newly created on success.</returns>
+ /// <remarks> The retun 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">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>
public int AddGeofence(Fence fence)
{
int fenceId = 0;
/// <summary>
/// Removes a geofence with a given geofence id.
/// </summary>
- /// <param name="fenceId">The specified geofence id </param>
+ /// <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">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>
public void RemoveGeofence(int fenceId)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemoveFence(Handle, fenceId);
/// <summary>
/// Gets the name of place.
/// </summary>
- /// <param name="placeId"> The place id</param>
- /// <returns>The name of the place </returns>
+ /// <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">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>
public string GetPlaceName(int placeId)
{
string name = "";
/// </summary>
/// <returns>list of places registered as 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">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>
public IEnumerable<PlaceData> GetPlaceDataList()
{
List<PlaceData> places = new List<PlaceData>();
/// <summary>
/// Retrieves a list of fences registered in the specified geofence manager.
/// </summary>
- /// <returns>list of FenceData instances registred for each Geofence</returns>
+ /// <returns>list of FenceData instances registred 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">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>
public IEnumerable<FenceData> GetFenceDataList()
{
List<FenceData> fences = new List<FenceData>();
/// <summary>
/// Retrieves a list of fences registered in the specified place.
/// </summary>
- /// <param name="placeId"> The place id </param>
- /// <returns>list of FenceData instances registred for each Geofence for specified place</returns>
+ /// <param name="placeId"> The place id.</param>
+ /// <returns>list of FenceData instances registred for each Geofence for 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">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>
public IEnumerable<FenceData> GetGeoFenceDataListByPlaceId(int placeId)
{
List<FenceData> fences = new List<FenceData>();
projects / platform / core / csapi / geofence.git / commitdiff