blob: 3a6d1fd19b13390cc1bd9f877de4d76683915b14 [file] [log] [blame]
Ihab Awade63fadb2014-07-09 21:52:04 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Tyler Gunnef9f6f92014-09-12 22:16:17 -070017package android.telecom;
Ihab Awade63fadb2014-07-09 21:52:04 -070018
Andrew Leeda80c872015-04-15 14:09:50 -070019import android.annotation.SystemApi;
Ihab Awade63fadb2014-07-09 21:52:04 -070020import android.net.Uri;
Nancy Chen10798dc2014-08-08 14:00:25 -070021import android.os.Bundle;
Andrew Lee011728f2015-04-23 15:47:06 -070022import android.os.Handler;
Ihab Awade63fadb2014-07-09 21:52:04 -070023
Andrew Lee50aca232014-07-22 16:41:54 -070024import java.lang.String;
Ihab Awade63fadb2014-07-09 21:52:04 -070025import java.util.ArrayList;
Tyler Gunn071be6f2016-05-10 14:52:33 -070026import java.util.Arrays;
Ihab Awade63fadb2014-07-09 21:52:04 -070027import java.util.Collections;
28import java.util.List;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -070029import java.util.Map;
Ihab Awade63fadb2014-07-09 21:52:04 -070030import java.util.Objects;
Jay Shrauner229e3822014-08-15 09:23:07 -070031import java.util.concurrent.CopyOnWriteArrayList;
Ihab Awade63fadb2014-07-09 21:52:04 -070032
33/**
34 * Represents an ongoing phone call that the in-call app should present to the user.
35 */
36public final class Call {
37 /**
38 * The state of a {@code Call} when newly created.
39 */
40 public static final int STATE_NEW = 0;
41
42 /**
43 * The state of an outgoing {@code Call} when dialing the remote number, but not yet connected.
44 */
45 public static final int STATE_DIALING = 1;
46
47 /**
48 * The state of an incoming {@code Call} when ringing locally, but not yet connected.
49 */
50 public static final int STATE_RINGING = 2;
51
52 /**
53 * The state of a {@code Call} when in a holding state.
54 */
55 public static final int STATE_HOLDING = 3;
56
57 /**
58 * The state of a {@code Call} when actively supporting conversation.
59 */
60 public static final int STATE_ACTIVE = 4;
61
62 /**
63 * The state of a {@code Call} when no further voice or other communication is being
64 * transmitted, the remote side has been or will inevitably be informed that the {@code Call}
65 * is no longer active, and the local data transport has or inevitably will release resources
66 * associated with this {@code Call}.
67 */
68 public static final int STATE_DISCONNECTED = 7;
69
Nancy Chen5da0fd52014-07-08 14:16:17 -070070 /**
Santos Cordone3c507b2015-04-23 14:44:19 -070071 * The state of an outgoing {@code Call} when waiting on user to select a
72 * {@link PhoneAccount} through which to place the call.
Nancy Chen5da0fd52014-07-08 14:16:17 -070073 */
Santos Cordone3c507b2015-04-23 14:44:19 -070074 public static final int STATE_SELECT_PHONE_ACCOUNT = 8;
75
76 /**
77 * @hide
78 * @deprecated use STATE_SELECT_PHONE_ACCOUNT.
79 */
80 @Deprecated
81 @SystemApi
82 public static final int STATE_PRE_DIAL_WAIT = STATE_SELECT_PHONE_ACCOUNT;
Nancy Chen5da0fd52014-07-08 14:16:17 -070083
Nancy Chene20930f2014-08-07 16:17:21 -070084 /**
Nancy Chene9b7a8e2014-08-08 14:26:27 -070085 * The initial state of an outgoing {@code Call}.
86 * Common transitions are to {@link #STATE_DIALING} state for a successful call or
87 * {@link #STATE_DISCONNECTED} if it failed.
Nancy Chene20930f2014-08-07 16:17:21 -070088 */
89 public static final int STATE_CONNECTING = 9;
90
Nancy Chen513c8922014-09-17 14:47:20 -070091 /**
Tyler Gunn4afc6af2014-10-07 10:14:55 -070092 * The state of a {@code Call} when the user has initiated a disconnection of the call, but the
93 * call has not yet been disconnected by the underlying {@code ConnectionService}. The next
94 * state of the call is (potentially) {@link #STATE_DISCONNECTED}.
95 */
96 public static final int STATE_DISCONNECTING = 10;
97
98 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -070099 * The state of an external call which is in the process of being pulled from a remote device to
100 * the local device.
101 * <p>
102 * A call can only be in this state if the {@link Details#PROPERTY_IS_EXTERNAL_CALL} property
103 * and {@link Details#CAPABILITY_CAN_PULL_CALL} capability are set on the call.
104 * <p>
105 * An {@link InCallService} will only see this state if it has the
106 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true} in its
107 * manifest.
108 */
109 public static final int STATE_PULLING_CALL = 11;
110
111 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700112 * The key to retrieve the optional {@code PhoneAccount}s Telecom can bundle with its Call
113 * extras. Used to pass the phone accounts to display on the front end to the user in order to
114 * select phone accounts to (for example) place a call.
Nancy Chen513c8922014-09-17 14:47:20 -0700115 */
116 public static final String AVAILABLE_PHONE_ACCOUNTS = "selectPhoneAccountAccounts";
117
Ihab Awade63fadb2014-07-09 21:52:04 -0700118 public static class Details {
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800119
120 /** Call can currently be put on hold or unheld. */
121 public static final int CAPABILITY_HOLD = 0x00000001;
122
123 /** Call supports the hold feature. */
124 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
125
126 /**
127 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
128 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
129 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
130 * capability allows a merge button to be shown while the conference call is in the foreground
131 * of the in-call UI.
132 * <p>
133 * This is only intended for use by a {@link Conference}.
134 */
135 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
136
137 /**
138 * Calls within a conference can be swapped between foreground and background.
139 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
140 * <p>
141 * This is only intended for use by a {@link Conference}.
142 */
143 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
144
145 /**
146 * @hide
147 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700148 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800149
150 /** Call supports responding via text option. */
151 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
152
153 /** Call can be muted. */
154 public static final int CAPABILITY_MUTE = 0x00000040;
155
156 /**
157 * Call supports conference call management. This capability only applies to {@link Conference}
158 * calls which can have {@link Connection}s as children.
159 */
160 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
161
162 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700163 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800164 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700165 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800166
167 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700168 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800169 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700170 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800171
172 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700173 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800174 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700175 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700176 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800177
178 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700179 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800180 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700181 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
182
183 /**
184 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700185 */
186 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
187
188 /**
189 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700190 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700191 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700192 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800193
194 /**
195 * Call is able to be separated from its parent {@code Conference}, if any.
196 */
197 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
198
199 /**
200 * Call is able to be individually disconnected when in a {@code Conference}.
201 */
202 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
203
204 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500205 * Speed up audio setup for MT call.
206 * @hide
207 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700208 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
209
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700210 /**
211 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700212 * @hide
213 */
214 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
215
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700216 /**
217 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700218 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700219 */
220 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
221
Bryce Lee81901682015-08-28 16:38:02 -0700222 /**
223 * Call sends responses through connection.
224 * @hide
225 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800226 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
227
228 /**
229 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
230 * <p>
231 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
232 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
233 * downgraded from a video call back to a VideoState of
234 * {@link VideoProfile#STATE_AUDIO_ONLY}.
235 * <p>
236 * Intuitively, a call which can be downgraded to audio should also have local and remote
237 * video
238 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
239 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
240 */
241 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700242
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700243 /**
244 * When set for an external call, indicates that this {@code Call} can be pulled from a
245 * remote device to the current device.
246 * <p>
247 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
248 * <p>
249 * An {@link InCallService} will only see calls with this capability if it has the
250 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
251 * in its manifest.
252 * <p>
253 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700254 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700255 */
256 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
257
Tyler Gunnd11a3152015-03-18 13:09:14 -0700258 //******************************************************************************************
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700259 // Next CAPABILITY value: 0x01000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700260 //******************************************************************************************
261
262 /**
263 * Whether the call is currently a conference.
264 */
265 public static final int PROPERTY_CONFERENCE = 0x00000001;
266
267 /**
268 * Whether the call is a generic conference, where we do not know the precise state of
269 * participants in the conference (eg. on CDMA).
270 */
271 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
272
273 /**
274 * Whether the call is made while the device is in emergency callback mode.
275 */
276 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
277
278 /**
279 * Connection is using WIFI.
280 */
281 public static final int PROPERTY_WIFI = 0x00000008;
282
283 /**
284 * Call is using high definition audio.
285 */
286 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
287
Tony Maka68dcce2015-12-17 09:31:18 +0000288 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100289 * Whether the call is associated with the work profile.
290 */
291 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
292
293 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700294 * When set, indicates that this {@code Call} does not actually exist locally for the
295 * {@link ConnectionService}.
296 * <p>
297 * Consider, for example, a scenario where a user has two phones with the same phone number.
298 * When a user places a call on one device, the telephony stack can represent that call on
299 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700300 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700301 * <p>
302 * An {@link InCallService} will only see calls with this property if it has the
303 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
304 * in its manifest.
305 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700306 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700307 */
308 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
309
Brad Ebinger15847072016-05-18 11:08:36 -0700310 /**
311 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
312 */
313 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
314
Andrew Lee2378ea72015-04-29 14:38:11 -0700315 //******************************************************************************************
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700316 // Next PROPERTY value: 0x00000100
Tyler Gunnd11a3152015-03-18 13:09:14 -0700317 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800318
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800319 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700320 private final Uri mHandle;
321 private final int mHandlePresentation;
322 private final String mCallerDisplayName;
323 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700324 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700325 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700326 private final int mCallProperties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700327 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700328 private final long mConnectTimeMillis;
329 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700330 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700331 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700332 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700333 private final Bundle mIntentExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -0700334
335 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800336 * Whether the supplied capabilities supports the specified capability.
337 *
338 * @param capabilities A bit field of capabilities.
339 * @param capability The capability to check capabilities for.
340 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800341 */
342 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800343 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800344 }
345
346 /**
347 * Whether the capabilities of this {@code Details} supports the specified capability.
348 *
349 * @param capability The capability to check capabilities for.
350 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800351 */
352 public boolean can(int capability) {
353 return can(mCallCapabilities, capability);
354 }
355
356 /**
357 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
358 *
359 * @param capabilities A capability bit field.
360 * @return A human readable string representation.
361 */
362 public static String capabilitiesToString(int capabilities) {
363 StringBuilder builder = new StringBuilder();
364 builder.append("[Capabilities:");
365 if (can(capabilities, CAPABILITY_HOLD)) {
366 builder.append(" CAPABILITY_HOLD");
367 }
368 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
369 builder.append(" CAPABILITY_SUPPORT_HOLD");
370 }
371 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
372 builder.append(" CAPABILITY_MERGE_CONFERENCE");
373 }
374 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
375 builder.append(" CAPABILITY_SWAP_CONFERENCE");
376 }
377 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
378 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
379 }
380 if (can(capabilities, CAPABILITY_MUTE)) {
381 builder.append(" CAPABILITY_MUTE");
382 }
383 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
384 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
385 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700386 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
387 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
388 }
389 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
390 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
391 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700392 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
393 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800394 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700395 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
396 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
397 }
398 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
399 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
400 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800401 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
402 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
403 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700404 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
405 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800406 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500407 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700408 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500409 }
Rekha Kumar07366812015-03-24 16:42:31 -0700410 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
411 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
412 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700413 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
414 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
415 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700416 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
417 builder.append(" CAPABILITY_CAN_PULL_CALL");
418 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800419 builder.append("]");
420 return builder.toString();
421 }
422
423 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700424 * Whether the supplied properties includes the specified property.
425 *
426 * @param properties A bit field of properties.
427 * @param property The property to check properties for.
428 * @return Whether the specified property is supported.
429 */
430 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800431 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700432 }
433
434 /**
435 * Whether the properties of this {@code Details} includes the specified property.
436 *
437 * @param property The property to check properties for.
438 * @return Whether the specified property is supported.
439 */
440 public boolean hasProperty(int property) {
441 return hasProperty(mCallProperties, property);
442 }
443
444 /**
445 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
446 *
447 * @param properties A property bit field.
448 * @return A human readable string representation.
449 */
450 public static String propertiesToString(int properties) {
451 StringBuilder builder = new StringBuilder();
452 builder.append("[Properties:");
453 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
454 builder.append(" PROPERTY_CONFERENCE");
455 }
456 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
457 builder.append(" PROPERTY_GENERIC_CONFERENCE");
458 }
459 if (hasProperty(properties, PROPERTY_WIFI)) {
460 builder.append(" PROPERTY_WIFI");
461 }
462 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
463 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
464 }
465 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700466 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700467 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700468 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
469 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
470 }
Brad Ebinger15847072016-05-18 11:08:36 -0700471 if(hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
472 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
473 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700474 builder.append("]");
475 return builder.toString();
476 }
477
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800478 /** {@hide} */
479 public String getTelecomCallId() {
480 return mTelecomCallId;
481 }
482
Andrew Lee2378ea72015-04-29 14:38:11 -0700483 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700484 * @return The handle (e.g., phone number) to which the {@code Call} is currently
485 * connected.
486 */
487 public Uri getHandle() {
488 return mHandle;
489 }
490
491 /**
492 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700493 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700494 */
495 public int getHandlePresentation() {
496 return mHandlePresentation;
497 }
498
499 /**
500 * @return The display name for the caller.
501 */
502 public String getCallerDisplayName() {
503 return mCallerDisplayName;
504 }
505
506 /**
507 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700508 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700509 */
510 public int getCallerDisplayNamePresentation() {
511 return mCallerDisplayNamePresentation;
512 }
513
514 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700515 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
516 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700517 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700518 public PhoneAccountHandle getAccountHandle() {
519 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -0700520 }
521
522 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800523 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
524 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -0700525 */
Ihab Awad5d0410f2014-07-30 10:07:40 -0700526 public int getCallCapabilities() {
527 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -0700528 }
529
530 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700531 * @return A bitmask of the properties of the {@code Call}, as defined by the various
532 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -0700533 */
534 public int getCallProperties() {
535 return mCallProperties;
536 }
537
538 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700539 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -0700540 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700541 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700542 public DisconnectCause getDisconnectCause() {
543 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700544 }
545
546 /**
547 * @return The time the {@code Call} has been connected. This information is updated
548 * periodically, but user interfaces should not rely on this to display any "call time
549 * clock".
550 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -0700551 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -0700552 return mConnectTimeMillis;
553 }
554
555 /**
556 * @return Information about any calling gateway the {@code Call} may be using.
557 */
558 public GatewayInfo getGatewayInfo() {
559 return mGatewayInfo;
560 }
561
Andrew Lee7a341382014-07-15 17:05:08 -0700562 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -0700563 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -0700564 */
565 public int getVideoState() {
566 return mVideoState;
567 }
568
Ihab Awad5d0410f2014-07-30 10:07:40 -0700569 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700570 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -0700571 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -0700572 */
573 public StatusHints getStatusHints() {
574 return mStatusHints;
575 }
576
Nancy Chen10798dc2014-08-08 14:00:25 -0700577 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -0700578 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700579 */
580 public Bundle getExtras() {
581 return mExtras;
582 }
583
Santos Cordon6b7f9552015-05-27 17:21:45 -0700584 /**
585 * @return The extras used with the original intent to place this call.
586 */
587 public Bundle getIntentExtras() {
588 return mIntentExtras;
589 }
590
Ihab Awade63fadb2014-07-09 21:52:04 -0700591 @Override
592 public boolean equals(Object o) {
593 if (o instanceof Details) {
594 Details d = (Details) o;
595 return
596 Objects.equals(mHandle, d.mHandle) &&
597 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
598 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
599 Objects.equals(mCallerDisplayNamePresentation,
600 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -0700601 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -0700602 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -0700603 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700604 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -0700605 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -0700606 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -0700607 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -0700608 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -0700609 areBundlesEqual(mExtras, d.mExtras) &&
610 areBundlesEqual(mIntentExtras, d.mIntentExtras);
Ihab Awade63fadb2014-07-09 21:52:04 -0700611 }
612 return false;
613 }
614
615 @Override
616 public int hashCode() {
617 return
618 Objects.hashCode(mHandle) +
619 Objects.hashCode(mHandlePresentation) +
620 Objects.hashCode(mCallerDisplayName) +
621 Objects.hashCode(mCallerDisplayNamePresentation) +
Evan Charlton8c8a0622014-07-20 12:31:00 -0700622 Objects.hashCode(mAccountHandle) +
Ihab Awad5d0410f2014-07-30 10:07:40 -0700623 Objects.hashCode(mCallCapabilities) +
Andrew Lee223ad142014-08-27 16:33:08 -0700624 Objects.hashCode(mCallProperties) +
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700625 Objects.hashCode(mDisconnectCause) +
Ihab Awade63fadb2014-07-09 21:52:04 -0700626 Objects.hashCode(mConnectTimeMillis) +
Andrew Lee85f5d422014-07-11 17:22:03 -0700627 Objects.hashCode(mGatewayInfo) +
Evan Charlton5b49ade2014-07-15 17:03:20 -0700628 Objects.hashCode(mVideoState) +
Nancy Chen10798dc2014-08-08 14:00:25 -0700629 Objects.hashCode(mStatusHints) +
Santos Cordon6b7f9552015-05-27 17:21:45 -0700630 Objects.hashCode(mExtras) +
631 Objects.hashCode(mIntentExtras);
Ihab Awade63fadb2014-07-09 21:52:04 -0700632 }
633
634 /** {@hide} */
635 public Details(
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800636 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -0700637 Uri handle,
638 int handlePresentation,
639 String callerDisplayName,
640 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -0700641 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -0700642 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -0700643 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700644 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -0700645 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -0700646 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -0700647 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -0700648 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -0700649 Bundle extras,
650 Bundle intentExtras) {
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800651 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700652 mHandle = handle;
653 mHandlePresentation = handlePresentation;
654 mCallerDisplayName = callerDisplayName;
655 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700656 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700657 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700658 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700659 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700660 mConnectTimeMillis = connectTimeMillis;
661 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700662 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700663 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700664 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700665 mIntentExtras = intentExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -0700666 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800667
668 /** {@hide} */
669 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
670 return new Details(
671 parcelableCall.getId(),
672 parcelableCall.getHandle(),
673 parcelableCall.getHandlePresentation(),
674 parcelableCall.getCallerDisplayName(),
675 parcelableCall.getCallerDisplayNamePresentation(),
676 parcelableCall.getAccountHandle(),
677 parcelableCall.getCapabilities(),
678 parcelableCall.getProperties(),
679 parcelableCall.getDisconnectCause(),
680 parcelableCall.getConnectTimeMillis(),
681 parcelableCall.getGatewayInfo(),
682 parcelableCall.getVideoState(),
683 parcelableCall.getStatusHints(),
684 parcelableCall.getExtras(),
685 parcelableCall.getIntentExtras());
686 }
Santos Cordon3c20d632016-02-25 16:12:35 -0800687
688 @Override
689 public String toString() {
690 StringBuilder sb = new StringBuilder();
691 sb.append("[pa: ");
692 sb.append(mAccountHandle);
693 sb.append(", hdl: ");
694 sb.append(Log.pii(mHandle));
695 sb.append(", caps: ");
696 sb.append(capabilitiesToString(mCallCapabilities));
697 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -0700698 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -0800699 sb.append("]");
700 return sb.toString();
701 }
Ihab Awade63fadb2014-07-09 21:52:04 -0700702 }
703
Andrew Leeda80c872015-04-15 14:09:50 -0700704 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -0700705 /**
706 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
707 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700708 * @param call The {@code Call} invoking this method.
709 * @param state The new state of the {@code Call}.
710 */
711 public void onStateChanged(Call call, int state) {}
712
713 /**
714 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
715 *
716 * @param call The {@code Call} invoking this method.
717 * @param parent The new parent of the {@code Call}.
718 */
719 public void onParentChanged(Call call, Call parent) {}
720
721 /**
722 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
723 *
724 * @param call The {@code Call} invoking this method.
725 * @param children The new children of the {@code Call}.
726 */
727 public void onChildrenChanged(Call call, List<Call> children) {}
728
729 /**
730 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
731 *
732 * @param call The {@code Call} invoking this method.
733 * @param details A {@code Details} object describing the {@code Call}.
734 */
735 public void onDetailsChanged(Call call, Details details) {}
736
737 /**
738 * Invoked when the text messages that can be used as responses to the incoming
739 * {@code Call} are loaded from the relevant database.
740 * See {@link #getCannedTextResponses()}.
741 *
742 * @param call The {@code Call} invoking this method.
743 * @param cannedTextResponses The text messages useable as responses.
744 */
745 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
746
747 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700748 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
749 * character. This causes the post-dial signals to stop pending user confirmation. An
750 * implementation should present this choice to the user and invoke
751 * {@link #postDialContinue(boolean)} when the user makes the choice.
752 *
753 * @param call The {@code Call} invoking this method.
754 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
755 */
756 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
757
758 /**
Andrew Lee50aca232014-07-22 16:41:54 -0700759 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700760 *
761 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -0700762 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700763 */
Andrew Lee50aca232014-07-22 16:41:54 -0700764 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -0700765
766 /**
767 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
768 * up their UI for the {@code Call} in response to state transitions. Specifically,
769 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
770 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
771 * clients should wait for this method to be invoked.
772 *
773 * @param call The {@code Call} being destroyed.
774 */
775 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700776
777 /**
778 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
779 * conferenced.
780 *
781 * @param call The {@code Call} being updated.
782 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
783 * conferenced.
784 */
785 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700786
787 /**
788 * Invoked when a call receives an event from its associated {@link Connection}.
789 * <p>
790 * See {@link Connection#sendConnectionEvent(String, Bundle)}.
791 *
792 * @param call The {@code Call} receiving the event.
793 * @param event The event.
794 * @param extras Extras associated with the connection event.
795 */
796 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Ihab Awade63fadb2014-07-09 21:52:04 -0700797 }
798
Andrew Leeda80c872015-04-15 14:09:50 -0700799 /**
800 * @deprecated Use {@code Call.Callback} instead.
801 * @hide
802 */
803 @Deprecated
804 @SystemApi
805 public static abstract class Listener extends Callback { }
806
Ihab Awade63fadb2014-07-09 21:52:04 -0700807 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700808 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700809 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -0700810 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -0700811 private final List<Call> mChildren = new ArrayList<>();
812 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -0700813 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700814 private final List<Call> mConferenceableCalls = new ArrayList<>();
815 private final List<Call> mUnmodifiableConferenceableCalls =
816 Collections.unmodifiableList(mConferenceableCalls);
817
Santos Cordon823fd3c2014-08-07 18:35:18 -0700818 private boolean mChildrenCached;
819 private String mParentId = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700820 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -0700821 private List<String> mCannedTextResponses = null;
822 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -0800823 private VideoCallImpl mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -0700824 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -0700825 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -0700826
827 /**
828 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
829 *
830 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
831 * remaining or this {@code Call} is not in a post-dial state.
832 */
833 public String getRemainingPostDialSequence() {
834 return mRemainingPostDialSequence;
835 }
836
837 /**
838 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -0700839 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -0700840 */
Andrew Lee8da4c3c2014-07-16 10:11:42 -0700841 public void answer(int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700842 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -0700843 }
844
845 /**
846 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
847 *
848 * @param rejectWithMessage Whether to reject with a text message.
849 * @param textMessage An optional text message with which to respond.
850 */
851 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700852 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -0700853 }
854
855 /**
856 * Instructs this {@code Call} to disconnect.
857 */
858 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700859 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700860 }
861
862 /**
863 * Instructs this {@code Call} to go on hold.
864 */
865 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700866 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700867 }
868
869 /**
870 * Instructs this {@link #STATE_HOLDING} call to release from hold.
871 */
872 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700873 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700874 }
875
876 /**
877 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
878 *
879 * Any other currently playing DTMF tone in the specified call is immediately stopped.
880 *
881 * @param digit A character representing the DTMF digit for which to play the tone. This
882 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
883 */
884 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700885 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -0700886 }
887
888 /**
889 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
890 * currently playing.
891 *
892 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
893 * currently playing, this method will do nothing.
894 */
895 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700896 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700897 }
898
899 /**
900 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
901 *
902 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
903 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -0700904 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700905 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -0700906 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
907 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700908 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -0700909 * {@code Call} will pause playing the tones and notify callbacks via
910 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -0700911 * should display to the user an indication of this state and an affordance to continue
912 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
913 * app should invoke the {@link #postDialContinue(boolean)} method.
914 *
915 * @param proceed Whether or not to continue with the post-dial sequence.
916 */
917 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700918 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -0700919 }
920
921 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700922 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -0700923 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -0700924 */
Nancy Chen36c62f32014-10-21 18:36:39 -0700925 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
926 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -0700927
928 }
929
930 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700931 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700932 *
933 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -0700934 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700935 public void conference(Call callToConferenceWith) {
936 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700937 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700938 }
Ihab Awade63fadb2014-07-09 21:52:04 -0700939 }
940
941 /**
942 * Instructs this {@code Call} to split from any conference call with which it may be
943 * connected.
944 */
945 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700946 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700947 }
948
949 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800950 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -0700951 */
952 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700953 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -0700954 }
955
956 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800957 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -0700958 */
959 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700960 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -0700961 }
962
963 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700964 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
965 * device.
966 * <p>
967 * Calls to this method are ignored if the call does not have the
968 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
969 * <p>
970 * An {@link InCallService} will only see calls which support this method if it has the
971 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
972 * in its manifest.
973 */
974 public void pullExternalCall() {
975 // If this isn't an external call, ignore the request.
976 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
977 return;
978 }
979
980 mInCallAdapter.pullExternalCall(mTelecomCallId);
981 }
982
983 /**
984 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
985 * the {@link ConnectionService}.
986 * <p>
987 * Events are exposed to {@link ConnectionService} implementations via
988 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
989 * <p>
990 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
991 * Events should be fully qualified (e.g., com.example.event.MY_EVENT) to avoid conflicts.
992 *
993 * @param event The connection event.
994 * @param extras Bundle containing extra information associated with the event.
995 */
996 public void sendCallEvent(String event, Bundle extras) {
997 mInCallAdapter.sendCallEvent(mTelecomCallId, event, extras);
998 }
999
1000 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07001001 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
1002 * added.
1003 * <p>
1004 * No assumptions should be made as to how an In-Call UI or service will handle these
1005 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
1006 *
1007 * @param extras The extras to add.
1008 */
1009 public final void putExtras(Bundle extras) {
1010 if (extras == null) {
1011 return;
1012 }
1013
1014 if (mExtras == null) {
1015 mExtras = new Bundle();
1016 }
1017 mExtras.putAll(extras);
1018 mInCallAdapter.putExtras(mTelecomCallId, extras);
1019 }
1020
1021 /**
1022 * Adds a boolean extra to this {@link Call}.
1023 *
1024 * @param key The extra key.
1025 * @param value The value.
1026 * @hide
1027 */
1028 public final void putExtra(String key, boolean value) {
1029 if (mExtras == null) {
1030 mExtras = new Bundle();
1031 }
1032 mExtras.putBoolean(key, value);
1033 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1034 }
1035
1036 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001037 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001038 *
1039 * @param key The extra key.
1040 * @param value The value.
1041 * @hide
1042 */
1043 public final void putExtra(String key, int value) {
1044 if (mExtras == null) {
1045 mExtras = new Bundle();
1046 }
1047 mExtras.putInt(key, value);
1048 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1049 }
1050
1051 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001052 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001053 *
1054 * @param key The extra key.
1055 * @param value The value.
1056 * @hide
1057 */
1058 public final void putExtra(String key, String value) {
1059 if (mExtras == null) {
1060 mExtras = new Bundle();
1061 }
1062 mExtras.putString(key, value);
1063 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1064 }
1065
1066 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001067 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001068 *
1069 * @param keys The keys of the extras to remove.
1070 */
1071 public final void removeExtras(List<String> keys) {
1072 if (mExtras != null) {
1073 for (String key : keys) {
1074 mExtras.remove(key);
1075 }
1076 if (mExtras.size() == 0) {
1077 mExtras = null;
1078 }
1079 }
1080 mInCallAdapter.removeExtras(mTelecomCallId, keys);
1081 }
1082
1083 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001084 * Removes extras from this {@link Call}.
1085 *
1086 * @param keys The keys of the extras to remove.
1087 */
1088 public final void removeExtras(String ... keys) {
1089 removeExtras(Arrays.asList(keys));
1090 }
1091
1092 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001093 * Obtains the parent of this {@code Call} in a conference, if any.
1094 *
1095 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
1096 * child of any conference {@code Call}s.
1097 */
1098 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001099 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001100 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001101 }
1102 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07001103 }
1104
1105 /**
1106 * Obtains the children of this conference {@code Call}, if any.
1107 *
1108 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
1109 * {@code List} otherwise.
1110 */
1111 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001112 if (!mChildrenCached) {
1113 mChildrenCached = true;
1114 mChildren.clear();
1115
1116 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001117 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001118 if (call == null) {
1119 // At least one child was still not found, so do not save true for "cached"
1120 mChildrenCached = false;
1121 } else {
1122 mChildren.add(call);
1123 }
1124 }
1125 }
1126
Ihab Awade63fadb2014-07-09 21:52:04 -07001127 return mUnmodifiableChildren;
1128 }
1129
1130 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001131 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
1132 *
1133 * @return The list of conferenceable {@code Call}s.
1134 */
1135 public List<Call> getConferenceableCalls() {
1136 return mUnmodifiableConferenceableCalls;
1137 }
1138
1139 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001140 * Obtains the state of this {@code Call}.
1141 *
1142 * @return A state value, chosen from the {@code STATE_*} constants.
1143 */
1144 public int getState() {
1145 return mState;
1146 }
1147
1148 /**
1149 * Obtains a list of canned, pre-configured message responses to present to the user as
1150 * ways of rejecting this {@code Call} using via a text message.
1151 *
1152 * @see #reject(boolean, String)
1153 *
1154 * @return A list of canned text message responses.
1155 */
1156 public List<String> getCannedTextResponses() {
1157 return mCannedTextResponses;
1158 }
1159
1160 /**
1161 * Obtains an object that can be used to display video from this {@code Call}.
1162 *
Andrew Lee50aca232014-07-22 16:41:54 -07001163 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001164 */
Andrew Lee50aca232014-07-22 16:41:54 -07001165 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001166 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07001167 }
1168
1169 /**
1170 * Obtains an object containing call details.
1171 *
1172 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
1173 * result may be {@code null}.
1174 */
1175 public Details getDetails() {
1176 return mDetails;
1177 }
1178
1179 /**
Andrew Leeda80c872015-04-15 14:09:50 -07001180 * Registers a callback to this {@code Call}.
1181 *
1182 * @param callback A {@code Callback}.
1183 */
1184 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07001185 registerCallback(callback, new Handler());
1186 }
1187
1188 /**
1189 * Registers a callback to this {@code Call}.
1190 *
1191 * @param callback A {@code Callback}.
1192 * @param handler A handler which command and status changes will be delivered to.
1193 */
1194 public void registerCallback(Callback callback, Handler handler) {
1195 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07001196 // Don't allow new callback registration if the call is already being destroyed.
1197 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001198 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
1199 }
Andrew Leeda80c872015-04-15 14:09:50 -07001200 }
1201
1202 /**
1203 * Unregisters a callback from this {@code Call}.
1204 *
1205 * @param callback A {@code Callback}.
1206 */
1207 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07001208 // Don't allow callback deregistration if the call is already being destroyed.
1209 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001210 for (CallbackRecord<Callback> record : mCallbackRecords) {
1211 if (record.getCallback() == callback) {
1212 mCallbackRecords.remove(record);
1213 break;
1214 }
1215 }
Andrew Leeda80c872015-04-15 14:09:50 -07001216 }
1217 }
1218
Santos Cordon3c20d632016-02-25 16:12:35 -08001219 @Override
1220 public String toString() {
1221 return new StringBuilder().
1222 append("Call [id: ").
1223 append(mTelecomCallId).
1224 append(", state: ").
1225 append(stateToString(mState)).
1226 append(", details: ").
1227 append(mDetails).
1228 append("]").toString();
1229 }
1230
1231 /**
1232 * @param state An integer value of a {@code STATE_*} constant.
1233 * @return A string representation of the value.
1234 */
1235 private static String stateToString(int state) {
1236 switch (state) {
1237 case STATE_NEW:
1238 return "NEW";
1239 case STATE_RINGING:
1240 return "RINGING";
1241 case STATE_DIALING:
1242 return "DIALING";
1243 case STATE_ACTIVE:
1244 return "ACTIVE";
1245 case STATE_HOLDING:
1246 return "HOLDING";
1247 case STATE_DISCONNECTED:
1248 return "DISCONNECTED";
1249 case STATE_CONNECTING:
1250 return "CONNECTING";
1251 case STATE_DISCONNECTING:
1252 return "DISCONNECTING";
1253 case STATE_SELECT_PHONE_ACCOUNT:
1254 return "SELECT_PHONE_ACCOUNT";
1255 default:
1256 Log.w(Call.class, "Unknown state %d", state);
1257 return "UNKNOWN";
1258 }
1259 }
1260
Andrew Leeda80c872015-04-15 14:09:50 -07001261 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001262 * Adds a listener to this {@code Call}.
1263 *
1264 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001265 * @deprecated Use {@link #registerCallback} instead.
1266 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001267 */
Andrew Leeda80c872015-04-15 14:09:50 -07001268 @Deprecated
1269 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001270 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001271 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001272 }
1273
1274 /**
1275 * Removes a listener from this {@code Call}.
1276 *
1277 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001278 * @deprecated Use {@link #unregisterCallback} instead.
1279 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001280 */
Andrew Leeda80c872015-04-15 14:09:50 -07001281 @Deprecated
1282 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001283 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001284 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001285 }
1286
1287 /** {@hide} */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001288 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter) {
Ihab Awade63fadb2014-07-09 21:52:04 -07001289 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001290 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001291 mInCallAdapter = inCallAdapter;
1292 mState = STATE_NEW;
1293 }
1294
1295 /** {@hide} */
Shriram Ganeshddf570e2015-05-31 09:18:48 -07001296 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state) {
1297 mPhone = phone;
1298 mTelecomCallId = telecomCallId;
1299 mInCallAdapter = inCallAdapter;
1300 mState = state;
1301 }
1302
1303 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001304 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001305 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001306 }
1307
1308 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001309 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Ihab Awade63fadb2014-07-09 21:52:04 -07001310 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001311 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07001312 boolean detailsChanged = !Objects.equals(mDetails, details);
1313 if (detailsChanged) {
1314 mDetails = details;
1315 }
1316
1317 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07001318 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
1319 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
1320 mCannedTextResponses =
1321 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07001322 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07001323 }
1324
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001325 VideoCallImpl newVideoCallImpl = parcelableCall.getVideoCallImpl();
Tyler Gunn75958422015-04-15 14:23:42 -07001326 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged() &&
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001327 !Objects.equals(mVideoCallImpl, newVideoCallImpl);
Andrew Lee50aca232014-07-22 16:41:54 -07001328 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001329 mVideoCallImpl = newVideoCallImpl;
1330 }
1331 if (mVideoCallImpl != null) {
1332 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07001333 }
1334
Santos Cordone3c507b2015-04-23 14:44:19 -07001335 int state = parcelableCall.getState();
Ihab Awade63fadb2014-07-09 21:52:04 -07001336 boolean stateChanged = mState != state;
1337 if (stateChanged) {
1338 mState = state;
1339 }
1340
Santos Cordon823fd3c2014-08-07 18:35:18 -07001341 String parentId = parcelableCall.getParentCallId();
1342 boolean parentChanged = !Objects.equals(mParentId, parentId);
1343 if (parentChanged) {
1344 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001345 }
1346
Santos Cordon823fd3c2014-08-07 18:35:18 -07001347 List<String> childCallIds = parcelableCall.getChildCallIds();
1348 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
1349 if (childrenChanged) {
1350 mChildrenIds.clear();
1351 mChildrenIds.addAll(parcelableCall.getChildCallIds());
1352 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07001353 }
1354
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001355 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
1356 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
1357 for (String otherId : conferenceableCallIds) {
1358 if (callIdMap.containsKey(otherId)) {
1359 conferenceableCalls.add(callIdMap.get(otherId));
1360 }
1361 }
1362
1363 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
1364 mConferenceableCalls.clear();
1365 mConferenceableCalls.addAll(conferenceableCalls);
1366 fireConferenceableCallsChanged();
1367 }
1368
Ihab Awade63fadb2014-07-09 21:52:04 -07001369 // Now we fire updates, ensuring that any client who listens to any of these notifications
1370 // gets the most up-to-date state.
1371
1372 if (stateChanged) {
1373 fireStateChanged(mState);
1374 }
1375 if (detailsChanged) {
1376 fireDetailsChanged(mDetails);
1377 }
1378 if (cannedTextResponsesChanged) {
1379 fireCannedTextResponsesLoaded(mCannedTextResponses);
1380 }
Andrew Lee50aca232014-07-22 16:41:54 -07001381 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001382 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07001383 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07001384 if (parentChanged) {
1385 fireParentChanged(getParent());
1386 }
1387 if (childrenChanged) {
1388 fireChildrenChanged(getChildren());
1389 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001390
1391 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
1392 // remove ourselves from the Phone. Note that we do this after completing all state updates
1393 // so a client can cleanly transition all their UI to the state appropriate for a
1394 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
1395 if (mState == STATE_DISCONNECTED) {
1396 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07001397 }
1398 }
1399
1400 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001401 final void internalSetPostDialWait(String remaining) {
1402 mRemainingPostDialSequence = remaining;
1403 firePostDialWait(mRemainingPostDialSequence);
1404 }
1405
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07001406 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07001407 final void internalSetDisconnected() {
1408 if (mState != Call.STATE_DISCONNECTED) {
1409 mState = Call.STATE_DISCONNECTED;
1410 fireStateChanged(mState);
1411 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07001412 }
1413 }
1414
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001415 /** {@hide} */
1416 final void internalOnConnectionEvent(String event, Bundle extras) {
1417 fireOnConnectionEvent(event, extras);
1418 }
1419
Andrew Lee011728f2015-04-23 15:47:06 -07001420 private void fireStateChanged(final int newState) {
1421 for (CallbackRecord<Callback> record : mCallbackRecords) {
1422 final Call call = this;
1423 final Callback callback = record.getCallback();
1424 record.getHandler().post(new Runnable() {
1425 @Override
1426 public void run() {
1427 callback.onStateChanged(call, newState);
1428 }
1429 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001430 }
1431 }
1432
Andrew Lee011728f2015-04-23 15:47:06 -07001433 private void fireParentChanged(final Call newParent) {
1434 for (CallbackRecord<Callback> record : mCallbackRecords) {
1435 final Call call = this;
1436 final Callback callback = record.getCallback();
1437 record.getHandler().post(new Runnable() {
1438 @Override
1439 public void run() {
1440 callback.onParentChanged(call, newParent);
1441 }
1442 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001443 }
1444 }
1445
Andrew Lee011728f2015-04-23 15:47:06 -07001446 private void fireChildrenChanged(final List<Call> children) {
1447 for (CallbackRecord<Callback> record : mCallbackRecords) {
1448 final Call call = this;
1449 final Callback callback = record.getCallback();
1450 record.getHandler().post(new Runnable() {
1451 @Override
1452 public void run() {
1453 callback.onChildrenChanged(call, children);
1454 }
1455 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001456 }
1457 }
1458
Andrew Lee011728f2015-04-23 15:47:06 -07001459 private void fireDetailsChanged(final Details details) {
1460 for (CallbackRecord<Callback> record : mCallbackRecords) {
1461 final Call call = this;
1462 final Callback callback = record.getCallback();
1463 record.getHandler().post(new Runnable() {
1464 @Override
1465 public void run() {
1466 callback.onDetailsChanged(call, details);
1467 }
1468 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001469 }
1470 }
1471
Andrew Lee011728f2015-04-23 15:47:06 -07001472 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
1473 for (CallbackRecord<Callback> record : mCallbackRecords) {
1474 final Call call = this;
1475 final Callback callback = record.getCallback();
1476 record.getHandler().post(new Runnable() {
1477 @Override
1478 public void run() {
1479 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
1480 }
1481 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001482 }
1483 }
1484
Andrew Lee011728f2015-04-23 15:47:06 -07001485 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
1486 for (CallbackRecord<Callback> record : mCallbackRecords) {
1487 final Call call = this;
1488 final Callback callback = record.getCallback();
1489 record.getHandler().post(new Runnable() {
1490 @Override
1491 public void run() {
1492 callback.onVideoCallChanged(call, videoCall);
1493 }
1494 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001495 }
1496 }
1497
Andrew Lee011728f2015-04-23 15:47:06 -07001498 private void firePostDialWait(final String remainingPostDialSequence) {
1499 for (CallbackRecord<Callback> record : mCallbackRecords) {
1500 final Call call = this;
1501 final Callback callback = record.getCallback();
1502 record.getHandler().post(new Runnable() {
1503 @Override
1504 public void run() {
1505 callback.onPostDialWait(call, remainingPostDialSequence);
1506 }
1507 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001508 }
1509 }
1510
1511 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07001512 /**
1513 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
1514 * onCallRemoved callback, we remove this call from the Phone's record
1515 * only once all of the registered onCallDestroyed callbacks are executed.
1516 * All the callbacks get removed from our records as a part of this operation
1517 * since onCallDestroyed is the final callback.
1518 */
1519 final Call call = this;
1520 if (mCallbackRecords.isEmpty()) {
1521 // No callbacks registered, remove the call from Phone's record.
1522 mPhone.internalRemoveCall(call);
1523 }
1524 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07001525 final Callback callback = record.getCallback();
1526 record.getHandler().post(new Runnable() {
1527 @Override
1528 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07001529 boolean isFinalRemoval = false;
1530 RuntimeException toThrow = null;
1531 try {
1532 callback.onCallDestroyed(call);
1533 } catch (RuntimeException e) {
1534 toThrow = e;
1535 }
1536 synchronized(Call.this) {
1537 mCallbackRecords.remove(record);
1538 if (mCallbackRecords.isEmpty()) {
1539 isFinalRemoval = true;
1540 }
1541 }
1542 if (isFinalRemoval) {
1543 mPhone.internalRemoveCall(call);
1544 }
1545 if (toThrow != null) {
1546 throw toThrow;
1547 }
Andrew Lee011728f2015-04-23 15:47:06 -07001548 }
1549 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001550 }
1551 }
1552
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001553 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07001554 for (CallbackRecord<Callback> record : mCallbackRecords) {
1555 final Call call = this;
1556 final Callback callback = record.getCallback();
1557 record.getHandler().post(new Runnable() {
1558 @Override
1559 public void run() {
1560 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
1561 }
1562 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001563 }
1564 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001565
1566 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001567 * Notifies listeners of an incoming connection event.
1568 * <p>
1569 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
1570 *
1571 * @param event
1572 * @param extras
1573 */
1574 private void fireOnConnectionEvent(final String event, final Bundle extras) {
1575 for (CallbackRecord<Callback> record : mCallbackRecords) {
1576 final Call call = this;
1577 final Callback callback = record.getCallback();
1578 record.getHandler().post(new Runnable() {
1579 @Override
1580 public void run() {
1581 callback.onConnectionEvent(call, event, extras);
1582 }
1583 });
1584 }
1585 }
1586
1587 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001588 * Determines if two bundles are equal.
1589 *
1590 * @param bundle The original bundle.
1591 * @param newBundle The bundle to compare with.
1592 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
1593 */
1594 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
1595 if (bundle == null || newBundle == null) {
1596 return bundle == newBundle;
1597 }
1598
1599 if (bundle.size() != newBundle.size()) {
1600 return false;
1601 }
1602
1603 for(String key : bundle.keySet()) {
1604 if (key != null) {
1605 final Object value = bundle.get(key);
1606 final Object newValue = newBundle.get(key);
1607 if (!Objects.equals(value, newValue)) {
1608 return false;
1609 }
1610 }
1611 }
1612 return true;
1613 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001614}