summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarko Saukko <marko.saukko@gmail.com>2009-10-20 09:25:38 +0300
committerDenis Kenzior <denkenz@gmail.com>2009-10-21 19:04:45 -0500
commit1b13ce308f0aabefa2da63ac77c6035948d6b4d1 (patch)
treeb0c8af4153ee7908a044d0ace8edbdad4b06dec7
parentf726596860dcc3244008a0588812a3f81b0651f8 (diff)
downloadofono-1b13ce308f0aabefa2da63ac77c6035948d6b4d1.tar.gz
Doc: Update modem api
Add SetProperty and Powered property to modem-api.txt document.
-rw-r--r--doc/modem-api.txt17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/modem-api.txt b/doc/modem-api.txt
index 3058880b..06a4ada8 100644
--- a/doc/modem-api.txt
+++ b/doc/modem-api.txt
@@ -12,12 +12,27 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
+ void SetProperty(string property, 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.DoesNotExist
+
Signals PropertyChanged(string name, variant value)
This signal indicates a changed value of the given
property.
-Properties string Manufacturer [readonly, optional]
+Properties boolean Powered [readwrite]
+
+ Boolean representing the power state of the modem
+ device.
+
+ string Manufacturer [readonly, optional]
String representing the manufacturer of the modem
device.