summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKrzysztof Wilk <krzysztofx.wilk@intel.com>2013-12-16 17:52:37 +0000
committerDenis Kenzior <denkenz@gmail.com>2013-12-18 00:07:47 -0600
commit203409a25b545a8d3683062cfc04a9090224d5b0 (patch)
tree18750243f8973ce5096f4bb36fdd1c2b79cd159e
parentfc98985d149973d84c4331c881f5a21ef2c07d6f (diff)
doc: Add Siri API
-rwxr-xr-x[-rw-r--r--]Makefile.am2
-rw-r--r--doc/siri-api.txt41
2 files changed, 42 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index 513ee14b..b89352e0 100644..100755
--- a/Makefile.am
+++ b/Makefile.am
@@ -566,7 +566,7 @@ doc_files = doc/overview.txt doc/ofono-paper.txt doc/release-faq.txt \
doc/audio-settings-api.txt doc/text-telephony-api.txt \
doc/calypso-modem.txt doc/message-api.txt \
doc/location-reporting-api.txt \
- doc/certification.txt
+ doc/certification.txt doc/siri-api.txt
test_scripts = test/backtrace \
diff --git a/doc/siri-api.txt b/doc/siri-api.txt
new file mode 100644
index 00000000..ed0e5ea6
--- /dev/null
+++ b/doc/siri-api.txt
@@ -0,0 +1,41 @@
+Siri hierarchy [experimental]
+========================
+
+Service org.ofono
+Interface org.ofono.Siri
+Object path [variable prefix]/{modem0,modem1,...}
+
+Methods dict GetProperties()
+
+ Returns all Siri 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 Enabled [readonly]
+
+ This property indicates whether Siri is available on
+ the device.
+
+ string EyesFreeMode [readwrite]
+
+ This property indicates the state of Siri Eyes Free
+ Mode. The current possible values are: "enabled"
+ and "disabled"