From 4cd8c43084b79e7665a129aabaaf9ef52bb8e91f Mon Sep 17 00:00:00 2001 From: "Hongkuk, Son" Date: Wed, 24 May 2017 21:32:13 +0900 Subject: [PATCH] Update C# API reference according to doc guide page - API doc guide : http://suprem.sec.samsung.net/confluence/pages/viewpage.action?pageId=34308136 - Namespace/Class/Interface/Struct/Enum/Field/Property/Method/Event/Delegate/ Signed-off-by: Hongkuk, Son Change-Id: I8c6a0737efa106daacd175892500637865397fa4 --- .../Tizen.Network.IoTConnectivity/Attributes.cs | 39 +++++++++++++-- .../CacheUpdatedEventArgs.cs | 5 +- .../DeviceInformationFoundEventArgs.cs | 15 +++++- .../FindingErrorOccurredEventArgs.cs | 7 ++- .../IoTConnectivityClientManager.cs | 39 +++++++++++++-- .../IoTConnectivityServerManager.cs | 21 +++++++- .../Tizen.Network.IoTConnectivity/LiteResource.cs | 7 +++ .../Tizen.Network.IoTConnectivity/NamespaceDoc.cs | 4 +- .../Tizen.Network.IoTConnectivity/ObservePolicy.cs | 5 +- .../Tizen.Network.IoTConnectivity/ObserveType.cs | 4 ++ .../ObserverNotifiedEventArgs.cs | 7 ++- .../PlatformInformationFoundEventArgs.cs | 29 ++++++++++- .../PresenceEventType.cs | 4 ++ .../PresenceReceivedEventArgs.cs | 11 ++++- .../QualityOfService.cs | 3 ++ .../RemoteResource.cs | 57 ++++++++++++++++++++-- .../RemoteResponse.cs | 9 +++- .../Representation.cs | 24 +++++++-- .../Tizen.Network.IoTConnectivity/Request.cs | 13 +++++ .../Tizen.Network.IoTConnectivity/Resource.cs | 26 ++++++++++ .../ResourceFoundEventArgs.cs | 9 +++- .../ResourceInterfaces.cs | 22 +++++++++ .../ResourceOptions.cs | 34 ++++++++++++- .../ResourcePolicy.cs | 8 +++ .../Tizen.Network.IoTConnectivity/ResourceQuery.cs | 43 ++++++++++++++-- .../Tizen.Network.IoTConnectivity/ResourceState.cs | 3 ++ .../Tizen.Network.IoTConnectivity/ResourceTypes.cs | 17 +++++++ .../Tizen.Network.IoTConnectivity/Response.cs | 10 ++++ .../Tizen.Network.IoTConnectivity/ResponseCode.cs | 12 ++++- .../StateChangedEventArgs.cs | 5 +- 30 files changed, 457 insertions(+), 35 deletions(-) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs index 243771d..e7bb84c 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Attributes.cs @@ -29,6 +29,7 @@ namespace Tizen.Network.IoTConnectivity /// It provides API to manage attributes. /// This class is accessed by using a constructor to create a new instance of this object. /// + /// 3 public class Attributes : IDictionary, IDisposable { internal IntPtr _resourceAttributesHandle = IntPtr.Zero; @@ -38,6 +39,8 @@ namespace Tizen.Network.IoTConnectivity /// /// The Attributes constructor /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when there is not enough memory /// @@ -76,6 +79,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets the number of keys /// + /// 3 + /// The number of keys. /// /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// attributes.Add("brightness", 50); @@ -93,6 +98,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Represents whether attribute is readonly /// + /// 3 + /// Whether attribute is readonly. /// /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" }, @@ -112,6 +119,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Contains all the attribute keys /// + /// 3 + /// All the attribute keys. /// /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" }, @@ -131,6 +140,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Contains all the attribute values /// + /// 3 + /// All the attribute values. /// /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { /// { "state", "ON" }, @@ -150,6 +161,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets or sets the attribute with the specified key. /// + /// 3 + /// The attribute with the specified key. /// The key of the attribute to get or set. /// The element with the specified key. /// @@ -176,7 +189,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Adds attribute key and value as a key value pair /// + /// 3 /// The key value pair to add + /// http://tizen.org/feature/iot.ocf /// /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); /// attributes.Add(new KeyValuePair ("state", "ON")); @@ -189,8 +204,10 @@ namespace Tizen.Network.IoTConnectivity /// /// Adds an attribute /// + /// 3 /// The key representing the attribute /// The value representing the attribute + /// http://tizen.org/feature/iot.ocf /// /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); /// attributes.Add("brightness", 50); @@ -280,6 +297,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Clears attributes collection /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when the operation is invalid /// @@ -304,6 +323,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Checks whether the given key value pair exists in attributes collection /// + /// 3 /// The status key value pair /// true if exists. Otherwise, false /// @@ -322,6 +342,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Checks whether the given key exists in attributes collection /// + /// 3 /// The status key to look for /// true if exists. Otherwise, false /// @@ -340,6 +361,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Copies the elements of the attributes to an array, starting at a particular index. /// + /// 3 /// The destination array /// The zero-based index in array at which copying begins. /// @@ -358,8 +380,9 @@ namespace Tizen.Network.IoTConnectivity } /// - /// Returns an enumerator that iterates through the collection. + /// Returns an enumerator that iterates through the collection. /// + /// 3 /// An enumerator that can be used to iterate through the collection. /// /// Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { @@ -379,8 +402,10 @@ namespace Tizen.Network.IoTConnectivity /// /// Removes an attribute from collection /// + /// 3 /// The attributes element to remove /// true if operation is success. Otherwise, false + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter /// Thrown when the operation is invalid @@ -398,10 +423,12 @@ namespace Tizen.Network.IoTConnectivity } /// - /// Removes an attribute from collection using key + /// Removes an attribute from collection using key /// + /// 3 /// The attributes element to remove /// true if operation is successful, Otherwise, false + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter /// Thrown when the operation is invalid @@ -430,6 +457,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets the value associated with the specified key. /// + /// 3 /// The key whose value to get. /// The value associated with the specified key /// true if the attributes collection contains an element with the specified key; otherwise, false. @@ -448,8 +476,9 @@ namespace Tizen.Network.IoTConnectivity } /// - /// Returns an enumerator that iterates through the collection. + /// Returns an enumerator that iterates through the collection. /// + /// 3 IEnumerator IEnumerable.GetEnumerator() { return _attributes.GetEnumerator(); @@ -458,6 +487,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -467,7 +498,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs index 03406ea..45292f8 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/CacheUpdatedEventArgs.cs @@ -20,8 +20,9 @@ using System; namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the CacheUpdated event. + /// This class represents event arguments of the CacheUpdated event. /// + /// 3 public class CacheUpdatedEventArgs : EventArgs { internal CacheUpdatedEventArgs() { } @@ -29,6 +30,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates the updated representation of the resource /// + /// 3 + /// The updated representation of the resource. public Representation Representation { get; internal set; } } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs index fe585a5..3a1b30d 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/DeviceInformationFoundEventArgs.cs @@ -18,8 +18,9 @@ namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the DeviceInformationFound event. + /// This class represents event arguments of the DeviceInformationFound event. /// + /// 3 public class DeviceInformationFoundEventArgs { internal DeviceInformationFoundEventArgs() { } @@ -27,31 +28,43 @@ namespace Tizen.Network.IoTConnectivity /// /// The request id /// + /// 3 + /// The request id. public int RequestId { get; internal set; } /// /// Indicates to continuously receive the event for finding device information. /// + /// 3 + /// Continuously receive the event for finding device information. public bool EventContinue { get; set; } /// /// Indicates human friendly name for device /// + /// 3 + /// Human friendly name for device. public string Name { get; internal set; } /// /// Indicates spec version of the core specification /// + /// 3 + /// Spec version of the core specification. public string SpecVersion { get; internal set; } /// /// Indicates unique identifier for OIC device /// + /// 3 + /// Unique identifier for OIC device. public string DeviceId { get; internal set; } /// /// Indicates version of the specs this device data model is implemented to /// + /// 3 + /// Version of the specs this device data model is implemented to. public string DataModelVersion { get; internal set; } } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs index 4e5db5c..6179747 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/FindingErrorOccurredEventArgs.cs @@ -20,8 +20,9 @@ using System; namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the FindingErrorOccurred event. + /// This class represents event arguments of the FindingErrorOccurred event. /// + /// 3 public class FindingErrorOccurredEventArgs : EventArgs { internal FindingErrorOccurredEventArgs() { } @@ -29,11 +30,15 @@ namespace Tizen.Network.IoTConnectivity /// /// The request id of the operation which caused this error /// + /// 3 + /// The request id of the operation which caused this error. public int RequestId { get; internal set; } /// /// Contains error details. /// + /// 3 + /// Error details. public Exception Error { get; internal set; } } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs index 95d42c7..dd41597 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityClientManager.cs @@ -23,11 +23,13 @@ namespace Tizen.Network.IoTConnectivity /// /// IoT connectivity client manager consists of client side APIs. /// + /// 3 public static class IoTConnectivityClientManager { /// /// The IP Address for multicast /// + /// 3 public const string MulticastAddress = null; private static int s_presenceListenerId = 1; @@ -42,40 +44,46 @@ namespace Tizen.Network.IoTConnectivity /// /// PresenceReceived event. This event is occurred when server starts sending presence of a resource. /// + /// 3 public static event EventHandler PresenceReceived; /// /// ResourceFound event. This event is occurred when a resource is found from the remote server /// after sending request using API StartFindingResource(). /// + /// 3 public static event EventHandler ResourceFound; /// /// PlatformInformationFound event. This event is occurred when platform information is found /// after sending request using API StartFindingPlatformInformation(). /// + /// 3 public static event EventHandler PlatformInformationFound; /// /// DeviceInformationFound event. This event is occurred when device information is found /// after sending request using API StartFindingDeviceInformation(). /// + /// 3 public static event EventHandler DeviceInformationFound; /// /// FindingError event. This event is occurred when an error is found. /// + /// 3 public static event EventHandler FindingErrorOccurred; /// /// Timeout in seconds /// - /// + /// 3 + /// /// Value to be set must be in range from 1 to 3600. Default timeout interval value is 30.\n /// Sets/gets the timeout of StartFindingResource(), StartFindingDeviceInformation(), StartFindingPlatformInformation(), /// RemoteResource.GetAsync(), RemoteResource.PutAsync(), RemoteResource.PostAsync() and RemoteResource.DeleteAsync() APIs.\n /// Setter can throw exception. - /// + /// /// 
         /// Initialize() should be called to initialize
         ///
