doc: Add initial Handsfree API documentation

These basic features have already been implemented.
This commit is contained in:
Mikel Astiz 2011-10-12 14:35:25 +02:00 committed by Denis Kenzior
parent eb361d874c
commit e9cee29cd4
1 changed files with 30 additions and 0 deletions

30
doc/handsfree-api.txt Normal file
View File

@ -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.