summaryrefslogtreecommitdiffstats
path: root/doc/message-waiting-api.txt
blob: 83c030b401ce6ebd22ab10d9127842b912b08113 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
MessageWaiting hierarchy
===============

Service		org.ofono
Interface	org.ofono.MessageWaiting
Object path	[variable prefix]/{modem0,modem1,...}

Methods		dict GetProperties()

			Returns properties for the MessageWaiting object. See
			the properties section for available properties.

		void SetProperty(string property, 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.InvalidFormat
					 [service].Error.NotSupported
					 [service].Error.SimNotReady
					 [service].Error.Failed

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	boolean VoicemailWaiting [readonly]

			Boolean representing whether there is a voicemail
			message waiting for the user on the voicemail server.

		byte VoicemailMessageCount [readonly]

			The total number of voicemail messages waiting.
			Values of 255 indicate 255 messages or more.  Value
			0 when VoicemailWaiting is true indicates that the
			mailbox is not empty and the message count is not
			known.

		string VoicemailMailboxNumber [readwrite]

			String containing the dialing number to be used for
			voice mailbox access.  This number is generally
			pre-provisioned on the SIM.  However, the user can
			change this number if required.