diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-12-09 18:16:11 +0100 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-12-09 18:16:11 +0100 |
| commit | 1cfc371f117c273f8b633dd9e5b74dd95be7ecf1 (patch) | |
| tree | 580deeed98267702c5a2159507f3cbdd87d409dd /doc | |
| parent | 2ace7fcefb7b636cea2d91e7c4c102b4b7037373 (diff) | |
| download | connman-1cfc371f117c273f8b633dd9e5b74dd95be7ecf1.tar.gz connman-1cfc371f117c273f8b633dd9e5b74dd95be7ecf1.tar.bz2 connman-1cfc371f117c273f8b633dd9e5b74dd95be7ecf1.zip | |
Document generic Name, Available and Remember properties
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/network-api.txt | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/doc/network-api.txt b/doc/network-api.txt index be0cf39f..9bcdf122 100644 --- a/doc/network-api.txt +++ b/doc/network-api.txt @@ -27,10 +27,25 @@ Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given property. -Properties string WiFi.Name [readonly] +Properties string Name [readonly] - If the network type is WiFi, then this property is - present and contains the network name. + 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. + + boolean Available [readonly] + + Indicates that this network is in range and + ready to be used. + + The scanning process can change this property. + + boolean Remember [readwrite] + + Indicates that this network will be remembered. + + For manually created networks this is set by + default. array{byte} WiFi.SSID [readonly] |