sysmocom
/
ofono
mirror of git://git.sysmocom.de/ofono
11
0
Fork 0
Code Issues Releases Activity

doc: Refactor the manager API and its modem object handling

This commit is contained in:
Marcel Holtmann 2010-09-08 21:39:50 +02:00
parent 3cf9747a0b
commit ae05cd5a51
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/manager-api.txt
View File

@ -5,18 +5,26 @@ Service org.ofono
Interface org.ofono.Manager
Object path /
Methods dict GetProperties()
Methods array{object,dict} GetModems()
Returns all global system properties. See the
properties section for available properties.
Get an array of modem objects and properties
that represents the currently attached modems.
This method call should only be used once when an
application starts up. Further modem additions
and removal shall be monitored via ModemAdded and
ModemRemoved signals.
Possible Errors: [service].Error.InvalidArguments
Signals PropertyChanged(string property, variant value)
Signals ModemAdded(object path, dict properties)
This signal indicates a changed value of the given
property.
Signal that is sent when a new modem is added. It
contains the object path of new modem and also its
properties.
Properties array{object} Modems [readonly]
ModemRemoved(object path)
List of all modem objects in the system.
Signal that is sent when a modem has been removed.
The object path is no longer accessible after this
signal and only emitted for reference.