-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 805b009
Showing
114 changed files
with
12,833 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,212 @@ | ||
|
||
.. _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_objects: | ||
|
||
objects | ||
+++++++ | ||
|
||
|
||
|
||
**Type**: :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() | ||
|
||
|
||
Inherited members | ||
***************** | ||
|
||
Signals | ||
+++++++ | ||
|
||
* :ref:`Object::completed <signal_Object_completed>` | ||
|
||
* :ref:`Object::propertyChanged <signal_Object_propertyChanged>` | ||
|
||
Properties | ||
++++++++++ | ||
|
||
* :ref:`Object::objectId <property_Object_objectId>` | ||
|
||
|
141 changes: 141 additions & 0 deletions
141
InCore.CloudOfThings/CloudOfThingsDeviceRegistrator.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
|
||
.. _object_CloudOfThingsDeviceRegistrator: | ||
|
||
|
||
:index:`CloudOfThingsDeviceRegistrator` | ||
--------------------------------------- | ||
|
||
**Inherits**: :ref:`Object <object_Object>` | ||
|
||
Description | ||
*********** | ||
|
||
|
||
|
||
Enumerations | ||
************ | ||
|
||
|
||
.. _enum_CloudOfThingsDeviceRegistrator_State: | ||
|
||
State | ||
+++++ | ||
|
||
|
||
|
||
=================================================== ========= =============== | ||
**Name** **Value** **Description** | ||
``CloudOfThingsDeviceRegistrator.Unregistered`` ``0`` | ||
``CloudOfThingsDeviceRegistrator.WaitingForAccept`` ``1`` | ||
``CloudOfThingsDeviceRegistrator.Reconnecting`` ``2`` | ||
``CloudOfThingsDeviceRegistrator.Registered`` ``3`` | ||
=================================================== ========= =============== | ||
|
||
Methods | ||
******* | ||
|
||
This object has no additional methods. | ||
|
||
Signals | ||
******* | ||
|
||
This object has no additional signals. | ||
|
||
Properties | ||
********** | ||
|
||
|
||
.. _property_CloudOfThingsDeviceRegistrator_bootstrapPassword: | ||
|
||
bootstrapPassword | ||
+++++++++++++++++ | ||
|
||
|
||
|
||
**Type**: String | ||
|
||
**Signal**: bootstrapPasswordChanged | ||
|
||
**Setter**: setBootstrapPassword() | ||
|
||
|
||
|
||
.. _property_CloudOfThingsDeviceRegistrator_bootstrapUser: | ||
|
||
bootstrapUser | ||
+++++++++++++ | ||
|
||
|
||
|
||
**Type**: String | ||
|
||
**Signal**: bootstrapUserChanged | ||
|
||
**Setter**: setBootstrapUser() | ||
|
||
|
||
|
||
.. _property_CloudOfThingsDeviceRegistrator_isRegistered: | ||
|
||
isRegistered | ||
++++++++++++ | ||
|
||
|
||
|
||
**Type**: Boolean | ||
|
||
**Default value**: ``false`` | ||
|
||
**Signal**: isRegisteredChanged | ||
|
||
**Setter**: setIsRegistered() | ||
|
||
|
||
|
||
.. _property_CloudOfThingsDeviceRegistrator_password: | ||
|
||
password | ||
++++++++ | ||
|
||
|
||
|
||
**Type**: String | ||
|
||
**Signal**: passwordChanged | ||
|
||
**Setter**: setPassword() | ||
|
||
|
||
|
||
.. _property_CloudOfThingsDeviceRegistrator_state: | ||
|
||
state | ||
+++++ | ||
|
||
|
||
|
||
**Type**: :ref:`State <enum_CloudOfThingsDeviceRegistrator_State>` | ||
|
||
**Default value**: ``CloudOfThingsDeviceRegistrator.Unregistered`` | ||
|
||
**Signal**: stateChanged | ||
|
||
**Setter**: setState() | ||
|
||
|
||
Inherited members | ||
***************** | ||
|
||
Signals | ||
+++++++ | ||
|
||
* :ref:`Object::completed <signal_Object_completed>` | ||
|
||
* :ref:`Object::propertyChanged <signal_Object_propertyChanged>` | ||
|
||
Properties | ||
++++++++++ | ||
|
||
* :ref:`Object::objectId <property_Object_objectId>` | ||
|
||
|
Oops, something went wrong.