summaryrefslogtreecommitdiffstats
path: root/doc/message-api.txt
diff options
context:
space:
mode:
authorFaiyaz Baxamusa <faiyaz.baxamusa@nokia.com>2011-01-20 13:42:36 -0800
committerDenis Kenzior <denkenz@gmail.com>2011-01-20 14:57:52 -0600
commit2da4496e1e6c0a6476db2056fd54379c1e545199 (patch)
tree89bb0da5509a738b57863985a7f4ac19451cebde /doc/message-api.txt
parenta1868171a8ba70d928df30ad32768ca8e1a5c0b8 (diff)
downloadofono-2da4496e1e6c0a6476db2056fd54379c1e545199.tar.bz2
doc: Add messagemanager-api and change message-api
Diffstat (limited to 'doc/message-api.txt')
-rw-r--r--doc/message-api.txt89
1 files changed, 0 insertions, 89 deletions
diff --git a/doc/message-api.txt b/doc/message-api.txt
index f7ab22a0..1c68aee4 100644
--- a/doc/message-api.txt
+++ b/doc/message-api.txt
@@ -1,92 +1,3 @@
-Message Manager hierarchy
-===============
-
-Service org.ofono
-Interface org.ofono.MessageManager
-Object path [variable prefix]/{modem0,modem1,...}
-
-Methods dict GetProperties()
-
- Returns properties for the manager object. See
- the properties section for available properties.
-
- Possible Errors: [service].Error.InvalidArguments
-
- array{object,dict} GetMessages()
-
- Get an array of message object paths and properties
- that represents the currently pending messages.
-
- This method call should only be used once when an
- application starts up. Further message additions
- and removal shall be monitored via MessageAdded and
- MessageRemoved signals.
-
- void SetProperty(string name, variant value)
-
- Changes the value of the specified property. Only
- properties that are listed as readwrite are
- changeable. On success a PropertyChanged signal
- will be emitted.
-
- Possible Errors: [service].Error.InvalidArguments
- [service].Error.DoesNotExist
-
- object SendMessage(string to, string text)
-
- Send the message in text to the number in to. If the
- message could be queued successfully, this method
- returns an object path to the created Message object.
-
-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.
-
- MessageAdded(object path, dict properties)
-
- This signal is emitted whenever a new Message object
- has been created.
-
- MessageRemoved(object path)
-
- This signal is emitted whenever a Message object
- has been removed, e.g. when it reaches a final state.
-
-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.
-
Message hierarchy
===============