Skip to content

Commit

Permalink
Update to 2.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
tobydox committed Mar 10, 2021
1 parent 6beba8f commit 8379835
Show file tree
Hide file tree
Showing 24 changed files with 4,072 additions and 56 deletions.
38 changes: 6 additions & 32 deletions InCore.Foundation/JsonRpcClient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,9 @@ Signals
.. hlist::
:columns: 1

* :ref:`callFinished() <signal_JsonRpcClient_callFinished>`
* :ref:`errorCodeReceived() <signal_JsonRpcClient_errorCodeReceived>`
* :ref:`errorDataReceived() <signal_JsonRpcClient_errorDataReceived>`
* :ref:`errorMessageReceived() <signal_JsonRpcClient_errorMessageReceived>`
* :ref:`propertyReceived() <signal_JsonRpcClient_propertyReceived>`
* :ref:`Object.completed() <signal_Object_completed>`


Expand Down Expand Up @@ -141,10 +139,10 @@ Methods
.. index::
single: call

call(String name, List arguments)
+++++++++++++++++++++++++++++++++
call(String name, List arguments, JSValue callback)
+++++++++++++++++++++++++++++++++++++++++++++++++++

This method calls the method specified by parameter `name` with the arguments specified in parameter ``arguments``. It returns ``true`` if the call request could be initiated succesfully. This does not neccessarily mean that the call itself was successful. Use the :ref:`errorCodeReceived() <signal_JsonRpcClient_errorCodeReceived>`, :ref:`errorDataReceived() <signal_JsonRpcClient_errorDataReceived>` or :ref:`errorMessageReceived() <signal_JsonRpcClient_errorMessageReceived>` signals to detect and handle actual RPC errors.
This method calls the method specified by parameter `name` with the arguments specified in parameter ``arguments``. It returns ``true`` if the call request could be initiated succesfully. This does not neccessarily mean that the call itself was successful. Use the :ref:`errorCodeReceived() <signal_JsonRpcClient_errorCodeReceived>`, :ref:`errorDataReceived() <signal_JsonRpcClient_errorDataReceived>` or :ref:`errorMessageReceived() <signal_JsonRpcClient_errorMessageReceived>` signals to detect and handle actual RPC errors. When the call succeeded, the return value will be passed to the given callback as the first argument.

:**› Returns**: Boolean

Expand All @@ -155,10 +153,10 @@ This method calls the method specified by parameter `name` with the arguments sp
.. index::
single: getProperty

getProperty(String name)
++++++++++++++++++++++++
getProperty(String name, JSValue callback)
++++++++++++++++++++++++++++++++++++++++++

This method wraps a call to the :ref:`getProperty() <method_JsonRpcClient_getProperty>` method implemented by :ref:`JsonRpcService <object_JsonRpcService>`. Whenever a property is received, the :ref:`propertyReceived() <signal_JsonRpcClient_propertyReceived>` signal (instead of the :ref:`callFinished() <signal_JsonRpcClient_callFinished>` signal) is emitted.
This method wraps a call to the :ref:`getProperty() <method_JsonRpcClient_getProperty>` method implemented by :ref:`JsonRpcService <object_JsonRpcService>`. Whenever a property is received, the given callback is called with the result as the first argument.

:**› Returns**: Boolean

Expand All @@ -181,18 +179,6 @@ Signals
*******


.. _signal_JsonRpcClient_callFinished:

.. index::
single: callFinished

callFinished(String name, Variant returnValue)
++++++++++++++++++++++++++++++++++++++++++++++

This signal is emitted whenever an RPC call has been finished successfully. The method name and return value are passed through the signal parameters.



.. _signal_JsonRpcClient_errorCodeReceived:

.. index::
Expand Down Expand Up @@ -228,18 +214,6 @@ errorMessageReceived(String name, String errorMessage)
This signal is emitted whenever an RPC error response with a valid error message is received.



.. _signal_JsonRpcClient_propertyReceived:

.. index::
single: propertyReceived

propertyReceived(String name, Variant value)
++++++++++++++++++++++++++++++++++++++++++++

This signal is emitted whenever a property requested via the :ref:`getProperty() <method_JsonRpcClient_getProperty>` has been received. The property's name and value are passed through the signal parameters.


