/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// 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.
+ /// <para>Value to be set must be in range from 1 to 3600. Default timeout interval value is 30.</para>
+ /// <para>Sets/gets the timeout of StartFindingResource(), StartFindingDeviceInformation(), StartFindingPlatformInformation(),
+ /// RemoteResource.GetAsync(), RemoteResource.PutAsync(), RemoteResource.PostAsync() and RemoteResource.DeleteAsync() APIs.</para>
+ /// <para>Setter can throw exception.</para>
/// </value>
/// <pre>
/// Initialize() should be called to initialize.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// @a filePath point to a file for handling secure virtual resources.
+ /// <paramref name="filePath"/> points to a file for handling secure virtual resources.
/// The file that is CBOR(Concise Binary Object Representation)-format must already exist
- /// in @a filePath. We recommend to use application-local file for @a filePath.
+ /// in <paramref name="filePath" />. We recommend to use application-local file for <paramref name="filePath" />.
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/network.get \n
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/network.get</privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
- /// <param name="filePath">The file path to point to storage for handling secure virtual resources.</param>
+ /// <param name="filePath">The file path pointing to storage for handling secure virtual resources.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// <post>
/// You must call Deinitialize() if IoTCon API is no longer needed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Sends request to receive presence to an interested server's resource with resourceType.
+ /// <para>Sends request to receive presence to an interested server's resource with resourceType.
/// If succeeded, <see cref="PresenceReceived"/> event handler will be triggered when the server sends presence.
- /// A server sends presence events when adds / removes / alters a resource or start / stop presence.\n
- /// @a hostAddress could be <see cref="MulticastAddress"/> for IPv4 multicast.
- /// The length of @ resourceType should be less than or equal to 61. The @ resourceType must start with a lowercase alphabetic character, followed by a sequence
- /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.
+ /// A server sends presence events when adds / removes / alters a resource or start / stop presence.</para>
+ /// <para><paramref name="hostAddress" /> could be <see cref="MulticastAddress"/> for IPv4 multicast.
+ /// The length of <paramref name="resourceType" /> should be less than or equal to 61.
+ /// The <paramref name="resourceType" /> must start with a lowercase alphabetic character, followed by a sequence
+ /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.</para>
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="hostAddress">The address or addressable name of the server.</param>
/// <param name="resourceType">A resource type that a client is interested in.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// <pre>Initialize() should be called to initialize.</pre>
/// <post>
- /// When the resource receive presence, <see cref="PresenceReceived"/> event handler will be invoked.\n
+ /// When the resource receive presence, <see cref="PresenceReceived"/> event handler will be invoked.<br/>
/// You must destroy presence by calling StopReceivingPresence() if presence event is no longer needed.
/// </post>
/// <seealso cref="IoTConnectivityServerManager.StartSendingPresence(uint)"/>
/// <remarks>
/// Sends request to not to receive server's presence any more.
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="presenceId">The start presence request identifier.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Sends request to find a resource of @a hostAddress server with @a resourceType.
- /// If succeeded, <see cref="ResourceFound"/> event handler will be triggered with information of the resource.\n
- /// @a hostAddress could be <see cref="MulticastAddress"/> for the IPv4 multicast.
- /// The length of @a resourceType should be less than or equal to 61. The @ resourceType must start with a lowercase alphabetic character, followed by a sequence
- /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.
+ /// <para>Sends request to find a resource of <paramref name="hostAddress" /> server with <paramref name="resourceType" />.
+ /// If succeeded, <see cref="ResourceFound"/> event handler will be triggered with information of the resource.</para>
+ /// <para><paramref name="hostAddress" /> could be <see cref="MulticastAddress"/> for the IPv4 multicast.
+ /// The length of <paramref name="resourceType" /> should be less than or equal to 61. The <paramref name="resourceType" /> must start
+ /// with a lowercase alphabetic character, followed by a sequence
+ /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.</para>
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="hostAddress">The address or addressable name of the server. The address includes a protocol like coaps://.</param>
/// <param name="query">The query specified as a filter for founding resources.</param>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Requests server for device information.
- /// If succeeded, <see cref="DeviceInformationFound"/> event handler will be triggered with information of the device.\n
- /// @a hostAddress could be <see cref="MulticastAddress"/> for the IPv4 multicast.
+ /// <para>Requests server for device information.
+ /// If succeeded, <see cref="DeviceInformationFound"/> event handler will be triggered with information of the device.</para>
+ /// <para><paramref name="hostAddress" /> could be <see cref="MulticastAddress"/> for the IPv4 multicast.</para>
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="hostAddress">The host address of the remote server.</param>
/// <param name="query">The query specified as a filter for founding resources.</param>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Requests server for platform information.
- /// If succeeded, <see cref="PlatformInformationFound" /> event handler will be triggered with information of the platform.\n
- /// @a hostAddress could be <see cref="MulticastAddress"/> for IPv4 multicast.
+ /// <para>Requests server for platform information.
+ /// If succeeded, <see cref="PlatformInformationFound" /> event handler will be triggered with information of the platform.</para>
+ /// <para><paramref name="hostAddress" /> could be <see cref="MulticastAddress"/> for IPv4 multicast.</para>
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="hostAddress">The host address of remote server.</param>
/// <param name="query">The query specified as a filter for founding resources.</param>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// @a filePath point to a file for handling secure virtual resources.
+ /// <paramref name="filePath" /> points to a file for handling secure virtual resources.
/// The file that is CBOR(Concise Binary Object Representation)-format must already exist
- /// in @a filePath. We recommend to use application-local file for @a filePath.
+ /// in <paramref name="filePath" />. We recommend to use application-local file for <paramref name="filePath" />.
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/network.get \n
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/network.get</privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
- /// <param name="filePath">The file path to point to storage for handling secure virtual resources.</param>
+ /// <param name="filePath">The file path pointing to storage for handling secure virtual resources.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// <post>
/// You must call Deinitialize() if IoTCon API is no longer needed.
/// Registers a resource in IoTCon server.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="resource">The resource to register.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// Unregisters a resource in IoTCon server.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="resource">The resource to unregister.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// 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
- /// If @a time is 0, server will set default value as 60 seconds.\n
- /// If @a time is very big, server will set maximum value as (60 * 60 * 24) seconds, (24 hours).
+ /// <para>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.</para>
+ /// <para>If <paramref name="time" /> is 0, server will set default value as 60 seconds.</para>
+ /// <para>If <paramref name="time" /> is very big, server will set maximum value as (60 * 60 * 24) seconds, (24 hours).</para>
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="time">The interval of announcing presence in seconds.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// 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.
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// <pre>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// 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 <see cref="IoTConnectivityClientManager.StartFindingDeviceInformation(string, ResourceQuery)"/>.
+ /// <para>This API sets the name of the local device (the device calling the API).</para>
+ /// <para>If the device name is set, clients can get the name using <see cref="IoTConnectivityClientManager.StartFindingDeviceInformation(string, ResourceQuery)"/>.</para>
/// </remarks>
/// <param name="deviceName">The device name.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Creates a lite resource, which can then be registered in server using <see cref="IoTConnectivityServerManager.RegisterResource(Resource)"/>.\n
- /// When client requests some operations, it sends a response to client automatically.\n
- /// @a uri length must be less than 128.
+ /// <para>Creates a lite resource, which can then be registered in server using <see cref="IoTConnectivityServerManager.RegisterResource(Resource)"/>.</para>
+ /// <para>When client requests some operations, it sends a response to client automatically.</para>
+ /// <para><paramref name="uri" /> length must be less than 128.</para>
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="uri">The uri path of the lite resource.</param>
/// <param name="types">The type of the resource.</param>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// To use this API, you should provide all the details required to correctly contact and
- /// observe the object.\n
- /// If not, you should discover the resource object manually.\n
- /// The @a policy can contain multiple policies like ResourcePolicy.Discoverable | ResourcePolicy.Observable.
+ /// <para>To use this API, you should provide all the details required to correctly contact and
+ /// observe the object.</para>
+ /// <para>If not, you should discover the resource object manually.</para>
+ /// <para>The <paramref name="policy" /> can contain multiple policies like <c>ResourcePolicy.Discoverable | ResourcePolicy.Observable</c>.</para>
/// </remarks>
/// <param name="hostAddress">The host address of the resource.</param>
/// <param name="uriPath">The URI path of the resource.</param>
/// <remarks>
/// When server sends notification message, <see cref="ObserverNotified"/> will be called.
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="policy">The type to specify how client wants to observe.</param>
/// <param name="query">The query to send to server.</param>
/// Stops observing on the resource.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// <exception cref="NotSupportedException">Thrown when the iotcon is not supported.</exception>
/// Gets the attributes of a resource asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="query">The ResourceQuery to send to server.</param>
/// <returns>Remote response with result and representation.</returns>
/// Puts the representation of a resource asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="representation">Resource representation to put.</param>
/// <param name="query">The ResourceQuery to send to server.</param>
/// Posts request on a resource asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="representation">Resource representation of request.</param>
/// <param name="query">The ResourceQuery to send to server.</param>
/// Deletes the resource asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <returns>Remote response with result and representation.</returns>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// @a uri format would be relative URI path like '/a/light'
+ /// <paramref name="uri" /> format would be relative URI path like '/a/light'
/// and its length must be less than 128.
/// </remarks>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="uri">The URI path of the resource.</param>
/// <param name="types">Resource types.</param>
/// Notify the specified representation and qos.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <privilege>
- /// http://tizen.org/privilege/internet
- /// </privilege>
+ /// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privlevel>public</privlevel>
/// <param name="representation">Representation.</param>
/// <param name="qos">The quality of service for message transfer.</param>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// @a item could be a value, such as <see cref="DefaultInterface"/>.
+ /// <paramref name="item" /> could be a value, such as <see cref="DefaultInterface"/>.
/// </remarks>
/// <param name="item">The string data to insert into the resource interfaces.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
namespace Tizen.Network.IoTConnectivity
{
/// <summary>
- /// This class represents resource options. It provides APIs to manage them.\n
- /// 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.
+ /// <para>This class represents resource options. It provides APIs to manage them.</para>
+ /// <para>The iotcon options API provides methods for managing vendor specific options of coap packet.</para>
+ /// <para>See more about coap packet in http://tools.ietf.org/html/rfc7252.</para>
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ResourceOptions : IDictionary<ushort, string>, IDisposable
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// ResourceOptions can have up to 2 options. \n
- /// key is always situated between 2048 and 3000. \n
- /// Length of option data is less than or equal to 15.
+ /// <para>ResourceOptions can have up to 2 options.</para>
+ /// <para>key is always situated between 2048 and 3000.</para>
+ /// <para>Length of option data is less than or equal to 15.</para>
/// </remarks>
/// <param name="key">The ID of the option to insert.</param>
/// <param name="value">The string data to insert into the options.</param>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// 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
- /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.\n
- /// Duplicate strings are not allowed.
+ /// <para>The length of <paramref name="item" /> should be less than or equal to 61.</para>
+ /// <para>The <paramref name="item" /> must start with a lowercase alphabetic character, followed by a sequence
+ /// of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.</para>
+ /// <para>Duplicate strings are not allowed.</para>
/// </remarks>
/// <param name="item">The string data to insert into the resource types.</param>
/// <feature>http://tizen.org/feature/iot.ocf</feature>
projects / platform / core / csapi / tizenfx.git / commitdiff