summaryrefslogtreecommitdiff
path: root/doc/technology-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2011-12-09 13:16:19 +0200
committerMarcel Holtmann <marcel@holtmann.org>2011-12-09 13:16:19 +0200
commitc864c7e1b97b3caef7b624874c707e690db4e833 (patch)
tree4a8aa40fc5816bbf74115fd013fc27f6e0e67cf1 /doc/technology-api.txt
parent06c5bd7d72a88d54ee9efd5bf37ffaabd91b1562 (diff)
downloadconnman-c864c7e1b97b3caef7b624874c707e690db4e833.tar.gz
connman-c864c7e1b97b3caef7b624874c707e690db4e833.tar.bz2
connman-c864c7e1b97b3caef7b624874c707e690db4e833.zip
doc: Update properties and methods for technology interface
Diffstat (limited to 'doc/technology-api.txt')
-rw-r--r--doc/technology-api.txt38
1 files changed, 35 insertions, 3 deletions
diff --git a/doc/technology-api.txt b/doc/technology-api.txt
index 12b421ca..851d5ea6 100644
--- a/doc/technology-api.txt
+++ b/doc/technology-api.txt
@@ -12,16 +12,48 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
+ void SetProperty(string name, variant value)
+
+ Changes the value of the specified property. Only
+ properties that are listed as read-write are
+ changeable. On success a PropertyChanged signal
+ will be emitted.
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.InvalidProperty
+
+ void Scan()
+
+ Trigger a scan for this specific technology. The
+ method call will return when a scan has been
+ finished and results are available.
+
+ Results will be signaled via the ServicesAdded (or
+ also ServicesRemoved) signal from the manager
+ interface.
+
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
-Properties string State [readonly]
+Properties boolean Powered [readwrite]
+
+ Boolean representing the power state of the
+ technology. False means that the technology is
+ off (and is available RF-Killed) while True means
+ that the technology is enabled.
+
+ boolean Connected [readonly]
+
+ Boolean representing if a technolgy is connected.
- The technology state information.
+ This is just a convience property for allowing the
+ UI to easily show if this technolgy has an active
+ connection or not.
- Valid states are "offline", "enabled" and "connected".
+ If this property is True it means that at least one
+ service of this technology is in ready state.
string Name [readonly]