Example
*******
See :ref:`JsonRpcService example <example_JsonRpcService>` on how to use JsonRpcClient.
6 changes: 2 additions & 4 deletions InCore.Foundation/JsonRpcService.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,13 @@ Example
JsonRpcClient {
id: rpcClient
onPropertyReceived: console.log("Received property", name, "with value", value)
onCallFinished: console.log("Function", name, "returned", returnValue)
onErrorCodeReceived: console.log("Call to", name, "returned with error code", errorCode)
onErrorMessageReceived: console.log("Call to", name, "returned with error message", errorMessage)
}
onCompleted: {
rpcClient.getProperty("systemClock")
rpcClient.call("callMe", ["My message"])
rpcClient.getProperty("systemClock", (value) => { console.log("System clock:", value) })
rpcClient.call("callMe", ["My message"], (retval) => { console.log("callMe() returned:", retval)})
rpcClient.call("nonExistingFunction", [])
}
Expand Down
129 changes: 128 additions & 1 deletion InCore.Foundation/MobileNetworkInterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ Properties
* :ref:`allowRoamingItem <property_MobileNetworkInterface_allowRoamingItem>`
* :ref:`apn <property_MobileNetworkInterface_apn>`
* :ref:`apnItem <property_MobileNetworkInterface_apnItem>`
* :ref:`authenticationType <property_MobileNetworkInterface_authenticationType>`
* :ref:`authenticationTypeItem <property_MobileNetworkInterface_authenticationTypeItem>`
* :ref:`deviceManufacturer <property_MobileNetworkInterface_deviceManufacturer>`
* :ref:`deviceModel <property_MobileNetworkInterface_deviceModel>`
* :ref:`iccid <property_MobileNetworkInterface_iccid>`
* :ref:`imei <property_MobileNetworkInterface_imei>`
Expand All @@ -51,6 +54,7 @@ Properties
* :ref:`NetworkInterface.hardwareName <property_NetworkInterface_hardwareName>`
* :ref:`NetworkInterface.networkAddresses <property_NetworkInterface_networkAddresses>`
* :ref:`NetworkInterface.operationalState <property_NetworkInterface_operationalState>`
* :ref:`NetworkInterface.routes <property_NetworkInterface_routes>`
* :ref:`NetworkInterface.setupState <property_NetworkInterface_setupState>`
* :ref:`NetworkInterface.useRoutes <property_NetworkInterface_useRoutes>`
* :ref:`NetworkInterface.useRoutesItem <property_NetworkInterface_useRoutesItem>`
Expand All @@ -74,13 +78,14 @@ Signals
+++++++

.. hlist::
:columns: 1
:columns: 2

* :ref:`connected() <signal_MobileNetworkInterface_connected>`
* :ref:`disconnected() <signal_MobileNetworkInterface_disconnected>`
* :ref:`messageReceived() <signal_MobileNetworkInterface_messageReceived>`
* :ref:`messageSent() <signal_MobileNetworkInterface_messageSent>`
* :ref:`NetworkInterface.errorOccurred() <signal_NetworkInterface_errorOccurred>`
* :ref:`NetworkInterface.routesDataChanged() <signal_NetworkInterface_routesDataChanged>`
* :ref:`ConfigurationObject.itemsDataChanged() <signal_ConfigurationObject_itemsDataChanged>`
* :ref:`Object.completed() <signal_Object_completed>`

Expand All @@ -90,6 +95,7 @@ Enumerations
.. hlist::
:columns: 1

