[SMS D-Bus 04/19] sms: document the org.ofono.SmsMessage interface
From: Inaky Perez-Gonzalez <inaky.perez-gonzalez(a)intel.com>
---
doc/sms-api.txt | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
1 files changed, 47 insertions(+), 2 deletions(-)
diff --git a/doc/sms-api.txt b/doc/sms-api.txt
index 1fc32ac..2bf588f 100644
--- a/doc/sms-api.txt
+++ b/doc/sms-api.txt
@@ -22,9 +22,27 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
[service].Error.DoesNotExist
- void SendMessage(string to, string text)
+ object SendMessage(string to, string text)
- Send the message in text to the number in to.
+ Submit a message for delivery /
+ processing. oFono owns it from now on until
+ successful delivery, cancellation (by the
+ user) or cancellation (by oFono). User has to
+ keep a copy around as oFono only offers
+ persistence to satisfy its needs.
+
+ Returns the name of the D-Bus object that
+ represents said SMS Message.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ array{object} Messages()
+
+ Returns a list of SMS Messages that have been
+ submitted for delivery and that are still
+ pending.
+
+ FIXME: currently not implemented
Signals PropertyChanged(string name, variant value)
@@ -64,3 +82,30 @@ Properties string ServiceCenterAddress
"ps-preferred" - Use CS if PS is unavailable
By default oFono uses "cs-preferred" setting.
+
+
+SMS / Messaging interface
+=========================
+
+Service org.ofono
+Interface org.ofono.SmsMessage
+Object path [variable prefix]/{modem0,modem1...}/{message01,message02...}
+
+Methods dict GetProperties()
+
+ Returns a dictionary with the current
+ properties of a message.
+
+ void Cancel()
+
+ Cancels a pending message's delivery.
+
+Signals PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+Properties string State
+
+ Current transmission state {queued, wsr, done,
+ canceling, cancelled, failed, expired}
--
1.6.6.1