From e9cee29cd4d32db34db2e55df53f6b98b4fc9b70 Mon Sep 17 00:00:00 2001 From: Mikel Astiz Date: Wed, 12 Oct 2011 14:35:25 +0200 Subject: doc: Add initial Handsfree API documentation These basic features have already been implemented. --- doc/handsfree-api.txt | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 doc/handsfree-api.txt (limited to 'doc') diff --git a/doc/handsfree-api.txt b/doc/handsfree-api.txt new file mode 100644 index 00000000..4b2b156b --- /dev/null +++ b/doc/handsfree-api.txt @@ -0,0 +1,30 @@ +Handsfree hierarchy +=================== + +Service org.ofono +Interface org.ofono.Handsfree +Object path [variable prefix]/{modem0,modem1,...} + +Methods dict GetProperties() + + Returns properties for the Handsfree Interface. See the + properties section for available properties. + + void SetProperty(string property, variant value) + + Changes the value of the specified property. Only + properties that are listed as readwrite are + changeable. On success a PropertyChanged signal + will be emitted. + + Possible Errors: [service].Error.InProgress + [service].Error.InvalidArguments + +Signals PropertyChanged(string property, variant value) + + Signal is emitted whenever a property has changed. + The new value is passed as the signal argument. + +Properties boolean InbandRinging [readonly] + + Boolean representing whether inband ringing is enabled. -- cgit v1.2.3