summaryrefslogtreecommitdiffstats
path: root/doc/messagemanager-api.txt
blob: 43c4d077923a6fdf2f56444e78a3405182936ca4 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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.InProgress
					 [service].Error.NotImplemented

		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.InProgress
					 [service].Error.NotImplemented
					 [service].Error.InvalidArguments
					 [service].Error.InvalidFormat
					 [service].Error.Failed

		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.

			Possible Errors: [service].Error.InvalidArguments
					 [service].Error.InvalidFormat
					 [service].Error.Failed

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.

		string Alphabet

			Contains the alphabet setting for outgoing SMSs.
			Possible values are:

				"default" - Default GSM alphabet
				"turkish" - Turkish alphabet
				"spanish" - Spanish alphabet
				"portuguese" - Portuguese alphabet

			The standard, language-specific alphabets are defined
			in 3GPP TS23.038, Annex A.  By default, oFono uses
			the "default" setting.