diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2010-09-08 21:39:50 +0200 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2010-09-08 21:39:50 +0200 |
| commit | ae05cd5a51dbb7ee44217657375e38668f622209 (patch) | |
| tree | 268f9b2413f00d788d08fbdbf6a7ec1a1e596598 /doc/manager-api.txt | |
| parent | 3cf9747a0b2b0c534e69b89aee6c489d4f672535 (diff) | |
| download | ofono-ae05cd5a51dbb7ee44217657375e38668f622209.tar.bz2 | |
doc: Refactor the manager API and its modem object handling
Diffstat (limited to 'doc/manager-api.txt')
| -rw-r--r-- | doc/manager-api.txt | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt index c4a153de..c2312456 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -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. |