@@ -110,13 +118,14 @@ namespace Tizen.Network.IoTConnectivity /// /// Polling interval of IoTConnectivity /// - /// + /// 3 + /// /// Sets/Gets the polling inerval(milliseconds) of IoTCon. Default value is 100 milliseconds. /// Value to be set must be in range from 1 to 999. The closer to 0, the faster it operates. /// Setter is invoked immediately for changing the interval. /// If you want the faster operation, we recommend you set 10 milliseconds for polling interval. /// Setter can throw exception. - /// + /// /// 
         /// Initialize() should be called to initialize
         ///
@@ -152,6 +161,7 @@ namespace Tizen.Network.IoTConnectivity /// Initializes IoTCon. /// Call this function to start IoTCon. /// + /// 3 /// /// @a filePath point to a file for handling secure virtual resources. /// The file that is CBOR(Concise Binary Object Representation)-format must already exist @@ -161,7 +171,9 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/network.get \n /// http://tizen.org/privilege/internet /// + /// public /// The file path to point to storage for handling secure virtual resources. + /// http://tizen.org/feature/iot.ocf /// /// You must call Deinitialize() if IoTCon API is no longer needed. /// @@ -186,9 +198,11 @@ namespace Tizen.Network.IoTConnectivity /// /// Deinitializes IoTCon. /// + /// 3 /// /// This API must be called if IoTCon API is no longer needed. /// + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -220,10 +234,12 @@ namespace Tizen.Network.IoTConnectivity /// /// Invokes a next message from a queue for receiving messages from others, immediately. /// + /// 3 /// /// This API invokes a next message from a queue for receiving messages from others, immediately. /// After calling the API, it continues the polling with existing interval. /// + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -244,6 +260,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Starts receiving presence events /// + /// 3 /// /// Sends request to receive presence to an interested server's resource with resourceType. /// If succeeded, event handler will be triggered when the server sends presence. @@ -255,9 +272,11 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public /// The address or addressable name of the server /// A resource type that a client is interested in /// PresenceId - An identifier for this request + /// http://tizen.org/feature/iot.ocf /// 
Initialize() should be called to initialize.
/// /// When the resource receive presence, event handler will be invoked.\n @@ -349,13 +368,16 @@ namespace Tizen.Network.IoTConnectivity /// /// Stops receiving presence events /// + /// 3 /// /// Sends request to not to receive server's presence any more. /// /// /// http://tizen.org/privilege/internet /// + /// public /// The start presence request identifier + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -420,6 +442,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Starts finding resources. /// + /// 3 /// /// Sends request to find a resource of @a hostAddress server with @a resourceType. /// If succeeded, event handler will be triggered with information of the resource.\n @@ -430,9 +453,11 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public /// The address or addressable name of the server. The address includes a protocol like coaps:// /// The query specified as a filter for founding resources /// RequestId - An identifier for this request + /// http://tizen.org/feature/iot.ocf /// 
Initialize() should be called to initialize.
/// /// When the resource is found, event handler will be invoked. @@ -530,6 +555,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Starts finding the device information of remote server. /// + /// 3 /// /// Requests server for device information. /// If succeeded, event handler will be triggered with information of the device.\n @@ -538,9 +564,11 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public /// The host address of remote server /// The query specified as a filter for founding resources /// RequestId - An identifier for this request + /// http://tizen.org/feature/iot.ocf /// 
Initialize() should be called to initialize.
/// /// event handler will be invoked. @@ -630,6 +658,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Starts finding the platform information of remote server. /// + /// 3 /// /// Requests server for platform information. /// If succeeded, event handler will be triggered with information of the platform.\n @@ -638,9 +667,11 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public /// The host address of remote server /// The query specified as a filter for founding resources /// RequestId - An identifier for this request + /// http://tizen.org/feature/iot.ocf /// 
Initialize() should be called to initialize.
/// /// event handler will be invoked. diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs index dde0f68..4256414 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/IoTConnectivityServerManager.cs @@ -22,15 +22,16 @@ namespace Tizen.Network.IoTConnectivity /// /// IoT connectivity server manager consists of server side APIs. /// + /// 3 public static class IoTConnectivityServerManager { - private static int s_requestId = 1; private static Dictionary s_RequestHandlerCallbackMap = new Dictionary(); /// /// Initializes IoTCon. Call this API to start IoTCon. /// + /// 3 /// /// @a filePath point to a file for handling secure virtual resources. /// The file that is CBOR(Concise Binary Object Representation)-format must already exist @@ -40,7 +41,9 @@ namespace Tizen.Network.IoTConnectivity /// http://tizen.org/privilege/network.get \n /// http://tizen.org/privilege/internet /// + /// public /// The file path to point to storage for handling secure virtual resources. + /// http://tizen.org/feature/iot.ocf /// /// You must call Deinitialize() if IoTCon API is no longer needed. /// @@ -65,9 +68,11 @@ namespace Tizen.Network.IoTConnectivity /// /// Deinitializes IoTCon. /// + /// 3 /// /// This API must be called if IoTCon API is no longer needed. /// + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -87,10 +92,13 @@ namespace Tizen.Network.IoTConnectivity /// /// Registers a resource in IoTCon server /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public /// The resource to register + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -156,10 +164,13 @@ namespace Tizen.Network.IoTConnectivity /// /// Unregisters a resource in IoTCon server /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public /// The resource to unregister + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -195,6 +206,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Starts presence of a server /// + /// 3 /// /// Use this API to send server's announcements to clients. /// Server can call this API when online for the first time or come back from offline to online.\n @@ -204,7 +216,9 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public /// The interval of announcing presence in seconds. + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -235,6 +249,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Stops presence of a server. /// + /// 3 /// /// Use this API to stop sending server's announcements to clients. /// Server can call this API when terminating, entering to offline or out of network. @@ -242,6 +257,8 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public + /// http://tizen.org/feature/iot.ocf /// 
         /// Initialize() should be called to initialize.
         ///
