build: Whitespace & keep vim happy
[platform/upstream/ofono.git] / doc / message-api.txt
1 Message hierarchy
2 ===============
3
4 Service         org.ofono
5 Interface       org.ofono.Message
6 Object path     [variable prefix]/{modem0,modem1,...}/{message_01,...}
7
8 Methods         dict GetProperties()
9
10                         Returns properties for the message object. See
11                         the properties section for available properties.
12
13                 void Cancel()
14
15                         Cancel a message that was previously sent. Only
16                         messages that are waiting on queue can be cancelled and
17                         it's not possible to cancel messages that already had
18                         some parts sent.
19
20                         Possible Errors: [service].Error.AccessDenied
21
22 Signals         PropertyChanged(string name, variant value)
23
24                         This signal indicates a changed value of the given
25                         property.
26
27 Properties      string State
28
29                         Contains the state of the message object.  Possible
30                         values are:
31                                 "pending",
32                                 "sent",
33                                 "failed"