From 8b550a2792d2e029b72647ff2cca6a9ac330242d Mon Sep 17 00:00:00 2001 From: jomui Date: Mon, 3 Jul 2017 20:35:36 +0900 Subject: [PATCH] API level : since_tizen Signed-off-by: jomui Change-Id: I41c236fd48692f207ae7627297213ffe902fbbd3 --- .../Tizen.Location.Geofence/Fence.cs | 13 ++++++++++ .../Tizen.Location.Geofence/FenceData.cs | 10 ++++++++ .../Tizen.Location.Geofence/FenceStatus.cs | 5 ++++ .../Tizen.Location.Geofence/GeofenceEnum.cs | 29 ++++++++++++++++++++++ .../GeofenceErrorFactory.cs | 15 +++++++++++ .../Tizen.Location.Geofence/GeofenceEventArgs.cs | 15 +++++++++++ .../Tizen.Location.Geofence/GeofenceManager.cs | 9 +++++++ .../Tizen.Location.Geofence/VirtualPerimeter.cs | 11 ++++++++ 8 files changed, 107 insertions(+) diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs index 46676eb..d22b94a 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs @@ -30,6 +30,7 @@ namespace Tizen.Location.Geofence /// 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) /// and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP. /// + /// 3 public class Fence : IDisposable { private bool _disposed = false; @@ -53,6 +54,7 @@ namespace Tizen.Location.Geofence /// /// Gets the type of geofence. /// + /// 3 public FenceType Type { get @@ -71,6 +73,7 @@ namespace Tizen.Location.Geofence /// /// Gets the id of place. /// + /// 3 public int PlaceId { get @@ -89,6 +92,7 @@ namespace Tizen.Location.Geofence /// /// Gets the longitude of geofence. /// + /// 3 public double Longitude { get @@ -108,6 +112,7 @@ namespace Tizen.Location.Geofence /// /// Gets the latitude of geofence. /// + /// 3 public double Latitude { get @@ -126,6 +131,7 @@ namespace Tizen.Location.Geofence /// /// Gets the radius of geofence. /// + /// 3 public int Radius { get @@ -144,6 +150,7 @@ namespace Tizen.Location.Geofence /// /// Gets the address of geofence. /// + /// 3 public string Address { get @@ -162,6 +169,7 @@ namespace Tizen.Location.Geofence /// /// Gets the bssid of geofence. /// + /// 3 public string Bssid { get @@ -180,6 +188,7 @@ namespace Tizen.Location.Geofence /// /// Gets the ssid of geofence. /// + /// 3 public string Ssid { get @@ -198,6 +207,7 @@ namespace Tizen.Location.Geofence /// /// Creates a geopoint type of 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). @@ -222,6 +232,7 @@ namespace Tizen.Location.Geofence /// /// Creates a Wi-Fi type of 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. @@ -244,6 +255,7 @@ namespace Tizen.Location.Geofence /// /// Creates a bluetooth type of new geofence. /// + /// 3 /// The current place id. /// Specifies the value of BSSID of BT MAC address. /// Specifies the value of SSID of BT Device. @@ -266,6 +278,7 @@ namespace Tizen.Location.Geofence /// /// Overloaded Dispose API for destroying the fence Handle. /// + /// 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 ee92017..cfda8cf 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceData.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceData.cs @@ -20,6 +20,7 @@ namespace Tizen.Location.Geofence /// /// Represents the Geofence list Item data. /// + /// 3 public class FenceData { internal FenceData(int fenceId, IntPtr handle, int index, int count) @@ -32,6 +33,7 @@ namespace Tizen.Location.Geofence /// /// Geofence instance. /// + /// 3 public Fence Fence { get; @@ -41,6 +43,7 @@ namespace Tizen.Location.Geofence /// /// The geofence id. /// + /// 3 public int GeofenceId { get; @@ -50,6 +53,7 @@ namespace Tizen.Location.Geofence /// /// The index number of the fences in the list. /// + /// 3 /// Index value starts from 1. public int Index { @@ -60,6 +64,7 @@ namespace Tizen.Location.Geofence /// /// The total number of fences that exists for the requester. /// + /// 3 public int Count { get; @@ -70,6 +75,7 @@ namespace Tizen.Location.Geofence /// /// Represents the Place list Item data. /// + /// 3 public class PlaceData { internal PlaceData(int id, string name, int index, int count) @@ -82,6 +88,7 @@ namespace Tizen.Location.Geofence /// /// The current place id. /// + /// 3 public int PlaceId { get; @@ -91,6 +98,7 @@ namespace Tizen.Location.Geofence /// /// The current place name. /// + /// 3 public string Name { get; @@ -100,6 +108,7 @@ namespace Tizen.Location.Geofence /// /// The index number of the places in the list. /// + /// 3 /// Index value starts from 1. public int Index { @@ -110,6 +119,7 @@ namespace Tizen.Location.Geofence /// /// The total number of places that exists for the requester. /// + /// 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 ceb82eb..46e5e66 100644 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs @@ -25,6 +25,7 @@ namespace Tizen.Location.Geofence /// Duration: Geofence is specified by duration of current state /// /// + /// 3 public class FenceStatus : IDisposable { private bool _disposed = false; @@ -38,6 +39,7 @@ namespace Tizen.Location.Geofence /// /// Creates a new geofence status. /// + /// 3 /// Incase of Invalid parameter. /// Incase of Geofence is not supported. public FenceStatus(int fenceId) @@ -60,6 +62,7 @@ namespace Tizen.Location.Geofence /// /// Gets the state of geofence. /// + /// 3 /// Incase of Geofence is not supported. public GeofenceState State { @@ -79,6 +82,7 @@ namespace Tizen.Location.Geofence /// /// Gets the amount of seconds geofence is in the current state. /// + /// 3 /// Incase of Geofence is not supported. public int Duration { @@ -98,6 +102,7 @@ namespace Tizen.Location.Geofence /// /// Overloaded Dispose API for destroying the fence Handle. /// + /// 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 3afeed4..b5be383 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEnum.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEnum.cs @@ -19,150 +19,179 @@ namespace Tizen.Location.Geofence /// /// Enumeration for geofence type. /// + /// 3 public enum FenceType { /// /// Geofence is specified by geospatial coordinate. /// + /// 3 GeoPoint = 1, /// /// Geofence is specified by Wi-Fi access point. /// + /// 3 Wifi, /// /// Geofence is specified by Bluetooth device. /// + /// 3 Bluetooth }; /// /// Enumerations for the state of geofence. /// + /// 3 public enum GeofenceState { /// /// Uncertain state of geofence. /// + /// 3 Uncertain = 0, /// /// Geofence In state. /// + /// 3 In, /// /// Geofence Out state. /// + /// 3 Out }; /// /// Enumerations for geofence management events. /// + /// 3 public enum GeofenceEventType { /// /// Geofence is added. /// + /// 3 FenceAdded = 0, /// /// Geofence is removed. /// + /// 3 FenceRemoved, /// /// Geofencing is started. /// + /// 3 FenceStarted, /// /// Geofencing is stopped. /// + /// 3 FenceStopped, /// /// Place is added. /// + /// 3 PlaceAdded = 0x10, /// /// Place is removed. /// + /// 3 PlaceRemoved, /// /// Place is updated. /// + /// 3 PlaceUpdated, /// /// Setting for geofencing is enabled. /// + /// 3 SettingEnabled = 0x20, /// /// Setting for geofencing is disabled. /// + /// 3 SettingDisabled }; /// /// Enumeration for the provider of proximity. /// + /// 3 public enum ProximityProvider { /// /// Proximity is specified by geospatial coordinate. /// + /// 3 Location = 0, /// /// Proximity is specified by Wi-Fi access point. /// + /// 3 Wifi, /// /// Proximity is specified by Bluetooth device. /// + /// 3 Bluetooth, /// /// Proximity is specified by Bluetooth low energy device. /// + /// 3 BLE, /// /// Proximity is specified by Sensor. /// + /// 3 Sensor } /// /// Enumeration for the state of proximity. /// + /// 3 public enum ProximityState { /// /// Uncertain state of proximity. /// + /// 3 Uncertain = 0, /// /// Far state of proximity. /// + /// 3 Far, /// /// Far state of proximity. /// + /// 3 Near, /// /// Immediate state of proximity. /// + /// 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 8b11020..e9fc3ad 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceErrorFactory.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceErrorFactory.cs @@ -23,76 +23,91 @@ namespace Tizen.Location.Geofence /// /// Enum to give the type of error occured, if any. /// + /// 3 public enum GeofenceError { /// /// Successful. /// + /// 3 None = Tizen.Internals.Errors.ErrorCode.None, /// /// Out of memory. /// + /// 3 OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory, /// /// Invalid parameter. /// + /// 3 InvalidParameter = Tizen.Internals.Errors.ErrorCode.InvalidParameter, /// /// Permission denied. /// + /// 3 PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied, /// /// Not Supported. /// + /// 3 NotSupported = Tizen.Internals.Errors.ErrorCode.NotSupported, /// /// Geofence Manager is not initialized. /// + /// 3 NotInitialized = -0x02C00000 | 0x100 | 0x01, /// /// Invalid geofence ID. /// + /// 3 InvalidID = -0x02C00000 | 0x100 | 0x02, /// /// Exception occurs. /// + /// 3 Exception = -0x02C00000 | 0x100 | 0x03, /// /// Geofencing is already started. /// + /// 3 AlreadyStarted = -0x02C00000 | 0x100 | 0x04, /// /// Too many geofence. /// + /// 3 TooManyGeofence = -0x02C00000 | 0x100 | 0x05, /// /// Error in GPS, Wi-Fi, or BT. /// + /// 3 IPC = -0x02C00000 | 0x100 | 0x06, /// /// DB error in the server side. /// + /// 3 DBFailed = -0x02C00000 | 0x100 | 0x07, /// /// Access to specified place is denied. /// + /// 3 PlaceAccessDenied = -0x02C00000 | 0x100 | 0x08, /// /// Access to specified geofence is denied. /// + /// 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 5ff6163..f5ef780 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEventArgs.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceEventArgs.cs @@ -21,11 +21,13 @@ namespace Tizen.Location.Geofence /// /// Event arguments passed when Event is triggered to notify proximity state change. /// + /// 3 public class ProximityStateEventArgs : EventArgs { /// /// Internal constructor. /// + /// 3 /// The geofence id. /// The proximity state. /// The proximity provider. @@ -39,6 +41,7 @@ namespace Tizen.Location.Geofence /// /// The geofence id. /// + /// 3 public int GeofenceId { get; @@ -47,6 +50,7 @@ namespace Tizen.Location.Geofence /// /// The proximity state. /// + /// 3 public ProximityState State { get; @@ -55,6 +59,7 @@ namespace Tizen.Location.Geofence /// /// The proximity provider. /// + /// 3 public ProximityProvider Provider { get; @@ -64,11 +69,13 @@ namespace Tizen.Location.Geofence /// /// Event arguments passed when Event is triggered to notify Geofence state change. /// + /// 3 public class GeofenceStateEventArgs : EventArgs { /// /// Internal constructor. /// + /// 3 /// The specified geofence id. /// The geofence state. internal GeofenceStateEventArgs(int fenceId, GeofenceState state) @@ -80,6 +87,7 @@ namespace Tizen.Location.Geofence /// /// The specified geofence id. /// + /// 3 public int GeofenceId { get; @@ -88,6 +96,7 @@ namespace Tizen.Location.Geofence /// /// The geofence state. /// + /// 3 public GeofenceState State { get; @@ -97,11 +106,13 @@ namespace Tizen.Location.Geofence /// /// Event arguments passed when Event occurs in geofence and place such as add, update, etc.. /// + /// 3 public class GeofenceResponseEventArgs : EventArgs { /// /// Internal constructor. /// + /// 3 /// The place id. /// The specified geofence id. /// The error code for the particular action. @@ -117,6 +128,7 @@ namespace Tizen.Location.Geofence /// /// The place id. /// + /// 3 public int PlaceId { get; @@ -125,6 +137,7 @@ namespace Tizen.Location.Geofence /// /// The specified geofence id. /// + /// 3 public int FenceId { get; @@ -133,6 +146,7 @@ namespace Tizen.Location.Geofence /// /// The error code for the particular action. /// + /// 3 public GeofenceError ErrorCode { get; @@ -141,6 +155,7 @@ namespace Tizen.Location.Geofence /// /// The result code for the particular place and geofence management. /// + /// 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 48d7762..ad69b02 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs @@ -35,6 +35,7 @@ namespace Tizen.Location.Geofence /// Results and errors for each event requested to geofence module /// /// + /// 3 public class GeofenceManager : IDisposable { private bool _disposed = false; @@ -48,6 +49,7 @@ namespace Tizen.Location.Geofence /// /// Creates a new geofence manager. /// + /// 3 /// Incase of OutOfMemory condition. /// Incase of any System error. /// Incase of Geofence is not supported. @@ -71,6 +73,7 @@ namespace Tizen.Location.Geofence /// /// Checks whether the geofence manager is available or not. /// + /// 3 public static bool IsSupported { get @@ -89,6 +92,7 @@ namespace Tizen.Location.Geofence /// /// Starts the geofencing service. /// + /// 3 /// The specified geofence id. /// http://tizen.org/privilege/location /// @@ -110,6 +114,7 @@ namespace Tizen.Location.Geofence /// /// Stops the geofenceing service. /// + /// 3 /// The specified geofence id. /// http://tizen.org/privilege/location /// @@ -141,6 +146,7 @@ namespace Tizen.Location.Geofence /// /// Invokes when a device enters or exits the given geofence, If this event is registered. /// + /// 3 /// /// Call to Start() will invoke this event. /// @@ -185,6 +191,7 @@ namespace Tizen.Location.Geofence /// /// Called when a proximity state of device is changed. /// + /// 3 /// /// Call to Start() will invoke this event. /// @@ -230,6 +237,7 @@ namespace Tizen.Location.Geofence /// Called when the some event occurs in geofence and place such as add, update, etc.. /// The events of public geofence is also received if there are public geofences. /// + /// 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. @@ -266,6 +274,7 @@ namespace Tizen.Location.Geofence /// /// Overloaded Dispose API for destroying the GeofenceManager Handle. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs index 860d48c..0d5cffe 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/VirtualPerimeter.cs @@ -23,6 +23,7 @@ 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. /// + /// 3 public class VirtualPerimeter { private IntPtr Handle; @@ -30,6 +31,7 @@ namespace Tizen.Location.Geofence /// /// Creates a VirtualPerimeter which can be used to create virtual fence. /// + /// 3 /// GeofenceManager instance. /// Incase of invlid parameter. public VirtualPerimeter(GeofenceManager manager) @@ -47,6 +49,7 @@ namespace Tizen.Location.Geofence /// /// Creates a new place for geofencing service. /// + /// 3 /// A place name to be created. /// The place id to be newly created on success. /// http://tizen.org/privilege/location @@ -69,6 +72,7 @@ namespace Tizen.Location.Geofence /// /// Updates the place name of a given place id. /// + /// 3 /// The specified place id. /// A new place name of the place id. /// http://tizen.org/privilege/location @@ -88,6 +92,7 @@ namespace Tizen.Location.Geofence /// /// Removes the specific place for geofencing service. /// + /// 3 /// The specified place id. /// http://tizen.org/privilege/location /// Incase of Invalid parameter. @@ -106,6 +111,7 @@ namespace Tizen.Location.Geofence /// /// Adds a 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. @@ -129,6 +135,7 @@ namespace Tizen.Location.Geofence /// /// Removes a geofence with a given geofence id. /// + /// 3 /// The specified geofence id. /// http://tizen.org/privilege/location /// Incase of Invalid parameter. @@ -147,6 +154,7 @@ namespace Tizen.Location.Geofence /// /// Gets the name of place. /// + /// 3 /// The place id. /// The name of the place. /// http://tizen.org/privilege/location @@ -169,6 +177,7 @@ namespace Tizen.Location.Geofence /// /// Retrieves a list of places registered in the specified geofence manager. /// + /// 3 /// list of places registered as PlaceData instance list. /// http://tizen.org/privilege/location /// Incase of any System error. @@ -199,6 +208,7 @@ namespace Tizen.Location.Geofence /// /// Retrieves a list of fences registered in the specified geofence manager. /// + /// 3 /// list of FenceData instances registred for each Geofence. /// http://tizen.org/privilege/location /// Incase of any System error. @@ -229,6 +239,7 @@ 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. /// http://tizen.org/privilege/location -- 2.7.4