4 <name>Tizen.Network.IoTConnectivity</name>
7 <member name="T:Tizen.Network.IoTConnectivity.Attributes">
9 This class represents current attributes of a resource.
10 It provides API to manage attributes.
11 This class is accessed by using a constructor to create a new instance of this object.
13 <since_tizen> 3 </since_tizen>
15 <member name="M:Tizen.Network.IoTConnectivity.Attributes.#ctor">
17 The Attributes constructor.
19 <since_tizen> 3 </since_tizen>
20 <feature>http://tizen.org/feature/iot.ocf</feature>
21 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
22 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
24 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
27 <member name="M:Tizen.Network.IoTConnectivity.Attributes.Finalize">
29 Destructor of the Attributes class.
32 <member name="P:Tizen.Network.IoTConnectivity.Attributes.Count">
34 Gets the number of keys.
36 <since_tizen> 3 </since_tizen>
37 <value>The number of keys.</value>
39 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
40 attributes.Add("brightness", 50);
41 var count = attributes.Count;
42 Console.WriteLine("There are {0} keys in the attribute object", count);
45 <member name="P:Tizen.Network.IoTConnectivity.Attributes.IsReadOnly">
47 Represents whether an attribute is readonly.
49 <since_tizen> 3 </since_tizen>
50 <value>Whether an attribute is readonly.</value>
52 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
56 if (attributes.IsReadOnly)
57 Console.WriteLine("Read only attribute");
60 <member name="P:Tizen.Network.IoTConnectivity.Attributes.Keys">
62 Contains all the attribute keys.
64 <since_tizen> 3 </since_tizen>
65 <value>All the attribute keys.</value>
67 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
71 var keys = attributes.Keys;
72 Console.WriteLine("Attribute contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1));
75 <member name="P:Tizen.Network.IoTConnectivity.Attributes.Values">
77 Contains all the attribute values.
79 <since_tizen> 3 </since_tizen>
80 <value>All the attribute values.</value>
82 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
86 var values = attributes.Values;
87 Console.WriteLine("Attribute contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1));
90 <member name="P:Tizen.Network.IoTConnectivity.Attributes.Item(System.String)">
92 Gets or sets the attribute with the specified key.
94 <since_tizen> 3 </since_tizen>
95 <value>The attribute with the specified key.</value>
96 <param name="key">The key of the attribute to get or set.</param>
97 <returns>The element with the specified key.</returns>
99 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
100 attributes["state"] = "ON";
101 Console.WriteLine("Attribute value for key 'state' : {0}", attributes["state"]);
104 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.Attributes.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})" -->
105 <member name="M:Tizen.Network.IoTConnectivity.Attributes.Add(System.String,System.Object)">
109 <since_tizen> 3 </since_tizen>
110 <param name="key">The key representing the attribute.</param>
111 <param name="value">The value representing the attribute.</param>
112 <feature>http://tizen.org/feature/iot.ocf</feature>
114 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
115 attributes.Add("brightness", 50);
118 <member name="M:Tizen.Network.IoTConnectivity.Attributes.Clear">
120 Clears attributes collection.
122 <since_tizen> 3 </since_tizen>
123 <feature>http://tizen.org/feature/iot.ocf</feature>
124 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported</exception>
125 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid</exception>
127 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes();
128 attributes.Add("brightness", 50);
132 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.Attributes.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})" -->
133 <member name="M:Tizen.Network.IoTConnectivity.Attributes.ContainsKey(System.String)">
135 Checks whether the given key exists in attributes collection.
137 <since_tizen> 3 </since_tizen>
138 <param name="key">The status key to look for.</param>
139 <returns>true if exists. Otherwise, false.</returns>
141 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
145 if (attributes.ContainsKey("dim"))
146 Console.WriteLine("Attribute conatins key : dim");
149 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.Attributes.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)" -->
150 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.Attributes.GetEnumerator" -->
151 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.Attributes.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})" -->
152 <member name="M:Tizen.Network.IoTConnectivity.Attributes.Remove(System.String)">
154 Removes an attribute from collection using a key.
156 <since_tizen> 3 </since_tizen>
157 <param name="key">The attributes element to remove.</param>
158 <returns>true if operation is successful, otherwise, false.</returns>
159 <feature>http://tizen.org/feature/iot.ocf</feature>
160 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported</exception>
161 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter</exception>
162 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid</exception>
164 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
168 if (attributes.Remove("state"))
169 Console.WriteLine("Remove was successful");
172 <member name="M:Tizen.Network.IoTConnectivity.Attributes.TryGetValue(System.String,System.Object@)">
174 Gets the value associated with the specified key.
176 <since_tizen> 3 </since_tizen>
177 <param name="key">The key whose value to get.</param>
178 <param name="value"> The value associated with the specified key.</param>
179 <returns> true if the attributes collection contains an element with the specified key, otherwise, false.</returns>
181 Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() {
185 var isPresent = attributes.TryGetValue("state", out value);
187 Console.WriteLine("value : {0}", value);
190 <member name="M:Tizen.Network.IoTConnectivity.Attributes.System#Collections#IEnumerable#GetEnumerator">
192 Returns an enumerator that iterates through the collection.
194 <since_tizen> 3 </since_tizen>
196 <member name="M:Tizen.Network.IoTConnectivity.Attributes.Dispose">
198 Releases any unmanaged resources used by this object.
200 <since_tizen> 3 </since_tizen>
201 <feature>http://tizen.org/feature/iot.ocf</feature>
203 <member name="M:Tizen.Network.IoTConnectivity.Attributes.Dispose(System.Boolean)">
205 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
207 <since_tizen> 3 </since_tizen>
208 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
209 <feature>http://tizen.org/feature/iot.ocf</feature>
211 <member name="T:Tizen.Network.IoTConnectivity.CacheUpdatedEventArgs">
213 This class represents event arguments of the CacheUpdated event.
215 <since_tizen> 3 </since_tizen>
217 <member name="P:Tizen.Network.IoTConnectivity.CacheUpdatedEventArgs.Representation">
219 Indicates the updated representation of the resource.
221 <since_tizen> 3 </since_tizen>
222 <value>The updated representation of the resource.</value>
224 <member name="T:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs">
226 This class represents event arguments of the DeviceInformationFound event.
228 <since_tizen> 3 </since_tizen>
230 <member name="P:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs.RequestId">
234 <since_tizen> 3 </since_tizen>
235 <value>The request ID.</value>
237 <member name="P:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs.EventContinue">
239 Indicates to continuously receive the event for finding device information.
241 <since_tizen> 3 </since_tizen>
242 <value>Continuously receive the event for finding device information.</value>
244 <member name="P:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs.Name">
246 Indicates the human friendly name for device.
248 <since_tizen> 3 </since_tizen>
249 <value>Human friendly name for device.</value>
251 <member name="P:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs.SpecVersion">
253 Indicates the spec version of the core specification.
255 <since_tizen> 3 </since_tizen>
256 <value>Spec version of the core specification.</value>
258 <member name="P:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs.DeviceId">
260 Indicates an unique identifier for the OIC device.
262 <since_tizen> 3 </since_tizen>
263 <value>Unique identifier for OIC device.</value>
265 <member name="P:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs.DataModelVersion">
267 Indicates version of the specs this device data model is implemented to.
269 <since_tizen> 3 </since_tizen>
270 <value>Version of the specs this device data model is implemented to.</value>
272 <member name="T:Tizen.Network.IoTConnectivity.FindingError">
274 Enumeration for resource found errors.
277 <member name="F:Tizen.Network.IoTConnectivity.FindingError.Io">
282 <member name="F:Tizen.Network.IoTConnectivity.FindingError.OutOfMemory">
287 <member name="F:Tizen.Network.IoTConnectivity.FindingError.PermissionDenied">
292 <member name="F:Tizen.Network.IoTConnectivity.FindingError.NotSupported">
297 <member name="F:Tizen.Network.IoTConnectivity.FindingError.InvalidParameter">
302 <member name="F:Tizen.Network.IoTConnectivity.FindingError.NoData">
307 <member name="F:Tizen.Network.IoTConnectivity.FindingError.TimeOut">
312 <member name="F:Tizen.Network.IoTConnectivity.FindingError.Iotivity">
317 <member name="F:Tizen.Network.IoTConnectivity.FindingError.Representation">
319 Representation errors.
322 <member name="F:Tizen.Network.IoTConnectivity.FindingError.InvalidType">
327 <member name="F:Tizen.Network.IoTConnectivity.FindingError.Already">
332 <member name="F:Tizen.Network.IoTConnectivity.FindingError.System">
337 <member name="T:Tizen.Network.IoTConnectivity.FindingErrorOccurredEventArgs">
339 This class represents event arguments of the FindingErrorOccurred event.
341 <since_tizen> 3 </since_tizen>
343 <member name="P:Tizen.Network.IoTConnectivity.FindingErrorOccurredEventArgs.RequestId">
345 The request ID of the operation, which caused this error.
347 <since_tizen> 3 </since_tizen>
348 <value>The request ID of the operation, which caused this error.</value>
350 <member name="P:Tizen.Network.IoTConnectivity.FindingErrorOccurredEventArgs.Error">
352 Contains error details.
354 <since_tizen> 3 </since_tizen>
355 <value>Error details.</value>
357 <member name="T:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager">
359 IoT connectivity client manager consists of client side APIs.
361 <since_tizen> 3 </since_tizen>
363 <member name="F:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.MulticastAddress">
365 The IP Address for multicast.
367 <since_tizen> 3 </since_tizen>
369 <member name="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.PresenceReceived">
371 PresenceReceived event. This event occurs when server starts sending presence of a resource.
373 <since_tizen> 3 </since_tizen>
375 <member name="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.ResourceFound">
377 ResourceFound event. This event occurs when a resource is found from the remote server
378 after sending request using API StartFindingResource().
380 <since_tizen> 3 </since_tizen>
382 <member name="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.PlatformInformationFound">
384 PlatformInformationFound event. This event occurs when platform information is found
385 after sending request using API StartFindingPlatformInformation().
387 <since_tizen> 3 </since_tizen>
389 <member name="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.DeviceInformationFound">
391 DeviceInformationFound event. This event occurs when device information is found
392 after sending request using API StartFindingDeviceInformation().
394 <since_tizen> 3 </since_tizen>
396 <member name="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.FindingErrorOccurred">
398 FindingError event. This event occurs when an error is found.
400 <since_tizen> 3 </since_tizen>
402 <member name="P:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.TimeOut">
406 <since_tizen> 3 </since_tizen>
408 Value to be set must be in range from 1 to 3600. Default timeout interval value is 30.\n
409 Sets/gets the timeout of StartFindingResource(), StartFindingDeviceInformation(), StartFindingPlatformInformation(),
410 RemoteResource.GetAsync(), RemoteResource.PutAsync(), RemoteResource.PostAsync() and RemoteResource.DeleteAsync() APIs.\n
411 Setter can throw exception.
414 Initialize() should be called to initialize.
417 IoTConnectivityClientManager.Initialize();
418 IoTConnectivityClientManager.TimeOut = 120;
421 <member name="P:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.PollingInterval">
423 Polling interval of IoTConnectivity.
425 <since_tizen> 3 </since_tizen>
427 Sets/Gets the polling inerval(milliseconds) of IoTCon. Default value is 100 milliseconds.
428 Value to be set must be in range from 1 to 999. The closer to 0, the faster it operates.
429 Setter is invoked immediately for changing the interval.
430 If you want the faster operation, we recommend you set 10 milliseconds for polling interval.
431 Setter can throw exception.
434 Initialize() should be called to initialize.
437 IoTConnectivityClientManager.Initialize();
438 IoTConnectivityClientManager.PollingInterval = 100;
441 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.Initialize(System.String)">
444 Call this function to start IoTCon.
446 <since_tizen> 3 </since_tizen>
448 @a filePath point to a file for handling secure virtual resources.
449 The file that is CBOR(Concise Binary Object Representation)-format must already exist
450 in @a filePath. We recommend to use application-local file for @a filePath.
453 http://tizen.org/privilege/network.get \n
454 http://tizen.org/privilege/internet
456 <privlevel>public</privlevel>
457 <param name="filePath">The file path to point to storage for handling secure virtual resources.</param>
458 <feature>http://tizen.org/feature/iot.ocf</feature>
460 You must call Deinitialize() if IoTCon API is no longer needed.
462 <seealso cref="M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.Deinitialize"/>
463 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
464 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
465 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception>
467 string filePath = "../../res/iotcon-test-svr-db-client.dat";
468 IoTConnectivityClientManager.Initialize(filePath);
471 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.Deinitialize">
473 Deinitializes IoTCon.
475 <since_tizen> 3 </since_tizen>
477 This API must be called if IoTCon API is no longer needed.
479 <feature>http://tizen.org/feature/iot.ocf</feature>
481 Initialize() should be called to initialize.
483 <seealso cref="!:Initialize()"/>
484 <seealso cref="!:SecureInitialize()"/>
486 IoTConnectivityClientManager.Deinitialize();
489 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.InvokePolling">
491 Invokes a next message from a queue for receiving messages from others, immediately.
493 <since_tizen> 3 </since_tizen>
495 This API invokes a next message from a queue for receiving messages from others, immediately.
496 After calling the API, it continues the polling with existing interval.
498 <feature>http://tizen.org/feature/iot.ocf</feature>
500 Initialize() should be called to initialize.
502 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
504 IoTConnectivityClientManager.InvokePolling();
507 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.StartReceivingPresence(System.String,System.String)" -->
508 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.StopReceivingPresence(System.Int32)" -->
509 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.StartFindingResource(System.String,Tizen.Network.IoTConnectivity.ResourceQuery)" -->
510 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.StartFindingDeviceInformation(System.String,Tizen.Network.IoTConnectivity.ResourceQuery)" -->
511 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.StartFindingPlatformInformation(System.String,Tizen.Network.IoTConnectivity.ResourceQuery)" -->
512 <member name="T:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager">
514 IoT connectivity server manager consists of server side APIs.
516 <since_tizen> 3 </since_tizen>
518 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.Initialize(System.String)">
520 Initializes IoTCon. Calls this API to start IoTCon.
522 <since_tizen> 3 </since_tizen>
524 @a filePath point to a file for handling secure virtual resources.
525 The file that is CBOR(Concise Binary Object Representation)-format must already exist
526 in @a filePath. We recommend to use application-local file for @a filePath.
529 http://tizen.org/privilege/network.get \n
530 http://tizen.org/privilege/internet
532 <privlevel>public</privlevel>
533 <param name="filePath">The file path to point to storage for handling secure virtual resources.</param>
534 <feature>http://tizen.org/feature/iot.ocf</feature>
536 You must call Deinitialize() if IoTCon API is no longer needed.
538 <seealso cref="M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.Deinitialize"/>
539 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
540 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
541 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access</exception>
543 string filePath = "../../res/iotcon-test-svr-db-server.dat";
544 IoTConnectivityServerManager.Initialize(filePath);
547 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.Deinitialize">
549 Deinitializes IoTCon.
551 <since_tizen> 3 </since_tizen>
553 This API must be called if IoTCon API is no longer needed.
555 <feature>http://tizen.org/feature/iot.ocf</feature>
557 Initialize() should be called to initialize.
559 <seealso cref="!:Initialize()"/>
561 IoTConnectivityServerManager.Deinitialize();
564 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.RegisterResource(Tizen.Network.IoTConnectivity.Resource)" -->
565 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.UnregisterResource(Tizen.Network.IoTConnectivity.Resource)" -->
566 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.StartSendingPresence(System.UInt32)">
568 Starts presence of a server.
570 <since_tizen> 3 </since_tizen>
572 Use this API to send server's announcements to clients.
573 Server can call this API when online for the first time or come back from offline to online.\n
574 If @a time is 0, server will set default value as 60 seconds.\n
575 If @a time is very big, server will set maximum value as (60 * 60 * 24) seconds, (24 hours).
578 http://tizen.org/privilege/internet
580 <privlevel>public</privlevel>
581 <param name="time">The interval of announcing presence in seconds.</param>
582 <feature>http://tizen.org/feature/iot.ocf</feature>
584 Initialize() should be called to initialize.
586 <seealso cref="!:IoTConnectivityClientManager.StartReceivingPresence()"/>
587 <seealso cref="!:IoTConnectivityClientManager.StopReceivingPresence()"/>
588 <seealso cref="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.PresenceReceived"/>
589 <seealso cref="M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.StopSendingPresence"/>
590 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
591 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
592 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception>
595 IoTConnectivityServerManager.StartSendingPresence(120);
596 } catch(Exception ex) {
597 Console.Log("Exception caught : " + ex.Message);
601 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.StopSendingPresence">
603 Stops presence of a server.
605 <since_tizen> 3 </since_tizen>
607 Use this API to stop sending server's announcements to clients.
608 Server can call this API when terminating, entering to offline or out of network.
611 http://tizen.org/privilege/internet
613 <privlevel>public</privlevel>
614 <feature>http://tizen.org/feature/iot.ocf</feature>
616 Initialize() should be called to initialize.
618 <seealso cref="!:IoTConnectivityClientManager.StartReceivingPresence()"/>
619 <seealso cref="!:IoTConnectivityClientManager.StopReceivingPresence()"/>
620 <seealso cref="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.PresenceReceived"/>
621 <seealso cref="!:StartSendingPresence()"/>
622 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
623 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
624 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception>
626 IoTConnectivityServerManager.StopSendingPresence();
629 <member name="M:Tizen.Network.IoTConnectivity.IoTConnectivityServerManager.SetDeviceName(System.String)">
631 Sets the device name.
633 <since_tizen> 3 </since_tizen>
635 This API sets the name of the local device (the device calling the API).\n
636 If the device name is set, clients can get the name using <see cref="!:IoTConnectivityClientManager.StartFindingDeviceInformation()"/>.
638 <param name="deviceName">The device name.</param>
639 <feature>http://tizen.org/feature/iot.ocf</feature>
640 <seealso cref="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.DeviceInformationFound"/>
641 <seealso cref="!:IoTConnectivityClientManager.StartFindingDeviceInformation()"/>
642 <seealso cref="T:Tizen.Network.IoTConnectivity.DeviceInformationFoundEventArgs"/>
643 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
644 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
645 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception>
647 IoTConnectivityServerManager.SetDeviceName("my-tizen");
650 <member name="T:Tizen.Network.IoTConnectivity.LiteResource">
652 This class represents a lite resource.
653 It provides APIs to encapsulate resources.
654 This class is accessed by using a constructor to create a new instance of this object.
656 <since_tizen> 3 </since_tizen>
658 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.LiteResource.#ctor(System.String,Tizen.Network.IoTConnectivity.ResourceTypes,Tizen.Network.IoTConnectivity.ResourcePolicy,Tizen.Network.IoTConnectivity.Attributes)" -->
659 <!-- Badly formed XML comment ignored for member "P:Tizen.Network.IoTConnectivity.LiteResource.Attributes" -->
660 <member name="M:Tizen.Network.IoTConnectivity.LiteResource.OnPost(Tizen.Network.IoTConnectivity.Attributes)">
662 Decides whether to accept or reject a post request.
664 <since_tizen> 3 </since_tizen>
666 Child classes of this class can override this method to accept or reject post request.
668 <param name="attribs">The new attributes of the lite resource.</param>
669 <returns>true to accept post request, false to reject it.</returns>
671 public class MyLightResource : LiteResource
673 protected override bool OnPost(Attributes attributes)
675 object newAttributes;
676 attributes.TryGetValue("LIGHT_ATTRIBUTE", out newAttributes);
677 if((int)newAttributes == 1)
684 <member name="M:Tizen.Network.IoTConnectivity.LiteResource.OnGet(Tizen.Network.IoTConnectivity.Request)">
687 <member name="T:Tizen.Network.IoTConnectivity.ObservePolicy">
689 Enumeration for the policy of observation.
691 <since_tizen> 3 </since_tizen>
693 <member name="F:Tizen.Network.IoTConnectivity.ObservePolicy.IgnoreOutOfOrder">
695 Indicates the observation request for the most up-to-date notifications only.
697 <since_tizen> 3 </since_tizen>
699 <member name="F:Tizen.Network.IoTConnectivity.ObservePolicy.AcceptOutOfOrder">
701 Indicates the observation request for all notifications including state notifications.
703 <since_tizen> 3 </since_tizen>
705 <member name="T:Tizen.Network.IoTConnectivity.ObserverNotifiedEventArgs">
707 This class represents event arguments of the ObserverNotified event.
709 <since_tizen> 3 </since_tizen>
711 <member name="P:Tizen.Network.IoTConnectivity.ObserverNotifiedEventArgs.Result">
713 Result of the observe response.
715 <since_tizen> 3 </since_tizen>
716 <value>Result of the observe response.</value>
718 <member name="P:Tizen.Network.IoTConnectivity.ObserverNotifiedEventArgs.Representation">
720 Representation of the resource being observed.
722 <since_tizen> 3 </since_tizen>
723 <value>Representation of the resource being observed.</value>
725 <member name="T:Tizen.Network.IoTConnectivity.ObserveType">
727 Enumeration for the type of observation.
729 <since_tizen> 3 </since_tizen>
731 <member name="F:Tizen.Network.IoTConnectivity.ObserveType.NoType">
735 <since_tizen> 3 </since_tizen>
737 <member name="F:Tizen.Network.IoTConnectivity.ObserveType.Register">
739 Indicates an action of the registering observation.
741 <since_tizen> 3 </since_tizen>
743 <member name="F:Tizen.Network.IoTConnectivity.ObserveType.Deregister">
745 Indicates an action of unregistering observation.
747 <since_tizen> 3 </since_tizen>
749 <member name="T:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs">
751 This class represents event arguments of the PlatformInformationFound event.
753 <since_tizen> 3 </since_tizen>
755 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.RequestId">
757 Indicates the request ID.
759 <since_tizen> 3 </since_tizen>
760 <value>The request ID.</value>
762 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.EventContinue">
764 Indicates to continuously receive the event for finding the platform information.
766 <since_tizen> 3 </since_tizen>
767 <value>Continuously receive the event for finding the platform information.</value>
769 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.PlatformId">
771 Indicates the platform identifier.
773 <since_tizen> 3 </since_tizen>
774 <value>The platform identifier.</value>
776 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.ManufacturerName">
778 Indicates the name of the manufacturer.
780 <since_tizen> 3 </since_tizen>
781 <value>The name of the manufacturer.</value>
783 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.ManufacturerURL">
785 Indicates the URL of the manufacturer.
787 <since_tizen> 3 </since_tizen>
788 <value>The URL of the manufacturer.</value>
790 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.ModelNumber">
792 Indicates the model number as designated by the manufacturer.
794 <since_tizen> 3 </since_tizen>
795 <value>The model number as designated by the manufacturer.</value>
797 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.DateOfManufacture">
799 Indicates the manufacturing date of the device.
801 <since_tizen> 3 </since_tizen>
802 <value>The manufacturing date of the device.</value>
804 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.PlatformVersion">
806 Indicates the version of the platfrom defined by the manufacturer.
808 <since_tizen> 3 </since_tizen>
809 <value>The version of platfrom defined by manufacturer.</value>
811 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.OsVersion">
813 Indicates the version of the platfrom resident OS.
815 <since_tizen> 3 </since_tizen>
816 <value>The version of the platfrom resident OS.</value>
818 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.HardwareVersion">
820 Indicates the version of the platform Hardware.
822 <since_tizen> 3 </since_tizen>
823 <value>The version of the platform Hardware.</value>
825 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.FirmwareVersion">
827 Indicates the version of the device firmware.
829 <since_tizen> 3 </since_tizen>
830 <value>The version of the device firmware.</value>
832 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.SupportUrl">
834 Indicates the URL that points to support information from the manufacturer.
836 <since_tizen> 3 </since_tizen>
837 <value>The URL that points to support information from the manufacturer.</value>
839 <member name="P:Tizen.Network.IoTConnectivity.PlatformInformationFoundEventArgs.SystemTime">
841 Indicates the reference time of the device.
843 <since_tizen> 3 </since_tizen>
844 <value>The reference time of the device.</value>
846 <member name="T:Tizen.Network.IoTConnectivity.PresenceEventType">
848 Enumeration for operation of presence response.
850 <since_tizen> 3 </since_tizen>
852 <member name="F:Tizen.Network.IoTConnectivity.PresenceEventType.ResourceCreated">
854 Indicates the resource creation operation of the server.
856 <since_tizen> 3 </since_tizen>
858 <member name="F:Tizen.Network.IoTConnectivity.PresenceEventType.ResourceUpdated">
860 Indicates the resource updation operation of the server.
862 <since_tizen> 3 </since_tizen>
864 <member name="F:Tizen.Network.IoTConnectivity.PresenceEventType.ResourceDestroyed">
866 Indicates the resource destruction operation of the server.
868 <since_tizen> 3 </since_tizen>
870 <member name="T:Tizen.Network.IoTConnectivity.PresenceReceivedEventArgs">
872 This class represents event arguments of the PresenceReceived event.
874 <since_tizen> 3 </since_tizen>
876 <member name="P:Tizen.Network.IoTConnectivity.PresenceReceivedEventArgs.PresenceId">
878 Indicates the request ID of the presence event.
880 <since_tizen> 3 </since_tizen>
881 <value>The request ID of the presence event.</value>
883 <member name="P:Tizen.Network.IoTConnectivity.PresenceReceivedEventArgs.EventType">
885 Indicates the event type.
887 <since_tizen> 3 </since_tizen>
888 <value>The event type.</value>
890 <member name="P:Tizen.Network.IoTConnectivity.PresenceReceivedEventArgs.HostAddress">
892 Indicates the host address of resource.
894 <since_tizen> 3 </since_tizen>
895 <value>The host address of resource.</value>
897 <member name="P:Tizen.Network.IoTConnectivity.PresenceReceivedEventArgs.Type">
899 Indicates the type of the resource.
901 <since_tizen> 3 </since_tizen>
902 <value>The type of the resource.</value>
904 <member name="T:Tizen.Network.IoTConnectivity.QualityOfService">
906 Enumeration for states of remote resource.
908 <since_tizen> 3 </since_tizen>
910 <member name="F:Tizen.Network.IoTConnectivity.QualityOfService.Low">
912 Indicates the low quality of service.
914 <since_tizen> 3 </since_tizen>
916 <member name="F:Tizen.Network.IoTConnectivity.QualityOfService.High">
918 Indicates the high quality of service.
920 <since_tizen> 3 </since_tizen>
922 <member name="T:Tizen.Network.IoTConnectivity.RemoteResource">
924 This class represents a remote resource.
925 It provides APIs to manage remote resource.
927 <since_tizen> 3 </since_tizen>
929 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.#ctor(System.String,System.String,Tizen.Network.IoTConnectivity.ResourcePolicy,Tizen.Network.IoTConnectivity.ResourceTypes,Tizen.Network.IoTConnectivity.ResourceInterfaces)">
931 Creates a remote resource instance.
933 <since_tizen> 3 </since_tizen>
935 To use this API, you should provide all the details required to correctly contact and
936 observe the object.\n
937 If not, you should discover the resource object manually.\n
938 The @a policy can contain multiple policies like ResourcePolicy.Discoverable | ResourcePolicy.Observable.
940 <param name="hostAddress">The host address of the resource.</param>
941 <param name="uriPath">The URI path of the resource.</param>
942 <param name="policy">The policies of the resource.</param>
943 <param name="resourceTypes">The resource types of the resource.</param>
944 <param name="resourceInterfaces">The resource interfaces of the resource.</param>
945 <feature>http://tizen.org/feature/iot.ocf</feature>
946 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
947 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
948 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
950 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.Finalize">
952 Destructor of the RemoteResource class.
955 <member name="E:Tizen.Network.IoTConnectivity.RemoteResource.CacheUpdated">
957 The event is invoked with cached resource attributes.
959 <since_tizen> 3 </since_tizen>
961 <member name="E:Tizen.Network.IoTConnectivity.RemoteResource.ObserverNotified">
963 Observe an event on the resource sent by the server.
965 <since_tizen> 3 </since_tizen>
967 <member name="E:Tizen.Network.IoTConnectivity.RemoteResource.StateChanged">
969 The event is called when remote resource's state are changed.
971 <since_tizen> 3 </since_tizen>
973 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.HostAddress">
975 The host address of the resource.
977 <since_tizen> 3 </since_tizen>
978 <value>The host address of the resource.</value>
980 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.UriPath">
982 The URI path of the resource.
984 <since_tizen> 3 </since_tizen>
985 <value>The URI path of the resource.</value>
987 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.Types">
989 The resource types of the remote resource.
991 <since_tizen> 3 </since_tizen>
992 <value>The resource types of the remote resource.</value>
994 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.Interfaces">
996 The interfaces of the resource.
998 <since_tizen> 3 </since_tizen>
999 <value>The interfaces of the resource.</value>
1001 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.Policy">
1003 The policy of the resource.
1005 <since_tizen> 3 </since_tizen>
1006 <value>The policy of the resource.</value>
1008 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.Options">
1010 The header options of the resource.
1012 <since_tizen> 3 </since_tizen>
1013 <value>The header options of the resource.</value>
1014 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1015 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1017 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.CacheEnabled">
1019 Indicates the CacheEnabled status of the remote resource.
1021 <since_tizen> 3 </since_tizen>
1023 Client can start caching only when this is set true. Set it to false to stop caching the resource attributes.
1025 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1026 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1027 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1028 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception>
1029 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
1031 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.TimeInterval">
1033 Time interval of monitoring and caching API.
1035 <since_tizen> 3 </since_tizen>
1037 Default time interval is 10 seconds.
1038 Seconds for time interval (must be in range from 1 to 3600).
1040 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1041 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1043 <member name="P:Tizen.Network.IoTConnectivity.RemoteResource.DeviceId">
1045 The device ID of the resource.
1047 <since_tizen> 3 </since_tizen>
1048 <value>The device ID of the resource.</value>
1050 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.CachedRepresentation">
1052 Gets cached representation from the remote resource.
1054 <since_tizen> 3 </since_tizen>
1055 <returns>cached representation from the remote resource.</returns>
1056 <feature>http://tizen.org/feature/iot.ocf</feature>
1058 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.StartObserving(Tizen.Network.IoTConnectivity.ObservePolicy,Tizen.Network.IoTConnectivity.ResourceQuery)">
1060 Starts observing on the resource.
1062 <since_tizen> 3 </since_tizen>
1064 When server sends notification message, <see cref="E:Tizen.Network.IoTConnectivity.RemoteResource.ObserverNotified"/> will be called.
1067 http://tizen.org/privilege/internet
1069 <privlevel>public</privlevel>
1070 <param name="policy">The type to specify how client wants to observe.</param>
1071 <param name="query">The query to send to server.</param>
1072 <feature>http://tizen.org/feature/iot.ocf</feature>
1073 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1074 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1075 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception>
1076 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
1078 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.StopObserving">
1080 Stops observing on the resource.
1082 <since_tizen> 3 </since_tizen>
1084 http://tizen.org/privilege/internet
1086 <privlevel>public</privlevel>
1087 <feature>http://tizen.org/feature/iot.ocf</feature>
1088 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1089 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1090 <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have privilege to access.</exception>
1092 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.GetAsync(Tizen.Network.IoTConnectivity.ResourceQuery)">
1094 Gets the attributes of a resource asynchronously.
1096 <since_tizen> 3 </since_tizen>
1098 http://tizen.org/privilege/internet
1100 <privlevel>public</privlevel>
1101 <param name="query">The ResourceQuery to send to server.</param>
1102 <returns>Remote response with result and representation.</returns>
1103 <feature>http://tizen.org/feature/iot.ocf</feature>
1105 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.PutAsync(Tizen.Network.IoTConnectivity.Representation,Tizen.Network.IoTConnectivity.ResourceQuery)">
1107 Puts the representation of a resource asynchronously.
1109 <since_tizen> 3 </since_tizen>
1111 http://tizen.org/privilege/internet
1113 <privlevel>public</privlevel>
1114 <param name="representation">Resource representation to put.</param>
1115 <param name="query">The ResourceQuery to send to server.</param>
1116 <returns>Remote response with result and representation.</returns>
1117 <feature>http://tizen.org/feature/iot.ocf</feature>
1119 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.PostAsync(Tizen.Network.IoTConnectivity.Representation,Tizen.Network.IoTConnectivity.ResourceQuery)">
1121 Posts request on a resource asynchronously.
1123 <since_tizen> 3 </since_tizen>
1125 http://tizen.org/privilege/internet
1127 <privlevel>public</privlevel>
1128 <param name="representation">Resource representation of request.</param>
1129 <param name="query">The ResourceQuery to send to server.</param>
1130 <returns>Remote response with result and representation.</returns>
1131 <feature>http://tizen.org/feature/iot.ocf</feature>
1133 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.DeleteAsync">
1135 Deletes the resource asynchronously.
1137 <since_tizen> 3 </since_tizen>
1139 http://tizen.org/privilege/internet
1141 <privlevel>public</privlevel>
1142 <returns>Remote response with result and representation.</returns>
1143 <feature>http://tizen.org/feature/iot.ocf</feature>
1145 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.Dispose">
1147 Releases any unmanaged resources used by this object.
1149 <since_tizen> 3 </since_tizen>
1150 <feature>http://tizen.org/feature/iot.ocf</feature>
1152 <member name="M:Tizen.Network.IoTConnectivity.RemoteResource.Dispose(System.Boolean)">
1154 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
1156 <since_tizen> 3 </since_tizen>
1157 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
1158 <feature>http://tizen.org/feature/iot.ocf</feature>
1160 <member name="T:Tizen.Network.IoTConnectivity.RemoteResponse">
1162 This class represents a remote response.
1163 It represents the response of all CRUD operations.
1165 <since_tizen> 3 </since_tizen>
1167 <member name="P:Tizen.Network.IoTConnectivity.RemoteResponse.Result">
1169 Indicates the result of the response.
1171 <since_tizen> 3 </since_tizen>
1172 <value>The result of the response.</value>
1174 <member name="P:Tizen.Network.IoTConnectivity.RemoteResponse.Representation">
1176 Indicates representation of the response.
1178 <since_tizen> 3 </since_tizen>
1179 <value>Representation of the response.</value>
1181 <member name="P:Tizen.Network.IoTConnectivity.RemoteResponse.Options">
1183 Indicates header options of the response.
1185 <since_tizen> 3 </since_tizen>
1186 <value>Header options of the response.</value>
1188 <member name="T:Tizen.Network.IoTConnectivity.Representation">
1190 This class provides APIs to manage representation.
1191 A representation is a payload of a request or a response.
1193 <since_tizen> 3 </since_tizen>
1195 <member name="M:Tizen.Network.IoTConnectivity.Representation.#ctor">
1197 The Representation constructor.
1199 <since_tizen> 3 </since_tizen>
1200 <feature>http://tizen.org/feature/iot.ocf</feature>
1201 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1202 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
1203 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1205 Representation repr = new Representation();
1208 <member name="M:Tizen.Network.IoTConnectivity.Representation.Finalize">
1210 Destructor of the Representation class.
1213 <member name="P:Tizen.Network.IoTConnectivity.Representation.UriPath">
1215 The URI path of resource.
1217 <since_tizen> 3 </since_tizen>
1219 The URI path of resource.
1220 Setter can throw exceptions.
1222 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1223 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1224 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1226 Representation repr = new Representation();
1227 repr.UriPath = "/a/light";
1228 Console.WriteLine("URI is {0}", repr.UriPath); //Getter
1231 <!-- Badly formed XML comment ignored for member "P:Tizen.Network.IoTConnectivity.Representation.Type" -->
1232 <!-- Badly formed XML comment ignored for member "P:Tizen.Network.IoTConnectivity.Representation.Interface" -->
1233 <member name="P:Tizen.Network.IoTConnectivity.Representation.Attributes">
1235 Current attributes of the resource.
1237 <since_tizen> 3 </since_tizen>
1238 <value>Current attributes of the resource.</value>
1239 <seealso cref="P:Tizen.Network.IoTConnectivity.Representation.Attributes"/>
1240 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1241 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1242 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1244 Representation repr = new Representation();
1245 Attributes attributes = new Attributes() {
1249 repr.Attributes = attributes;
1250 var newAttributes = repr.Attributes; // Getter
1251 string strval = newAttributes["state"] as string;
1252 int intval = (int)newAttributes["dim"];
1253 Console.WriteLine("attributes are {0} and {1}", strval, intval);
1256 <!-- Badly formed XML comment ignored for member "P:Tizen.Network.IoTConnectivity.Representation.Children" -->
1257 <member name="M:Tizen.Network.IoTConnectivity.Representation.Dispose">
1259 Releases any unmanaged resources used by this object.
1261 <since_tizen> 3 </since_tizen>
1262 <feature>http://tizen.org/feature/iot.ocf</feature>
1264 <member name="M:Tizen.Network.IoTConnectivity.Representation.Dispose(System.Boolean)">
1266 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
1268 <since_tizen> 3 </since_tizen>
1269 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
1270 <feature>http://tizen.org/feature/iot.ocf</feature>
1272 <member name="T:Tizen.Network.IoTConnectivity.Request">
1274 Class respresenting request to a resource.
1275 It provides APIs to manage client's request.
1277 <since_tizen> 3 </since_tizen>
1279 <member name="M:Tizen.Network.IoTConnectivity.Request.Finalize">
1281 Destructor of the Request class.
1284 <member name="P:Tizen.Network.IoTConnectivity.Request.HostAddress">
1286 The host address of the request.
1288 <since_tizen> 3 </since_tizen>
1289 <value>The host address of the request.</value>
1291 <member name="P:Tizen.Network.IoTConnectivity.Request.Representation">
1293 The representation of the request.
1295 <since_tizen> 3 </since_tizen>
1296 <value>The representation of the request.</value>
1298 <member name="P:Tizen.Network.IoTConnectivity.Request.Query">
1300 The query of the request.
1302 <since_tizen> 3 </since_tizen>
1303 <value>The query of the request.</value>
1305 <member name="P:Tizen.Network.IoTConnectivity.Request.Options">
1307 The options related to the request.
1309 <since_tizen> 3 </since_tizen>
1310 <value>The options related to the request.</value>
1312 <member name="M:Tizen.Network.IoTConnectivity.Request.Dispose">
1314 Releases any unmanaged resources used by this object.
1316 <since_tizen> 3 </since_tizen>
1317 <feature>http://tizen.org/feature/iot.ocf</feature>
1319 <member name="M:Tizen.Network.IoTConnectivity.Request.Dispose(System.Boolean)">
1321 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
1323 <since_tizen> 3 </since_tizen>
1324 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
1325 <feature>http://tizen.org/feature/iot.ocf</feature>
1327 <member name="T:Tizen.Network.IoTConnectivity.Resource">
1329 Abstract class respresenting a resource.
1330 All resources need to inherit from this class.
1332 <since_tizen> 3 </since_tizen>
1334 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.Resource.#ctor(System.String,Tizen.Network.IoTConnectivity.ResourceTypes,Tizen.Network.IoTConnectivity.ResourceInterfaces,Tizen.Network.IoTConnectivity.ResourcePolicy)" -->
1335 <member name="M:Tizen.Network.IoTConnectivity.Resource.Finalize">
1337 Destructor of the Resource class.
1340 <member name="P:Tizen.Network.IoTConnectivity.Resource.Types">
1342 Type details of the resource.
1344 <since_tizen> 3 </since_tizen>
1345 <value>Type details of the resource.</value>
1347 <member name="P:Tizen.Network.IoTConnectivity.Resource.Interfaces">
1349 Interface details of the resource.
1351 <since_tizen> 3 </since_tizen>
1352 <value>Interface details of the resource.</value>
1354 <member name="P:Tizen.Network.IoTConnectivity.Resource.Policy">
1356 The policies of the resource.
1358 <since_tizen> 3 </since_tizen>
1359 <value>The policies of the resource.</value>
1361 <member name="P:Tizen.Network.IoTConnectivity.Resource.UriPath">
1363 URI path of the resource.
1365 <since_tizen> 3 </since_tizen>
1366 <value>URI path of the resource.</value>
1368 <member name="P:Tizen.Network.IoTConnectivity.Resource.Children">
1370 List of Child resources.
1372 <since_tizen> 3 </since_tizen>
1373 <value>List of Child resources.</value>
1375 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.Resource.Notify(Tizen.Network.IoTConnectivity.Representation,Tizen.Network.IoTConnectivity.QualityOfService)" -->
1376 <member name="M:Tizen.Network.IoTConnectivity.Resource.OnGet(Tizen.Network.IoTConnectivity.Request)">
1378 This is called when the client performs get operation on this resource.
1380 <since_tizen> 3 </since_tizen>
1381 <param name="request">A request from client.</param>
1382 <returns>A response having the representation and the result.</returns>
1384 <member name="M:Tizen.Network.IoTConnectivity.Resource.OnPut(Tizen.Network.IoTConnectivity.Request)">
1386 This is called when the client performs put operation on this resource.
1388 <since_tizen> 3 </since_tizen>
1389 <param name="request">A request from client.</param>
1390 <returns>A response.</returns>
1392 <member name="M:Tizen.Network.IoTConnectivity.Resource.OnPost(Tizen.Network.IoTConnectivity.Request)">
1394 This is called when the client performs post operation on this resource.
1396 <since_tizen> 3 </since_tizen>
1397 <param name="request">A request from client.</param>
1398 <returns>A response having the representation and the result.</returns>
1400 <member name="M:Tizen.Network.IoTConnectivity.Resource.OnDelete(Tizen.Network.IoTConnectivity.Request)">
1402 This is called when the client performs delete operation on this resource.
1404 <since_tizen> 3 </since_tizen>
1405 <param name="request">A request from client.</param>
1406 <returns>A response.</returns>
1408 <member name="M:Tizen.Network.IoTConnectivity.Resource.OnObserving(Tizen.Network.IoTConnectivity.Request,Tizen.Network.IoTConnectivity.ObserveType,System.Int32)">
1410 Called on the observing event.
1412 <since_tizen> 3 </since_tizen>
1413 <param name="request">A request from client.</param>
1414 <param name="type">Observer type.</param>
1415 <param name="observeId">Observe identifier.</param>
1416 <returns>Returns true if it wants to be observed, else false.</returns>
1418 <member name="M:Tizen.Network.IoTConnectivity.Resource.Dispose">
1420 Releases any unmanaged resources used by this object.
1422 <since_tizen> 3 </since_tizen>
1423 <feature>http://tizen.org/feature/iot.ocf</feature>
1425 <member name="M:Tizen.Network.IoTConnectivity.Resource.Dispose(System.Boolean)">
1427 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
1429 <since_tizen> 3 </since_tizen>
1430 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
1431 <feature>http://tizen.org/feature/iot.ocf</feature>
1433 <member name="T:Tizen.Network.IoTConnectivity.ResourceFoundEventArgs">
1435 This class represents event arguments of the ResourceFound event.
1437 <since_tizen> 3 </since_tizen>
1439 <member name="P:Tizen.Network.IoTConnectivity.ResourceFoundEventArgs.RequestId">
1441 Indicates the request ID.
1442 This is the same request ID returned by the <see cref="!:IoTConnectivityClientManager.StartFindingResource()"/> API.
1444 <since_tizen> 3 </since_tizen>
1445 <value>The request ID.</value>
1447 <member name="P:Tizen.Network.IoTConnectivity.ResourceFoundEventArgs.EventContinue">
1449 Indicates to continuously receive the event for finding resource.
1451 <since_tizen> 3 </since_tizen>
1452 <value>Continuously receive the event for finding resource.</value>
1454 <member name="P:Tizen.Network.IoTConnectivity.ResourceFoundEventArgs.Resource">
1456 Remote resource, which is found after <see cref="!:IoTConnectivityClientManager.StartFindingResource()"/>.
1458 <since_tizen> 3 </since_tizen>
1459 <value>Remote resource which is found after <see cref="!:IoTConnectivityClientManager.StartFindingResource()"/>.</value>
1460 <seealso cref="E:Tizen.Network.IoTConnectivity.IoTConnectivityClientManager.ResourceFound"/>
1461 <seealso cref="!:IoTConnectivityClientManager.StartFindingResource()"/>
1463 <member name="T:Tizen.Network.IoTConnectivity.ResourceInterfaces">
1465 This class contains resource interfaces and provides APIs to manage, add, or remove those interfaces.
1466 A resource interface indicates a class or category of resources.
1468 <since_tizen> 3 </since_tizen>
1470 <member name="F:Tizen.Network.IoTConnectivity.ResourceInterfaces.DefaultInterface">
1474 <since_tizen> 3 </since_tizen>
1476 <member name="F:Tizen.Network.IoTConnectivity.ResourceInterfaces.LinkInterface">
1478 List Links Interface, which is used to list the references to other resources contained in a resource.
1480 <since_tizen> 3 </since_tizen>
1482 <member name="F:Tizen.Network.IoTConnectivity.ResourceInterfaces.BatchInterface">
1484 Batch Interface, which is used to manipulate (GET, PUT, POST, DELETE) on other resource contained in a resource.
1486 <since_tizen> 3 </since_tizen>
1488 <member name="F:Tizen.Network.IoTConnectivity.ResourceInterfaces.GroupInterface">
1490 Group Interface, which is used to manipulate (GET, PUT, POST) a group of remote resources.
1492 <since_tizen> 3 </since_tizen>
1494 <member name="F:Tizen.Network.IoTConnectivity.ResourceInterfaces.ReadonlyInterface">
1496 Read-Only Interface, which is used to limit the methods that can be applied to a resource to GET only.
1498 <since_tizen> 3 </since_tizen>
1500 <member name="M:Tizen.Network.IoTConnectivity.ResourceInterfaces.#ctor">
1502 Constructor of ResourceInterfaces.
1504 <since_tizen> 3 </since_tizen>
1505 <feature>http://tizen.org/feature/iot.ocf</feature>
1506 <seealso cref="!:Add()"/>
1507 <seealso cref="!:Remove()"/>
1508 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1509 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
1511 ResourceInterfaces resourceInterfaces = new ResourceInterfaces();
1514 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceInterfaces.#ctor(System.Collections.Generic.IEnumerable{System.String})" -->
1515 <member name="M:Tizen.Network.IoTConnectivity.ResourceInterfaces.Finalize">
1517 Destructor of the ResourceInterfaces class.
1520 <!-- Badly formed XML comment ignored for member "P:Tizen.Network.IoTConnectivity.ResourceInterfaces.Count" -->
1521 <member name="M:Tizen.Network.IoTConnectivity.ResourceInterfaces.Add(System.String)">
1523 Adds a resource interface into the list.
1525 <since_tizen> 3 </since_tizen>
1527 @a item could be a value, such as <see cref="F:Tizen.Network.IoTConnectivity.ResourceInterfaces.DefaultInterface"/>.
1529 <param name="item">The string data to insert into the resource interfaces.</param>
1530 <feature>http://tizen.org/feature/iot.ocf</feature>
1531 <seealso cref="!:Remove()"/>
1532 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1533 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1534 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1536 ResourceInterfaces resourceInterfaces = new ResourceInterfaces();
1537 resourceInterfaces.Add(ResourceInterfaces.BatchInterface);
1540 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceInterfaces.Remove(System.String)" -->
1541 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceInterfaces.GetEnumerator" -->
1542 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceInterfaces.System#Collections#IEnumerable#GetEnumerator" -->
1543 <member name="M:Tizen.Network.IoTConnectivity.ResourceInterfaces.Dispose">
1545 Releases any unmanaged resources used by this object.
1547 <since_tizen> 3 </since_tizen>
1548 <feature>http://tizen.org/feature/iot.ocf</feature>
1550 <member name="M:Tizen.Network.IoTConnectivity.ResourceInterfaces.Dispose(System.Boolean)">
1552 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
1554 <since_tizen> 3 </since_tizen>
1555 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
1556 <feature>http://tizen.org/feature/iot.ocf</feature>
1558 <member name="T:Tizen.Network.IoTConnectivity.ResourceOptions">
1560 This class represents resource options. It provides APIs to manage them.\n
1561 The iotcon options API provides methods for managing vendor specific options of coap packet.\n
1562 See more about coap packet in http://tools.ietf.org/html/rfc7252.
1564 <since_tizen> 3 </since_tizen>
1566 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.#ctor">
1568 The resource options constructor.
1570 <since_tizen> 3 </since_tizen>
1571 <feature>http://tizen.org/feature/iot.ocf</feature>
1572 <seealso cref="!:Add()"/>
1573 <seealso cref="!:Remove()"/>
1574 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1575 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
1577 ResourceOptions options = new ResourceOptions();
1580 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.Finalize">
1582 Destructor of the ResourceOptions class.
1585 <member name="P:Tizen.Network.IoTConnectivity.ResourceOptions.Keys">
1587 Contains all the Option keys.
1589 <since_tizen> 3 </since_tizen>
1590 <value>All the Option keys.</value>
1592 ResourceOptions options = new ResourceOptions();
1593 options.Add(2050, "sample-data");
1594 options.Add(2055, "sample value");
1595 var keys = options.Keys;
1596 Console.WriteLine("Resource options contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1));
1599 <member name="P:Tizen.Network.IoTConnectivity.ResourceOptions.Values">
1601 Contains all the Option values.
1603 <since_tizen> 3 </since_tizen>
1604 <value>All the Option values.</value>
1606 ResourceOptions options = new ResourceOptions();
1607 options.Add(2050, "sample-data");
1608 options.Add(2055, "sample value");
1609 var values = options.Values;
1610 Console.WriteLine("Resource options contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1));
1613 <member name="P:Tizen.Network.IoTConnectivity.ResourceOptions.Count">
1615 Gets the number of options.
1617 <since_tizen> 3 </since_tizen>
1618 <value>The number of options.</value>
1620 ResourceOptions options = new ResourceOptions();
1621 options.Add(2050, "sample-data");
1622 options.Add(2055, "sample value");
1623 var count = options.Count;
1624 Console.WriteLine("There are {0} keys in the options object", count);
1627 <member name="P:Tizen.Network.IoTConnectivity.ResourceOptions.IsReadOnly">
1629 Represents whether the collection is readonly.
1631 <since_tizen> 3 </since_tizen>
1632 <value>Whether the collection is readonly.</value>
1634 ResourceOptions options = new ResourceOptions();
1635 if (options.IsReadOnly)
1636 Console.WriteLine("Read only options");
1639 <member name="P:Tizen.Network.IoTConnectivity.ResourceOptions.Item(System.UInt16)">
1641 Gets or sets the option data.
1643 <since_tizen> 3 </since_tizen>
1644 <value>The option data.</value>
1645 <param name="key">The option ID to get or set.</param>
1646 <returns>The option with the specified ID.</returns>
1648 ResourceOptions options = new ResourceOptions();
1649 options[2055] = "sample-data";
1650 Console.WriteLine("Option has : {0}", options[2055]);
1653 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.ContainsKey(System.UInt16)">
1655 Checks whether the given key exists in Options collection.
1657 <since_tizen> 3 </since_tizen>
1658 <param name="key">The key to look for.</param>
1659 <returns>true if exists. Otherwise, false.</returns>
1661 ResourceOptions options = new ResourceOptions();
1662 options.Add(2050, "sample-data");
1663 if (options.ContainsKey(2050))
1664 Console.WriteLine("options conatins key : 2050");
1667 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.Add(System.UInt16,System.String)">
1669 Adds a new ID and a correspoding data into the options.
1671 <since_tizen> 3 </since_tizen>
1673 ResourceOptions can have up to 2 options. \n
1674 key is always situated between 2048 and 3000. \n
1675 Length of option data is less than or equal to 15.
1677 <param name="key">The ID of the option to insert.</param>
1678 <param name="value">The string data to insert into the options.</param>
1679 <feature>http://tizen.org/feature/iot.ocf</feature>
1680 <seealso cref="!:Remove()"/>
1681 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1682 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1684 ResourceOptions options = new ResourceOptions();
1685 options.Add(2050, "sample-data");
1688 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.Remove(System.UInt16)">
1690 Removes the ID and its associated data from the options.
1692 <since_tizen> 3 </since_tizen>
1693 <param name="key">The ID of the option to delete.</param>
1694 <returns>True if operation is successful. Otherwise, false.</returns>
1695 <feature>http://tizen.org/feature/iot.ocf</feature>
1696 <seealso cref="!:Add()"/>
1697 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1698 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1700 ResourceOptions options = new ResourceOptions();
1701 options.Add(2050, "12345");
1702 var result = options.Remove(2050);
1705 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.TryGetValue(System.UInt16,System.String@)">
1707 Gets the value associated with the specified key.
1709 <since_tizen> 3 </since_tizen>
1710 <param name="key">The option ID.</param>
1711 <param name="value">Value corresponding to option ID.</param>
1712 <returns>True if the key exists, false otherwise.</returns>
1714 ResourceOptions options = new ResourceOptions();
1715 options.Add(2050, "12345");
1717 var isPresent = options.TryGetValue(2050, out value);
1719 Console.WriteLine("value : {0}", value);
1722 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceOptions.Add(System.Collections.Generic.KeyValuePair{System.UInt16,System.String})" -->
1723 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.Clear">
1725 Clears the Options collection.
1727 <since_tizen> 3 </since_tizen>
1728 <feature>http://tizen.org/feature/iot.ocf</feature>
1729 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1731 ResourceOptions options = new ResourceOptions();
1732 options.Add(2050, "12345");
1733 options.Add(2055, "sample");
1737 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceOptions.Contains(System.Collections.Generic.KeyValuePair{System.UInt16,System.String})" -->
1738 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceOptions.CopyTo(System.Collections.Generic.KeyValuePair{System.UInt16,System.String}[],System.Int32)" -->
1739 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceOptions.Remove(System.Collections.Generic.KeyValuePair{System.UInt16,System.String})" -->
1740 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceOptions.GetEnumerator" -->
1741 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.Dispose">
1743 Releases any unmanaged resources used by this object.
1745 <since_tizen> 3 </since_tizen>
1746 <feature>http://tizen.org/feature/iot.ocf</feature>
1748 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceOptions.System#Collections#IEnumerable#GetEnumerator" -->
1749 <member name="M:Tizen.Network.IoTConnectivity.ResourceOptions.Dispose(System.Boolean)">
1751 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
1753 <since_tizen> 3 </since_tizen>
1754 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
1755 <feature>http://tizen.org/feature/iot.ocf</feature>
1757 <member name="T:Tizen.Network.IoTConnectivity.ResourcePolicy">
1759 Enumeration for the policy, which can be held in a resource.
1761 <since_tizen> 3 </since_tizen>
1763 <member name="F:Tizen.Network.IoTConnectivity.ResourcePolicy.NoProperty">
1765 Indicates resource uninitialized.
1767 <since_tizen> 3 </since_tizen>
1769 <member name="F:Tizen.Network.IoTConnectivity.ResourcePolicy.Discoverable">
1771 Indicates resource that is allowed to be discovered.
1773 <since_tizen> 3 </since_tizen>
1775 <member name="F:Tizen.Network.IoTConnectivity.ResourcePolicy.Observable">
1777 Indicates resource that is allowed to be observed.
1779 <since_tizen> 3 </since_tizen>
1781 <member name="F:Tizen.Network.IoTConnectivity.ResourcePolicy.Active">
1783 Indicates resource initialized and activated.
1785 <since_tizen> 3 </since_tizen>
1787 <member name="F:Tizen.Network.IoTConnectivity.ResourcePolicy.Slow">
1789 Indicates resource, which takes some delay to respond.
1791 <since_tizen> 3 </since_tizen>
1793 <member name="F:Tizen.Network.IoTConnectivity.ResourcePolicy.Secure">
1795 Indicates secure resource.
1797 <since_tizen> 3 </since_tizen>
1799 <member name="F:Tizen.Network.IoTConnectivity.ResourcePolicy.ExplicitDiscoverable">
1801 When this bit is set, the resource is allowed to be discovered only if discovery request contains an explicit querystring.
1803 <since_tizen> 3 </since_tizen>
1805 <member name="T:Tizen.Network.IoTConnectivity.ResourceQuery">
1807 This class provides APIs to manage the query of request.
1809 <since_tizen> 3 </since_tizen>
1811 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.#ctor">
1813 The resource query constructor.
1815 <since_tizen> 3 </since_tizen>
1816 <feature>http://tizen.org/feature/iot.ocf</feature>
1817 <seealso cref="!:Add()"/>
1818 <seealso cref="!:Remove()"/>
1819 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1820 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
1822 ResourceQuery query = new ResourceQuery();
1825 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.Finalize">
1827 Destructor of the ResourceQuery class.
1830 <member name="P:Tizen.Network.IoTConnectivity.ResourceQuery.Type">
1832 Gets and sets the resource type of the query.
1834 <since_tizen> 3 </since_tizen>
1835 <value>The resource type of the query.</value>
1836 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1837 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1838 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1840 ResourceQuery query = new ResourceQuery();
1841 query.Type = "org.tizen.light";
1842 Console.WriteLine("Type of query : {0}", query.Type);
1845 <member name="P:Tizen.Network.IoTConnectivity.ResourceQuery.Interface">
1847 Gets and sets the resource interface of the query.
1849 <since_tizen> 3 </since_tizen>
1851 The resource interface of the query.
1852 Setter value could be a value, such as <see cref="F:Tizen.Network.IoTConnectivity.ResourceInterfaces.DefaultInterface"/>.
1854 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1855 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1856 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1858 ResourceQuery query = new ResourceQuery();
1859 query.Interface = ResourceInterfaces.LinkInterface;
1862 <member name="P:Tizen.Network.IoTConnectivity.ResourceQuery.Keys">
1864 Contains all the query keys.
1866 <since_tizen> 3 </since_tizen>
1867 <value>All the query keys.</value>
1869 ResourceQuery query = new ResourceQuery();
1870 query.Add("key", "value");
1871 query.Add("newKey", "sample value");
1872 var keys = query.Keys;
1873 Console.WriteLine("Resource query contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1));
1876 <member name="P:Tizen.Network.IoTConnectivity.ResourceQuery.Values">
1878 Contains all the query values.
1880 <since_tizen> 3 </since_tizen>
1881 <value>All the query values.</value>
1883 ResourceQuery query = new ResourceQuery();
1884 query.Add("key", "value");
1885 query.Add("newKey", "sample value");
1886 var values = query.Values;
1887 Console.WriteLine("Resource query contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1));
1890 <member name="P:Tizen.Network.IoTConnectivity.ResourceQuery.Count">
1892 Gets the number of query elements.
1894 <since_tizen> 3 </since_tizen>
1895 <value>The number of query elements.</value>
1897 ResourceQuery query = new ResourceQuery();
1898 query.Add("key", "value");
1899 query.Add("newKey", "sample value");
1900 var count = query.Count;
1901 Console.WriteLine("There are {0} keys in the query object", count);
1904 <member name="P:Tizen.Network.IoTConnectivity.ResourceQuery.IsReadOnly">
1906 Represents whether the collection is readonly.
1908 <since_tizen> 3 </since_tizen>
1909 <value>Whether the collection is readonly.</value>
1911 ResourceQuery query = new ResourceQuery();
1912 if (query.IsReadOnly)
1913 Console.WriteLine("Read only query");
1916 <member name="P:Tizen.Network.IoTConnectivity.ResourceQuery.Item(System.String)">
1918 Gets or sets the query data.
1920 <since_tizen> 3 </since_tizen>
1921 <value>The query data.</value>
1922 <param name="key">The query key to get or set.</param>
1923 <returns>The query with the specified key.</returns>
1925 ResourceQuery query = new ResourceQuery();
1926 query["key1"] = "sample-data";
1927 Console.WriteLine("query has : {0}", query["key1"]);
1930 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.ContainsKey(System.String)">
1932 Checks whether the given key exists in the query collection.
1934 <since_tizen> 3 </since_tizen>
1935 <param name="key">The key to look for.</param>
1936 <returns>true if exists. Otherwise, false.</returns>
1938 ResourceQuery query = new ResourceQuery();
1939 query.Add("key1", "value1");
1940 if (query.ContainsKey("key1"))
1941 Console.WriteLine("query conatins key : key1");
1944 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.Add(System.String,System.String)">
1946 Adds a new key and correspoding value into the query.
1948 <since_tizen> 3 </since_tizen>
1950 The full length of query should be less than or equal to 64.
1952 <param name="key">The key of the query to insert.</param>
1953 <param name="value">The string data to insert into the query.</param>
1954 <feature>http://tizen.org/feature/iot.ocf</feature>
1955 <seealso cref="!:Remove()"/>
1956 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1957 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1958 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1960 ResourceQuery query = new ResourceQuery();
1961 query.Add("key1", "value1");
1964 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.Remove(System.String)">
1966 Removes the key and its associated value from the query.
1968 <since_tizen> 3 </since_tizen>
1969 <param name="key">The ID of the query to delete.</param>
1970 <returns>True if operation is successful. Otherwise, false.</returns>
1971 <feature>http://tizen.org/feature/iot.ocf</feature>
1972 <seealso cref="!:Add()"/>
1973 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
1974 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
1975 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
1977 ResourceQuery query = new ResourceQuery();
1978 query.Add("key1", "value1");
1979 var result = query.Remove("key1");
1982 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.TryGetValue(System.String,System.String@)">
1984 Gets the value associated with the specified key.
1986 <since_tizen> 3 </since_tizen>
1987 <param name="key">The query key.</param>
1988 <param name="value">Value corresponding to query key.</param>
1989 <returns>True if the key exists, false otherwise.</returns>
1991 ResourceQuery query = new ResourceQuery();
1992 query.Add("key1", "value1");
1994 var isPresent = query.TryGetValue("key1", out value);
1996 Console.WriteLine("value : {0}", value);
1999 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceQuery.Add(System.Collections.Generic.KeyValuePair{System.String,System.String})" -->
2000 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.Clear">
2002 Clears the query collection.
2004 <since_tizen> 3 </since_tizen>
2005 <feature>http://tizen.org/feature/iot.ocf</feature>
2006 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
2007 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
2009 ResourceQuery query = new ResourceQuery();
2010 query.Add("key1", "value1");
2011 query.Add("key2", "value2");
2015 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceQuery.Contains(System.Collections.Generic.KeyValuePair{System.String,System.String})" -->
2016 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceQuery.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.String}[],System.Int32)" -->
2017 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceQuery.Remove(System.Collections.Generic.KeyValuePair{System.String,System.String})" -->
2018 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceQuery.GetEnumerator" -->
2019 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceQuery.System#Collections#IEnumerable#GetEnumerator" -->
2020 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.Dispose">
2022 Releases any unmanaged resources used by this object.
2024 <since_tizen> 3 </since_tizen>
2025 <feature>http://tizen.org/feature/iot.ocf</feature>
2027 <member name="M:Tizen.Network.IoTConnectivity.ResourceQuery.Dispose(System.Boolean)">
2029 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
2031 <since_tizen> 3 </since_tizen>
2032 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
2033 <feature>http://tizen.org/feature/iot.ocf</feature>
2035 <member name="T:Tizen.Network.IoTConnectivity.ResourceState">
2037 Enumeration for states of the remote resource.
2039 <since_tizen> 3 </since_tizen>
2041 <member name="F:Tizen.Network.IoTConnectivity.ResourceState.Alive">
2043 Indicates remote resource is alive.
2045 <since_tizen> 3 </since_tizen>
2047 <member name="F:Tizen.Network.IoTConnectivity.ResourceState.LostSignal">
2049 Indicates remote resource is lost.
2051 <since_tizen> 3 </since_tizen>
2053 <member name="T:Tizen.Network.IoTConnectivity.ResourceTypes">
2055 This class contains resource types and provides APIs to manage, add, or remove those types.
2056 A resource type indicates a class or a category of resources.
2058 <since_tizen> 3 </since_tizen>
2060 <member name="M:Tizen.Network.IoTConnectivity.ResourceTypes.#ctor">
2062 Constructor of ResourceTypes.
2064 <since_tizen> 3 </since_tizen>
2065 <feature>http://tizen.org/feature/iot.ocf</feature>
2066 <seealso cref="!:Add()"/>
2067 <seealso cref="!:Remove()"/>
2068 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
2069 <exception cref="T:System.OutOfMemoryException">Thrown when there is not enough memory.</exception>
2071 ResourceTypes types = new ResourceTypes();
2074 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceTypes.#ctor(System.Collections.Generic.IEnumerable{System.String})" -->
2075 <member name="M:Tizen.Network.IoTConnectivity.ResourceTypes.Finalize">
2077 Destructor of the ResourceTypes class.
2080 <!-- Badly formed XML comment ignored for member "P:Tizen.Network.IoTConnectivity.ResourceTypes.Count" -->
2081 <member name="M:Tizen.Network.IoTConnectivity.ResourceTypes.Add(System.String)">
2083 Adds a resource type into the list.
2085 <since_tizen> 3 </since_tizen>
2087 The length of @a item should be less than or equal to 61.\n
2088 The @a item must start with a lowercase alphabetic character, followed by a sequence
2089 of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.\n
2090 Duplicate strings are not allowed.
2092 <param name="item">The string data to insert into the resource types.</param>
2093 <feature>http://tizen.org/feature/iot.ocf</feature>
2094 <seealso cref="!:Remove()"/>
2095 <exception cref="T:System.NotSupportedException">Thrown when the iotcon is not supported.</exception>
2096 <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>
2097 <exception cref="T:System.InvalidOperationException">Thrown when the operation is invalid.</exception>
2099 ResourceTypes resourceTypes = new ResourceTypes();
2100 resourceTypes.Add("org.tizen.light");
2103 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceTypes.Remove(System.String)" -->
2104 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceTypes.GetEnumerator" -->
2105 <!-- Badly formed XML comment ignored for member "M:Tizen.Network.IoTConnectivity.ResourceTypes.System#Collections#IEnumerable#GetEnumerator" -->
2106 <member name="M:Tizen.Network.IoTConnectivity.ResourceTypes.Dispose">
2108 Releases any unmanaged resources used by this object.
2110 <since_tizen> 3 </since_tizen>
2111 <feature>http://tizen.org/feature/iot.ocf</feature>
2113 <member name="M:Tizen.Network.IoTConnectivity.ResourceTypes.Dispose(System.Boolean)">
2115 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
2117 <since_tizen> 3 </since_tizen>
2118 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
2119 <feature>http://tizen.org/feature/iot.ocf</feature>
2121 <member name="T:Tizen.Network.IoTConnectivity.Response">
2123 This class represents response from a resource.
2124 It provides APIs to manage response.
2126 <since_tizen> 3 </since_tizen>
2128 <member name="M:Tizen.Network.IoTConnectivity.Response.#ctor">
2130 Constructor of Response.
2132 <since_tizen> 3 </since_tizen>
2134 Response response = new Response();
2137 <member name="M:Tizen.Network.IoTConnectivity.Response.Finalize">
2139 Destructor of the Response class.
2142 <member name="P:Tizen.Network.IoTConnectivity.Response.Result">
2144 Gets or sets the result from/into the response.
2146 <since_tizen> 3 </since_tizen>
2147 <value>The result from/into the response.</value>
2149 <member name="P:Tizen.Network.IoTConnectivity.Response.Representation">
2151 Gets or sets the representation from/into the response.
2153 <since_tizen> 3 </since_tizen>
2154 <value>The representation from/into the response.</value>
2156 <member name="P:Tizen.Network.IoTConnectivity.Response.Options">
2158 Gets or sets the options from/into the response.
2160 <since_tizen> 3 </since_tizen>
2161 <value>The options from/into the response.</value>
2163 <member name="M:Tizen.Network.IoTConnectivity.Response.Dispose">
2165 Releases any unmanaged resources used by this object.
2167 <since_tizen> 3 </since_tizen>
2169 <member name="M:Tizen.Network.IoTConnectivity.Response.Dispose(System.Boolean)">
2171 Releases any unmanaged resources used by this object. Can also dispose any other disposable objects.
2173 <since_tizen> 3 </since_tizen>
2174 <param name="disposing">If true, disposes any disposable objects. If false, does not dispose disposable objects.</param>
2176 <member name="T:Tizen.Network.IoTConnectivity.ResponseCode">
2178 Enumeration for the result of response.
2180 <since_tizen> 3 </since_tizen>
2182 <member name="F:Tizen.Network.IoTConnectivity.ResponseCode.Ok">
2184 Indicates the result of response for success.
2186 <since_tizen> 3 </since_tizen>
2188 <member name="F:Tizen.Network.IoTConnectivity.ResponseCode.Error">
2190 Indicates the result of response for some error.
2192 <since_tizen> 3 </since_tizen>
2194 <member name="F:Tizen.Network.IoTConnectivity.ResponseCode.Created">
2196 Indicates the result of response for created resource.
2198 <since_tizen> 3 </since_tizen>
2200 <member name="F:Tizen.Network.IoTConnectivity.ResponseCode.Deleted">
2202 Indicates the result of response for deleted resource.
2204 <since_tizen> 3 </since_tizen>
2206 <member name="F:Tizen.Network.IoTConnectivity.ResponseCode.Changed">
2208 Indicates the result of response for changed resource.
2210 <since_tizen> 3 </since_tizen>
2212 <member name="F:Tizen.Network.IoTConnectivity.ResponseCode.Slow">
2214 Indicates the result of response for slow resource.
2216 <since_tizen> 3 </since_tizen>
2218 <member name="F:Tizen.Network.IoTConnectivity.ResponseCode.Forbidden">
2220 Indicates the result of response for accessing unauthorized resource.
2222 <since_tizen> 3 </since_tizen>
2224 <member name="T:Tizen.Network.IoTConnectivity.StateChangedEventArgs">
2226 This class represents event arguments of the StateChanged event.
2228 <since_tizen> 3 </since_tizen>
2230 <member name="P:Tizen.Network.IoTConnectivity.StateChangedEventArgs.State">
2232 Indicates the new state of the resource.
2234 <since_tizen> 3 </since_tizen>
2235 <value>The new state of the resource.</value>