diff options
Diffstat (limited to 'doc/message-api.txt')
-rw-r--r-- | doc/message-api.txt | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/message-api.txt b/doc/message-api.txt new file mode 100644 index 00000000..693a111b --- /dev/null +++ b/doc/message-api.txt @@ -0,0 +1,66 @@ +Message Manager hierarchy +=============== + +Service org.ofono +Interface org.ofono.MessageManager +Object path [variable prefix]/{modem0,modem1,...} + +Methods dict GetProperties() + + Returns properties for the modem object. See + the properties section for available properties. + + Possible Errors: [service].Error.InvalidArguments + + 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.DoesNotExist + + void SendMessage(string to, string text) + + Send the message in text to the number in to. + +Signals PropertyChanged(string name, variant value) + + This signal indicates a changed value of the given + property. + + ImmediateMessage(string message, dict info) + + New immediate (class 0) SMS received. Info has Sender, + LocalSentTime, and SentTime information. Sender + address is given in string format. LocalSentTime and + SentTime are given in string form using ISO8601 format. + + IncomingMessage(string message, dict info) + + New incoming text SMS received. Info has Sender, + LocalSentTime, and SentTime information. + +Properties string ServiceCenterAddress + + Contains the number of the SMS service center. + + boolean UseDeliveryReports + + This property controls whether SMS Status Reports, + sometimes better known as Delivery Reports are to be + used. If enabled, all outgoing SMS messages will be + flagged to request a status report from the SMSC. + + string Bearer + + Contains the bearer to use for SMS messages. Possible + values are: + "cs-only" - Circuit Switched only + "ps-only" - Packet Domain only + "cs-preferred" - Use PS if CS is unavailable + "ps-preferred" - Use CS if PS is unavailable + + By default oFono uses "cs-preferred" setting. |