From c864c7e1b97b3caef7b624874c707e690db4e833 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Fri, 9 Dec 2011 13:16:19 +0200 Subject: [PATCH] doc: Update properties and methods for technology interface --- doc/technology-api.txt | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/doc/technology-api.txt b/doc/technology-api.txt index 12b421c..851d5ea 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] -- 2.7.4