X-Git-Url: https://vcs.maemo.org/git/?a=blobdiff_plain;f=doc%2Fnetwork-api.txt;h=fc4f3480c7aa2fdf9b30f69c8afb158c32ed5448;hb=2da467e698563d3be334a2bbf7038cb74e56c753;hp=be0cf39fed68a17c4a048fa03f32e2a963a0a5f3;hpb=2ace7fcefb7b636cea2d91e7c4c102b4b7037373;p=connman diff --git a/doc/network-api.txt b/doc/network-api.txt index be0cf39..fc4f348 100644 --- a/doc/network-api.txt +++ b/doc/network-api.txt @@ -27,16 +27,63 @@ Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given property. -Properties string WiFi.Name [readonly] +Properties string Address [readonly] - If the network type is WiFi, then this property is - present and contains the network name. + The address of the network. + + string Name [readonly] + + The pretty/long version of the network name. For + example in case of WiFi this should be the UTF-8 + valid version of the SSID. + + This property might not be available for every + network. For example hidden WiFi networks will + not include it. + + boolean Available [readonly] + + Indicates that this network is in range and + ready to be used. + + The scanning process can change this property. + + boolean Connected [readonly] + + Indicates that this network is currently connected. + + boolean Remember [readwrite] + + Indicates that this network will be remembered. + + For manually created networks this is set by + default. + + uint8 Strength [readonly] + + Indicates the signal strength of the network. This + is a normalized value between 0 and 100. + + object Device [readonly] + + The object path of the device this networks + belongs to. array{byte} WiFi.SSID [readonly] If the network type is WiFi, then this property is present and contains the binary SSID value. + string WiFi.Mode [readonly, readwrite] + + If the network type is WiFi, then this property is + present and contains the mode of the network. The + possible values are "managed" or "adhoc". + + For scanned networks this value is read only, but in + case the network was manually created it is also + changeable. + string WiFi.Security [readonly, readwrite] If the network type is WiFi, then this property is @@ -47,7 +94,7 @@ Properties string WiFi.Name [readonly] case the network was manually created it is also changeable. - Possible values are NONE, WPA and WPA2. + Possible values are "none", "wep", "wpa" and "wpa2". string WiFi.Passphrase [readwrite] @@ -55,5 +102,5 @@ Properties string WiFi.Name [readonly] requires, then this property is present and contains the passphrase in clear text. - For system using PolicyKit, the access to this value + For systems using PolicyKit, the access to this value will be protected by the security policy.