From 081f595c2a92c0332c240481f463109b924474d0 Mon Sep 17 00:00:00 2001 From: Denis Kenzior Date: Mon, 28 Oct 2019 21:23:05 -0500 Subject: [PATCH] doc: extra clarifications for properties --- doc/network-api.txt | 12 +++++++++--- doc/station-api.txt | 14 ++++++++++++-- 2 files changed, 21 insertions(+), 5 deletions(-) diff --git a/doc/network-api.txt b/doc/network-api.txt index ca479118..7d059f8e 100644 --- a/doc/network-api.txt +++ b/doc/network-api.txt @@ -26,12 +26,18 @@ Properties string Name [readonly] boolean Connected [readonly] - Reflects whether the device is connected to this - network. + Reflects whether the network is currently connected + or actively being connected to. This is meant for + the application to show a check-box or some other + means to notify the user which network is currently + selected. Refer to net.connman.iwd.Station + documentation for more details if you need to know + the actual state of the connection (i.e connecting, + connected, etc) object Device [readonly] - The object path of the device the network belongs to. + The object path of the station the network belongs to. string Type [readonly] diff --git a/doc/station-api.txt b/doc/station-api.txt index 821d0a59..f9399ce2 100644 --- a/doc/station-api.txt +++ b/doc/station-api.txt @@ -147,11 +147,21 @@ Properties string State [readonly] net.connman.iwd.Network object representing the network the device is currently connected to or to - which a connection is in progress. + which a connection is in progress. This property + will be updated with the object path of the Network + object as soon as the connection process is initiated, + and will remain for as long as the connection is in + progress, completed and the network has not been + disconnected. + + On disconnection this property becomes invalid and + disappears from the property list. Refer to the + State property documentation if you need to track + the actual state of the connection. boolean Scanning [readonly] - Reflects whether the device is currently scanning + Reflects whether the station is currently scanning for networks. net.connman.iwd.Network objects are updated when this property goes from true to false.