blob: c99e22a42ffab11e0ccbab170bf1d0216081489f [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
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -0700704 /**
705 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
706 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
707 * implementation.
708 * <p>
709 * You can handle these callbacks by extending the {@link Callback} class and overriding the
710 * callbacks that your {@link InCallService} is interested in. The callback methods include the
711 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
712 * {@link Callback} implementation, if desired.
713 * <p>
714 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
715 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
716 * (typically in {@link InCallService#onCallRemoved(Call)}).
717 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
718 * reach your implementation of {@link Callback}, so it is important to register your callback
719 * as soon as your {@link InCallService} is notified of a new call via
720 * {@link InCallService#onCallAdded(Call)}.
721 */
Andrew Leeda80c872015-04-15 14:09:50 -0700722 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -0700723 /**
724 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
725 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700726 * @param call The {@code Call} invoking this method.
727 * @param state The new state of the {@code Call}.
728 */
729 public void onStateChanged(Call call, int state) {}
730
731 /**
732 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
733 *
734 * @param call The {@code Call} invoking this method.
735 * @param parent The new parent of the {@code Call}.
736 */
737 public void onParentChanged(Call call, Call parent) {}
738
739 /**
740 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
741 *
742 * @param call The {@code Call} invoking this method.
743 * @param children The new children of the {@code Call}.
744 */
745 public void onChildrenChanged(Call call, List<Call> children) {}
746
747 /**
748 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
749 *
750 * @param call The {@code Call} invoking this method.
751 * @param details A {@code Details} object describing the {@code Call}.
752 */
753 public void onDetailsChanged(Call call, Details details) {}
754
755 /**
756 * Invoked when the text messages that can be used as responses to the incoming
757 * {@code Call} are loaded from the relevant database.
758 * See {@link #getCannedTextResponses()}.
759 *
760 * @param call The {@code Call} invoking this method.
761 * @param cannedTextResponses The text messages useable as responses.
762 */
763 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
764
765 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700766 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
767 * character. This causes the post-dial signals to stop pending user confirmation. An
768 * implementation should present this choice to the user and invoke
769 * {@link #postDialContinue(boolean)} when the user makes the choice.
770 *
771 * @param call The {@code Call} invoking this method.
772 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
773 */
774 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
775
776 /**
Andrew Lee50aca232014-07-22 16:41:54 -0700777 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700778 *
779 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -0700780 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700781 */
Andrew Lee50aca232014-07-22 16:41:54 -0700782 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -0700783
784 /**
785 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
786 * up their UI for the {@code Call} in response to state transitions. Specifically,
787 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
788 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
789 * clients should wait for this method to be invoked.
790 *
791 * @param call The {@code Call} being destroyed.
792 */
793 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700794
795 /**
796 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
797 * conferenced.
798 *
799 * @param call The {@code Call} being updated.
800 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
801 * conferenced.
802 */
803 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700804
805 /**
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -0700806 * Invoked when a {@link Call} receives an event from its associated {@link Connection}.
807 * <p>
808 * Where possible, the Call should make an attempt to handle {@link Connection} events which
809 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
810 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
811 * possible that a {@link ConnectionService} has defined its own Connection events which a
812 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700813 * <p>
814 * See {@link Connection#sendConnectionEvent(String, Bundle)}.
815 *
816 * @param call The {@code Call} receiving the event.
817 * @param event The event.
818 * @param extras Extras associated with the connection event.
819 */
820 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Ihab Awade63fadb2014-07-09 21:52:04 -0700821 }
822
Andrew Leeda80c872015-04-15 14:09:50 -0700823 /**
824 * @deprecated Use {@code Call.Callback} instead.
825 * @hide
826 */
827 @Deprecated
828 @SystemApi
829 public static abstract class Listener extends Callback { }
830
Ihab Awade63fadb2014-07-09 21:52:04 -0700831 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700832 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700833 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -0700834 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -0700835 private final List<Call> mChildren = new ArrayList<>();
836 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -0700837 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700838 private final List<Call> mConferenceableCalls = new ArrayList<>();
839 private final List<Call> mUnmodifiableConferenceableCalls =
840 Collections.unmodifiableList(mConferenceableCalls);
841
Santos Cordon823fd3c2014-08-07 18:35:18 -0700842 private boolean mChildrenCached;
843 private String mParentId = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700844 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -0700845 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -0800846 private String mCallingPackage;
Ihab Awade63fadb2014-07-09 21:52:04 -0700847 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -0800848 private VideoCallImpl mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -0700849 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -0700850 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -0700851
852 /**
853 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
854 *
855 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
856 * remaining or this {@code Call} is not in a post-dial state.
857 */
858 public String getRemainingPostDialSequence() {
859 return mRemainingPostDialSequence;
860 }
861
862 /**
863 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -0700864 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -0700865 */
Andrew Lee8da4c3c2014-07-16 10:11:42 -0700866 public void answer(int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700867 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -0700868 }
869
870 /**
871 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
872 *
873 * @param rejectWithMessage Whether to reject with a text message.
874 * @param textMessage An optional text message with which to respond.
875 */
876 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700877 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -0700878 }
879
880 /**
881 * Instructs this {@code Call} to disconnect.
882 */
883 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700884 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700885 }
886
887 /**
888 * Instructs this {@code Call} to go on hold.
889 */
890 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700891 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700892 }
893
894 /**
895 * Instructs this {@link #STATE_HOLDING} call to release from hold.
896 */
897 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700898 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700899 }
900
901 /**
902 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
903 *
904 * Any other currently playing DTMF tone in the specified call is immediately stopped.
905 *
906 * @param digit A character representing the DTMF digit for which to play the tone. This
907 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
908 */
909 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700910 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -0700911 }
912
913 /**
914 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
915 * currently playing.
916 *
917 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
918 * currently playing, this method will do nothing.
919 */
920 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700921 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700922 }
923
924 /**
925 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
926 *
927 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
928 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -0700929 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700930 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -0700931 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
932 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700933 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -0700934 * {@code Call} will pause playing the tones and notify callbacks via
935 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -0700936 * should display to the user an indication of this state and an affordance to continue
937 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
938 * app should invoke the {@link #postDialContinue(boolean)} method.
939 *
940 * @param proceed Whether or not to continue with the post-dial sequence.
941 */
942 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700943 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -0700944 }
945
946 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700947 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -0700948 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -0700949 */
Nancy Chen36c62f32014-10-21 18:36:39 -0700950 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
951 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -0700952
953 }
954
955 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700956 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700957 *
958 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -0700959 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700960 public void conference(Call callToConferenceWith) {
961 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700962 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700963 }
Ihab Awade63fadb2014-07-09 21:52:04 -0700964 }
965
966 /**
967 * Instructs this {@code Call} to split from any conference call with which it may be
968 * connected.
969 */
970 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700971 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -0700972 }
973
974 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800975 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -0700976 */
977 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700978 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -0700979 }
980
981 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800982 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -0700983 */
984 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700985 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -0700986 }
987
988 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700989 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
990 * device.
991 * <p>
992 * Calls to this method are ignored if the call does not have the
993 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
994 * <p>
995 * An {@link InCallService} will only see calls which support this method if it has the
996 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
997 * in its manifest.
998 */
999 public void pullExternalCall() {
1000 // If this isn't an external call, ignore the request.
1001 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
1002 return;
1003 }
1004
1005 mInCallAdapter.pullExternalCall(mTelecomCallId);
1006 }
1007
1008 /**
1009 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
1010 * the {@link ConnectionService}.
1011 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001012 * Call events are used to communicate point in time information from an {@link InCallService}
1013 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
1014 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
1015 * {@link ConnectionService}.
1016 * <p>
1017 * A {@link ConnectionService} can communicate to the {@link InCallService} using
1018 * {@link Connection#sendConnectionEvent(String, Bundle)}.
1019 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001020 * Events are exposed to {@link ConnectionService} implementations via
1021 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
1022 * <p>
1023 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001024 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
1025 * ignore some events altogether.
1026 * <p>
1027 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
1028 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
1029 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
1030 * they define their own event types in this namespace. When defining a custom event type,
1031 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
1032 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
1033 * <p>
1034 * When defining events and the associated extras, it is important to keep their behavior
1035 * consistent when the associated {@link InCallService} is updated. Support for deprecated
1036 * events/extras should me maintained to ensure backwards compatibility with older
1037 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001038 *
1039 * @param event The connection event.
1040 * @param extras Bundle containing extra information associated with the event.
1041 */
1042 public void sendCallEvent(String event, Bundle extras) {
1043 mInCallAdapter.sendCallEvent(mTelecomCallId, event, extras);
1044 }
1045
1046 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07001047 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
1048 * added.
1049 * <p>
1050 * No assumptions should be made as to how an In-Call UI or service will handle these
1051 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
1052 *
1053 * @param extras The extras to add.
1054 */
1055 public final void putExtras(Bundle extras) {
1056 if (extras == null) {
1057 return;
1058 }
1059
1060 if (mExtras == null) {
1061 mExtras = new Bundle();
1062 }
1063 mExtras.putAll(extras);
1064 mInCallAdapter.putExtras(mTelecomCallId, extras);
1065 }
1066
1067 /**
1068 * Adds a boolean extra to this {@link Call}.
1069 *
1070 * @param key The extra key.
1071 * @param value The value.
1072 * @hide
1073 */
1074 public final void putExtra(String key, boolean value) {
1075 if (mExtras == null) {
1076 mExtras = new Bundle();
1077 }
1078 mExtras.putBoolean(key, value);
1079 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1080 }
1081
1082 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001083 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001084 *
1085 * @param key The extra key.
1086 * @param value The value.
1087 * @hide
1088 */
1089 public final void putExtra(String key, int value) {
1090 if (mExtras == null) {
1091 mExtras = new Bundle();
1092 }
1093 mExtras.putInt(key, value);
1094 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1095 }
1096
1097 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001098 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001099 *
1100 * @param key The extra key.
1101 * @param value The value.
1102 * @hide
1103 */
1104 public final void putExtra(String key, String value) {
1105 if (mExtras == null) {
1106 mExtras = new Bundle();
1107 }
1108 mExtras.putString(key, value);
1109 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1110 }
1111
1112 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001113 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001114 *
1115 * @param keys The keys of the extras to remove.
1116 */
1117 public final void removeExtras(List<String> keys) {
1118 if (mExtras != null) {
1119 for (String key : keys) {
1120 mExtras.remove(key);
1121 }
1122 if (mExtras.size() == 0) {
1123 mExtras = null;
1124 }
1125 }
1126 mInCallAdapter.removeExtras(mTelecomCallId, keys);
1127 }
1128
1129 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001130 * Removes extras from this {@link Call}.
1131 *
1132 * @param keys The keys of the extras to remove.
1133 */
1134 public final void removeExtras(String ... keys) {
1135 removeExtras(Arrays.asList(keys));
1136 }
1137
1138 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001139 * Obtains the parent of this {@code Call} in a conference, if any.
1140 *
1141 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
1142 * child of any conference {@code Call}s.
1143 */
1144 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001145 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001146 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001147 }
1148 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07001149 }
1150
1151 /**
1152 * Obtains the children of this conference {@code Call}, if any.
1153 *
1154 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
1155 * {@code List} otherwise.
1156 */
1157 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001158 if (!mChildrenCached) {
1159 mChildrenCached = true;
1160 mChildren.clear();
1161
1162 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001163 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001164 if (call == null) {
1165 // At least one child was still not found, so do not save true for "cached"
1166 mChildrenCached = false;
1167 } else {
1168 mChildren.add(call);
1169 }
1170 }
1171 }
1172
Ihab Awade63fadb2014-07-09 21:52:04 -07001173 return mUnmodifiableChildren;
1174 }
1175
1176 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001177 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
1178 *
1179 * @return The list of conferenceable {@code Call}s.
1180 */
1181 public List<Call> getConferenceableCalls() {
1182 return mUnmodifiableConferenceableCalls;
1183 }
1184
1185 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001186 * Obtains the state of this {@code Call}.
1187 *
1188 * @return A state value, chosen from the {@code STATE_*} constants.
1189 */
1190 public int getState() {
1191 return mState;
1192 }
1193
1194 /**
1195 * Obtains a list of canned, pre-configured message responses to present to the user as
1196 * ways of rejecting this {@code Call} using via a text message.
1197 *
1198 * @see #reject(boolean, String)
1199 *
1200 * @return A list of canned text message responses.
1201 */
1202 public List<String> getCannedTextResponses() {
1203 return mCannedTextResponses;
1204 }
1205
1206 /**
1207 * Obtains an object that can be used to display video from this {@code Call}.
1208 *
Andrew Lee50aca232014-07-22 16:41:54 -07001209 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001210 */
Andrew Lee50aca232014-07-22 16:41:54 -07001211 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001212 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07001213 }
1214
1215 /**
1216 * Obtains an object containing call details.
1217 *
1218 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
1219 * result may be {@code null}.
1220 */
1221 public Details getDetails() {
1222 return mDetails;
1223 }
1224
1225 /**
Andrew Leeda80c872015-04-15 14:09:50 -07001226 * Registers a callback to this {@code Call}.
1227 *
1228 * @param callback A {@code Callback}.
1229 */
1230 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07001231 registerCallback(callback, new Handler());
1232 }
1233
1234 /**
1235 * Registers a callback to this {@code Call}.
1236 *
1237 * @param callback A {@code Callback}.
1238 * @param handler A handler which command and status changes will be delivered to.
1239 */
1240 public void registerCallback(Callback callback, Handler handler) {
1241 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07001242 // Don't allow new callback registration if the call is already being destroyed.
1243 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001244 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
1245 }
Andrew Leeda80c872015-04-15 14:09:50 -07001246 }
1247
1248 /**
1249 * Unregisters a callback from this {@code Call}.
1250 *
1251 * @param callback A {@code Callback}.
1252 */
1253 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07001254 // Don't allow callback deregistration if the call is already being destroyed.
1255 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001256 for (CallbackRecord<Callback> record : mCallbackRecords) {
1257 if (record.getCallback() == callback) {
1258 mCallbackRecords.remove(record);
1259 break;
1260 }
1261 }
Andrew Leeda80c872015-04-15 14:09:50 -07001262 }
1263 }
1264
Santos Cordon3c20d632016-02-25 16:12:35 -08001265 @Override
1266 public String toString() {
1267 return new StringBuilder().
1268 append("Call [id: ").
1269 append(mTelecomCallId).
1270 append(", state: ").
1271 append(stateToString(mState)).
1272 append(", details: ").
1273 append(mDetails).
1274 append("]").toString();
1275 }
1276
1277 /**
1278 * @param state An integer value of a {@code STATE_*} constant.
1279 * @return A string representation of the value.
1280 */
1281 private static String stateToString(int state) {
1282 switch (state) {
1283 case STATE_NEW:
1284 return "NEW";
1285 case STATE_RINGING:
1286 return "RINGING";
1287 case STATE_DIALING:
1288 return "DIALING";
1289 case STATE_ACTIVE:
1290 return "ACTIVE";
1291 case STATE_HOLDING:
1292 return "HOLDING";
1293 case STATE_DISCONNECTED:
1294 return "DISCONNECTED";
1295 case STATE_CONNECTING:
1296 return "CONNECTING";
1297 case STATE_DISCONNECTING:
1298 return "DISCONNECTING";
1299 case STATE_SELECT_PHONE_ACCOUNT:
1300 return "SELECT_PHONE_ACCOUNT";
1301 default:
1302 Log.w(Call.class, "Unknown state %d", state);
1303 return "UNKNOWN";
1304 }
1305 }
1306
Andrew Leeda80c872015-04-15 14:09:50 -07001307 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001308 * Adds a listener to this {@code Call}.
1309 *
1310 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001311 * @deprecated Use {@link #registerCallback} instead.
1312 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001313 */
Andrew Leeda80c872015-04-15 14:09:50 -07001314 @Deprecated
1315 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001316 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001317 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001318 }
1319
1320 /**
1321 * Removes a listener from this {@code Call}.
1322 *
1323 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001324 * @deprecated Use {@link #unregisterCallback} instead.
1325 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001326 */
Andrew Leeda80c872015-04-15 14:09:50 -07001327 @Deprecated
1328 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001329 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001330 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001331 }
1332
1333 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08001334 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage) {
Ihab Awade63fadb2014-07-09 21:52:04 -07001335 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001336 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001337 mInCallAdapter = inCallAdapter;
1338 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001339 mCallingPackage = callingPackage;
Ihab Awade63fadb2014-07-09 21:52:04 -07001340 }
1341
1342 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08001343 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
1344 String callingPackage) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07001345 mPhone = phone;
1346 mTelecomCallId = telecomCallId;
1347 mInCallAdapter = inCallAdapter;
1348 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001349 mCallingPackage = callingPackage;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07001350 }
1351
1352 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001353 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001354 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001355 }
1356
1357 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001358 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08001359
Ihab Awade63fadb2014-07-09 21:52:04 -07001360 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001361 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07001362 boolean detailsChanged = !Objects.equals(mDetails, details);
1363 if (detailsChanged) {
1364 mDetails = details;
1365 }
1366
1367 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07001368 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
1369 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
1370 mCannedTextResponses =
1371 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07001372 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07001373 }
1374
Tyler Gunnb88b3112016-11-09 10:19:23 -08001375 VideoCallImpl newVideoCallImpl = parcelableCall.getVideoCallImpl(mCallingPackage);
Tyler Gunn75958422015-04-15 14:23:42 -07001376 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged() &&
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001377 !Objects.equals(mVideoCallImpl, newVideoCallImpl);
Andrew Lee50aca232014-07-22 16:41:54 -07001378 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001379 mVideoCallImpl = newVideoCallImpl;
1380 }
1381 if (mVideoCallImpl != null) {
1382 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07001383 }
1384
Santos Cordone3c507b2015-04-23 14:44:19 -07001385 int state = parcelableCall.getState();
Ihab Awade63fadb2014-07-09 21:52:04 -07001386 boolean stateChanged = mState != state;
1387 if (stateChanged) {
1388 mState = state;
1389 }
1390
Santos Cordon823fd3c2014-08-07 18:35:18 -07001391 String parentId = parcelableCall.getParentCallId();
1392 boolean parentChanged = !Objects.equals(mParentId, parentId);
1393 if (parentChanged) {
1394 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001395 }
1396
Santos Cordon823fd3c2014-08-07 18:35:18 -07001397 List<String> childCallIds = parcelableCall.getChildCallIds();
1398 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
1399 if (childrenChanged) {
1400 mChildrenIds.clear();
1401 mChildrenIds.addAll(parcelableCall.getChildCallIds());
1402 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07001403 }
1404
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001405 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
1406 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
1407 for (String otherId : conferenceableCallIds) {
1408 if (callIdMap.containsKey(otherId)) {
1409 conferenceableCalls.add(callIdMap.get(otherId));
1410 }
1411 }
1412
1413 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
1414 mConferenceableCalls.clear();
1415 mConferenceableCalls.addAll(conferenceableCalls);
1416 fireConferenceableCallsChanged();
1417 }
1418
Ihab Awade63fadb2014-07-09 21:52:04 -07001419 // Now we fire updates, ensuring that any client who listens to any of these notifications
1420 // gets the most up-to-date state.
1421
1422 if (stateChanged) {
1423 fireStateChanged(mState);
1424 }
1425 if (detailsChanged) {
1426 fireDetailsChanged(mDetails);
1427 }
1428 if (cannedTextResponsesChanged) {
1429 fireCannedTextResponsesLoaded(mCannedTextResponses);
1430 }
Andrew Lee50aca232014-07-22 16:41:54 -07001431 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001432 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07001433 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07001434 if (parentChanged) {
1435 fireParentChanged(getParent());
1436 }
1437 if (childrenChanged) {
1438 fireChildrenChanged(getChildren());
1439 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001440
1441 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
1442 // remove ourselves from the Phone. Note that we do this after completing all state updates
1443 // so a client can cleanly transition all their UI to the state appropriate for a
1444 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
1445 if (mState == STATE_DISCONNECTED) {
1446 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07001447 }
1448 }
1449
1450 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001451 final void internalSetPostDialWait(String remaining) {
1452 mRemainingPostDialSequence = remaining;
1453 firePostDialWait(mRemainingPostDialSequence);
1454 }
1455
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07001456 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07001457 final void internalSetDisconnected() {
1458 if (mState != Call.STATE_DISCONNECTED) {
1459 mState = Call.STATE_DISCONNECTED;
1460 fireStateChanged(mState);
1461 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07001462 }
1463 }
1464
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001465 /** {@hide} */
1466 final void internalOnConnectionEvent(String event, Bundle extras) {
1467 fireOnConnectionEvent(event, extras);
1468 }
1469
Andrew Lee011728f2015-04-23 15:47:06 -07001470 private void fireStateChanged(final int newState) {
1471 for (CallbackRecord<Callback> record : mCallbackRecords) {
1472 final Call call = this;
1473 final Callback callback = record.getCallback();
1474 record.getHandler().post(new Runnable() {
1475 @Override
1476 public void run() {
1477 callback.onStateChanged(call, newState);
1478 }
1479 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001480 }
1481 }
1482
Andrew Lee011728f2015-04-23 15:47:06 -07001483 private void fireParentChanged(final Call newParent) {
1484 for (CallbackRecord<Callback> record : mCallbackRecords) {
1485 final Call call = this;
1486 final Callback callback = record.getCallback();
1487 record.getHandler().post(new Runnable() {
1488 @Override
1489 public void run() {
1490 callback.onParentChanged(call, newParent);
1491 }
1492 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001493 }
1494 }
1495
Andrew Lee011728f2015-04-23 15:47:06 -07001496 private void fireChildrenChanged(final List<Call> children) {
1497 for (CallbackRecord<Callback> record : mCallbackRecords) {
1498 final Call call = this;
1499 final Callback callback = record.getCallback();
1500 record.getHandler().post(new Runnable() {
1501 @Override
1502 public void run() {
1503 callback.onChildrenChanged(call, children);
1504 }
1505 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001506 }
1507 }
1508
Andrew Lee011728f2015-04-23 15:47:06 -07001509 private void fireDetailsChanged(final Details details) {
1510 for (CallbackRecord<Callback> record : mCallbackRecords) {
1511 final Call call = this;
1512 final Callback callback = record.getCallback();
1513 record.getHandler().post(new Runnable() {
1514 @Override
1515 public void run() {
1516 callback.onDetailsChanged(call, details);
1517 }
1518 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001519 }
1520 }
1521
Andrew Lee011728f2015-04-23 15:47:06 -07001522 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
1523 for (CallbackRecord<Callback> record : mCallbackRecords) {
1524 final Call call = this;
1525 final Callback callback = record.getCallback();
1526 record.getHandler().post(new Runnable() {
1527 @Override
1528 public void run() {
1529 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
1530 }
1531 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001532 }
1533 }
1534
Andrew Lee011728f2015-04-23 15:47:06 -07001535 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
1536 for (CallbackRecord<Callback> record : mCallbackRecords) {
1537 final Call call = this;
1538 final Callback callback = record.getCallback();
1539 record.getHandler().post(new Runnable() {
1540 @Override
1541 public void run() {
1542 callback.onVideoCallChanged(call, videoCall);
1543 }
1544 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001545 }
1546 }
1547
Andrew Lee011728f2015-04-23 15:47:06 -07001548 private void firePostDialWait(final String remainingPostDialSequence) {
1549 for (CallbackRecord<Callback> record : mCallbackRecords) {
1550 final Call call = this;
1551 final Callback callback = record.getCallback();
1552 record.getHandler().post(new Runnable() {
1553 @Override
1554 public void run() {
1555 callback.onPostDialWait(call, remainingPostDialSequence);
1556 }
1557 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001558 }
1559 }
1560
1561 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07001562 /**
1563 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
1564 * onCallRemoved callback, we remove this call from the Phone's record
1565 * only once all of the registered onCallDestroyed callbacks are executed.
1566 * All the callbacks get removed from our records as a part of this operation
1567 * since onCallDestroyed is the final callback.
1568 */
1569 final Call call = this;
1570 if (mCallbackRecords.isEmpty()) {
1571 // No callbacks registered, remove the call from Phone's record.
1572 mPhone.internalRemoveCall(call);
1573 }
1574 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07001575 final Callback callback = record.getCallback();
1576 record.getHandler().post(new Runnable() {
1577 @Override
1578 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07001579 boolean isFinalRemoval = false;
1580 RuntimeException toThrow = null;
1581 try {
1582 callback.onCallDestroyed(call);
1583 } catch (RuntimeException e) {
1584 toThrow = e;
1585 }
1586 synchronized(Call.this) {
1587 mCallbackRecords.remove(record);
1588 if (mCallbackRecords.isEmpty()) {
1589 isFinalRemoval = true;
1590 }
1591 }
1592 if (isFinalRemoval) {
1593 mPhone.internalRemoveCall(call);
1594 }
1595 if (toThrow != null) {
1596 throw toThrow;
1597 }
Andrew Lee011728f2015-04-23 15:47:06 -07001598 }
1599 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001600 }
1601 }
1602
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001603 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07001604 for (CallbackRecord<Callback> record : mCallbackRecords) {
1605 final Call call = this;
1606 final Callback callback = record.getCallback();
1607 record.getHandler().post(new Runnable() {
1608 @Override
1609 public void run() {
1610 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
1611 }
1612 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001613 }
1614 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001615
1616 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001617 * Notifies listeners of an incoming connection event.
1618 * <p>
1619 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
1620 *
1621 * @param event
1622 * @param extras
1623 */
1624 private void fireOnConnectionEvent(final String event, final Bundle extras) {
1625 for (CallbackRecord<Callback> record : mCallbackRecords) {
1626 final Call call = this;
1627 final Callback callback = record.getCallback();
1628 record.getHandler().post(new Runnable() {
1629 @Override
1630 public void run() {
1631 callback.onConnectionEvent(call, event, extras);
1632 }
1633 });
1634 }
1635 }
1636
1637 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001638 * Determines if two bundles are equal.
1639 *
1640 * @param bundle The original bundle.
1641 * @param newBundle The bundle to compare with.
1642 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
1643 */
1644 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
1645 if (bundle == null || newBundle == null) {
1646 return bundle == newBundle;
1647 }
1648
1649 if (bundle.size() != newBundle.size()) {
1650 return false;
1651 }
1652
1653 for(String key : bundle.keySet()) {
1654 if (key != null) {
1655 final Object value = bundle.get(key);
1656 final Object newValue = newBundle.get(key);
1657 if (!Objects.equals(value, newValue)) {
1658 return false;
1659 }
1660 }
1661 }
1662 return true;
1663 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001664}