summaryrefslogtreecommitdiffstats
path: root/doc/call-settings-api.txt
blob: de9f314f85b388fb026492d4fd17cb22d6690c0e (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
Call Settings hierarchy
===============
Service		org.ofono
Interface	org.ofono.CallSettings
Object path	[variable prefix]/{modem0,modem1,...}

Methods		dict GetProperties()

			Contains the properties for this object.

			Possible Errors: [service].Error.InProgress

		void SetProperty(string property, variant value)

			Sets the given property value to that specified in
			call parameter.

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

Signals		PropertyChanged(string property, variant value)

			Signal is emitted whenever a property has changed.
			The new value is passed as the signal argument.

Properties	string CallingLinePresentation [readonly]

			Contains the value of the calling line identification
			presentation property.  The value indicates
			the state of the CLIP supplementary service in the
			network.  If enabled, the network will provide
			the number of the calling party for incoming calls.
			Possible values are:
				"disabled",
				"enabled",
				"unknown"

		string CalledLinePresentation [readonly]

			Contains the value of the called line identification
			presentation property.  The value indicates the state
			of the CDIP supplementary service in the network.  If
			enabled, when receiving a call the network will provide
			the subscriber's line dialed.  This is useful for
			subscribers which have a multiple line service with
			their network provider and would like to know what
			line the call is coming in on.

			Possible values are:
				"disabled",
				"enabled",
				"unknown"

		string CallingNamePresentation [readonly]

			Contains the value of the calling name identification
			presentation property.  The value indicates
			the state of the CNAP supplementary service in the
			network.  If enabled, the network will provide
			the name of the calling party for incoming calls.
			Possible values are:
				"disabled",
				"enabled",
				"unknown"

		string ConnectedLinePresentation [readonly]

			Contains the value of the connected line identification
			presentation property.  The value indicates the state
			of the COLP supplementary service in the network.  If
			enabled, the network will attempt to provide the number
			of the connected party for outgoing calls.  Possible
			values are:
				"disabled",
				"enabled",
				"unknown"

		string ConnectedLineRestriction [readonly]

			Contains the value of the connected line identification
			restriction property. The value indicates the state of
			the COLR supplementary service in the network.  If
			enabled, the network will withhold subscriber number
			information from the calling party on incoming calls.
			The possible values are:
				"disabled",
				"enabled",
				"unknown"

			Not all modems can report this information.

		string CallingLineRestriction [readonly]

			Contains the value of the calling line identification
			restriction property.  The value indicates the state of
			the CLIR supplementary service in the network.  If
			enabled permanently or temporarily the restriction is
			in effect, the subscriber number information will be
			withheld from the called party on outgoing calls
			unless the value is overriden using the HideCallerId
			property or on a per call basis.

			The possible values are:
				"disabled"
				"permanent"
				"unknown",
				"on",
				"off"

		string HideCallerId [readwrite]

			Sets whether the ID of the caller will should be
			provided or withheld for outgoing calls.  This setting
			is also modified by the status of the CLIR supplementary
			service in the network (see the CallingLineRestriction
			property).  The three possible values are:
				"default" - Uses the network setting
				"enabled" - CLIR invoked, caller id is withheld
				"disabled" - CLIR suppressed, caller id is
						provided

			This setting can also be changed on a per-call basis,
			see the VoiceCallManager Dial method documentation.

		string VoiceCallWaiting [readwrite]

			Contains the call waiting status for Voice calls.
			If enabled, the call waiting status will be
			presented to the subscriber for voice calls.
			Possible values are:
				"disabled",
				"enabled",