From 411c4dcce7d4110c155d206026ae033aa6593ecc Mon Sep 17 00:00:00 2001 From: jomui Date: Thu, 17 Aug 2017 15:23:48 +0900 Subject: [PATCH] sync with original geofence package Signed-off-by: jomui Change-Id: Ia5dd87286aa53c27c827e139b0e98bb379eac540 --- .../Tizen.Location.Geofence/Fence.cs | 96 ++++++------ .../Tizen.Location.Geofence/FenceData.cs | 38 ++--- .../Tizen.Location.Geofence/FenceStatus.cs | 26 ++-- .../Tizen.Location.Geofence/GeofenceEnum.cs | 80 +++++----- .../GeofenceErrorFactory.cs | 38 ++--- .../GeofenceEventArgs.cs | 58 ++++---- .../GeofenceManager.cs | 84 +++++------ .../Tizen.Location.Geofence/NamespaceDoc.cs | 22 +-- .../VirtualPerimeter.cs | 140 +++++++++--------- 9 files changed, 291 insertions(+), 291 deletions(-) diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs index d22b94afa..7dbe95b7d 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs @@ -19,18 +19,18 @@ using System; namespace Tizen.Location.Geofence { /// - /// 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. /// - /// Geopoint: Geofence is specified by coordinates (Latitude and Longitude) and Radius - /// WIFI: Geofence is specified by BSSID of Wi-Fi access point - /// BT: Geofence is specified by Bluetooth address + /// Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius. + /// WIFI: Geofence is specified by the BSSID of the Wi-Fi access point. + /// BT: Geofence is specified by the Bluetooth address. /// - /// 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. /// - /// 3 + /// 3 public class Fence : IDisposable { private bool _disposed = false; @@ -54,7 +54,7 @@ namespace Tizen.Location.Geofence /// /// Gets the type of geofence. /// - /// 3 + /// 3 public FenceType Type { get @@ -71,9 +71,9 @@ namespace Tizen.Location.Geofence } /// - /// Gets the id of place. + /// Gets the ID of the place. /// - /// 3 + /// 3 public int PlaceId { get @@ -92,7 +92,7 @@ namespace Tizen.Location.Geofence /// /// Gets the longitude of geofence. /// - /// 3 + /// 3 public double Longitude { get @@ -112,7 +112,7 @@ namespace Tizen.Location.Geofence /// /// Gets the latitude of geofence. /// - /// 3 + /// 3 public double Latitude { get @@ -131,7 +131,7 @@ namespace Tizen.Location.Geofence /// /// Gets the radius of geofence. /// - /// 3 + /// 3 public int Radius { get @@ -150,7 +150,7 @@ namespace Tizen.Location.Geofence /// /// Gets the address of geofence. /// - /// 3 + /// 3 public string Address { get @@ -167,9 +167,9 @@ namespace Tizen.Location.Geofence } /// - /// Gets the bssid of geofence. + /// Gets the BSSID of geofence. /// - /// 3 + /// 3 public string Bssid { get @@ -186,9 +186,9 @@ namespace Tizen.Location.Geofence } /// - /// Gets the ssid of geofence. + /// Gets the SSID of geofence. /// - /// 3 + /// 3 public string Ssid { get @@ -205,18 +205,18 @@ namespace Tizen.Location.Geofence } /// - /// Creates a geopoint type of new geofence. + /// Creates a geopoint type of the new geofence. /// - /// 3 - /// The current place id. - /// Specifies the value of latitude of geofence [-90.0 ~ 90.0] (degrees). - /// Specifies the value of longitude of geofence [-180.0 ~ 180.0] (degrees). - /// Specifies the value of radius of geofence [100 ~ 500](meter). - /// Specifies the value of address. - /// Newly created geofence instance. - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Geofence is not supported. + /// 3 + /// The current place ID. + /// Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees). + /// Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees). + /// Specifies the value of radius of the geofence [100 ~ 500](meter). + /// Specifies the value of the address. + /// The newly created geofence instance. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case the geofence is not supported. public static Fence CreateGPSFence(int placeId, int latitude, int longitude, int radius, string address) { IntPtr handle = IntPtr.Zero; @@ -230,16 +230,16 @@ namespace Tizen.Location.Geofence } /// - /// Creates a Wi-Fi type of new geofence. + /// Creates a Wi-Fi type of the new geofence. /// - /// 3 - /// The current place id. - /// Specifies the value of BSSID of Wi-Fi MAC address. - /// Specifies the value of SSID of Wi-Fi Device. - /// Newly created geofence instance. - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Geofence is not supported. + /// 3 + /// The current place ID. + /// Specifies the value of BSSID of the Wi-Fi MAC address. + /// Specifies the value of SSID of the Wi-Fi device. + /// The newly created geofence instance. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case the geofence is not supported. public static Fence CreateWifiFence(int placeId, string bssid, string ssid) { IntPtr handle = IntPtr.Zero; @@ -253,16 +253,16 @@ namespace Tizen.Location.Geofence } /// - /// Creates a bluetooth type of new geofence. + /// Creates a Bluetooth type of the new geofence. /// - /// 3 - /// The current place id. + /// 3 + /// The current place ID. /// Specifies the value of BSSID of BT MAC address. /// Specifies the value of SSID of BT Device. - /// Newly created geofence instance. - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Geofence is not supported. + /// The newly created geofence instance. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case the geofence is not supported. public static Fence CreateBTFence(int placeId, string bssid, string ssid) { IntPtr handle = IntPtr.Zero; @@ -276,9 +276,9 @@ namespace Tizen.Location.Geofence } /// - /// Overloaded Dispose API for destroying the fence Handle. + /// The overloaded Dispose API for destroying the fence handle. /// - /// 3 + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceData.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceData.cs index cfda8cf31..d328f4e4f 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceData.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceData.cs @@ -18,9 +18,9 @@ using System; namespace Tizen.Location.Geofence { /// - /// Represents the Geofence list Item data. + /// Represents the geofence list item data. /// - /// 3 + /// 3 public class FenceData { internal FenceData(int fenceId, IntPtr handle, int index, int count) @@ -31,9 +31,9 @@ namespace Tizen.Location.Geofence Count = count; } /// - /// Geofence instance. + /// The geofence instance. /// - /// 3 + /// 3 public Fence Fence { get; @@ -41,9 +41,9 @@ namespace Tizen.Location.Geofence } /// - /// The geofence id. + /// The geofence ID. /// - /// 3 + /// 3 public int GeofenceId { get; @@ -51,10 +51,10 @@ namespace Tizen.Location.Geofence } /// - /// The index number of the fences in the list. + /// The index number of fences in the list. /// - /// 3 - /// Index value starts from 1. + /// 3 + /// The index value starts from 1. public int Index { get; @@ -64,7 +64,7 @@ namespace Tizen.Location.Geofence /// /// The total number of fences that exists for the requester. /// - /// 3 + /// 3 public int Count { get; @@ -73,9 +73,9 @@ namespace Tizen.Location.Geofence }; /// - /// Represents the Place list Item data. + /// Represents the place list item data. /// - /// 3 + /// 3 public class PlaceData { internal PlaceData(int id, string name, int index, int count) @@ -86,9 +86,9 @@ namespace Tizen.Location.Geofence Count = count; } /// - /// The current place id. + /// The current place ID. /// - /// 3 + /// 3 public int PlaceId { get; @@ -98,7 +98,7 @@ namespace Tizen.Location.Geofence /// /// The current place name. /// - /// 3 + /// 3 public string Name { get; @@ -106,10 +106,10 @@ namespace Tizen.Location.Geofence } /// - /// The index number of the places in the list. + /// The index number of places in the list. /// - /// 3 - /// Index value starts from 1. + /// 3 + /// The index value starts from 1. public int Index { get; @@ -119,7 +119,7 @@ namespace Tizen.Location.Geofence /// /// The total number of places that exists for the requester. /// - /// 3 + /// 3 public int Count { get; diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs index 46e5e6694..c430ca1b6 100644 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs @@ -21,11 +21,11 @@ namespace Tizen.Location.Geofence /// /// The geofence status describes the current state and duration of a geofence. /// - /// State: State is specified by current state of fence - /// Duration: Geofence is specified by duration of current state + /// State: The state is specified by the current state of the fence. + /// Duration: Geofence is specified by the duration of the current state. /// /// - /// 3 + /// 3 public class FenceStatus : IDisposable { private bool _disposed = false; @@ -39,9 +39,9 @@ namespace Tizen.Location.Geofence /// /// Creates a new geofence status. /// - /// 3 - /// Incase of Invalid parameter. - /// Incase of Geofence is not supported. + /// 3 + /// In case of an invalid parameter. + /// In case of geofence is not supported. public FenceStatus(int fenceId) { IntPtr handle; @@ -62,8 +62,8 @@ namespace Tizen.Location.Geofence /// /// Gets the state of geofence. /// - /// 3 - /// Incase of Geofence is not supported. + /// 3 + /// In case the geofence is not supported. public GeofenceState State { get @@ -80,10 +80,10 @@ namespace Tizen.Location.Geofence } /// - /// Gets the amount of seconds geofence is in the current state. + /// Gets the amount of seconds, the geofence is in the current state. /// - /// 3 - /// Incase of Geofence is not supported. + /// 3 + /// In case the geofence is not supported. public int Duration { get @@ -100,9 +100,9 @@ namespace Tizen.Location.Geofence } /// - /// Overloaded Dispose API for destroying the fence Handle. + /// The overloaded Dispose API for destroying the fence handle. /// - /// 3 + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEnum.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEnum.cs index b5be38371..9f18ecabd 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEnum.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEnum.cs @@ -17,181 +17,181 @@ namespace Tizen.Location.Geofence { /// - /// Enumeration for geofence type. + /// Enumeration for the geofence types. /// - /// 3 + /// 3 public enum FenceType { /// - /// Geofence is specified by geospatial coordinate. + /// Geofence is specified by the geospatial coordinate. /// - /// 3 + /// 3 GeoPoint = 1, /// - /// Geofence is specified by Wi-Fi access point. + /// Geofence is specified by the Wi-Fi access point. /// - /// 3 + /// 3 Wifi, /// - /// Geofence is specified by Bluetooth device. + /// Geofence is specified by the Bluetooth device. /// - /// 3 + /// 3 Bluetooth }; /// - /// Enumerations for the state of geofence. + /// Enumeration for the state of geofence. /// - /// 3 + /// 3 public enum GeofenceState { /// /// Uncertain state of geofence. /// - /// 3 + /// 3 Uncertain = 0, /// /// Geofence In state. /// - /// 3 + /// 3 In, /// /// Geofence Out state. /// - /// 3 + /// 3 Out }; /// - /// Enumerations for geofence management events. + /// Enumeration for the geofence management events. /// - /// 3 + /// 3 public enum GeofenceEventType { /// /// Geofence is added. /// - /// 3 + /// 3 FenceAdded = 0, /// /// Geofence is removed. /// - /// 3 + /// 3 FenceRemoved, /// /// Geofencing is started. /// - /// 3 + /// 3 FenceStarted, /// /// Geofencing is stopped. /// - /// 3 + /// 3 FenceStopped, /// /// Place is added. /// - /// 3 + /// 3 PlaceAdded = 0x10, /// /// Place is removed. /// - /// 3 + /// 3 PlaceRemoved, /// /// Place is updated. /// - /// 3 + /// 3 PlaceUpdated, /// /// Setting for geofencing is enabled. /// - /// 3 + /// 3 SettingEnabled = 0x20, /// /// Setting for geofencing is disabled. /// - /// 3 + /// 3 SettingDisabled }; /// /// Enumeration for the provider of proximity. /// - /// 3 + /// 3 public enum ProximityProvider { /// - /// Proximity is specified by geospatial coordinate. + /// Proximity is specified by the geospatial coordinate. /// - /// 3 + /// 3 Location = 0, /// - /// Proximity is specified by Wi-Fi access point. + /// Proximity is specified by the Wi-Fi access point. /// - /// 3 + /// 3 Wifi, /// - /// Proximity is specified by Bluetooth device. + /// Proximity is specified by the Bluetooth device. /// - /// 3 + /// 3 Bluetooth, /// - /// Proximity is specified by Bluetooth low energy device. + /// Proximity is specified by the Bluetooth low-energy device. /// - /// 3 + /// 3 BLE, /// - /// Proximity is specified by Sensor. + /// Proximity is specified by the sensor. /// - /// 3 + /// 3 Sensor } /// /// Enumeration for the state of proximity. /// - /// 3 + /// 3 public enum ProximityState { /// /// Uncertain state of proximity. /// - /// 3 + /// 3 Uncertain = 0, /// /// Far state of proximity. /// - /// 3 + /// 3 Far, /// /// Far state of proximity. /// - /// 3 + /// 3 Near, /// /// Immediate state of proximity. /// - /// 3 + /// 3 Immediate } } diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceErrorFactory.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceErrorFactory.cs index e9fc3ad78..57339c925 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceErrorFactory.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceErrorFactory.cs @@ -21,93 +21,93 @@ using Tizen; namespace Tizen.Location.Geofence { /// - /// Enum to give the type of error occured, if any. + /// Enumeration for the types of error occured, if any. /// - /// 3 + /// 3 public enum GeofenceError { /// /// Successful. /// - /// 3 + /// 3 None = Tizen.Internals.Errors.ErrorCode.None, /// /// Out of memory. /// - /// 3 + /// 3 OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory, /// /// Invalid parameter. /// - /// 3 + /// 3 InvalidParameter = Tizen.Internals.Errors.ErrorCode.InvalidParameter, /// /// Permission denied. /// - /// 3 + /// 3 PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied, /// /// Not Supported. /// - /// 3 + /// 3 NotSupported = Tizen.Internals.Errors.ErrorCode.NotSupported, /// - /// Geofence Manager is not initialized. + /// Geofence manager is not initialized. /// - /// 3 + /// 3 NotInitialized = -0x02C00000 | 0x100 | 0x01, /// /// Invalid geofence ID. /// - /// 3 + /// 3 InvalidID = -0x02C00000 | 0x100 | 0x02, /// /// Exception occurs. /// - /// 3 + /// 3 Exception = -0x02C00000 | 0x100 | 0x03, /// /// Geofencing is already started. /// - /// 3 + /// 3 AlreadyStarted = -0x02C00000 | 0x100 | 0x04, /// /// Too many geofence. /// - /// 3 + /// 3 TooManyGeofence = -0x02C00000 | 0x100 | 0x05, /// /// Error in GPS, Wi-Fi, or BT. /// - /// 3 + /// 3 IPC = -0x02C00000 | 0x100 | 0x06, /// /// DB error in the server side. /// - /// 3 + /// 3 DBFailed = -0x02C00000 | 0x100 | 0x07, /// - /// Access to specified place is denied. + /// Access to the specified place is denied. /// - /// 3 + /// 3 PlaceAccessDenied = -0x02C00000 | 0x100 | 0x08, /// - /// Access to specified geofence is denied. + /// Access to the specified geofence is denied. /// - /// 3 + /// 3 GeofenceAccessDenied = -0x02C00000 | 0x100 | 0x09 }; diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEventArgs.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEventArgs.cs index f5ef7806f..b16ee117c 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEventArgs.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEventArgs.cs @@ -19,16 +19,16 @@ using System; namespace Tizen.Location.Geofence { /// - /// 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. /// - /// 3 + /// 3 public class ProximityStateEventArgs : EventArgs { /// - /// Internal constructor. + /// The internal constructor. /// - /// 3 - /// The geofence id. + /// 3 + /// The geofence ID. /// The proximity state. /// The proximity provider. internal ProximityStateEventArgs(int id, ProximityState state, ProximityProvider provider) @@ -39,9 +39,9 @@ namespace Tizen.Location.Geofence } /// - /// The geofence id. + /// The geofence ID. /// - /// 3 + /// 3 public int GeofenceId { get; @@ -50,7 +50,7 @@ namespace Tizen.Location.Geofence /// /// The proximity state. /// - /// 3 + /// 3 public ProximityState State { get; @@ -59,7 +59,7 @@ namespace Tizen.Location.Geofence /// /// The proximity provider. /// - /// 3 + /// 3 public ProximityProvider Provider { get; @@ -67,16 +67,16 @@ namespace Tizen.Location.Geofence }; /// - /// 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. /// - /// 3 + /// 3 public class GeofenceStateEventArgs : EventArgs { /// - /// Internal constructor. + /// The internal constructor. /// - /// 3 - /// The specified geofence id. + /// 3 + /// The specified geofence ID. /// The geofence state. internal GeofenceStateEventArgs(int fenceId, GeofenceState state) { @@ -85,9 +85,9 @@ namespace Tizen.Location.Geofence } /// - /// The specified geofence id. + /// The specified geofence ID. /// - /// 3 + /// 3 public int GeofenceId { get; @@ -96,7 +96,7 @@ namespace Tizen.Location.Geofence /// /// The geofence state. /// - /// 3 + /// 3 public GeofenceState State { get; @@ -104,17 +104,17 @@ namespace Tizen.Location.Geofence } /// - /// 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.. /// - /// 3 + /// 3 public class GeofenceResponseEventArgs : EventArgs { /// - /// Internal constructor. + /// The internal constructor. /// - /// 3 - /// The place id. - /// The specified geofence id. + /// 3 + /// The place ID. + /// The specified geofence ID. /// The error code for the particular action. /// The result code for the particular place and geofence management. internal GeofenceResponseEventArgs(int placeId, int fenceId, GeofenceError error, GeofenceEventType eventType) @@ -126,18 +126,18 @@ namespace Tizen.Location.Geofence } /// - /// The place id. + /// The place ID. /// - /// 3 + /// 3 public int PlaceId { get; } /// - /// The specified geofence id. + /// The specified geofence ID. /// - /// 3 + /// 3 public int FenceId { get; @@ -146,7 +146,7 @@ namespace Tizen.Location.Geofence /// /// The error code for the particular action. /// - /// 3 + /// 3 public GeofenceError ErrorCode { get; @@ -155,7 +155,7 @@ namespace Tizen.Location.Geofence /// /// The result code for the particular place and geofence management. /// - /// 3 + /// 3 public GeofenceEventType EventType { get; diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs index ad69b02bd..20750f765 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs @@ -19,23 +19,23 @@ using System; namespace Tizen.Location.Geofence { /// - /// 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: /// - /// Public places and fences that are created by MyPlace app can be used by all apps. - /// Private places and fences that are created by specified app can be used by the same app. + /// Public places and fences are created by the MyPlace application that can be used by all applications. + /// Private places and fences are created by the specified application that can be used by the same application. /// /// Notifications can be received about the following events: /// - /// Zone in when a device enters a specific area - /// Zone out when a device exits a specific area - /// Results and errors for each event requested to geofence module + /// Zone in when a device enters a specific area. + /// Zone out when a device exits a specific area. + /// Results and errors for each event requested to the geofence module. /// /// - /// 3 + /// 3 public class GeofenceManager : IDisposable { private bool _disposed = false; @@ -47,12 +47,12 @@ namespace Tizen.Location.Geofence } /// - /// Creates a new geofence manager. + /// Creates a new Geofence manager. /// - /// 3 - /// Incase of OutOfMemory condition. - /// Incase of any System error. - /// Incase of Geofence is not supported. + /// 3 + /// In case of out of memory condition. + /// In case of any system error. + /// In case the geofence is not supported. public GeofenceManager() { IntPtr handle; @@ -71,9 +71,9 @@ namespace Tizen.Location.Geofence } /// - /// Checks whether the geofence manager is available or not. + /// Checks whether the Geofence manager is available or not. /// - /// 3 + /// 3 public static bool IsSupported { get @@ -92,16 +92,16 @@ namespace Tizen.Location.Geofence /// /// Starts the geofencing service. /// - /// 3 - /// The specified geofence id. + /// 3 + /// The specified geofence ID. /// http://tizen.org/privilege/location /// /// When the location service is enabled, the StateChanged event is invoked and the service starts. /// - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public void Start(int geofenceId) { GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Start(Handle, geofenceId); @@ -114,17 +114,17 @@ namespace Tizen.Location.Geofence /// /// Stops the geofenceing service. /// - /// 3 - /// The specified geofence id. + /// 3 + /// The specified geofence ID. /// http://tizen.org/privilege/location /// /// 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. /// - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public void Stop(int geofenceId) { GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Stop(Handle, geofenceId); @@ -144,13 +144,13 @@ namespace Tizen.Location.Geofence private static event EventHandler s_stateChanged = null; /// - /// 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. /// - /// 3 + /// 3 /// /// Call to Start() will invoke this event. /// - /// Incase of feature Not supported. + /// In case the feature is not supported. public event EventHandler StateChanged { add @@ -189,13 +189,13 @@ namespace Tizen.Location.Geofence private static event EventHandler s_proximityChanged; /// - /// Called when a proximity state of device is changed. + /// Called when the proximity state of a device is changed. /// - /// 3 + /// 3 /// /// Call to Start() will invoke this event. /// - /// Incase of feature Not supported. + /// In case the feature is not supported. public event EventHandler ProximityChanged { add @@ -234,15 +234,15 @@ namespace Tizen.Location.Geofence private static event EventHandler s_geofenceEventChanged; /// - /// 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. /// - /// 3 + /// 3 /// /// 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. /// - /// Incase of feature Not supported. + /// In case the feature is not supported. public event EventHandler GeofenceEventChanged { add @@ -272,9 +272,9 @@ namespace Tizen.Location.Geofence } /// - /// Overloaded Dispose API for destroying the GeofenceManager Handle. + /// The overloaded Dispose API for destroying the GeofenceManager handle. /// - /// 3 + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs index 440da9761..7944fc4c0 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs @@ -6,26 +6,26 @@ The Tizen.Location.Geofence namespace provides classes for virtual perimeter.

Overview

-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.

+This API provides functions to set the gofence 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:
-- Public places and fences that are created by MyPlace app can be used by all apps.
-- Private places and fences that are created by specified app can be used by the same app.

+- Public places and fences that are created by the MyPlace application can be used by all applications.
+- Private places and fences that are created by the specified application can be used by the same application.

Notifications can be received about the following events:
-- Zone in when a device enters a specific area
-- Zone out when a device exits a specific area
-- Results and errors for each event requested to geofence module

+- Zone in when a device enters a specific area.
+- Zone out when a device exits a specific area.
+- Results and errors for each event requested to geofence module.

The Geofence manager has the following properties:
-- geofence type
-- status
+- The geofence type.
+- The status.
- 'Service state change' callback

Related Features

-To guarantee that the Geofence application runs on a device with Geofence profile feature, +To guarantee that the geofence application runs on a device with the geofence profile feature, declare the following feature requirements in the config file:
http://tizen.org/feature/location
-http://tizen.org/feature/location.geofence
+http://tizen.org/feature/location.Geofence
http://tizen.org/feature/location.wps diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs index 0d5cffee2..3923657bc 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs @@ -20,20 +20,20 @@ using System.Collections.Generic; namespace Tizen.Location.Geofence { /// - /// 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. /// - /// 3 + /// 3 public class VirtualPerimeter { private IntPtr Handle; /// - /// Creates a VirtualPerimeter which can be used to create virtual fence. + /// Creates a VirtualPerimeter which can be used to create a virtual fence. /// - /// 3 - /// GeofenceManager instance. - /// Incase of invlid parameter. + /// 3 + /// The GeofenceManager instance. + /// In case of an invalid parameter. public VirtualPerimeter(GeofenceManager manager) { if (manager == null) @@ -47,16 +47,16 @@ namespace Tizen.Location.Geofence } /// - /// Creates a new place for geofencing service. + /// Creates a new place for the geofencing service. /// - /// 3 + /// 3 /// A place name to be created. - /// The place id to be newly created on success. + /// The place ID to be newly created on success. /// http://tizen.org/privilege/location - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public int AddPlaceName(string name) { int placeId = 0; @@ -70,16 +70,16 @@ namespace Tizen.Location.Geofence } /// - /// Updates the place name of a given place id. + /// Updates the place name of a given place ID. /// - /// 3 - /// The specified place id. - /// A new place name of the place id. + /// 3 + /// The specified place ID. + /// A new place name of the place ID. /// http://tizen.org/privilege/location - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any System error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public void UpdatePlace(int placeId, string name) { GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.UpdatePlace(Handle, placeId, name); @@ -90,15 +90,15 @@ namespace Tizen.Location.Geofence } /// - /// Removes the specific place for geofencing service. + /// Removes the specific place for the geofencing service. /// - /// 3 - /// The specified place id. + /// 3 + /// The specified place ID. /// http://tizen.org/privilege/location - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// Incase of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public void RemovePlace(int placeId) { GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemovePlace(Handle, placeId); @@ -109,17 +109,17 @@ namespace Tizen.Location.Geofence } /// - /// Adds a geofence for a given geofence manager. + /// Adds the geofence for a given Geofence manager. /// - /// 3 - /// The Geofence instance to be added. - /// The geofence id to be newly created on success. - /// The retun value will always be a number greater than zero. + /// 3 + /// The geofence instance to be added. + /// The geofence ID to be newly created on success. + /// The return value will always be a number greater than zero. /// http://tizen.org/privilege/location - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public int AddGeofence(Fence fence) { int fenceId = 0; @@ -133,15 +133,15 @@ namespace Tizen.Location.Geofence } /// - /// Removes a geofence with a given geofence id. + /// Removes the geofence with a given geofence ID. /// - /// 3 - /// The specified geofence id. + /// 3 + /// The specified geofence ID. /// http://tizen.org/privilege/location - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public void RemoveGeofence(int fenceId) { GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemoveFence(Handle, fenceId); @@ -154,14 +154,14 @@ namespace Tizen.Location.Geofence /// /// Gets the name of place. /// - /// 3 - /// The place id. + /// 3 + /// The place ID. /// The name of the place. /// http://tizen.org/privilege/location - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public string GetPlaceName(int placeId) { string name = ""; @@ -175,14 +175,14 @@ namespace Tizen.Location.Geofence } /// - /// Retrieves a list of places registered in the specified geofence manager. + /// Retrieves a list of places registered in the specified Geofence manager. /// - /// 3 - /// list of places registered as PlaceData instance list. + /// 3 + /// List of places registered as the PlaceData instance list. /// http://tizen.org/privilege/location - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public IEnumerable GetPlaceDataList() { List places = new List(); @@ -206,14 +206,14 @@ namespace Tizen.Location.Geofence } /// - /// Retrieves a list of fences registered in the specified geofence manager. + /// Retrieves a list of fences registered in the specified Geofence manager. /// - /// 3 - /// list of FenceData instances registred for each Geofence. + /// 3 + /// List of FenceData instances registered for each geofence. /// http://tizen.org/privilege/location - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of any system error. + /// In case privileges are not defined. + /// In case geofence is not supported. public IEnumerable GetFenceDataList() { List fences = new List(); @@ -239,14 +239,14 @@ namespace Tizen.Location.Geofence /// /// Retrieves a list of fences registered in the specified place. /// - /// 3 - /// The place id. - /// list of FenceData instances registred for each Geofence for specified place. + /// 3 + /// The place ID. + /// The list of FenceData instances registered for each geofence for the specified place. /// http://tizen.org/privilege/location - /// Incase of Invalid parameter. - /// Incase of any System error. - /// Incase of Privileges are not defined. - /// Incase of Geofence is not supported. + /// In case of an invalid parameter. + /// In case of any system error. + /// In case privileges are not defined. + /// In case the geofence is not supported. public IEnumerable GetGeofenceDataListByPlaceId(int placeId) { List fences = new List(); -- 2.34.1