doc: Add Siri API

diff --git a/Makefile.am b/Makefile.am
old mode 100644 (file)
new mode 100755 (executable)
index 513ee14..b89352e
--- 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 (file)
index 0000000..ed0e5ea
--- /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"