Add doc for emulator manager interface
---
 doc/emulatormanager-api.txt |   42 ++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 42 insertions(+), 0 deletions(-)
 create mode 100644 doc/emulatormanager-api.txt

diff --git a/doc/emulatormanager-api.txt b/doc/emulatormanager-api.txt
new file mode 100644
index 0000000..f0966c3
--- /dev/null
+++ b/doc/emulatormanager-api.txt
@@ -0,0 +1,42 @@
+EmulatorManager hierarchy
+==========================
+
+Service                org.ofono
+Interface      org.ofono.EmulatorManager
+Object path    [variable prefix]/{modem0,modem1,...}
+
+Methods                dict GetProperties()
+
+                       Returns all global system properties. See the
+                       properties section for available properties.
+
+               object Create(string type, int fd)
+
+                       Creates an emulator with given type and file
+                       descriptor. Returns the object path of the newly
+                       created emulator.
+
+                       The defined types are:
+                               "DUN" - Dial-Up Network.
+                               "HFP AG" - Bluetooth Hands-free gateway role.
+                                       It talks to the HFP unit role client
+                                       through Bluetooth connection.
+                               "SPP" - Serial Port Profile.
+
+                       Possible Errors: [service].Error.InvalidArguments
+                                        [service].Error.Failed
+
+               void DestroyAll()
+
+                       Releases all emulators.
+
+Signals                PropertyChanged(string property, variant value)
+
+                       Signal is emitted whenever a property has changed. The
+                       new value is passed as the signal argument.
+
+Properties     array{object} Emulators [readonly]
+
+                       Returns the list of emulators currently present in the
+                       system. If there are no emulators, the list will be
+                       empty.
-- 
1.6.3.3

_______________________________________________
ofono mailing list
[email protected]
http://lists.ofono.org/listinfo/ofono

Reply via email to