Initial import

InCore.CloudOfThings/CloudOfThingsClient.rst

@@ -0,0 +1,259 @@
+
+.. _object_CloudOfThingsClient:
+
+
+:index:`CloudOfThingsClient`
+----------------------------
+
+**Inherits**: :ref:`Object <object_Object>`
+
+Description
+***********
+
+
+
+Enumerations
+************
+
+
+.. _enum_CloudOfThingsClient_Error:
+
+Error
++++++
+
+
+
+============================================== ========= ===============
+**Name**                                       **Value** **Description**
+``CloudOfThingsClient.NoError``                ``0``                    
+``CloudOfThingsClient.InvalidProtocolVersion`` ``1``                    
+``CloudOfThingsClient.IdRejected``             ``2``                    
+``CloudOfThingsClient.ServerUnavailable``      ``3``                    
+``CloudOfThingsClient.BadUsernameOrPassword``  ``4``                    
+``CloudOfThingsClient.NotAuthorized``          ``5``                    
+``CloudOfThingsClient.TransportInvalid``       ``256``                  
+``CloudOfThingsClient.ProtocolViolation``      ``257``                  
+``CloudOfThingsClient.UnknownError``           ``258``                  
+============================================== ========= ===============
+
+
+.. _enum_CloudOfThingsClient_State:
+
+State
++++++
+
+
+
+==================================== ========= ===============
+**Name**                             **Value** **Description**
+``CloudOfThingsClient.Disconnected`` ``0``                    
+``CloudOfThingsClient.Connecting``   ``1``                    
+``CloudOfThingsClient.Connected``    ``2``                    
+==================================== ========= ===============
+
+Methods
+*******
+
+
+.. _method_CloudOfThingsClient_connectToHost:
+
+connectToHost()
++++++++++++++++
+
+
+
+
+
+.. _method_CloudOfThingsClient_disconnectFromHost:
+
+disconnectFromHost()
+++++++++++++++++++++
+
+
+
+
+
+.. _method_CloudOfThingsClient_requestPing:
+
+requestPing()
++++++++++++++
+
+
+
+**Return value type**: Boolean
+
+
+Signals
+*******
+
+
+.. _signal_CloudOfThingsClient_brokerSessionRestored:
+
+brokerSessionRestored()
++++++++++++++++++++++++
+
+
+
+
+
+.. _signal_CloudOfThingsClient_connected:
+
+connected()
++++++++++++
+
+
+
+
+
+.. _signal_CloudOfThingsClient_disconnected:
+
+disconnected()
+++++++++++++++
+
+
+
+
+
+.. _signal_CloudOfThingsClient_objectsDataChanged:
+
+objectsDataChanged(SignedInteger index)
++++++++++++++++++++++++++++++++++++++++
+
+
+
+
+
+.. _signal_CloudOfThingsClient_pingResponseReceived:
+
+pingResponseReceived()
+++++++++++++++++++++++
+
+
+
+
+Properties
+**********
+
+
+.. _property_CloudOfThingsClient_autoConnect:
+
+autoConnect
++++++++++++
+
+
+
+**Type**: Boolean
+
+**Default value**: ``true``
+
+**Signal**: autoConnectChanged
+
+**Setter**: setAutoConnect()
+
+
+
+.. _property_CloudOfThingsClient_cleanSession:
+
+cleanSession
+++++++++++++
+
+
+
+**Type**: Boolean
+
+**Default value**: ``true``
+
+**Signal**: cleanSessionChanged
+
+**Setter**: setCleanSession()
+
+
+
+.. _property_CloudOfThingsClient_error:
+
+error
++++++
+
+
+
+**Type**: :ref:`Error <enum_CloudOfThingsClient_Error>`
+
+**Default value**: ``CloudOfThingsClient.NoError``
+
+**Signal**: errorChanged
+
+
+
+.. _property_CloudOfThingsClient_objects:
+
+objects
++++++++
+
+
+
+**Type**: :ref:`List <object_List>`\<:ref:`Object <object_Object>`>
+
+**Signal**: objectsChanged
+
+
+
+.. _property_CloudOfThingsClient_registrator:
+
+registrator
++++++++++++
+
+
+
+**Type**: :ref:`CloudOfThingsDeviceRegistrator <object_CloudOfThingsDeviceRegistrator>`
+
+**Signal**: registratorChanged
+
+
+
+.. _property_CloudOfThingsClient_requestOperationsInterval:
+
+requestOperationsInterval
++++++++++++++++++++++++++
+
+
+
+**Type**: SignedInteger
+
+**Default value**: ``60000``
+
+**Signal**: requestOperationsIntervalChanged
+
+**Setter**: setRequestOperationsInterval()
+
+
+
+.. _property_CloudOfThingsClient_state:
+
+state
++++++
+
+
+
+**Type**: :ref:`State <enum_CloudOfThingsClient_State>`
+
+**Default value**: ``CloudOfThingsClient.Disconnected``
+
+**Signal**: stateChanged
+
+
+Inherited members
+*****************
+
+Signals
++++++++
+
+* :ref:`Object::completed <signal_Object_completed>`
+
+* :ref:`Object::propertyChanged <signal_Object_propertyChanged>`
+
+Properties
+++++++++++
+
+* :ref:`Object::objectId <property_Object_objectId>`
+
+