mirror of
https://git.kernel.org/pub/scm/network/wireless/iwd.git
synced 2024-12-22 13:02:44 +01:00
doc: Document new KnownNetwork API, remove old
This commit is contained in:
parent
00a643f093
commit
7d3656858f
30
doc/knownnetwork-api.txt
Normal file
30
doc/knownnetwork-api.txt
Normal file
@ -0,0 +1,30 @@
|
||||
KnownNetwork hierarchy
|
||||
======================
|
||||
|
||||
Service net.connman.iwd
|
||||
Interface net.connman.iwd.KnownNetwork [Experimental]
|
||||
Object path /Xxx
|
||||
|
||||
Methods void Forget()
|
||||
|
||||
Removes the network from the 'known networks' list and
|
||||
removes any associated configuration data. If the
|
||||
network is currently connected, then it is immediately
|
||||
disconnected.
|
||||
|
||||
Properties string Name [readonly]
|
||||
|
||||
Contains the Name (SSID) of the network
|
||||
|
||||
string Type [readonly]
|
||||
|
||||
Contains the type of the network. Possible
|
||||
types are "open", "psk", "8021x" (EAP)
|
||||
|
||||
string LastConnectedTime [readonly, optional]
|
||||
|
||||
Contains the last time this network has been
|
||||
successfully connected to. The time is given as a
|
||||
ISO 8601-formatted string. If the network is known
|
||||
but has never been successfully connected to,
|
||||
this property is not visible.
|
@ -1,42 +0,0 @@
|
||||
KnownNetworks hierarchy
|
||||
======================
|
||||
|
||||
Service net.connman.iwd
|
||||
Interface net.connman.iwd.KnownNetworks
|
||||
Object path /
|
||||
|
||||
Methods aa{sv} ListKnownNetworks()
|
||||
|
||||
Returns an array of known networks. Each array
|
||||
contains a dictionary of string-value pairs. The
|
||||
type of the value can be determined from the string
|
||||
type. The following types are supported:
|
||||
|
||||
string Name
|
||||
|
||||
Contains the Name (SSID) of the network
|
||||
|
||||
string Type
|
||||
|
||||
Contains the type of the network. Possible
|
||||
types are "open", "psk", "8021x" (EAP)
|
||||
|
||||
string LastConnectedTime [optional]
|
||||
|
||||
Contains the last time this network has been
|
||||
connected to. The time is given as a string
|
||||
in ISO 8601 format. If the network is known,
|
||||
but has never been successfully connected to,
|
||||
this attribute is omitted.
|
||||
|
||||
string LastSeenTime [optional]
|
||||
|
||||
Contains the last time this network has been
|
||||
seen in scan results.
|
||||
|
||||
void ForgetNetwork(string name, string type)
|
||||
|
||||
Removes the network from the 'known networks' list and
|
||||
removes any associated meta-data. If the network is
|
||||
currently connected, then it is automatically
|
||||
disconnected.
|
Loading…
Reference in New Issue
Block a user