summaryrefslogtreecommitdiffstats
path: root/doc/cdma-voicecall-manager-api.txt
blob: 535909a970b9ac0969332e103d47b1dbe805e18e (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
CDMA VoiceCallManager hierarchy [experimental]
===============================

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

Methods		dict GetProperties()

			Returns properties for the VoiceCallManager Interface.
			See the properties section for available properties.

		void Dial(string number)

			Initiates a new outgoing call.  This is usually
			implemented using the ATD AT command.

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

		void Hangup()

			Hangup all active calls.

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

		void Answer()

			Answer the incoming call.  This only affects the
			incoming call.

		void SendFlash(string flash_string)

			Sends the flash string to the network.

		void SendTones(string tones)

			Sends the DTMF tones to the network.  The tones have
			a fixed duration.  Tones can be one of: '0' - '9',
			'*', '#', 'A', 'B', 'C', 'D'.  The last four are
			typically not used in normal circumstances.

		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.DoesNotExist

Signals		PropertyChanged(string property, variant value)

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

		DisconnectReason(string reason)

			This signal is emitted when the modem manager can
			provide extra information about why the call was
			released. The possible reason values are:
				"local" - The call was release due to local
						user action
				"remote" - Remote party released the call
				"network" - Network released the call, most
						likely due to low signal or
						other network failure

			Not all implementations are able to provide this
			information, so applications should treat the emission
			of this signal as optional. This signal will be
			emitted before the PropertyChanged signal.

Properties	string State [readonly]

			Contains the state of the current call.  The state
			can be one of:
				- "active" - The call is active
				- "dialing" - The call is being dialed
				- "alerting" - The remote party is being alerted
				- "incoming" - Incoming call in progress
				- "disconnected" - No call is connected

		boolean CallWaiting [readonly]

			Contains whether a call is waiting.

		string CallWaitingNumber [readonly, optional]

			Contains the call waiting number.

		string ToneDuration [readwrite]

			Contains the length of the DTMF tone duration.  The
			currently supported values are:
				"short",
				"long"

		string LineIdentification [readonly]

			Contains the Line Identification information returned
			by the network, if present. For incoming calls this is
			effectively the CLIP. For outgoing calls this attribute
			will hold the dialed number.

			Please note that after sending flash this property
			will be empty.

		string StartTime [readonly, optional]

			Contains the starting time of the call.  The time is
			stamped when the call enters the "active" state.
			Client applications can use this to infer somewhat
			reliable call duration information.

			Please note that after sending Flash, there will not be
			any StartTime property change for the Flash
			string/number.