* :ref:`AuthenticationType <enum_MobileNetworkInterface_AuthenticationType>`
* :ref:`State <enum_MobileNetworkInterface_State>`
* :ref:`NetworkInterface.DhcpClientIdentifier <enum_NetworkInterface_DhcpClientIdentifier>`
* :ref:`NetworkInterface.Error <enum_NetworkInterface_Error>`
Expand Down Expand Up @@ -165,6 +171,59 @@ This property holds an internal :ref:`ConfigurationItem <object_ConfigurationIte
:**› Attributes**: Readonly


.. _property_MobileNetworkInterface_authenticationType:

.. _signal_MobileNetworkInterface_authenticationTypeChanged:

.. index::
single: authenticationType

authenticationType
++++++++++++++++++



This property was introduced in InCore 2.3.

:**› Type**: :ref:`AuthenticationType <enum_MobileNetworkInterface_AuthenticationType>`
:**› Default**: :ref:`MobileNetworkInterface.UnknownAuthentication <enumitem_MobileNetworkInterface_UnknownAuthentication>`
:**› Signal**: authenticationTypeChanged()
:**› Attributes**: Writable


.. _property_MobileNetworkInterface_authenticationTypeItem:

.. index::
single: authenticationTypeItem

authenticationTypeItem
++++++++++++++++++++++

This property holds an internal :ref:`ConfigurationItem <object_ConfigurationItem>` instance for the :ref:`authenticationType <property_MobileNetworkInterface_authenticationType>` property.

:**› Type**: :ref:`ConfigurationItem <object_ConfigurationItem>`
:**› Attributes**: Readonly


.. _property_MobileNetworkInterface_deviceManufacturer:

.. _signal_MobileNetworkInterface_deviceManufacturerChanged:

.. index::
single: deviceManufacturer

deviceManufacturer
++++++++++++++++++

This property holds the manufacturer name of the modem device.

This property was introduced in InCore 2.3.

:**› Type**: String
:**› Signal**: deviceManufacturerChanged()
:**› Attributes**: Readonly


.. _property_MobileNetworkInterface_deviceModel:

.. _signal_MobileNetworkInterface_deviceModelChanged:
Expand Down Expand Up @@ -471,6 +530,74 @@ Enumerations
************


.. _enum_MobileNetworkInterface_AuthenticationType:

.. index::
single: AuthenticationType

AuthenticationType
++++++++++++++++++



.. index::
single: MobileNetworkInterface.UnknownAuthentication
.. index::
single: MobileNetworkInterface.NoAuthentication
.. index::
single: MobileNetworkInterface.PAP
.. index::
single: MobileNetworkInterface.CHAP
.. index::
single: MobileNetworkInterface.MSCHAP
.. index::
single: MobileNetworkInterface.MSCHAPv2
.. index::
single: MobileNetworkInterface.EAP
.. list-table::
:widths: auto
:header-rows: 1

* - Name
- Value
- Description

.. _enumitem_MobileNetworkInterface_UnknownAuthentication:
* - ``MobileNetworkInterface.UnknownAuthentication``
- ``0``
-

.. _enumitem_MobileNetworkInterface_NoAuthentication:
* - ``MobileNetworkInterface.NoAuthentication``
- ``1``
-

.. _enumitem_MobileNetworkInterface_PAP:
* - ``MobileNetworkInterface.PAP``
- ``2``
-

.. _enumitem_MobileNetworkInterface_CHAP:
* - ``MobileNetworkInterface.CHAP``
- ``3``
-

.. _enumitem_MobileNetworkInterface_MSCHAP:
* - ``MobileNetworkInterface.MSCHAP``
- ``4``
-

.. _enumitem_MobileNetworkInterface_MSCHAPv2:
* - ``MobileNetworkInterface.MSCHAPv2``
- ``5``
-

.. _enumitem_MobileNetworkInterface_EAP:
* - ``MobileNetworkInterface.EAP``
- ``6``
-


.. _enum_MobileNetworkInterface_State:

.. index::
Expand Down
33 changes: 33 additions & 0 deletions InCore.Foundation/NetworkInterface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Properties
* :ref:`hardwareName <property_NetworkInterface_hardwareName>`
* :ref:`networkAddresses <property_NetworkInterface_networkAddresses>`
* :ref:`operationalState <property_NetworkInterface_operationalState>`
* :ref:`routes <property_NetworkInterface_routes>`
* :ref:`setupState <property_NetworkInterface_setupState>`
* :ref:`useRoutes <property_NetworkInterface_useRoutes>`
* :ref:`useRoutesItem <property_NetworkInterface_useRoutesItem>`
Expand All @@ -57,6 +58,7 @@ Signals
:columns: 1

* :ref:`errorOccurred() <signal_NetworkInterface_errorOccurred>`
* :ref:`routesDataChanged() <signal_NetworkInterface_routesDataChanged>`
* :ref:`ConfigurationObject.itemsDataChanged() <signal_ConfigurationObject_itemsDataChanged>`
* :ref:`Object.completed() <signal_Object_completed>`

Expand Down Expand Up @@ -243,6 +245,25 @@ This property holds the operational state of the network interface. The most com
:**› Attributes**: Readonly


.. _property_NetworkInterface_routes:

.. _signal_NetworkInterface_routesChanged:

.. index::
single: routes

routes
++++++

This property holds a list of :ref:`NetworkRoute <object_NetworkRoute>` objects which hold additional network routes to configure.

This property was introduced in InCore 2.3.

:**› Type**: :ref:`List <object_List>`\<:ref:`NetworkRoute <object_NetworkRoute>`>
:**› Signal**: routesChanged()
:**› Attributes**: Readonly


.. _property_NetworkInterface_setupState:

.. _signal_NetworkInterface_setupStateChanged:
Expand Down Expand Up @@ -307,6 +328,18 @@ errorOccurred()
This signal is emitted whenever an error has occurred, regardless of whether the :ref:`error <property_NetworkInterface_error>` property has changed or not. In contrast to the change notification signal of the :ref:`error <property_NetworkInterface_error>` property this signal is also emitted several times if a certain error occurs several times in succession.



.. _signal_NetworkInterface_routesDataChanged:

.. index::
single: routesDataChanged

routesDataChanged(SignedInteger index)
++++++++++++++++++++++++++++++++++++++

This signal is emitted whenever the :ref:`List.dataChanged() <signal_List_dataChanged>` signal is emitted, i.e. the item at ``index`` in the :ref:`routes <property_NetworkInterface_routes>` list itself emitted the dataChanged() signal.


Enumerations
************

Expand Down

0 comments on commit 8379835

Please sign in to comment.