summaryrefslogtreecommitdiff
path: root/doc/ims-api.txt
blob: c4f5ffad38871818d8efc5eacd23d3dd416a5c12 (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
IpMultimediaSystem Hierarchy
============================

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

Methods		dict GetProperties()

			Returns all IpMultimediaSystem configuration 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.InProgress
					 [service].Error.InvalidArguments
					 [service].Error.Failed

		void Register()

			Attempts to register to IMS. A successful method return
			indicates that the registration process could be
			initiated successfully. The actual registration state
			will be reflected by the 'Registered' property.

			Possible Errors: [service].Error.InProgress
					 [service].Error.NotImplemented

		void Unregister()

			Attempts to unregister from IMS. A successful method
			return indicates that the unregistration process could
			be initiated successfully. The actual unregistration
			state will be reflected by the 'Registered' property.

			Possible Errors: [service].Error.InProgress
					 [service].Error.NotImplemented

Signals		PropertyChanged(string property, variant value)

			This signal indicates a changed value of the given
			property.

Properties	boolean Registered [readonly]

			Contains the current IMS registration state.

		boolean VoiceCapable [readonly, optional]

			Boolean representing whether voice call transfer over
			RTP (IMS) is available.

		boolean SmsCapable [readonly, optional]

			Boolean representing whether SMS-over-IMS is available.