@@ -268,11 +285,13 @@ namespace Tizen.Network.IoTConnectivity /// /// Sets the device name /// + /// 3 /// /// This API sets the name of the local device (the device calling the API).\n /// If the device name is set, clients can get the name using . /// /// The device name + /// http://tizen.org/feature/iot.ocf /// /// /// diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs index ae1612a..f6238c6 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/LiteResource.cs @@ -22,11 +22,13 @@ namespace Tizen.Network.IoTConnectivity /// It provides APIs to encapsulate resources. /// This class is accessed by using a constructor to create a new instance of this object. /// + /// 3 public class LiteResource : Resource { /// /// The LiteResource constructor /// + /// 3 /// /// Creates a lite resource which can then be registered in server using .\n /// When client requests some operations, it send a response to client, automatically.\n @@ -35,10 +37,12 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public /// The uri path of the lite resource /// The type of the resource /// Policy of the resource /// Optional attributes of the resource + /// http://tizen.org/feature/iot.ocf /// 
         /// IoTConnectivityServerManager.Initialize() should be called to initialize
         ///
@@ -61,6 +65,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets or sets the attributes of the lite resource /// + /// 3 + /// The attributes of the lite resource. /// /// List list = new List() { "org.tizen.light" }; /// LiteResource res = new LiteResource("/light/1", new ResourceTypes(list), ResourcePolicy.Discoverable); @@ -78,6 +84,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Decides whether to accept or reject a post request. /// + /// 3 /// /// Child classes of this class can override this method to accept or reject post request. /// diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs index 098ec24..6c4b38f 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs @@ -3,10 +3,10 @@ The Tizen.Network.IoTConnectivity namespace provides classes to manage Resource, RemoteResource, Request, Response and so on which are based on IoTivity project. - + The Tizen.Network.IoTConnectivity namespace provides classes to manage Resource, RemoteResource, Request, Response and so on which are based on IoTivity project. - + */ namespace Tizen.Network.IoTConnectivity {} diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs index fa10b88..f50901b 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObservePolicy.cs @@ -20,15 +20,18 @@ namespace Tizen.Network.IoTConnectivity /// /// Enumeration for policy of observation /// + /// 3 public enum ObservePolicy { /// /// Indicates observation request for most up-to-date notifications only /// + /// 3 IgnoreOutOfOrder = 0, /// - /// Indicates observation request for all notifications including stale notifications + /// Indicates observation request for all notifications including state notifications /// + /// 3 AcceptOutOfOrder } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs index ca2ecc7..ca611bb 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserveType.cs @@ -20,21 +20,25 @@ namespace Tizen.Network.IoTConnectivity /// /// Enumeration for type of observation /// + /// 3 public enum ObserveType { /// /// No observe action /// + /// 3 NoType = 0, /// /// Indicates action of registering observation /// + /// 3 Register = 1, /// /// Indicates action of unregistering observation /// + /// 3 Deregister = 2, } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs index cca3f78..edbbef2 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ObserverNotifiedEventArgs.cs @@ -20,8 +20,9 @@ using System; namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the ObserverNotified event. + /// This class represents event arguments of the ObserverNotified event. /// + /// 3 public class ObserverNotifiedEventArgs : EventArgs { internal ObserverNotifiedEventArgs() { } @@ -29,11 +30,15 @@ namespace Tizen.Network.IoTConnectivity /// /// Result of the observe response /// + /// 3 + /// Result of the observe response. public ResponseCode Result { get; internal set; } /// /// Representation of the resource being observed. /// + /// 3 + /// Representation of the resource being observed. public Representation Representation { get; internal set; } } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs index c6e6642..312f05f 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PlatformInformationFoundEventArgs.cs @@ -18,8 +18,9 @@ namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the PlatformInformationFound event. + /// This class represents event arguments of the PlatformInformationFound event. /// + /// 3 public class PlatformInformationFoundEventArgs { internal PlatformInformationFoundEventArgs() { } @@ -27,66 +28,92 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates the request id /// + /// 3 + /// The request id. public int RequestId { get; internal set; } /// /// Indicates to continuously receive the event for finding platform information. /// + /// 3 + /// Continuously receive the event for finding platform information. public bool EventContinue { get; set; } /// /// Indicates the platform identifier /// + /// 3 + /// The platform identifier. public string PlatformId { get; internal set; } /// /// Indicates the name of manufacturer /// + /// 3 + /// The name of manufacturer. public string ManufacturerName { get; internal set; } /// /// Indicates URL of the manufacturer /// + /// 3 + /// URL of the manufacturer. public string ManufacturerURL { get; internal set; } /// /// Indicates model number as designated by manufacturer /// + /// 3 + /// Model number as designated by manufacturer. public string ModelNumber { get; internal set; } /// /// Indicates manufacturing date of the device /// + /// 3 + /// Manufacturing date of the device. public string DateOfManufacture { get; internal set; } /// /// Indicates version of platfrom defined by manufacturer /// + /// 3 + /// Version of platfrom defined by manufacturer. public string PlatformVersion { get; internal set; } /// /// Indicates version of platfrom resident OS /// + /// 3 + /// Version of platfrom resident OS. public string OsVersion { get; internal set; } /// /// Indicates version of platform Hardware /// + /// 3 + /// Version of platform Hardware. public string HardwareVersion { get; internal set; } /// /// Indicates version of device firmware /// + /// 3 + /// Version of device firmware. public string FirmwareVersion { get; internal set; } /// /// Indicates URL that points to support information from manufacturer /// + /// 3 + /// URL that points to support information from manufacturer. public string SupportUrl { get; internal set; } /// /// Indicates reference time of the device /// + /// 3 + /// Reference time of the device. public string SystemTime { get; internal set; } } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs index f295129..77ba72a 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceEventType.cs @@ -20,19 +20,23 @@ namespace Tizen.Network.IoTConnectivity /// /// Enumeration for operation of presence response. /// + /// 3 public enum PresenceEventType { /// /// Indicates for resource creation operation of server /// + /// 3 ResourceCreated = 0, /// /// Indicates for resource updation operation of server /// + /// 3 ResourceUpdated, /// /// Indicates for resource destruction operation of server /// + /// 3 ResourceDestroyed } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs index ef71306..0138c11 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/PresenceReceivedEventArgs.cs @@ -20,8 +20,9 @@ using System; namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the PresenceReceived event. + /// This class represents event arguments of the PresenceReceived event. /// + /// 3 public class PresenceReceivedEventArgs : EventArgs { internal PresenceReceivedEventArgs() { } @@ -29,21 +30,29 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates request id of presence event. /// + /// 3 + /// Request id of presence event. public int PresenceId { get; internal set; } /// /// Indicates event type /// + /// 3 + /// Event type. public PresenceEventType EventType { get; internal set; } /// /// Indicates host address of resource /// + /// 3 + /// Host address of resource. public string HostAddress { get; internal set; } /// /// Indicates type of the resource /// + /// 3 + /// Type of the resource. public string Type { get; internal set; } } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs index 619fd35..c05ffc9 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/QualityOfService.cs @@ -20,15 +20,18 @@ namespace Tizen.Network.IoTConnectivity /// /// Enumeration for states of remote resource. /// + /// 3 public enum QualityOfService { /// /// Indicates low quality of service /// + /// 3 Low = 0, /// /// Indicates high quality of service /// + /// 3 High } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs index 463b8fa..3844199 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResource.cs @@ -27,6 +27,7 @@ namespace Tizen.Network.IoTConnectivity /// This class represents a remote resource. /// It provides APIs to manage remote resource. /// + /// 3 public class RemoteResource : IDisposable { internal const int TimeOutMax = 3600; @@ -48,6 +49,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Creates a remote resource instance /// + /// 3 /// /// To use this API, you should provide all of the details required to correctly contact and /// observe the object.\n @@ -59,6 +61,7 @@ namespace Tizen.Network.IoTConnectivity /// The policies of the resource /// The resource types of the resource /// The resource interfaces of the resource + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when there is not enough memory /// Thrown when there is an invalid parameter @@ -102,16 +105,19 @@ namespace Tizen.Network.IoTConnectivity /// /// Event that is invoked with cached resource attributes /// + /// 3 public event EventHandler CacheUpdated; /// /// Observe event on the resource sent by the server /// + /// 3 public event EventHandler ObserverNotified; /// /// Event that is called when remote resource's state are changed /// + /// 3 public event EventHandler StateChanged { add @@ -135,31 +141,43 @@ namespace Tizen.Network.IoTConnectivity /// /// The host address of the resource /// + /// 3 + /// The host address of the resource. public string HostAddress { get; private set; } /// /// The URI path of the resource /// + /// 3 + /// The URI path of the resource. public string UriPath { get; private set; } /// /// The resource types of the remote resource /// + /// 3 + /// The resource types of the remote resource. public IEnumerable Types { get; private set; } /// /// The interfaces of the resource /// + /// 3 + /// The interfaces of the resource. public IEnumerable Interfaces { get; private set; } /// /// The policy of the resource /// + /// 3 + /// The policy of the resource. public ResourcePolicy Policy { get; private set; } /// /// The header options of the resource /// + /// 3 + /// The header options of the resource. /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter public ResourceOptions Options @@ -186,9 +204,10 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates the CacheEnabled status of the remote resource. /// - /// + /// 3 + /// /// Client can start caching only when this is set true. Set it to false to stop caching the resource attributes. - /// + /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter /// Thrown when the operation is invalid @@ -213,10 +232,11 @@ namespace Tizen.Network.IoTConnectivity /// /// Time interval of monitoring and caching API /// - /// - /// Default time interval is 10 seconds.\n + /// 3 + /// + /// Default time interval is 10 seconds. /// Seconds for time interval (must be in range from 1 to 3600) - /// + /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter public int TimeInterval @@ -250,11 +270,16 @@ namespace Tizen.Network.IoTConnectivity /// /// The device id of the resource /// + /// 3 + /// The device id of the resource. public string DeviceId { get; private set; } /// /// Gets cached representation from the remote resource /// + /// 3 + /// cached representation from the remote resource + /// http://tizen.org/feature/iot.ocf public Representation CachedRepresentation() { IntPtr handle; @@ -272,14 +297,17 @@ namespace Tizen.Network.IoTConnectivity /// /// Starts observing on the resource /// + /// 3 /// /// When server sends notification message, will be called. /// /// /// http://tizen.org/privilege/internet /// + /// public /// The type to specify how client wants to observe /// The query to send to server + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when the operation is invalid /// Thrown when app does not have privilege to access @@ -340,9 +368,12 @@ namespace Tizen.Network.IoTConnectivity /// /// Stops observing on the resource /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when the operation is invalid /// Thrown when app does not have privilege to access @@ -359,11 +390,14 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets the attributes of a resource, asynchronously /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public /// The ResourceQuery to send to server /// Remote response with result and representation + /// http://tizen.org/feature/iot.ocf public async Task GetAsync(ResourceQuery query = null) { TaskCompletionSource tcsRemoteResponse = new TaskCompletionSource(); @@ -412,12 +446,15 @@ namespace Tizen.Network.IoTConnectivity /// /// Puts the representation of a resource, asynchronously. /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public /// Resource representation to put /// The ResourceQuery to send to server /// Remote response with result and representation + /// http://tizen.org/feature/iot.ocf public async Task PutAsync(Representation representation, ResourceQuery query = null) { TaskCompletionSource tcsRemoteResponse = new TaskCompletionSource(); @@ -471,12 +508,15 @@ namespace Tizen.Network.IoTConnectivity /// /// Post request on a resource, asynchronously /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public /// Resource representation of request /// The ResourceQuery to send to server /// Remote response with result and representation + /// http://tizen.org/feature/iot.ocf public async Task PostAsync(Representation representation, ResourceQuery query = null) { TaskCompletionSource tcsRemoteResponse = new TaskCompletionSource(); @@ -523,10 +563,13 @@ namespace Tizen.Network.IoTConnectivity /// /// Deletes the resource, asynchronously /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public /// Remote response with result and representation + /// http://tizen.org/feature/iot.ocf public async Task DeleteAsync() { TaskCompletionSource tcsRemoteResponse = new TaskCompletionSource(); @@ -580,6 +623,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -651,7 +696,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs index 3820934..667b5c3 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/RemoteResponse.cs @@ -18,9 +18,10 @@ namespace Tizen.Network.IoTConnectivity { /// - /// This class represents remote response. + /// This class represents a remote response. /// It represents the response of all CRUD operations. /// + /// 3 public class RemoteResponse { internal RemoteResponse() { } @@ -28,16 +29,22 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates the result of the response /// + /// 3 + /// The result of the response. public ResponseCode Result { get; internal set; } /// /// Indicates representation of the response /// + /// 3 + /// Representation of the response. public Representation Representation { get; internal set; } /// /// Indicates header options of the response /// + /// 3 + /// Header options of the response. public ResourceOptions Options { get; internal set; } } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs index 67a0eb2..7f7b633 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Representation.cs @@ -23,9 +23,10 @@ using System.Runtime.InteropServices; namespace Tizen.Network.IoTConnectivity { /// - /// This class provides API to manage representation. + /// This class provides APIs to manage representation. /// A representation is a payload of a request or a response. /// + /// 3 public class Representation : IDisposable { internal IntPtr _representationHandle = IntPtr.Zero; @@ -36,7 +37,8 @@ namespace Tizen.Network.IoTConnectivity /// /// The Representation constructor /// - /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when there is not enough memory /// Thrown when there is an invalid parameter @@ -83,9 +85,11 @@ namespace Tizen.Network.IoTConnectivity /// /// The URI path of resource /// - /// + /// 3 + /// + /// The URI path of resource. /// Setter can throw exceptions - /// + /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter /// Thrown when the operation is invalid @@ -123,6 +127,8 @@ namespace Tizen.Network.IoTConnectivity /// /// The type of resource /// + /// 3 + /// The type of resource. /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -166,6 +172,8 @@ namespace Tizen.Network.IoTConnectivity /// /// The interface of the resource /// + /// 3 + /// The interface of the resource. /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -209,6 +217,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Current attributes of the resource /// + /// 3 + /// Current attributes of the resource. /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -256,6 +266,8 @@ namespace Tizen.Network.IoTConnectivity /// /// List of Child resource representation /// + /// 3 + /// List of Child resource representation. /// /// Representation repr = new Representation(); /// Representation child1 = new Representation(); @@ -284,6 +296,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -293,7 +307,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs index 53bb53d..93d5326 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Request.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.IoTConnectivity /// Class respresenting request to a resource. /// It provides APIs to manage client's request. /// + /// 3 public class Request : IDisposable { private bool _disposed = false; @@ -42,26 +43,36 @@ namespace Tizen.Network.IoTConnectivity /// /// The host address of the request /// + /// 3 + /// The host address of the request. public string HostAddress { get; internal set; } /// /// The representation of the request /// + /// 3 + /// The representation of the request. public Representation Representation { get; internal set; } /// /// The query of the request /// + /// 3 + /// The query of the request. public ResourceQuery Query { get; internal set; } /// /// The options related to the request /// + /// 3 + /// The options related to the request. public ResourceOptions Options { get; internal set; } /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -71,7 +82,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs index dd95cbc..27f0c94 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Resource.cs @@ -26,6 +26,7 @@ namespace Tizen.Network.IoTConnectivity /// Abstract class respresenting a resource. /// All resources need to inherit from this class. /// + /// 3 public abstract class Resource : IDisposable { private IntPtr _resourceHandle = IntPtr.Zero; @@ -36,6 +37,7 @@ namespace Tizen.Network.IoTConnectivity /// /// The constructor /// + /// 3 /// /// @a uri format would be relative URI path like '/a/light' /// and its length must be less than 128. @@ -43,10 +45,12 @@ namespace Tizen.Network.IoTConnectivity /// /// http://tizen.org/privilege/internet /// + /// public /// The URI path of the resource /// Resource types /// Resource interfaces /// The policies of the resoruce + /// http://tizen.org/feature/iot.ocf /// 
         /// IoTConnectivityServerManager.Initialize() should be called to initialize
         ///
