mirror of git://git.sysmocom.de/ofono
ctm: add documentation for TextTelephony interface
This commit is contained in:
parent
df2984a724
commit
f41d00f332
|
@ -356,7 +356,7 @@ doc_files = doc/overview.txt doc/ofono-paper.txt \
|
||||||
doc/message-api.txt doc/message-waiting-api.txt \
|
doc/message-api.txt doc/message-waiting-api.txt \
|
||||||
doc/phonebook-api.txt doc/radio-settings-api.txt \
|
doc/phonebook-api.txt doc/radio-settings-api.txt \
|
||||||
doc/sim-api.txt doc/stk-api.txt \
|
doc/sim-api.txt doc/stk-api.txt \
|
||||||
doc/audio-settings-api.txt
|
doc/audio-settings-api.txt doc/text-telephony-api.txt
|
||||||
|
|
||||||
|
|
||||||
test_scripts = test/backtrace \
|
test_scripts = test/backtrace \
|
||||||
|
|
|
@ -0,0 +1,39 @@
|
||||||
|
Text Telephony hierarchy
|
||||||
|
========================
|
||||||
|
|
||||||
|
Service org.ofono
|
||||||
|
Interface org.ofono.TextTelephony
|
||||||
|
Object path [variable prefix]/{modem0,modem1,...}
|
||||||
|
|
||||||
|
Methods dict GetProperties()
|
||||||
|
|
||||||
|
Returns all Text Telephony properties. See the
|
||||||
|
properties section for available properties.
|
||||||
|
|
||||||
|
Possible Errors: [service].Error.InProgress
|
||||||
|
[service].Error.Failed
|
||||||
|
|
||||||
|
void SetProperty(string name, variant value)
|
||||||
|
|
||||||
|
Changes the value of the specified property. Only
|
||||||
|
properties that are listed as read-write are
|
||||||
|
changeable. On success a PropertyChanged signal
|
||||||
|
will be emitted.
|
||||||
|
|
||||||
|
Possible Errors: [service].Error.InvalidArguments
|
||||||
|
[service].Error.InProgress
|
||||||
|
[service].Error.Failed
|
||||||
|
|
||||||
|
Signals PropertyChanged(string property, variant value)
|
||||||
|
|
||||||
|
This signal indicates a changed value of the given
|
||||||
|
property.
|
||||||
|
|
||||||
|
Properties boolean Powered [readwrite]
|
||||||
|
|
||||||
|
This property will enable or disable the text
|
||||||
|
telephony feature in the modem.
|
||||||
|
|
||||||
|
Text telephony (TTY), also known as Cellular Text Modem
|
||||||
|
(CTM), is a feature present in some modems that allow
|
||||||
|
them to be used by hearing impaired people.
|
Loading…
Reference in New Issue