build: Whitespace & keep vim happy
[platform/upstream/ofono.git] / doc / message-waiting-api.txt
1 MessageWaiting hierarchy
2 ===============
3
4 Service         org.ofono
5 Interface       org.ofono.MessageWaiting
6 Object path     [variable prefix]/{modem0,modem1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns properties for the MessageWaiting object. See
11                         the properties section for available properties.
12
13                 void SetProperty(string property, variant value)
14
15                         Changes the value of the specified property. Only
16                         properties that are listed as readwrite are
17                         changeable. On success a PropertyChanged signal
18                         will be emitted.
19
20                         Possible Errors: [service].Error.InvalidArguments
21                                          [service].Error.InvalidFormat
22                                          [service].Error.NotSupported
23                                          [service].Error.SimNotReady
24                                          [service].Error.Failed
25
26 Signals         PropertyChanged(string name, variant value)
27
28                         This signal indicates a changed value of the given
29                         property.
30
31 Properties      boolean VoicemailWaiting [readonly]
32
33                         Boolean representing whether there is a voicemail
34                         message waiting for the user on the voicemail server.
35
36                 byte VoicemailMessageCount [readonly]
37
38                         The total number of voicemail messages waiting.
39                         Values of 255 indicate 255 messages or more.  Value
40                         0 when VoicemailWaiting is true indicates that the
41                         mailbox is not empty and the message count is not
42                         known.
43
44                 string VoicemailMailboxNumber [readwrite]
45
46                         String containing the dialing number to be used for
47                         voice mailbox access.  This number is generally
48                         pre-provisioned on the SIM.  However, the user can
49                         change this number if required.