@@ -104,26 +108,36 @@ namespace Tizen.Network.IoTConnectivity /// /// Type details of the resource /// + /// 3 + /// Type details of the resource. public ResourceTypes Types { get; internal set; } /// /// Interface details of the resource /// + /// 3 + /// Interface details of the resource. public ResourceInterfaces Interfaces { get; internal set; } /// /// The policies of the resource /// + /// 3 + /// The policies of the resource. public ResourcePolicy Policy { get; internal set; } /// /// URI path of the resource /// + /// 3 + /// URI path of the resource. public string UriPath { get; internal set; } /// /// List of Child resources /// + /// 3 + /// List of Child resources. public ICollection Children { get @@ -147,11 +161,14 @@ namespace Tizen.Network.IoTConnectivity /// /// Notify the specified representation and qos. /// + /// 3 /// /// http://tizen.org/privilege/internet /// + /// public /// Representation. /// The quality of service for message transfer. + /// http://tizen.org/feature/iot.ocf /// 
         /// IoTConnectivityServerManager.Initialize() should be called to initialize
         ///
@@ -188,6 +205,7 @@ namespace Tizen.Network.IoTConnectivity /// /// This is Called when the client performs get operation on this resource. /// + /// 3 /// A request from client /// A response having the representation and the result protected abstract Response OnGet(Request request); @@ -195,6 +213,7 @@ namespace Tizen.Network.IoTConnectivity /// /// This is Called when the client performs put operation on this resource. /// + /// 3 /// A request from client /// A response protected abstract Response OnPut(Request request); @@ -202,6 +221,7 @@ namespace Tizen.Network.IoTConnectivity /// /// This is Called when the client performs post operation on this resource. /// + /// 3 /// A request from client /// A response having the representation and the result protected abstract Response OnPost(Request request); @@ -209,6 +229,7 @@ namespace Tizen.Network.IoTConnectivity /// /// This is Called when the client performs delete operation on this resource. /// + /// 3 /// A request from client /// A response protected abstract Response OnDelete(Request request); @@ -216,6 +237,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Called on the observing event. /// + /// 3 /// A request from client /// Observer type /// Observe identifier. @@ -225,6 +247,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -234,7 +258,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs index 7195cf1..86a9c8a 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceFoundEventArgs.cs @@ -20,8 +20,9 @@ using System; namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the ResourceFound event. + /// This class represents event arguments of the ResourceFound event. /// + /// 3 public class ResourceFoundEventArgs : EventArgs { internal ResourceFoundEventArgs() { } @@ -30,16 +31,22 @@ namespace Tizen.Network.IoTConnectivity /// Indicates the request id. /// This is the same request id returned by the API. /// + /// 3 + /// The request id. public int RequestId { get; internal set; } /// /// Indicates to continuously receive the event for finding resource. /// + /// 3 + /// Continuously receive the event for finding resource. public bool EventContinue { get; set; } /// /// Remote resource which is found after . /// + /// 3 + /// Remote resource which is found after . /// /// public RemoteResource Resource { get; internal set; } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs index 3975644..8d0f789 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceInterfaces.cs @@ -26,31 +26,37 @@ namespace Tizen.Network.IoTConnectivity /// This class contains resource interfaces and provides APIs to manage, add, remove those interfaces. /// A resource interface indicates a class or category of resources. /// + /// 3 public class ResourceInterfaces : IEnumerable, IDisposable { /// /// Default Interface /// + /// 3 public const string DefaultInterface = "oic.if.baseline"; /// /// List Links Interface which is used to list the references to other resources contained in a resource. /// + /// 3 public const string LinkInterface = "oic.if.ll"; /// /// Batch Interface which is used to manipulate (GET, PUT, POST, DELETE) on other resource contained in a resource. /// + /// 3 public const string BatchInterface = "oic.if.b"; /// /// Group Interface which is used to manipulate (GET, PUT, POST) a group of remote resources. /// + /// 3 public const string GroupInterface = "oic.mi.grp"; /// /// Read-Only Interface which is used to limit the methods that can be applied to a resource to GET only. /// + /// 3 public const string ReadonlyInterface = "oic.if.r"; private readonly IntPtr _resourceInterfacesHandle = IntPtr.Zero; @@ -61,6 +67,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Constructor of ResourceInterfaces /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// /// /// Thrown when the iotcon is not supported @@ -81,7 +89,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Constructor of ResourceInterfaces using list of interfaces /// + /// 3 /// List of resource interfaces + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when there is not enough memory /// Thrown when there is an invalid parameter @@ -145,6 +155,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates count of interfaces in the list /// + /// 3 + /// Count of interfaces in the list. /// /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List() /// { ResourceInterfaces.LinkInterface, ResourceInterfaces.ReadonlyInterface }); @@ -161,10 +173,12 @@ namespace Tizen.Network.IoTConnectivity /// /// Adds a resource interface into the list. /// + /// 3 /// /// @a item could be a value such as /// /// The string data to insert into the resource interfaces + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when the operation is invalid @@ -195,7 +209,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Removes a resource interface from the list /// + /// 3 /// The string data to delete from the resource ifaces + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -223,6 +239,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Return enumerator for the list of interfaces /// + /// 3 /// The enumerator /// /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List() @@ -240,6 +257,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Return enumerator for the list of interfaces /// + /// 3 /// The enumerator /// /// ResourceInterfaces resourceInterfaces = new ResourceInterfaces(new List() @@ -257,6 +275,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -272,7 +292,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs index 1c9c6fd..37ee5e4 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceOptions.cs @@ -27,6 +27,7 @@ namespace Tizen.Network.IoTConnectivity /// The iotcon options API provides methods for managing vendor specific options of coap packet.\n /// See more about coap packet in http://tools.ietf.org/html/rfc7252. /// + /// 3 public class ResourceOptions : IDictionary, IDisposable { internal const int MaxSize = 2; @@ -41,6 +42,8 @@ namespace Tizen.Network.IoTConnectivity /// /// The resource options constructor /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// /// /// Thrown when the iotcon is not supported @@ -93,6 +96,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Contains all the Option keys /// + /// 3 + /// All the Option keys. /// /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "sample-data"); @@ -111,6 +116,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Contains all the Option values /// + /// 3 + /// All the Option values. /// /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "sample-data"); @@ -129,6 +136,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets the number of options /// + /// 3 + /// The number of options. /// /// ResourceOptions options = new ResourceOptions(); /// options.Add(2050, "sample-data"); @@ -147,6 +156,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Represents whether the collection is readonly /// + /// 3 + /// Whether the collection is readonly. /// /// ResourceOptions options = new ResourceOptions(); /// if (options.IsReadOnly) @@ -163,7 +174,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets or sets the option data /// - /// + /// 3 + /// The option data. /// The option id to get or set. /// The option with the specified id. /// @@ -186,6 +198,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Checks whether the given key exists in Options collection /// + /// 3 /// The key to look for /// true if exists. Otherwise, false /// @@ -202,6 +215,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Adds a new id and a correspoding data into the options. /// + /// 3 /// /// ResourceOptions can have up to 2 options. \n /// key is always situated between 2048 and 3000. \n @@ -209,6 +223,7 @@ namespace Tizen.Network.IoTConnectivity /// /// The id of the option to insert /// The string data to insert into the options + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -239,8 +254,10 @@ namespace Tizen.Network.IoTConnectivity /// /// Removes the id and its associated data from the options. /// + /// 3 /// The id of the option to delete /// True if operation is successful. Otherwise, false + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -266,6 +283,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets the value associated with the specified key. /// + /// 3 /// The option id /// Value corresponding to option id /// True if the key exists, false otherwise @@ -285,7 +303,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Adds options key and value as a key value pair /// + /// 3 /// The key value pair + /// http://tizen.org/feature/iot.ocf /// /// /// ResourceOptions options = new ResourceOptions(); @@ -299,6 +319,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Clears the Options collection /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// /// ResourceOptions options = new ResourceOptions(); @@ -323,6 +345,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Checks if the given option pair exists /// + /// 3 /// The key value pair /// True if exists. Otherwise, false /// @@ -340,6 +363,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Copies the elements of the options collection to an Array, starting at a particular index. /// + /// 3 /// The destination array /// Index parameter /// @@ -357,8 +381,10 @@ namespace Tizen.Network.IoTConnectivity /// /// Remove the given key value pair from the options /// + /// 3 /// The key value pair to remove /// True if operation is successful. Otherwise, false + /// http://tizen.org/feature/iot.ocf /// /// Thrown when there is an invalid parameter /// @@ -374,6 +400,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Get the enumerator to options collection /// + /// 3 /// Enumerator to option pairs /// /// ResourceOptions options = new ResourceOptions(); @@ -392,6 +419,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -401,6 +430,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Get the enumerator to options collection /// + /// 3 /// Enumerator to option pairs /// /// ResourceOptions options = new ResourceOptions(); @@ -419,7 +449,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs index 365df42..ca1082a 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourcePolicy.cs @@ -22,35 +22,43 @@ namespace Tizen.Network.IoTConnectivity /// /// Enumeration for policy which can be held in a resource. /// + /// 3 public enum ResourcePolicy { /// /// Indicates resource uninitialized /// + /// 3 NoProperty = 0, /// /// Indicates resource that is allowed to be discovered /// + /// 3 Discoverable = (1 << 0), /// /// Indicates resource that is allowed to be observed /// + /// 3 Observable = (1 << 1), /// /// Indicates resource initialized and activated /// + /// 3 Active = (1 << 2), /// /// Indicates resource which takes some delay to respond /// + /// 3 Slow = (1 << 3), /// /// Indicates secure resource /// + /// 3 Secure = (1 << 4), /// /// When this bit is set, the resource is allowed to be discovered only if discovery request contains an explicit querystring. /// + /// 3 ExplicitDiscoverable = (1 << 5), } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs index 6c286db..27a8135 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceQuery.cs @@ -25,6 +25,7 @@ namespace Tizen.Network.IoTConnectivity /// /// This class provides APIs to manage query of request. /// + /// 3 public class ResourceQuery : IDictionary, IDisposable { internal const int QueryMaxLenth = 64; @@ -35,6 +36,8 @@ namespace Tizen.Network.IoTConnectivity /// /// The resource query constructor /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// /// /// Thrown when the iotcon is not supported @@ -86,6 +89,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets and sets the resource type of the query /// + /// 3 + /// The resource type of the query. /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter /// Thrown when the operation is invalid @@ -124,9 +129,11 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets and sets the resource interface of the query /// - /// + /// 3 + /// + /// The resource interface of the query. /// Setter value could be a value such as - /// + /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter /// Thrown when the operation is invalid @@ -164,6 +171,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Contains all the query keys /// + /// 3 + /// All the query keys. /// /// ResourceQuery query = new ResourceQuery(); /// query.Add("key", "value"); @@ -182,6 +191,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Contains all the query values /// + /// 3 + /// All the query values. /// /// ResourceQuery query = new ResourceQuery(); /// query.Add("key", "value"); @@ -200,6 +211,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets the number of query elements /// + /// 3 + /// The number of query elements. /// /// ResourceQuery query = new ResourceQuery(); /// query.Add("key", "value"); @@ -218,6 +231,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Represents whether the collection is readonly /// + /// 3 + /// Whether the collection is readonly. /// /// ResourceQuery query = new ResourceQuery(); /// if (query.IsReadOnly) @@ -234,6 +249,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets or sets the query data /// + /// 3 + /// The query data. /// The query key to get or set. /// The query with the specified key. /// @@ -257,6 +274,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Checks whether the given key exists in Query collection /// + /// 3 /// The key to look for /// true if exists. Otherwise, false /// @@ -273,11 +291,13 @@ namespace Tizen.Network.IoTConnectivity /// /// Adds a new key and correspoding value into the query. /// + /// 3 /// /// The full length of query should be less than or equal to 64. /// /// The key of the query to insert /// The string data to insert into the query + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -308,8 +328,10 @@ namespace Tizen.Network.IoTConnectivity /// /// Removes the key and its associated value from the query. /// + /// 3 /// The id of the query to delete /// True if operation is successful. Otherwise, false + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -336,6 +358,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets the value associated with the specified key. /// + /// 3 /// The query key /// Value corresponding to query key /// True if the key exists, false otherwise @@ -353,9 +376,11 @@ namespace Tizen.Network.IoTConnectivity } /// - /// Adds query key and value as a key value pair + /// Adds query key and value as a key value pair /// + /// 3 /// The key value pair + /// http://tizen.org/feature/iot.ocf /// /// /// ResourceQuery query = new ResourceQuery(); @@ -369,6 +394,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Clears the Query collection /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// Thrown when the iotcon is not supported /// Thrown when the operation is invalid /// @@ -394,6 +421,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Checks if the given query pair exists /// + /// 3 /// The key value pair /// True if exists. Otherwise, false /// @@ -411,6 +439,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Copies the elements of the query collection to an Array, starting at a particular index. /// + /// 3 /// The destination array /// Index parameter /// @@ -428,8 +457,10 @@ namespace Tizen.Network.IoTConnectivity /// /// Remove the given key value pair from the query /// + /// 3 /// The key value pair to remove /// True if operation is successful. Otherwise, false + /// http://tizen.org/feature/iot.ocf /// /// Thrown when there is an invalid parameter /// @@ -445,6 +476,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Get the enumerator to query collection /// + /// 3 /// Enumerator to query pairs /// /// ResourceQuery query = new ResourceQuery(); @@ -463,6 +495,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Get the enumerator to query collection /// + /// 3 /// Enumerator to query pairs /// /// ResourceQuery query = new ResourceQuery(); @@ -481,6 +514,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -490,7 +525,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs index b818dce..32eb72d 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceState.cs @@ -20,15 +20,18 @@ namespace Tizen.Network.IoTConnectivity /// /// Enumeration for states of remote resource. /// + /// 3 public enum ResourceState { /// /// Indicates remote resource is alive /// + /// 3 Alive = 0, /// /// Indicates remote resource is lost /// + /// 3 LostSignal } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs index 65eef6c..21bd1b3 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResourceTypes.cs @@ -26,6 +26,7 @@ namespace Tizen.Network.IoTConnectivity /// This class contains resource types and provides APIs to manage, add, remove those types. /// A resource type indicates a class or category of resources. /// + /// 3 public class ResourceTypes : IEnumerable, IDisposable { internal const int MaxLength = 61; @@ -36,6 +37,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Constructor of ResourceTypes /// + /// 3 + /// http://tizen.org/feature/iot.ocf /// /// /// Thrown when the iotcon is not supported @@ -56,7 +59,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Constructor of ResourceTypes using list of types /// + /// 3 /// List of resource types + /// http://tizen.org/feature/iot.ocf /// Thrown when there is an invalid parameter /// /// ResourceTypes types = new ResourceTypes(new List() { "org.tizen.light", "oic.if.room" }); @@ -110,6 +115,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates count of types in the list /// + /// 3 + /// Count of types in the list. /// /// ResourceTypes types = new ResourceTypes(new List() { "org.tizen.light", "oic.if.room" }); /// Console.WriteLine("There are {0} items", types.Count); @@ -125,6 +132,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Adds a resource type into the list. /// + /// 3 /// /// The length of @a item should be less than or equal to 61.\n /// The @a item must start with a lowercase alphabetic character, followed by a sequence @@ -132,6 +140,7 @@ namespace Tizen.Network.IoTConnectivity /// Duplicate strings are not allowed. /// /// The string data to insert into the resource types + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -162,7 +171,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Removes a resource type from the list /// + /// 3 /// The string data to delete from the resource types + /// http://tizen.org/feature/iot.ocf /// /// Thrown when the iotcon is not supported /// Thrown when there is an invalid parameter @@ -186,6 +197,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Return enumerator for the list of types /// + /// 3 /// The enumerator /// /// ResourceTypes resourceTypes = new ResourceTypes(new List() { "org.tizen.light", "oic.if.room" }); @@ -202,6 +214,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Return enumerator for the list of types /// + /// 3 /// The enumerator /// /// ResourceTypes resourceTypes = new ResourceTypes(new List() { "org.tizen.light", "oic.if.room" }); @@ -218,6 +231,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. /// + /// 3 + /// http://tizen.org/feature/iot.ocf public void Dispose() { Dispose(true); @@ -233,7 +248,9 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// http://tizen.org/feature/iot.ocf protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs index a81e6db..60e9e9d 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/Response.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.IoTConnectivity /// This class represents response from a resource. /// It provides APIs to manage response. /// + /// 3 public class Response : IDisposable { private bool _disposed = false; @@ -30,6 +31,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Constructor of Response /// + /// 3 /// /// Response response = new Response(); /// @@ -46,21 +48,28 @@ namespace Tizen.Network.IoTConnectivity /// /// Gets or sets the result from/into the reponse /// + /// 3 + /// The result from/into the reponse. public ResponseCode Result { get; set; } /// /// Gets or sets the representation from/into the reponse /// + /// 3 + /// The representation from/into the reponse. public Representation Representation { get; set; } /// /// Gets or sets the options from/into the reponse /// + /// 3 + /// The options from/into the reponse. public ResourceOptions Options { get; set; } /// /// Releases any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); @@ -122,6 +131,7 @@ namespace Tizen.Network.IoTConnectivity /// /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// + /// 3 /// If true, disposes any disposable objects. If false, does not dispose disposable objects. protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs index 2c72a9a..4e6ddfa 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/ResponseCode.cs @@ -20,35 +20,43 @@ namespace Tizen.Network.IoTConnectivity /// /// Enumeration for result of response /// + /// 3 public enum ResponseCode { /// /// Indicates result of response for success /// + /// 3 Ok = 0, /// /// Indicates result of response for some error /// + /// 3 Error, /// /// Indicates result of response for created resource /// + /// 3 Created, /// - /// Indicates result of response for deleted resource + /// Indicates result of response for deleted resource /// + /// 3 Deleted, /// - /// Indicates result of response for changed resource + /// Indicates result of response for changed resource /// + /// 3 Changed, /// /// Indicates result of response for slow resource /// + /// 3 Slow, /// /// Indicates result of response for accessing unauthorized resource /// + /// 3 Forbidden } } diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs index 0e54405..eefc47e 100755 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs +++ b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/StateChangedEventArgs.cs @@ -20,8 +20,9 @@ using System; namespace Tizen.Network.IoTConnectivity { /// - /// This class is an event arguments of the StateChanged event. + /// This class represents event arguments of the StateChanged event. /// + /// 3 public class StateChangedEventArgs : EventArgs { internal StateChangedEventArgs() { } @@ -29,6 +30,8 @@ namespace Tizen.Network.IoTConnectivity /// /// Indicates the new state of the resource /// + /// 3 + /// The new state of the resource. public ResourceState State { get; internal set; } } } -- 2.7.4