blob: 9c1e8dd25a0e744429b84eec0b57e0d49792e83f [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
Hall Liu95d55872017-01-25 17:12:49 -080019import android.annotation.IntDef;
Ravi Paluri404babb2020-01-23 19:02:44 +053020import android.annotation.NonNull;
Hall Liu95d55872017-01-25 17:12:49 -080021import android.annotation.Nullable;
Andrew Leeda80c872015-04-15 14:09:50 -070022import android.annotation.SystemApi;
Hall Liu6dfa2492019-10-01 17:20:39 -070023import android.annotation.TestApi;
Artur Satayev53ada2a2019-12-10 17:47:56 +000024import android.compat.annotation.UnsupportedAppUsage;
Tyler Gunn460b7d42020-05-15 10:19:32 -070025import android.content.pm.ServiceInfo;
Ihab Awade63fadb2014-07-09 21:52:04 -070026import android.net.Uri;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080027import android.os.Build;
Nancy Chen10798dc2014-08-08 14:00:25 -070028import android.os.Bundle;
Andrew Lee011728f2015-04-23 15:47:06 -070029import android.os.Handler;
Hall Liu95d55872017-01-25 17:12:49 -080030import android.os.ParcelFileDescriptor;
Ihab Awade63fadb2014-07-09 21:52:04 -070031
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -080032import com.android.internal.telecom.IVideoProvider;
33
Hall Liu95d55872017-01-25 17:12:49 -080034import java.io.IOException;
35import java.io.InputStreamReader;
36import java.io.OutputStreamWriter;
Hall Liu95d55872017-01-25 17:12:49 -080037import java.lang.annotation.Retention;
38import java.lang.annotation.RetentionPolicy;
39import java.nio.charset.StandardCharsets;
Ihab Awade63fadb2014-07-09 21:52:04 -070040import java.util.ArrayList;
Tyler Gunn071be6f2016-05-10 14:52:33 -070041import java.util.Arrays;
Ihab Awade63fadb2014-07-09 21:52:04 -070042import java.util.Collections;
43import java.util.List;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -070044import java.util.Map;
Ihab Awade63fadb2014-07-09 21:52:04 -070045import java.util.Objects;
Jay Shrauner229e3822014-08-15 09:23:07 -070046import java.util.concurrent.CopyOnWriteArrayList;
Ihab Awade63fadb2014-07-09 21:52:04 -070047
48/**
49 * Represents an ongoing phone call that the in-call app should present to the user.
50 */
51public final class Call {
52 /**
53 * The state of a {@code Call} when newly created.
54 */
55 public static final int STATE_NEW = 0;
56
57 /**
58 * The state of an outgoing {@code Call} when dialing the remote number, but not yet connected.
59 */
60 public static final int STATE_DIALING = 1;
61
62 /**
63 * The state of an incoming {@code Call} when ringing locally, but not yet connected.
64 */
65 public static final int STATE_RINGING = 2;
66
67 /**
68 * The state of a {@code Call} when in a holding state.
69 */
70 public static final int STATE_HOLDING = 3;
71
72 /**
73 * The state of a {@code Call} when actively supporting conversation.
74 */
75 public static final int STATE_ACTIVE = 4;
76
77 /**
78 * The state of a {@code Call} when no further voice or other communication is being
79 * transmitted, the remote side has been or will inevitably be informed that the {@code Call}
80 * is no longer active, and the local data transport has or inevitably will release resources
81 * associated with this {@code Call}.
82 */
83 public static final int STATE_DISCONNECTED = 7;
84
Nancy Chen5da0fd52014-07-08 14:16:17 -070085 /**
Santos Cordone3c507b2015-04-23 14:44:19 -070086 * The state of an outgoing {@code Call} when waiting on user to select a
87 * {@link PhoneAccount} through which to place the call.
Nancy Chen5da0fd52014-07-08 14:16:17 -070088 */
Santos Cordone3c507b2015-04-23 14:44:19 -070089 public static final int STATE_SELECT_PHONE_ACCOUNT = 8;
90
91 /**
92 * @hide
93 * @deprecated use STATE_SELECT_PHONE_ACCOUNT.
94 */
95 @Deprecated
96 @SystemApi
97 public static final int STATE_PRE_DIAL_WAIT = STATE_SELECT_PHONE_ACCOUNT;
Nancy Chen5da0fd52014-07-08 14:16:17 -070098
Nancy Chene20930f2014-08-07 16:17:21 -070099 /**
Nancy Chene9b7a8e2014-08-08 14:26:27 -0700100 * The initial state of an outgoing {@code Call}.
101 * Common transitions are to {@link #STATE_DIALING} state for a successful call or
102 * {@link #STATE_DISCONNECTED} if it failed.
Nancy Chene20930f2014-08-07 16:17:21 -0700103 */
104 public static final int STATE_CONNECTING = 9;
105
Nancy Chen513c8922014-09-17 14:47:20 -0700106 /**
Tyler Gunn4afc6af2014-10-07 10:14:55 -0700107 * The state of a {@code Call} when the user has initiated a disconnection of the call, but the
108 * call has not yet been disconnected by the underlying {@code ConnectionService}. The next
109 * state of the call is (potentially) {@link #STATE_DISCONNECTED}.
110 */
111 public static final int STATE_DISCONNECTING = 10;
112
113 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700114 * The state of an external call which is in the process of being pulled from a remote device to
115 * the local device.
116 * <p>
117 * A call can only be in this state if the {@link Details#PROPERTY_IS_EXTERNAL_CALL} property
118 * and {@link Details#CAPABILITY_CAN_PULL_CALL} capability are set on the call.
119 * <p>
120 * An {@link InCallService} will only see this state if it has the
121 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true} in its
122 * manifest.
123 */
124 public static final int STATE_PULLING_CALL = 11;
125
126 /**
Hall Liu6dfa2492019-10-01 17:20:39 -0700127 * The state of a call that is active with the network, but the audio from the call is
128 * being intercepted by an app on the local device. Telecom does not hold audio focus in this
129 * state, and the call will be invisible to the user except for a persistent notification.
130 */
131 public static final int STATE_AUDIO_PROCESSING = 12;
132
133 /**
134 * The state of a call that is being presented to the user after being in
135 * {@link #STATE_AUDIO_PROCESSING}. The call is still active with the network in this case, and
136 * Telecom will hold audio focus and play a ringtone if appropriate.
137 */
138 public static final int STATE_SIMULATED_RINGING = 13;
139
140 /**
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700141 * @hide
142 */
143 @IntDef(prefix = { "STATE_" },
144 value = {
145 STATE_NEW,
146 STATE_DIALING,
147 STATE_RINGING,
148 STATE_HOLDING,
149 STATE_ACTIVE,
150 STATE_DISCONNECTED,
151 STATE_SELECT_PHONE_ACCOUNT,
152 STATE_CONNECTING,
153 STATE_DISCONNECTING,
154 STATE_PULLING_CALL,
155 STATE_AUDIO_PROCESSING,
156 STATE_SIMULATED_RINGING
157 })
158 @Retention(RetentionPolicy.SOURCE)
159 public @interface CallState {};
160
161 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700162 * The key to retrieve the optional {@code PhoneAccount}s Telecom can bundle with its Call
163 * extras. Used to pass the phone accounts to display on the front end to the user in order to
164 * select phone accounts to (for example) place a call.
Hall Liu34d9e242018-11-21 17:05:58 -0800165 * @deprecated Use the list from {@link #EXTRA_SUGGESTED_PHONE_ACCOUNTS} instead.
Nancy Chen513c8922014-09-17 14:47:20 -0700166 */
Hall Liu34d9e242018-11-21 17:05:58 -0800167 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -0700168 public static final String AVAILABLE_PHONE_ACCOUNTS = "selectPhoneAccountAccounts";
169
mike dooley4af561f2016-12-20 08:55:17 -0800170 /**
Hall Liu34d9e242018-11-21 17:05:58 -0800171 * Key for extra used to pass along a list of {@link PhoneAccountSuggestion}s to the in-call
172 * UI when a call enters the {@link #STATE_SELECT_PHONE_ACCOUNT} state. The list included here
173 * will have the same length and be in the same order as the list passed with
174 * {@link #AVAILABLE_PHONE_ACCOUNTS}.
175 */
176 public static final String EXTRA_SUGGESTED_PHONE_ACCOUNTS =
177 "android.telecom.extra.SUGGESTED_PHONE_ACCOUNTS";
178
179 /**
mike dooley91217422017-03-09 12:58:42 -0800180 * Extra key used to indicate the time (in milliseconds since midnight, January 1, 1970 UTC)
181 * when the last outgoing emergency call was made. This is used to identify potential emergency
182 * callbacks.
mike dooley4af561f2016-12-20 08:55:17 -0800183 */
184 public static final String EXTRA_LAST_EMERGENCY_CALLBACK_TIME_MILLIS =
185 "android.telecom.extra.LAST_EMERGENCY_CALLBACK_TIME_MILLIS";
186
Usman Abdullahb0dc29a2019-03-06 15:54:56 -0800187
188 /**
189 * Extra key used to indicate whether a {@link CallScreeningService} has requested to silence
190 * the ringtone for a call. If the {@link InCallService} declares
191 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in its manifest, it should not
192 * play a ringtone for an incoming call with this extra key set.
193 */
194 public static final String EXTRA_SILENT_RINGING_REQUESTED =
195 "android.telecom.extra.SILENT_RINGING_REQUESTED";
196
Tyler Gunn8bf76572017-04-06 15:30:08 -0700197 /**
198 * Call event sent from a {@link Call} via {@link #sendCallEvent(String, Bundle)} to inform
199 * Telecom that the user has requested that the current {@link Call} should be handed over
200 * to another {@link ConnectionService}.
201 * <p>
202 * The caller must specify the {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE} to indicate to
203 * Telecom which {@link PhoneAccountHandle} the {@link Call} should be handed over to.
204 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700205 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
206 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700207 */
208 public static final String EVENT_REQUEST_HANDOVER =
209 "android.telecom.event.REQUEST_HANDOVER";
210
211 /**
212 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
213 * {@link PhoneAccountHandle} to which a call should be handed over to.
214 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700215 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
216 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700217 */
218 public static final String EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE =
219 "android.telecom.extra.HANDOVER_PHONE_ACCOUNT_HANDLE";
220
221 /**
222 * Integer extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
223 * video state of the call when it is handed over to the new {@link PhoneAccount}.
224 * <p>
225 * Valid values: {@link VideoProfile#STATE_AUDIO_ONLY},
226 * {@link VideoProfile#STATE_BIDIRECTIONAL}, {@link VideoProfile#STATE_RX_ENABLED}, and
227 * {@link VideoProfile#STATE_TX_ENABLED}.
228 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700229 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
230 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700231 */
232 public static final String EXTRA_HANDOVER_VIDEO_STATE =
233 "android.telecom.extra.HANDOVER_VIDEO_STATE";
234
235 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700236 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Used by the
237 * {@link InCallService} initiating a handover to provide a {@link Bundle} with extra
238 * information to the handover {@link ConnectionService} specified by
239 * {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE}.
240 * <p>
241 * This {@link Bundle} is not interpreted by Telecom, but passed as-is to the
242 * {@link ConnectionService} via the request extras when
243 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
244 * is called to initate the handover.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700245 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700246 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
247 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700248 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700249 public static final String EXTRA_HANDOVER_EXTRAS = "android.telecom.extra.HANDOVER_EXTRAS";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700250
251 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700252 * Call event sent from Telecom to the handover {@link ConnectionService} via
253 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
254 * to the {@link ConnectionService} has completed successfully.
255 * <p>
256 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700257 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700258 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
259 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700260 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700261 public static final String EVENT_HANDOVER_COMPLETE =
262 "android.telecom.event.HANDOVER_COMPLETE";
Tyler Gunn34a2b312017-06-23 08:32:00 -0700263
264 /**
265 * Call event sent from Telecom to the handover destination {@link ConnectionService} via
266 * {@link Connection#onCallEvent(String, Bundle)} to inform the handover destination that the
267 * source connection has disconnected. The {@link Bundle} parameter for the call event will be
268 * {@code null}.
269 * <p>
270 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
271 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700272 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
273 * APIs instead.
Tyler Gunn34a2b312017-06-23 08:32:00 -0700274 */
275 public static final String EVENT_HANDOVER_SOURCE_DISCONNECTED =
276 "android.telecom.event.HANDOVER_SOURCE_DISCONNECTED";
277
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700278 /**
279 * Call event sent from Telecom to the handover {@link ConnectionService} via
280 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
281 * to the {@link ConnectionService} has failed.
282 * <p>
283 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
284 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700285 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
286 * APIs instead.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700287 */
288 public static final String EVENT_HANDOVER_FAILED =
289 "android.telecom.event.HANDOVER_FAILED";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700290
Tyler Gunnd5821842021-02-05 11:12:57 -0800291 /**
292 * Event reported from the Telecom stack to report an in-call diagnostic message which the
293 * dialer app may opt to display to the user. A diagnostic message is used to communicate
294 * scenarios the device has detected which may impact the quality of the ongoing call.
295 * <p>
296 * For example a problem with a bluetooth headset may generate a recommendation for the user to
297 * try using the speakerphone instead, or if the device detects it has entered a poor service
298 * area, the user might be warned so that they can finish their call prior to it dropping.
299 * <p>
300 * A diagnostic message is considered persistent in nature. When the user enters a poor service
301 * area, for example, the accompanying diagnostic message persists until they leave the area
302 * of poor service. Each message is accompanied with a {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID}
303 * which uniquely identifies the diagnostic condition being reported. The framework raises a
304 * call event of type {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE} when the condition reported has
305 * been cleared. The dialer app should display the diagnostic message until it is cleared.
306 * If multiple diagnostic messages are sent with different IDs (which have not yet been cleared)
307 * the dialer app should prioritize the most recently received message, but still provide the
308 * user with a means to review past messages.
309 * <p>
310 * The text of the message is found in {@link #EXTRA_DIAGNOSTIC_MESSAGE} in the form of a human
311 * readable {@link CharSequence} which is intended for display in the call UX.
312 * <p>
313 * The telecom framework audibly notifies the user of the presence of a diagnostic message, so
314 * the dialer app needs only to concern itself with visually displaying the message.
315 * <p>
316 * The dialer app receives this event via
317 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
318 */
319 public static final String EVENT_DISPLAY_DIAGNOSTIC_MESSAGE =
320 "android.telecom.event.DISPLAY_DIAGNOSTIC_MESSAGE";
321
322 /**
323 * Event reported from the telecom framework when a diagnostic message previously raised with
324 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE} has cleared and is no longer pertinent.
325 * <p>
326 * The {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID} indicates the diagnostic message which has been
327 * cleared.
328 * <p>
329 * The dialer app receives this event via
330 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
331 */
332 public static final String EVENT_CLEAR_DIAGNOSTIC_MESSAGE =
333 "android.telecom.event.CLEAR_DIAGNOSTIC_MESSAGE";
334
335 /**
336 * Integer extra representing a message ID for a message posted via
337 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. Used to ensure that the dialer app knows when
338 * the message in question has cleared via {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE}.
339 */
340 public static final String EXTRA_DIAGNOSTIC_MESSAGE_ID =
341 "android.telecom.extra.DIAGNOSTIC_MESSAGE_ID";
342
343 /**
344 * {@link CharSequence} extra used with {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. This is the
345 * diagnostic message the dialer app should display.
346 */
347 public static final String EXTRA_DIAGNOSTIC_MESSAGE =
348 "android.telecom.extra.DIAGNOSTIC_MESSAGE";
Tyler Gunnfacfdee2020-01-23 13:10:37 -0800349
350 /**
351 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
352 * call because they have declined to answer it. This typically means that they are unable
353 * to answer the call at this time and would prefer it be sent to voicemail.
354 */
355 public static final int REJECT_REASON_DECLINED = 1;
356
357 /**
358 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
359 * call because it is an unwanted call. This allows the user to indicate that they are
360 * rejecting a call because it is likely a nuisance call.
361 */
362 public static final int REJECT_REASON_UNWANTED = 2;
363
364 /**
365 * @hide
366 */
367 @IntDef(prefix = { "REJECT_REASON_" },
368 value = {REJECT_REASON_DECLINED, REJECT_REASON_UNWANTED})
369 @Retention(RetentionPolicy.SOURCE)
370 public @interface RejectReason {};
371
Ihab Awade63fadb2014-07-09 21:52:04 -0700372 public static class Details {
Tyler Gunn94f8f112018-12-17 09:56:11 -0800373 /** @hide */
374 @Retention(RetentionPolicy.SOURCE)
375 @IntDef(
376 prefix = { "DIRECTION_" },
377 value = {DIRECTION_UNKNOWN, DIRECTION_INCOMING, DIRECTION_OUTGOING})
378 public @interface CallDirection {}
379
380 /**
381 * Indicates that the call is neither and incoming nor an outgoing call. This can be the
382 * case for calls reported directly by a {@link ConnectionService} in special cases such as
383 * call handovers.
384 */
385 public static final int DIRECTION_UNKNOWN = -1;
386
387 /**
388 * Indicates that the call is an incoming call.
389 */
390 public static final int DIRECTION_INCOMING = 0;
391
392 /**
393 * Indicates that the call is an outgoing call.
394 */
395 public static final int DIRECTION_OUTGOING = 1;
396
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800397 /** Call can currently be put on hold or unheld. */
398 public static final int CAPABILITY_HOLD = 0x00000001;
399
400 /** Call supports the hold feature. */
401 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
402
403 /**
404 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
405 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
406 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
407 * capability allows a merge button to be shown while the conference call is in the foreground
408 * of the in-call UI.
409 * <p>
410 * This is only intended for use by a {@link Conference}.
411 */
412 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
413
414 /**
415 * Calls within a conference can be swapped between foreground and background.
416 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
417 * <p>
418 * This is only intended for use by a {@link Conference}.
419 */
420 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
421
422 /**
423 * @hide
424 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700425 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800426
427 /** Call supports responding via text option. */
428 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
429
430 /** Call can be muted. */
431 public static final int CAPABILITY_MUTE = 0x00000040;
432
433 /**
434 * Call supports conference call management. This capability only applies to {@link Conference}
435 * calls which can have {@link Connection}s as children.
436 */
437 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
438
439 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700440 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800441 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700442 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800443
444 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700445 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800446 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700447 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800448
449 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700450 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800451 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700452 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700453 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800454
455 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700456 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800457 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700458 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
459
460 /**
461 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700462 */
463 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
464
465 /**
466 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700467 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700468 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700469 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800470
471 /**
472 * Call is able to be separated from its parent {@code Conference}, if any.
473 */
474 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
475
476 /**
477 * Call is able to be individually disconnected when in a {@code Conference}.
478 */
479 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
480
481 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500482 * Speed up audio setup for MT call.
483 * @hide
484 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700485 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
486
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700487 /**
488 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700489 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800490 * @deprecated Use {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
491 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL} to indicate for a call
492 * whether or not video calling is supported.
Rekha Kumar07366812015-03-24 16:42:31 -0700493 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800494 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Rekha Kumar07366812015-03-24 16:42:31 -0700495 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
496
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700497 /**
498 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700499 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700500 */
501 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
502
Bryce Lee81901682015-08-28 16:38:02 -0700503 /**
504 * Call sends responses through connection.
505 * @hide
506 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800507 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
508
509 /**
510 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
511 * <p>
512 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
513 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
514 * downgraded from a video call back to a VideoState of
515 * {@link VideoProfile#STATE_AUDIO_ONLY}.
516 * <p>
517 * Intuitively, a call which can be downgraded to audio should also have local and remote
518 * video
519 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
520 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
521 */
522 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700523
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700524 /**
525 * When set for an external call, indicates that this {@code Call} can be pulled from a
526 * remote device to the current device.
527 * <p>
528 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
529 * <p>
530 * An {@link InCallService} will only see calls with this capability if it has the
531 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
532 * in its manifest.
533 * <p>
534 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700535 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700536 */
537 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
538
Pooja Jaind34698d2017-12-28 14:15:31 +0530539 /** Call supports the deflect feature. */
540 public static final int CAPABILITY_SUPPORT_DEFLECT = 0x01000000;
541
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800542 /**
543 * Call supports adding participants to the call via
Grace Jia8587ee52020-07-10 15:42:32 -0700544 * {@link #addConferenceParticipants(List)}. Once participants are added, the call becomes
545 * an adhoc conference call ({@link #PROPERTY_IS_ADHOC_CONFERENCE}).
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800546 */
Ravi Paluri404babb2020-01-23 19:02:44 +0530547 public static final int CAPABILITY_ADD_PARTICIPANT = 0x02000000;
Ravi Palurif4b38e72020-02-05 12:35:41 +0530548
549 /**
550 * When set for a call, indicates that this {@code Call} can be transferred to another
551 * number.
Tyler Gunn460360d2020-07-29 10:21:45 -0700552 * Call supports the confirmed and unconfirmed call transfer feature.
Ravi Palurif4b38e72020-02-05 12:35:41 +0530553 *
554 * @hide
555 */
556 public static final int CAPABILITY_TRANSFER = 0x04000000;
557
558 /**
559 * When set for a call, indicates that this {@code Call} can be transferred to another
560 * ongoing call.
561 * Call supports the consultative call transfer feature.
562 *
563 * @hide
564 */
565 public static final int CAPABILITY_TRANSFER_CONSULTATIVE = 0x08000000;
566
Alvin Dey2f37d772018-05-18 23:16:10 +0530567 /**
568 * Indicates whether the remote party supports RTT or not to the UI.
569 */
570
571 public static final int CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT = 0x10000000;
572
Tyler Gunnd11a3152015-03-18 13:09:14 -0700573 //******************************************************************************************
Alvin Dey2f37d772018-05-18 23:16:10 +0530574 // Next CAPABILITY value: 0x20000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700575 //******************************************************************************************
576
577 /**
578 * Whether the call is currently a conference.
579 */
580 public static final int PROPERTY_CONFERENCE = 0x00000001;
581
582 /**
583 * Whether the call is a generic conference, where we do not know the precise state of
584 * participants in the conference (eg. on CDMA).
585 */
586 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
587
588 /**
589 * Whether the call is made while the device is in emergency callback mode.
590 */
591 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
592
593 /**
594 * Connection is using WIFI.
595 */
596 public static final int PROPERTY_WIFI = 0x00000008;
597
598 /**
Tyler Gunn6b6ae552018-10-11 10:42:10 -0700599 * When set, the UI should indicate to the user that a call is using high definition
600 * audio.
601 * <p>
602 * The underlying {@link ConnectionService} is responsible for reporting this
603 * property. It is important to note that this property is not intended to report the
604 * actual audio codec being used for a Call, but whether the call should be indicated
605 * to the user as high definition.
606 * <p>
607 * The Android Telephony stack reports this property for calls based on a number
608 * of factors, including which audio codec is used and whether a call is using an HD
609 * codec end-to-end. Some mobile operators choose to suppress display of an HD indication,
610 * and in these cases this property will not be set for a call even if the underlying audio
611 * codec is in fact "high definition".
Andrew Lee2378ea72015-04-29 14:38:11 -0700612 */
613 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
614
Tony Maka68dcce2015-12-17 09:31:18 +0000615 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100616 * Whether the call is associated with the work profile.
617 */
618 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
619
620 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700621 * When set, indicates that this {@code Call} does not actually exist locally for the
622 * {@link ConnectionService}.
623 * <p>
624 * Consider, for example, a scenario where a user has two phones with the same phone number.
625 * When a user places a call on one device, the telephony stack can represent that call on
626 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700627 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700628 * <p>
629 * An {@link InCallService} will only see calls with this property if it has the
630 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
631 * in its manifest.
632 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700633 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700634 */
635 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
636
Brad Ebinger15847072016-05-18 11:08:36 -0700637 /**
638 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
639 */
640 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
641
Tyler Gunn24e18332017-02-10 09:42:49 -0800642 /**
643 * Indicates that the call is from a self-managed {@link ConnectionService}.
644 * <p>
645 * See also {@link Connection#PROPERTY_SELF_MANAGED}
646 */
647 public static final int PROPERTY_SELF_MANAGED = 0x00000100;
648
Eric Erfanianec881872017-12-06 16:27:53 -0800649 /**
650 * Indicates the call used Assisted Dialing.
Tyler Gunn5567d742019-10-31 13:04:37 -0700651 *
652 * @see TelecomManager#EXTRA_USE_ASSISTED_DIALING
Eric Erfanianec881872017-12-06 16:27:53 -0800653 */
Tyler Gunnc9503d62020-01-27 10:30:51 -0800654 public static final int PROPERTY_ASSISTED_DIALING = 0x00000200;
Eric Erfanianec881872017-12-06 16:27:53 -0800655
Hall Liue9041242018-02-09 16:40:03 -0800656 /**
657 * Indicates that the call is an RTT call. Use {@link #getRttCall()} to get the
658 * {@link RttCall} object that is used to send and receive text.
659 */
660 public static final int PROPERTY_RTT = 0x00000400;
661
Tyler Gunn5bd90852018-09-21 09:37:07 -0700662 /**
663 * Indicates that the call has been identified as the network as an emergency call. This
664 * property may be set for both incoming and outgoing calls which the network identifies as
665 * emergency calls.
666 */
667 public static final int PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL = 0x00000800;
668
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700669 /**
670 * Indicates that the call is using VoIP audio mode.
671 * <p>
672 * When this property is set, the {@link android.media.AudioManager} audio mode for this
673 * call will be {@link android.media.AudioManager#MODE_IN_COMMUNICATION}. When this
674 * property is not set, the audio mode for this call will be
675 * {@link android.media.AudioManager#MODE_IN_CALL}.
676 * <p>
677 * This property reflects changes made using {@link Connection#setAudioModeIsVoip(boolean)}.
678 * <p>
679 * You can use this property to determine whether an un-answered incoming call or a held
680 * call will use VoIP audio mode (if the call does not currently have focus, the system
681 * audio mode may not reflect the mode the call will use).
682 */
683 public static final int PROPERTY_VOIP_AUDIO_MODE = 0x00001000;
684
Ravi Paluri80aa2142019-12-02 11:57:37 +0530685 /**
686 * Indicates that the call is an adhoc conference call. This property can be set for both
Grace Jia8587ee52020-07-10 15:42:32 -0700687 * incoming and outgoing calls. An adhoc conference call is formed using
688 * {@link #addConferenceParticipants(List)},
689 * {@link TelecomManager#addNewIncomingConference(PhoneAccountHandle, Bundle)}, or
690 * {@link TelecomManager#startConference(List, Bundle)}, rather than by merging existing
691 * call using {@link #conference(Call)}.
Ravi Paluri80aa2142019-12-02 11:57:37 +0530692 */
693 public static final int PROPERTY_IS_ADHOC_CONFERENCE = 0x00002000;
694
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800695 /**
Sooraj Sasindranfa1e57a2021-03-22 13:44:14 -0700696 * Connection is using cross sim technology.
697 * <p>
698 * Indicates that the {@link Connection} is using a cross sim technology which would
699 * register IMS over internet APN of default data subscription.
700 * <p>
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800701 */
702 public static final int PROPERTY_CROSS_SIM = 0x00004000;
703
Andrew Lee2378ea72015-04-29 14:38:11 -0700704 //******************************************************************************************
Ravi Paluri80aa2142019-12-02 11:57:37 +0530705 // Next PROPERTY value: 0x00004000
Tyler Gunnd11a3152015-03-18 13:09:14 -0700706 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800707
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700708 private final @CallState int mState;
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800709 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700710 private final Uri mHandle;
711 private final int mHandlePresentation;
712 private final String mCallerDisplayName;
713 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700714 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700715 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700716 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800717 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700718 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700719 private final long mConnectTimeMillis;
720 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700721 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700722 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700723 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700724 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700725 private final long mCreationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -0800726 private final String mContactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -0800727 private final @CallDirection int mCallDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -0700728 private final @Connection.VerificationStatus int mCallerNumberVerificationStatus;
Ihab Awade63fadb2014-07-09 21:52:04 -0700729
730 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800731 * Whether the supplied capabilities supports the specified capability.
732 *
733 * @param capabilities A bit field of capabilities.
734 * @param capability The capability to check capabilities for.
735 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800736 */
737 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800738 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800739 }
740
741 /**
742 * Whether the capabilities of this {@code Details} supports the specified capability.
743 *
744 * @param capability The capability to check capabilities for.
745 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800746 */
747 public boolean can(int capability) {
748 return can(mCallCapabilities, capability);
749 }
750
751 /**
752 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
753 *
754 * @param capabilities A capability bit field.
755 * @return A human readable string representation.
756 */
757 public static String capabilitiesToString(int capabilities) {
758 StringBuilder builder = new StringBuilder();
759 builder.append("[Capabilities:");
760 if (can(capabilities, CAPABILITY_HOLD)) {
761 builder.append(" CAPABILITY_HOLD");
762 }
763 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
764 builder.append(" CAPABILITY_SUPPORT_HOLD");
765 }
766 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
767 builder.append(" CAPABILITY_MERGE_CONFERENCE");
768 }
769 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
770 builder.append(" CAPABILITY_SWAP_CONFERENCE");
771 }
772 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
773 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
774 }
775 if (can(capabilities, CAPABILITY_MUTE)) {
776 builder.append(" CAPABILITY_MUTE");
777 }
778 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
779 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
780 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700781 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
782 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
783 }
784 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
785 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
786 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700787 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
788 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800789 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700790 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
791 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
792 }
793 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
794 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
795 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800796 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
797 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
798 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700799 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
800 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800801 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500802 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700803 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500804 }
Rekha Kumar07366812015-03-24 16:42:31 -0700805 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
806 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
807 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700808 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
809 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
810 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700811 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
812 builder.append(" CAPABILITY_CAN_PULL_CALL");
813 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530814 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
815 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
816 }
Ravi Paluri404babb2020-01-23 19:02:44 +0530817 if (can(capabilities, CAPABILITY_ADD_PARTICIPANT)) {
818 builder.append(" CAPABILITY_ADD_PARTICIPANT");
819 }
Ravi Palurif4b38e72020-02-05 12:35:41 +0530820 if (can(capabilities, CAPABILITY_TRANSFER)) {
821 builder.append(" CAPABILITY_TRANSFER");
822 }
823 if (can(capabilities, CAPABILITY_TRANSFER_CONSULTATIVE)) {
824 builder.append(" CAPABILITY_TRANSFER_CONSULTATIVE");
825 }
Alvin Dey2f37d772018-05-18 23:16:10 +0530826 if (can(capabilities, CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT)) {
827 builder.append(" CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT");
828 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800829 builder.append("]");
830 return builder.toString();
831 }
832
833 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700834 * Whether the supplied properties includes the specified property.
835 *
836 * @param properties A bit field of properties.
837 * @param property The property to check properties for.
838 * @return Whether the specified property is supported.
839 */
840 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800841 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700842 }
843
844 /**
845 * Whether the properties of this {@code Details} includes the specified property.
846 *
847 * @param property The property to check properties for.
848 * @return Whether the specified property is supported.
849 */
850 public boolean hasProperty(int property) {
851 return hasProperty(mCallProperties, property);
852 }
853
854 /**
855 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
856 *
857 * @param properties A property bit field.
858 * @return A human readable string representation.
859 */
860 public static String propertiesToString(int properties) {
861 StringBuilder builder = new StringBuilder();
862 builder.append("[Properties:");
863 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
864 builder.append(" PROPERTY_CONFERENCE");
865 }
866 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
867 builder.append(" PROPERTY_GENERIC_CONFERENCE");
868 }
869 if (hasProperty(properties, PROPERTY_WIFI)) {
870 builder.append(" PROPERTY_WIFI");
871 }
872 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
873 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
874 }
875 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700876 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700877 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700878 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
879 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
880 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700881 if (hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
Brad Ebinger15847072016-05-18 11:08:36 -0700882 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
883 }
Tyler Gunnc9503d62020-01-27 10:30:51 -0800884 if (hasProperty(properties, PROPERTY_ASSISTED_DIALING)) {
Eric Erfanianec881872017-12-06 16:27:53 -0800885 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
886 }
Tyler Gunn5bd90852018-09-21 09:37:07 -0700887 if (hasProperty(properties, PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL)) {
888 builder.append(" PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL");
889 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700890 if (hasProperty(properties, PROPERTY_RTT)) {
891 builder.append(" PROPERTY_RTT");
892 }
893 if (hasProperty(properties, PROPERTY_VOIP_AUDIO_MODE)) {
894 builder.append(" PROPERTY_VOIP_AUDIO_MODE");
895 }
Ravi Paluri80aa2142019-12-02 11:57:37 +0530896 if (hasProperty(properties, PROPERTY_IS_ADHOC_CONFERENCE)) {
897 builder.append(" PROPERTY_IS_ADHOC_CONFERENCE");
898 }
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800899 if (hasProperty(properties, PROPERTY_CROSS_SIM)) {
900 builder.append(" PROPERTY_CROSS_SIM");
901 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700902 builder.append("]");
903 return builder.toString();
904 }
905
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700906 /**
907 * @return the state of the {@link Call} represented by this {@link Call.Details}.
908 */
909 public final @CallState int getState() {
910 return mState;
911 }
912
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800913 /** {@hide} */
Hall Liu31de23d2019-10-11 15:38:29 -0700914 @TestApi
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800915 public String getTelecomCallId() {
916 return mTelecomCallId;
917 }
918
Andrew Lee2378ea72015-04-29 14:38:11 -0700919 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700920 * @return The handle (e.g., phone number) to which the {@code Call} is currently
921 * connected.
922 */
923 public Uri getHandle() {
924 return mHandle;
925 }
926
927 /**
928 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700929 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700930 */
931 public int getHandlePresentation() {
932 return mHandlePresentation;
933 }
934
935 /**
Tyler Gunnd081f042018-12-04 12:56:45 -0800936 * The display name for the caller.
937 * <p>
938 * This is the name as reported by the {@link ConnectionService} associated with this call.
Tyler Gunnd081f042018-12-04 12:56:45 -0800939 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700940 * @return The display name for the caller.
941 */
942 public String getCallerDisplayName() {
943 return mCallerDisplayName;
944 }
945
946 /**
947 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700948 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700949 */
950 public int getCallerDisplayNamePresentation() {
951 return mCallerDisplayNamePresentation;
952 }
953
954 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700955 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
956 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700957 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700958 public PhoneAccountHandle getAccountHandle() {
959 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -0700960 }
961
962 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800963 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
964 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -0700965 */
Ihab Awad5d0410f2014-07-30 10:07:40 -0700966 public int getCallCapabilities() {
967 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -0700968 }
969
970 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700971 * @return A bitmask of the properties of the {@code Call}, as defined by the various
972 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -0700973 */
974 public int getCallProperties() {
975 return mCallProperties;
976 }
977
978 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800979 * @return a bitmask of the audio routes available for the call.
980 *
981 * @hide
982 */
983 public int getSupportedAudioRoutes() {
984 return mSupportedAudioRoutes;
985 }
986
987 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700988 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -0700989 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700990 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700991 public DisconnectCause getDisconnectCause() {
992 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700993 }
994
995 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700996 * Returns the time the {@link Call} connected (i.e. became active). This information is
997 * updated periodically, but user interfaces should not rely on this to display the "call
998 * time clock". For the time when the call was first added to Telecom, see
999 * {@link #getCreationTimeMillis()}.
1000 *
1001 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -07001002 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -07001003 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -07001004 return mConnectTimeMillis;
1005 }
1006
1007 /**
1008 * @return Information about any calling gateway the {@code Call} may be using.
1009 */
1010 public GatewayInfo getGatewayInfo() {
1011 return mGatewayInfo;
1012 }
1013
Andrew Lee7a341382014-07-15 17:05:08 -07001014 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -07001015 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -07001016 */
1017 public int getVideoState() {
1018 return mVideoState;
1019 }
1020
Ihab Awad5d0410f2014-07-30 10:07:40 -07001021 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001022 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -07001023 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -07001024 */
1025 public StatusHints getStatusHints() {
1026 return mStatusHints;
1027 }
1028
Nancy Chen10798dc2014-08-08 14:00:25 -07001029 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -07001030 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -07001031 */
1032 public Bundle getExtras() {
1033 return mExtras;
1034 }
1035
Santos Cordon6b7f9552015-05-27 17:21:45 -07001036 /**
1037 * @return The extras used with the original intent to place this call.
1038 */
1039 public Bundle getIntentExtras() {
1040 return mIntentExtras;
1041 }
1042
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001043 /**
1044 * Returns the time when the call was first created and added to Telecom. This is the same
1045 * time that is logged as the start time in the Call Log (see
1046 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
1047 * (became active), see {@link #getConnectTimeMillis()}.
1048 *
1049 * @return The creation time of the call, in millis since the epoch.
1050 */
1051 public long getCreationTimeMillis() {
1052 return mCreationTimeMillis;
1053 }
1054
Tyler Gunnd081f042018-12-04 12:56:45 -08001055 /**
Hall Liuef98bf82020-01-09 15:22:44 -08001056 * Returns the name of the caller on the remote end, as derived from a
1057 * {@link android.provider.ContactsContract} lookup of the call's handle.
1058 * @return The name of the caller, or {@code null} if the lookup is not yet complete, if
1059 * there's no contacts entry for the caller, or if the {@link InCallService} does
1060 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
1061 */
1062 public @Nullable String getContactDisplayName() {
1063 return mContactDisplayName;
1064 }
1065
1066 /**
Tyler Gunn94f8f112018-12-17 09:56:11 -08001067 * Indicates whether the call is an incoming or outgoing call.
1068 * @return The call's direction.
1069 */
1070 public @CallDirection int getCallDirection() {
1071 return mCallDirection;
1072 }
1073
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001074 /**
1075 * Gets the verification status for the phone number of an incoming call as identified in
1076 * ATIS-1000082.
Tyler Gunn9c642492020-10-08 13:37:03 -07001077 * <p>
1078 * For incoming calls, the number verification status indicates whether the device was
1079 * able to verify the authenticity of the calling number using the STIR process outlined
1080 * in ATIS-1000082. {@link Connection#VERIFICATION_STATUS_NOT_VERIFIED} indicates that
1081 * the network was not able to use STIR to verify the caller's number (i.e. nothing is
1082 * known regarding the authenticity of the number.
1083 * {@link Connection#VERIFICATION_STATUS_PASSED} indicates that the network was able to
1084 * use STIR to verify the caller's number. This indicates that the network has a high
1085 * degree of confidence that the incoming call actually originated from the indicated
1086 * number. {@link Connection#VERIFICATION_STATUS_FAILED} indicates that the network's
1087 * STIR verification did not pass. This indicates that the incoming call may not
1088 * actually be from the indicated number. This could occur if, for example, the caller
1089 * is using an impersonated phone number.
1090 * <p>
1091 * A {@link CallScreeningService} can use this information to help determine if an
1092 * incoming call is potentially an unwanted call. A verification status of
1093 * {@link Connection#VERIFICATION_STATUS_FAILED} indicates that an incoming call may not
1094 * actually be from the number indicated on the call (i.e. impersonated number) and that it
1095 * should potentially be blocked. Likewise,
1096 * {@link Connection#VERIFICATION_STATUS_PASSED} can be used as a positive signal to
1097 * help clarify that the incoming call is originating from the indicated number and it
1098 * is less likely to be an undesirable call.
1099 * <p>
1100 * An {@link InCallService} can use this information to provide a visual indicator to the
1101 * user regarding the verification status of a call and to help identify calls from
1102 * potentially impersonated numbers.
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001103 * @return the verification status.
1104 */
1105 public @Connection.VerificationStatus int getCallerNumberVerificationStatus() {
1106 return mCallerNumberVerificationStatus;
1107 }
1108
Ihab Awade63fadb2014-07-09 21:52:04 -07001109 @Override
1110 public boolean equals(Object o) {
1111 if (o instanceof Details) {
1112 Details d = (Details) o;
1113 return
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001114 Objects.equals(mState, d.mState) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001115 Objects.equals(mHandle, d.mHandle) &&
1116 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
1117 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
1118 Objects.equals(mCallerDisplayNamePresentation,
1119 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -07001120 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -07001121 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -07001122 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001123 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001124 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -07001125 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -07001126 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -07001127 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001128 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001129 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
Tyler Gunnd081f042018-12-04 12:56:45 -08001130 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis) &&
Hall Liuef98bf82020-01-09 15:22:44 -08001131 Objects.equals(mContactDisplayName, d.mContactDisplayName) &&
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001132 Objects.equals(mCallDirection, d.mCallDirection) &&
1133 Objects.equals(mCallerNumberVerificationStatus,
1134 d.mCallerNumberVerificationStatus);
Ihab Awade63fadb2014-07-09 21:52:04 -07001135 }
1136 return false;
1137 }
1138
1139 @Override
1140 public int hashCode() {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001141 return Objects.hash(mState,
1142 mHandle,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001143 mHandlePresentation,
1144 mCallerDisplayName,
1145 mCallerDisplayNamePresentation,
1146 mAccountHandle,
1147 mCallCapabilities,
1148 mCallProperties,
1149 mDisconnectCause,
1150 mConnectTimeMillis,
1151 mGatewayInfo,
1152 mVideoState,
1153 mStatusHints,
1154 mExtras,
1155 mIntentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001156 mCreationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001157 mContactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001158 mCallDirection,
1159 mCallerNumberVerificationStatus);
Ihab Awade63fadb2014-07-09 21:52:04 -07001160 }
1161
1162 /** {@hide} */
1163 public Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001164 @CallState int state,
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001165 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -07001166 Uri handle,
1167 int handlePresentation,
1168 String callerDisplayName,
1169 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -07001170 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -07001171 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -07001172 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001173 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -07001174 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -07001175 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -07001176 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -07001177 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -07001178 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001179 Bundle intentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001180 long creationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001181 String contactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001182 int callDirection,
1183 int callerNumberVerificationStatus) {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001184 mState = state;
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001185 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001186 mHandle = handle;
1187 mHandlePresentation = handlePresentation;
1188 mCallerDisplayName = callerDisplayName;
1189 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -07001190 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -07001191 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -07001192 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001193 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001194 mConnectTimeMillis = connectTimeMillis;
1195 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -07001196 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -07001197 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -07001198 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -07001199 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001200 mCreationTimeMillis = creationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -08001201 mContactDisplayName = contactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -08001202 mCallDirection = callDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001203 mCallerNumberVerificationStatus = callerNumberVerificationStatus;
Ihab Awade63fadb2014-07-09 21:52:04 -07001204 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001205
1206 /** {@hide} */
1207 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
1208 return new Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001209 parcelableCall.getState(),
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001210 parcelableCall.getId(),
1211 parcelableCall.getHandle(),
1212 parcelableCall.getHandlePresentation(),
1213 parcelableCall.getCallerDisplayName(),
1214 parcelableCall.getCallerDisplayNamePresentation(),
1215 parcelableCall.getAccountHandle(),
1216 parcelableCall.getCapabilities(),
1217 parcelableCall.getProperties(),
1218 parcelableCall.getDisconnectCause(),
1219 parcelableCall.getConnectTimeMillis(),
1220 parcelableCall.getGatewayInfo(),
1221 parcelableCall.getVideoState(),
1222 parcelableCall.getStatusHints(),
1223 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001224 parcelableCall.getIntentExtras(),
Tyler Gunnd081f042018-12-04 12:56:45 -08001225 parcelableCall.getCreationTimeMillis(),
Hall Liuef98bf82020-01-09 15:22:44 -08001226 parcelableCall.getContactDisplayName(),
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001227 parcelableCall.getCallDirection(),
1228 parcelableCall.getCallerNumberVerificationStatus());
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001229 }
Santos Cordon3c20d632016-02-25 16:12:35 -08001230
1231 @Override
1232 public String toString() {
1233 StringBuilder sb = new StringBuilder();
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001234 sb.append("[id: ");
1235 sb.append(mTelecomCallId);
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001236 sb.append(", state: ");
1237 sb.append(Call.stateToString(mState));
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001238 sb.append(", pa: ");
Santos Cordon3c20d632016-02-25 16:12:35 -08001239 sb.append(mAccountHandle);
1240 sb.append(", hdl: ");
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001241 sb.append(Log.piiHandle(mHandle));
1242 sb.append(", hdlPres: ");
1243 sb.append(mHandlePresentation);
1244 sb.append(", videoState: ");
1245 sb.append(VideoProfile.videoStateToString(mVideoState));
Santos Cordon3c20d632016-02-25 16:12:35 -08001246 sb.append(", caps: ");
1247 sb.append(capabilitiesToString(mCallCapabilities));
1248 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -07001249 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -08001250 sb.append("]");
1251 return sb.toString();
1252 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001253 }
1254
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001255 /**
1256 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
1257 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
1258 * implementation.
1259 * <p>
1260 * You can handle these callbacks by extending the {@link Callback} class and overriding the
1261 * callbacks that your {@link InCallService} is interested in. The callback methods include the
1262 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
1263 * {@link Callback} implementation, if desired.
1264 * <p>
1265 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
1266 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
1267 * (typically in {@link InCallService#onCallRemoved(Call)}).
1268 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
1269 * reach your implementation of {@link Callback}, so it is important to register your callback
1270 * as soon as your {@link InCallService} is notified of a new call via
1271 * {@link InCallService#onCallAdded(Call)}.
1272 */
Andrew Leeda80c872015-04-15 14:09:50 -07001273 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -07001274 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001275 * @hide
1276 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001277 @IntDef(prefix = { "HANDOVER_" },
1278 value = {HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_NOT_SUPPORTED,
Tyler Gunn5c60d712018-03-16 09:53:44 -07001279 HANDOVER_FAILURE_USER_REJECTED, HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL,
Tyler Gunn9d127732018-03-02 15:45:51 -08001280 HANDOVER_FAILURE_UNKNOWN})
Sanket Padawea8eddd42017-11-03 11:07:35 -07001281 @Retention(RetentionPolicy.SOURCE)
1282 public @interface HandoverFailureErrors {}
1283
1284 /**
1285 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
Tyler Gunn9d127732018-03-02 15:45:51 -08001286 * to handover the call to rejects the handover request.
1287 * <p>
1288 * Will be returned when {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} is called
1289 * and the destination {@link PhoneAccountHandle}'s {@link ConnectionService} returns a
1290 * {@code null} {@link Connection} from
1291 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
1292 * ConnectionRequest)}.
1293 * <p>
1294 * For more information on call handovers, see
1295 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001296 */
1297 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
1298
1299 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001300 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1301 * is initiated but the source or destination app does not support handover.
1302 * <p>
1303 * Will be returned when a handover is requested via
1304 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)} and the destination
1305 * {@link PhoneAccountHandle} does not declare
1306 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}. May also be returned when a handover is
1307 * requested at the {@link PhoneAccountHandle} for the current call (i.e. the source call's
1308 * {@link Details#getAccountHandle()}) does not declare
1309 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}.
1310 * <p>
1311 * For more information on call handovers, see
1312 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001313 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001314 public static final int HANDOVER_FAILURE_NOT_SUPPORTED = 2;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001315
1316 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001317 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the remote
1318 * user rejects the handover request.
1319 * <p>
1320 * For more information on call handovers, see
1321 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001322 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001323 public static final int HANDOVER_FAILURE_USER_REJECTED = 3;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001324
Sanket Padawe85291f62017-12-01 13:59:27 -08001325 /**
1326 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
1327 * is ongoing emergency call.
Tyler Gunn9d127732018-03-02 15:45:51 -08001328 * <p>
1329 * This error code is returned when {@link #handoverTo(PhoneAccountHandle, int, Bundle)} is
1330 * called on an emergency call, or if any other call is an emergency call.
1331 * <p>
1332 * Handovers are not permitted while there are ongoing emergency calls.
1333 * <p>
1334 * For more information on call handovers, see
1335 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawe85291f62017-12-01 13:59:27 -08001336 */
Tyler Gunn5c60d712018-03-16 09:53:44 -07001337 public static final int HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL = 4;
Sanket Padawe85291f62017-12-01 13:59:27 -08001338
Tyler Gunn9d127732018-03-02 15:45:51 -08001339 /**
1340 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1341 * fails for an unknown reason.
1342 * <p>
1343 * For more information on call handovers, see
1344 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
1345 */
1346 public static final int HANDOVER_FAILURE_UNKNOWN = 5;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001347
1348 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001349 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
1350 *
Ihab Awade63fadb2014-07-09 21:52:04 -07001351 * @param call The {@code Call} invoking this method.
1352 * @param state The new state of the {@code Call}.
1353 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001354 public void onStateChanged(Call call, @CallState int state) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001355
1356 /**
1357 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
1358 *
1359 * @param call The {@code Call} invoking this method.
1360 * @param parent The new parent of the {@code Call}.
1361 */
1362 public void onParentChanged(Call call, Call parent) {}
1363
1364 /**
1365 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
1366 *
1367 * @param call The {@code Call} invoking this method.
1368 * @param children The new children of the {@code Call}.
1369 */
1370 public void onChildrenChanged(Call call, List<Call> children) {}
1371
1372 /**
1373 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
1374 *
1375 * @param call The {@code Call} invoking this method.
1376 * @param details A {@code Details} object describing the {@code Call}.
1377 */
1378 public void onDetailsChanged(Call call, Details details) {}
1379
1380 /**
1381 * Invoked when the text messages that can be used as responses to the incoming
1382 * {@code Call} are loaded from the relevant database.
1383 * See {@link #getCannedTextResponses()}.
1384 *
1385 * @param call The {@code Call} invoking this method.
1386 * @param cannedTextResponses The text messages useable as responses.
1387 */
1388 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
1389
1390 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001391 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
1392 * character. This causes the post-dial signals to stop pending user confirmation. An
1393 * implementation should present this choice to the user and invoke
1394 * {@link #postDialContinue(boolean)} when the user makes the choice.
1395 *
1396 * @param call The {@code Call} invoking this method.
1397 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
1398 */
1399 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
1400
1401 /**
Andrew Lee50aca232014-07-22 16:41:54 -07001402 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -07001403 *
1404 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -07001405 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001406 */
Andrew Lee50aca232014-07-22 16:41:54 -07001407 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001408
1409 /**
1410 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
1411 * up their UI for the {@code Call} in response to state transitions. Specifically,
1412 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
1413 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
1414 * clients should wait for this method to be invoked.
1415 *
1416 * @param call The {@code Call} being destroyed.
1417 */
1418 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001419
1420 /**
1421 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
1422 * conferenced.
1423 *
1424 * @param call The {@code Call} being updated.
1425 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
1426 * conferenced.
1427 */
1428 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001429
1430 /**
Tyler Gunn5567d742019-10-31 13:04:37 -07001431 * Invoked when a {@link Call} receives an event from its associated {@link Connection} or
1432 * {@link Conference}.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001433 * <p>
1434 * Where possible, the Call should make an attempt to handle {@link Connection} events which
1435 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1436 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1437 * possible that a {@link ConnectionService} has defined its own Connection events which a
1438 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001439 * <p>
Tyler Gunn5567d742019-10-31 13:04:37 -07001440 * See {@link Connection#sendConnectionEvent(String, Bundle)},
1441 * {@link Conference#sendConferenceEvent(String, Bundle)}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001442 *
1443 * @param call The {@code Call} receiving the event.
1444 * @param event The event.
1445 * @param extras Extras associated with the connection event.
1446 */
1447 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001448
1449 /**
1450 * Invoked when the RTT mode changes for this call.
1451 * @param call The call whose RTT mode has changed.
1452 * @param mode the new RTT mode, one of
1453 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1454 * or {@link RttCall#RTT_MODE_VCO}
1455 */
1456 public void onRttModeChanged(Call call, int mode) {}
1457
1458 /**
1459 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1460 * @param call The call whose RTT status has changed.
1461 * @param enabled whether RTT is now enabled or disabled
1462 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1463 * on, null otherwise.
1464 */
1465 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1466
1467 /**
1468 * Invoked when the remote end of the connection has requested that an RTT communication
1469 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1470 * with the same ID that this method is invoked with.
1471 * @param call The call which the RTT request was placed on
1472 * @param id The ID of the request.
1473 */
1474 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001475
1476 /**
1477 * Invoked when the RTT session failed to initiate for some reason, including rejection
1478 * by the remote party.
Tyler Gunnb9a04962022-02-17 08:23:54 -08001479 * <p>
1480 * This callback will ONLY be invoked to report a failure related to a user initiated
1481 * session modification request (i.e. {@link Call#sendRttRequest()}).
1482 * <p>
1483 * If a call is initiated with {@link TelecomManager#EXTRA_START_CALL_WITH_RTT} specified,
1484 * the availability of RTT can be determined by checking {@link Details#PROPERTY_RTT}
1485 * once the call enters state {@link Details#STATE_ACTIVE}.
1486 *
Hall Liu57006aa2017-02-06 10:49:48 -08001487 * @param call The call which the RTT initiation failure occurred on.
1488 * @param reason One of the status codes defined in
Tyler Gunnb9a04962022-02-17 08:23:54 -08001489 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1490 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
Hall Liu57006aa2017-02-06 10:49:48 -08001491 */
Tyler Gunnb9a04962022-02-17 08:23:54 -08001492 public void onRttInitiationFailure(Call call,
1493 @android.telecom.Connection.RttModifyStatus.RttSessionModifyStatus int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001494
1495 /**
1496 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1497 * has completed successfully.
Tyler Gunn9d127732018-03-02 15:45:51 -08001498 * <p>
1499 * For a full discussion of the handover process and the APIs involved, see
1500 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1501 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001502 * @param call The call which had initiated handover.
1503 */
1504 public void onHandoverComplete(Call call) {}
1505
1506 /**
1507 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1508 * has failed.
Tyler Gunn9d127732018-03-02 15:45:51 -08001509 * <p>
1510 * For a full discussion of the handover process and the APIs involved, see
1511 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1512 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001513 * @param call The call which had initiated handover.
Tyler Gunn9d127732018-03-02 15:45:51 -08001514 * @param failureReason Error reason for failure.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001515 */
1516 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001517 }
1518
1519 /**
1520 * A class that holds the state that describes the state of the RTT channel to the remote
1521 * party, if it is active.
1522 */
1523 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001524 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001525 @Retention(RetentionPolicy.SOURCE)
1526 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1527 public @interface RttAudioMode {}
1528
1529 /**
1530 * For metrics use. Default value in the proto.
1531 * @hide
1532 */
1533 public static final int RTT_MODE_INVALID = 0;
1534
1535 /**
1536 * Indicates that there should be a bidirectional audio stream between the two parties
1537 * on the call.
1538 */
1539 public static final int RTT_MODE_FULL = 1;
1540
1541 /**
1542 * Indicates that the local user should be able to hear the audio stream from the remote
1543 * user, but not vice versa. Equivalent to muting the microphone.
1544 */
1545 public static final int RTT_MODE_HCO = 2;
1546
1547 /**
1548 * Indicates that the remote user should be able to hear the audio stream from the local
1549 * user, but not vice versa. Equivalent to setting the volume to zero.
1550 */
1551 public static final int RTT_MODE_VCO = 3;
1552
1553 private static final int READ_BUFFER_SIZE = 1000;
1554
1555 private InputStreamReader mReceiveStream;
1556 private OutputStreamWriter mTransmitStream;
1557 private int mRttMode;
1558 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001559 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001560 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1561
1562 /**
1563 * @hide
1564 */
Hall Liu57006aa2017-02-06 10:49:48 -08001565 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1566 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1567 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001568 mReceiveStream = receiveStream;
1569 mTransmitStream = transmitStream;
1570 mRttMode = mode;
1571 mInCallAdapter = inCallAdapter;
1572 }
1573
1574 /**
1575 * Returns the current RTT audio mode.
1576 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1577 * {@link #RTT_MODE_HCO}.
1578 */
1579 public int getRttAudioMode() {
1580 return mRttMode;
1581 }
1582
1583 /**
1584 * Sets the RTT audio mode. The requested mode change will be communicated through
1585 * {@link Callback#onRttModeChanged(Call, int)}.
1586 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1587 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1588 */
1589 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001590 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001591 }
1592
1593 /**
1594 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
Hall Liudc46c852020-10-29 16:15:33 -07001595 * RTT transmits text in real-time, this method should be called once for each user action.
1596 * For example, when the user enters text as discrete characters using the keyboard, this
1597 * method should be called once for each character. However, if the user enters text by
1598 * pasting or autocomplete, the entire contents of the pasted or autocompleted text should
1599 * be sent in one call to this method.
Hall Liu95d55872017-01-25 17:12:49 -08001600 *
1601 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1602 * lead to interleaved text.
1603 * @param input The message to send to the remote user.
1604 */
1605 public void write(String input) throws IOException {
1606 mTransmitStream.write(input);
1607 mTransmitStream.flush();
1608 }
1609
1610 /**
1611 * Reads a string from the remote user, blocking if there is no data available. Returns
1612 * {@code null} if the RTT conversation has been terminated and there is no further data
1613 * to read.
1614 *
1615 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1616 * lead to interleaved text.
1617 * @return A string containing text sent by the remote user, or {@code null} if the
1618 * conversation has been terminated or if there was an error while reading.
1619 */
Hall Liub1c8a772017-07-17 17:04:41 -07001620 public String read() {
1621 try {
1622 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1623 if (numRead < 0) {
1624 return null;
1625 }
1626 return new String(mReadBuffer, 0, numRead);
1627 } catch (IOException e) {
1628 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001629 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001630 }
Hall Liuffa4a812017-03-02 16:11:00 -08001631 }
1632
1633 /**
1634 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1635 * be read.
1636 * @return A string containing text entered by the user, or {@code null} if the user has
1637 * not entered any new text yet.
1638 */
1639 public String readImmediately() throws IOException {
1640 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001641 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1642 if (numRead < 0) {
1643 return null;
1644 }
1645 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001646 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001647 return null;
1648 }
1649 }
Hall Liue9041242018-02-09 16:40:03 -08001650
1651 /**
1652 * Closes the underlying file descriptors
1653 * @hide
1654 */
1655 public void close() {
1656 try {
1657 mReceiveStream.close();
1658 } catch (IOException e) {
1659 // ignore
1660 }
1661 try {
1662 mTransmitStream.close();
1663 } catch (IOException e) {
1664 // ignore
1665 }
1666 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001667 }
1668
Andrew Leeda80c872015-04-15 14:09:50 -07001669 /**
1670 * @deprecated Use {@code Call.Callback} instead.
1671 * @hide
1672 */
1673 @Deprecated
1674 @SystemApi
1675 public static abstract class Listener extends Callback { }
1676
Ihab Awade63fadb2014-07-09 21:52:04 -07001677 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001678 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001679 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001680 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001681 private final List<Call> mChildren = new ArrayList<>();
1682 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001683 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001684 private final List<Call> mConferenceableCalls = new ArrayList<>();
1685 private final List<Call> mUnmodifiableConferenceableCalls =
1686 Collections.unmodifiableList(mConferenceableCalls);
1687
Santos Cordon823fd3c2014-08-07 18:35:18 -07001688 private boolean mChildrenCached;
1689 private String mParentId = null;
Hall Liuef98bf82020-01-09 15:22:44 -08001690 private String mActiveGenericConferenceChild = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001691 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001692 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001693 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001694 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001695 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001696 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001697 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001698 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001699 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001700
1701 /**
1702 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1703 *
1704 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1705 * remaining or this {@code Call} is not in a post-dial state.
1706 */
1707 public String getRemainingPostDialSequence() {
1708 return mRemainingPostDialSequence;
1709 }
1710
1711 /**
1712 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001713 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001714 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001715 public void answer(@VideoProfile.VideoState int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001716 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001717 }
1718
1719 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301720 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1721 *
1722 * @param address The address to which the call will be deflected.
1723 */
1724 public void deflect(Uri address) {
1725 mInCallAdapter.deflectCall(mTelecomCallId, address);
1726 }
1727
1728 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001729 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1730 *
1731 * @param rejectWithMessage Whether to reject with a text message.
1732 * @param textMessage An optional text message with which to respond.
1733 */
1734 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001735 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001736 }
1737
1738 /**
Tyler Gunnfacfdee2020-01-23 13:10:37 -08001739 * Instructs the {@link ConnectionService} providing this {@link #STATE_RINGING} call that the
1740 * user has chosen to reject the call and has indicated a reason why the call is being rejected.
1741 *
1742 * @param rejectReason the reason the call is being rejected.
1743 */
1744 public void reject(@RejectReason int rejectReason) {
1745 mInCallAdapter.rejectCall(mTelecomCallId, rejectReason);
1746 }
1747
1748 /**
Ravi Palurif4b38e72020-02-05 12:35:41 +05301749 * Instructs this {@code Call} to be transferred to another number.
1750 *
1751 * @param targetNumber The address to which the call will be transferred.
Tyler Gunn460360d2020-07-29 10:21:45 -07001752 * @param isConfirmationRequired if {@code true} it will initiate a confirmed transfer,
1753 * if {@code false}, it will initiate an unconfirmed transfer.
Ravi Palurif4b38e72020-02-05 12:35:41 +05301754 *
1755 * @hide
1756 */
1757 public void transfer(@NonNull Uri targetNumber, boolean isConfirmationRequired) {
1758 mInCallAdapter.transferCall(mTelecomCallId, targetNumber, isConfirmationRequired);
1759 }
1760
1761 /**
1762 * Instructs this {@code Call} to be transferred to another ongoing call.
1763 * This will initiate CONSULTATIVE transfer.
1764 * @param toCall The other ongoing {@code Call} to which this call will be transferred.
1765 *
1766 * @hide
1767 */
1768 public void transfer(@NonNull android.telecom.Call toCall) {
1769 mInCallAdapter.transferCall(mTelecomCallId, toCall.mTelecomCallId);
1770 }
1771
1772 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001773 * Instructs this {@code Call} to disconnect.
1774 */
1775 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001776 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001777 }
1778
1779 /**
1780 * Instructs this {@code Call} to go on hold.
1781 */
1782 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001783 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001784 }
1785
1786 /**
1787 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1788 */
1789 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001790 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001791 }
1792
1793 /**
Hall Liu6dfa2492019-10-01 17:20:39 -07001794 * Instructs Telecom to put the call into the background audio processing state.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001795 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001796 * This method can be called either when the call is in {@link #STATE_RINGING} or
1797 * {@link #STATE_ACTIVE}. After Telecom acknowledges the request by setting the call's state to
1798 * {@link #STATE_AUDIO_PROCESSING}, your app may setup the audio paths with the audio stack in
1799 * order to capture and play audio on the call stream.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001800 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001801 * This method can only be called by the default dialer app.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001802 * <p>
1803 * Apps built with SDK version {@link android.os.Build.VERSION_CODES#R} or later which are using
1804 * the microphone as part of audio processing should specify the foreground service type using
1805 * the attribute {@link android.R.attr#foregroundServiceType} in the {@link InCallService}
1806 * service element of the app's manifest file.
1807 * The {@link ServiceInfo#FOREGROUND_SERVICE_TYPE_MICROPHONE} attribute should be specified.
1808 * @see <a href="https://developer.android.com/preview/privacy/foreground-service-types">
1809 * the Android Developer Site</a> for more information.
Hall Liu6dfa2492019-10-01 17:20:39 -07001810 * @hide
1811 */
1812 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001813 public void enterBackgroundAudioProcessing() {
1814 if (mState != STATE_ACTIVE && mState != STATE_RINGING) {
1815 throw new IllegalStateException("Call must be active or ringing");
1816 }
1817 mInCallAdapter.enterBackgroundAudioProcessing(mTelecomCallId);
1818 }
1819
1820 /**
1821 * Instructs Telecom to come out of the background audio processing state requested by
1822 * {@link #enterBackgroundAudioProcessing()} or from the call screening service.
1823 *
1824 * This method can only be called when the call is in {@link #STATE_AUDIO_PROCESSING}.
1825 *
1826 * @param shouldRing If true, Telecom will put the call into the
1827 * {@link #STATE_SIMULATED_RINGING} state and notify other apps that there is
1828 * a ringing call. Otherwise, the call will go into {@link #STATE_ACTIVE}
1829 * immediately.
1830 * @hide
1831 */
1832 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001833 public void exitBackgroundAudioProcessing(boolean shouldRing) {
1834 if (mState != STATE_AUDIO_PROCESSING) {
1835 throw new IllegalStateException("Call must in the audio processing state");
1836 }
1837 mInCallAdapter.exitBackgroundAudioProcessing(mTelecomCallId, shouldRing);
1838 }
1839
1840 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001841 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
Tyler Gunn2517d032023-02-06 16:34:54 +00001842 * <p>
1843 * Tones are both played locally for the user to hear and sent to the network to be relayed
1844 * to the remote device.
1845 * <p>
1846 * You must ensure that any call to {@link #playDtmfTone(char}) is followed by a matching
1847 * call to {@link #stopDtmfTone()} and that each tone is stopped before a new one is started.
1848 * The play and stop commands are relayed to the underlying
1849 * {@link android.telecom.ConnectionService} as executed; implementations may not correctly
1850 * handle out of order commands.
Ihab Awade63fadb2014-07-09 21:52:04 -07001851 *
1852 * @param digit A character representing the DTMF digit for which to play the tone. This
1853 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1854 */
1855 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001856 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001857 }
1858
1859 /**
1860 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1861 * currently playing.
1862 *
1863 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1864 * currently playing, this method will do nothing.
1865 */
1866 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001867 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001868 }
1869
1870 /**
1871 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1872 *
1873 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1874 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001875 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001876 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001877 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1878 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001879 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001880 * {@code Call} will pause playing the tones and notify callbacks via
1881 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001882 * should display to the user an indication of this state and an affordance to continue
1883 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1884 * app should invoke the {@link #postDialContinue(boolean)} method.
1885 *
1886 * @param proceed Whether or not to continue with the post-dial sequence.
1887 */
1888 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001889 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001890 }
1891
1892 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001893 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001894 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001895 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001896 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1897 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001898
1899 }
1900
1901 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001902 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001903 *
1904 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001905 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001906 public void conference(Call callToConferenceWith) {
1907 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001908 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001909 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001910 }
1911
1912 /**
1913 * Instructs this {@code Call} to split from any conference call with which it may be
1914 * connected.
1915 */
1916 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001917 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001918 }
1919
1920 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001921 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001922 */
1923 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001924 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001925 }
1926
1927 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001928 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001929 */
1930 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001931 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001932 }
1933
1934 /**
Ravi Paluri404babb2020-01-23 19:02:44 +05301935 * Pulls participants to existing call by forming a conference call.
1936 * See {@link Details#CAPABILITY_ADD_PARTICIPANT}.
1937 *
1938 * @param participants participants to be pulled to existing call.
1939 */
1940 public void addConferenceParticipants(@NonNull List<Uri> participants) {
1941 mInCallAdapter.addConferenceParticipants(mTelecomCallId, participants);
1942 }
1943
1944 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001945 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1946 * device.
1947 * <p>
1948 * Calls to this method are ignored if the call does not have the
1949 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
1950 * <p>
1951 * An {@link InCallService} will only see calls which support this method if it has the
1952 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
1953 * in its manifest.
1954 */
1955 public void pullExternalCall() {
1956 // If this isn't an external call, ignore the request.
1957 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
1958 return;
1959 }
1960
1961 mInCallAdapter.pullExternalCall(mTelecomCallId);
1962 }
1963
1964 /**
1965 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
1966 * the {@link ConnectionService}.
1967 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001968 * Call events are used to communicate point in time information from an {@link InCallService}
1969 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
1970 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
1971 * {@link ConnectionService}.
1972 * <p>
1973 * A {@link ConnectionService} can communicate to the {@link InCallService} using
1974 * {@link Connection#sendConnectionEvent(String, Bundle)}.
1975 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001976 * Events are exposed to {@link ConnectionService} implementations via
1977 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
1978 * <p>
1979 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001980 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
1981 * ignore some events altogether.
1982 * <p>
1983 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
1984 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
1985 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
1986 * they define their own event types in this namespace. When defining a custom event type,
1987 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
1988 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
1989 * <p>
1990 * When defining events and the associated extras, it is important to keep their behavior
1991 * consistent when the associated {@link InCallService} is updated. Support for deprecated
1992 * events/extras should me maintained to ensure backwards compatibility with older
1993 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001994 *
1995 * @param event The connection event.
1996 * @param extras Bundle containing extra information associated with the event.
1997 */
1998 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08001999 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002000 }
2001
2002 /**
Hall Liu95d55872017-01-25 17:12:49 -08002003 * Sends an RTT upgrade request to the remote end of the connection. Success is not
2004 * guaranteed, and notification of success will be via the
2005 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2006 */
2007 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08002008 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002009 }
2010
2011 /**
2012 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
2013 * callback.
2014 * The ID used here should be the same as the ID that was received via the callback.
2015 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
2016 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
2017 */
2018 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08002019 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08002020 }
2021
2022 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07002023 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
2024 * by {@code toHandle}. The videoState specified indicates the desired video state after the
2025 * handover.
2026 * <p>
Tyler Gunn9d127732018-03-02 15:45:51 -08002027 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2028 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2029 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2030 * is referred to as the source of the handover, and the video calling app is referred to as the
2031 * destination.
2032 * <p>
2033 * When considering a handover scenario the device this method is called on is considered the
2034 * <em>initiating</em> device (since the user initiates the handover from this device), and the
2035 * other device is considered the <em>receiving</em> device.
2036 * <p>
2037 * When this method is called on the <em>initiating</em> device, the Telecom framework will bind
2038 * to the {@link ConnectionService} defined by the {@code toHandle} {@link PhoneAccountHandle}
2039 * and invoke
2040 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
2041 * ConnectionRequest)} to inform the destination app that a request has been made to handover a
2042 * call to it. The app returns an instance of {@link Connection} to represent the handover call
2043 * At this point the app should display UI to indicate to the user that a call
2044 * handover is in process.
2045 * <p>
2046 * The destination app is responsible for communicating the handover request from the
2047 * <em>initiating</em> device to the <em>receiving</em> device.
2048 * <p>
2049 * When the app on the <em>receiving</em> device receives the handover request, it calls
2050 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)} to continue the handover
2051 * process from the <em>initiating</em> device to the <em>receiving</em> device. At this point
2052 * the destination app on the <em>receiving</em> device should show UI to allow the user to
2053 * choose whether they want to continue their call in the destination app.
2054 * <p>
2055 * When the destination app on the <em>receiving</em> device calls
2056 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)}, Telecom will bind to its
2057 * {@link ConnectionService} and call
2058 * {@link ConnectionService#onCreateIncomingHandoverConnection(PhoneAccountHandle,
2059 * ConnectionRequest)} to inform it of the handover request. The app returns an instance of
2060 * {@link Connection} to represent the handover call.
2061 * <p>
2062 * If the user of the <em>receiving</em> device accepts the handover, the app calls
2063 * {@link Connection#setActive()} to complete the handover process; Telecom will disconnect the
2064 * original call. If the user rejects the handover, the app calls
2065 * {@link Connection#setDisconnected(DisconnectCause)} and specifies a {@link DisconnectCause}
2066 * of {@link DisconnectCause#CANCELED} to indicate that the handover has been cancelled.
2067 * <p>
2068 * Telecom will only allow handovers from {@link PhoneAccount}s which declare
2069 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}. Similarly, the {@link PhoneAccount}
2070 * specified by {@code toHandle} must declare {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}.
2071 * <p>
2072 * Errors in the handover process are reported to the {@link InCallService} via
2073 * {@link Callback#onHandoverFailed(Call, int)}. Errors in the handover process are reported to
2074 * the involved {@link ConnectionService}s via
2075 * {@link ConnectionService#onHandoverFailed(ConnectionRequest, int)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07002076 *
2077 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
2078 * this call to.
Tyler Gunn9d127732018-03-02 15:45:51 -08002079 * @param videoState Indicates the video state desired after the handover (see the
2080 * {@code STATE_*} constants defined in {@link VideoProfile}).
Sanket Padawea8eddd42017-11-03 11:07:35 -07002081 * @param extras Bundle containing extra information to be passed to the
2082 * {@link ConnectionService}
2083 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002084 public void handoverTo(PhoneAccountHandle toHandle, @VideoProfile.VideoState int videoState,
2085 Bundle extras) {
Sanket Padawea8eddd42017-11-03 11:07:35 -07002086 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
2087 }
2088
2089 /**
Hall Liu95d55872017-01-25 17:12:49 -08002090 * Terminate the RTT session on this call. The resulting state change will be notified via
2091 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2092 */
2093 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08002094 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002095 }
2096
2097 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07002098 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
2099 * added.
2100 * <p>
2101 * No assumptions should be made as to how an In-Call UI or service will handle these
2102 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
2103 *
2104 * @param extras The extras to add.
2105 */
2106 public final void putExtras(Bundle extras) {
2107 if (extras == null) {
2108 return;
2109 }
2110
2111 if (mExtras == null) {
2112 mExtras = new Bundle();
2113 }
2114 mExtras.putAll(extras);
2115 mInCallAdapter.putExtras(mTelecomCallId, extras);
2116 }
2117
2118 /**
2119 * Adds a boolean extra to this {@link Call}.
2120 *
2121 * @param key The extra key.
2122 * @param value The value.
2123 * @hide
2124 */
2125 public final void putExtra(String key, boolean value) {
2126 if (mExtras == null) {
2127 mExtras = new Bundle();
2128 }
2129 mExtras.putBoolean(key, value);
2130 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2131 }
2132
2133 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002134 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002135 *
2136 * @param key The extra key.
2137 * @param value The value.
2138 * @hide
2139 */
2140 public final void putExtra(String key, int value) {
2141 if (mExtras == null) {
2142 mExtras = new Bundle();
2143 }
2144 mExtras.putInt(key, value);
2145 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2146 }
2147
2148 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002149 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002150 *
2151 * @param key The extra key.
2152 * @param value The value.
2153 * @hide
2154 */
2155 public final void putExtra(String key, String value) {
2156 if (mExtras == null) {
2157 mExtras = new Bundle();
2158 }
2159 mExtras.putString(key, value);
2160 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2161 }
2162
2163 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002164 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002165 *
2166 * @param keys The keys of the extras to remove.
2167 */
2168 public final void removeExtras(List<String> keys) {
2169 if (mExtras != null) {
2170 for (String key : keys) {
2171 mExtras.remove(key);
2172 }
2173 if (mExtras.size() == 0) {
2174 mExtras = null;
2175 }
2176 }
2177 mInCallAdapter.removeExtras(mTelecomCallId, keys);
2178 }
2179
2180 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002181 * Removes extras from this {@link Call}.
2182 *
2183 * @param keys The keys of the extras to remove.
2184 */
2185 public final void removeExtras(String ... keys) {
2186 removeExtras(Arrays.asList(keys));
2187 }
2188
2189 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002190 * Obtains the parent of this {@code Call} in a conference, if any.
2191 *
2192 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
2193 * child of any conference {@code Call}s.
2194 */
2195 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002196 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002197 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002198 }
2199 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07002200 }
2201
2202 /**
2203 * Obtains the children of this conference {@code Call}, if any.
2204 *
2205 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
2206 * {@code List} otherwise.
2207 */
2208 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002209 if (!mChildrenCached) {
2210 mChildrenCached = true;
2211 mChildren.clear();
2212
2213 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002214 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002215 if (call == null) {
2216 // At least one child was still not found, so do not save true for "cached"
2217 mChildrenCached = false;
2218 } else {
2219 mChildren.add(call);
2220 }
2221 }
2222 }
2223
Ihab Awade63fadb2014-07-09 21:52:04 -07002224 return mUnmodifiableChildren;
2225 }
2226
2227 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002228 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
2229 *
2230 * @return The list of conferenceable {@code Call}s.
2231 */
2232 public List<Call> getConferenceableCalls() {
2233 return mUnmodifiableConferenceableCalls;
2234 }
2235
2236 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002237 * Obtains the state of this {@code Call}.
2238 *
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002239 * @return The call state.
2240 * @deprecated The call state is available via {@link Call.Details#getState()}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002241 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002242 @Deprecated
2243 public @CallState int getState() {
Ihab Awade63fadb2014-07-09 21:52:04 -07002244 return mState;
2245 }
2246
2247 /**
Hall Liuef98bf82020-01-09 15:22:44 -08002248 * Returns the child {@link Call} in a generic conference that is currently active.
Hall Liu135e53aa2020-02-27 18:34:11 -08002249 *
2250 * A "generic conference" is the mechanism used to support two simultaneous calls on a device
2251 * in CDMA networks. It is effectively equivalent to having one call active and one call on hold
2252 * in GSM or IMS calls. This method returns the currently active call.
2253 *
2254 * In a generic conference, the network exposes the conference to us as a single call, and we
2255 * switch between talking to the two participants using a CDMA flash command. Since the network
2256 * exposes no additional information about the call, the only way we know which caller we're
2257 * currently talking to is by keeping track of the flash commands that we've sent to the
2258 * network.
2259 *
Hall Liuef98bf82020-01-09 15:22:44 -08002260 * For calls that are not generic conferences, or when the generic conference has more than
2261 * 2 children, returns {@code null}.
2262 * @see Details#PROPERTY_GENERIC_CONFERENCE
2263 * @return The active child call.
2264 */
2265 public @Nullable Call getGenericConferenceActiveChildCall() {
2266 if (mActiveGenericConferenceChild != null) {
2267 return mPhone.internalGetCallByTelecomId(mActiveGenericConferenceChild);
2268 }
2269 return null;
2270 }
2271
2272 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002273 * Obtains a list of canned, pre-configured message responses to present to the user as
Tyler Gunn434fc2c2020-10-06 14:23:54 -07002274 * ways of rejecting an incoming {@code Call} using via a text message.
2275 * <p>
2276 * <em>Note:</em> Since canned responses may be loaded from the file system, they are not
2277 * guaranteed to be present when this {@link Call} is first added to the {@link InCallService}
2278 * via {@link InCallService#onCallAdded(Call)}. The callback
2279 * {@link Call.Callback#onCannedTextResponsesLoaded(Call, List)} will be called when/if canned
2280 * responses for the call become available.
Ihab Awade63fadb2014-07-09 21:52:04 -07002281 *
2282 * @see #reject(boolean, String)
2283 *
2284 * @return A list of canned text message responses.
2285 */
2286 public List<String> getCannedTextResponses() {
2287 return mCannedTextResponses;
2288 }
2289
2290 /**
2291 * Obtains an object that can be used to display video from this {@code Call}.
2292 *
Andrew Lee50aca232014-07-22 16:41:54 -07002293 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002294 */
Andrew Lee50aca232014-07-22 16:41:54 -07002295 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002296 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07002297 }
2298
2299 /**
2300 * Obtains an object containing call details.
2301 *
2302 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
2303 * result may be {@code null}.
2304 */
2305 public Details getDetails() {
2306 return mDetails;
2307 }
2308
2309 /**
Hall Liu95d55872017-01-25 17:12:49 -08002310 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
2311 * receive RTT text data, as well as to change the RTT mode.
2312 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
2313 */
2314 public @Nullable RttCall getRttCall() {
2315 return mRttCall;
2316 }
2317
2318 /**
2319 * Returns whether this call has an active RTT connection.
2320 * @return true if there is a connection, false otherwise.
2321 */
2322 public boolean isRttActive() {
Hall Liue9041242018-02-09 16:40:03 -08002323 return mRttCall != null && mDetails.hasProperty(Details.PROPERTY_RTT);
Hall Liu95d55872017-01-25 17:12:49 -08002324 }
2325
2326 /**
Andrew Leeda80c872015-04-15 14:09:50 -07002327 * Registers a callback to this {@code Call}.
2328 *
2329 * @param callback A {@code Callback}.
2330 */
2331 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07002332 registerCallback(callback, new Handler());
2333 }
2334
2335 /**
2336 * Registers a callback to this {@code Call}.
2337 *
2338 * @param callback A {@code Callback}.
2339 * @param handler A handler which command and status changes will be delivered to.
2340 */
2341 public void registerCallback(Callback callback, Handler handler) {
2342 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07002343 // Don't allow new callback registration if the call is already being destroyed.
2344 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002345 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
2346 }
Andrew Leeda80c872015-04-15 14:09:50 -07002347 }
2348
2349 /**
2350 * Unregisters a callback from this {@code Call}.
2351 *
2352 * @param callback A {@code Callback}.
2353 */
2354 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07002355 // Don't allow callback deregistration if the call is already being destroyed.
2356 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002357 for (CallbackRecord<Callback> record : mCallbackRecords) {
2358 if (record.getCallback() == callback) {
2359 mCallbackRecords.remove(record);
2360 break;
2361 }
2362 }
Andrew Leeda80c872015-04-15 14:09:50 -07002363 }
2364 }
2365
Santos Cordon3c20d632016-02-25 16:12:35 -08002366 @Override
2367 public String toString() {
2368 return new StringBuilder().
2369 append("Call [id: ").
2370 append(mTelecomCallId).
2371 append(", state: ").
2372 append(stateToString(mState)).
2373 append(", details: ").
2374 append(mDetails).
2375 append("]").toString();
2376 }
2377
2378 /**
2379 * @param state An integer value of a {@code STATE_*} constant.
2380 * @return A string representation of the value.
2381 */
2382 private static String stateToString(int state) {
2383 switch (state) {
2384 case STATE_NEW:
2385 return "NEW";
2386 case STATE_RINGING:
2387 return "RINGING";
2388 case STATE_DIALING:
2389 return "DIALING";
2390 case STATE_ACTIVE:
2391 return "ACTIVE";
2392 case STATE_HOLDING:
2393 return "HOLDING";
2394 case STATE_DISCONNECTED:
2395 return "DISCONNECTED";
2396 case STATE_CONNECTING:
2397 return "CONNECTING";
2398 case STATE_DISCONNECTING:
2399 return "DISCONNECTING";
2400 case STATE_SELECT_PHONE_ACCOUNT:
2401 return "SELECT_PHONE_ACCOUNT";
Hall Liu4e35b642019-10-14 17:50:45 -07002402 case STATE_SIMULATED_RINGING:
2403 return "SIMULATED_RINGING";
2404 case STATE_AUDIO_PROCESSING:
2405 return "AUDIO_PROCESSING";
Santos Cordon3c20d632016-02-25 16:12:35 -08002406 default:
2407 Log.w(Call.class, "Unknown state %d", state);
2408 return "UNKNOWN";
2409 }
2410 }
2411
Andrew Leeda80c872015-04-15 14:09:50 -07002412 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002413 * Adds a listener to this {@code Call}.
2414 *
2415 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002416 * @deprecated Use {@link #registerCallback} instead.
2417 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002418 */
Andrew Leeda80c872015-04-15 14:09:50 -07002419 @Deprecated
2420 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002421 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002422 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002423 }
2424
2425 /**
2426 * Removes a listener from this {@code Call}.
2427 *
2428 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002429 * @deprecated Use {@link #unregisterCallback} instead.
2430 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002431 */
Andrew Leeda80c872015-04-15 14:09:50 -07002432 @Deprecated
2433 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002434 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002435 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002436 }
2437
2438 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08002439 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
2440 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002441 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002442 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002443 mInCallAdapter = inCallAdapter;
2444 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002445 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002446 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07002447 }
2448
2449 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08002450 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08002451 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002452 mPhone = phone;
2453 mTelecomCallId = telecomCallId;
2454 mInCallAdapter = inCallAdapter;
2455 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002456 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002457 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002458 }
2459
2460 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002461 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002462 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002463 }
2464
2465 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002466 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08002467
Ihab Awade63fadb2014-07-09 21:52:04 -07002468 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08002469 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07002470 boolean detailsChanged = !Objects.equals(mDetails, details);
2471 if (detailsChanged) {
2472 mDetails = details;
2473 }
2474
2475 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07002476 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
2477 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
2478 mCannedTextResponses =
2479 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07002480 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07002481 }
2482
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002483 IVideoProvider previousVideoProvider = mVideoCallImpl == null ? null :
2484 mVideoCallImpl.getVideoProvider();
2485 IVideoProvider newVideoProvider = parcelableCall.getVideoProvider();
2486
2487 // parcelableCall.isVideoCallProviderChanged is only true when we have a video provider
2488 // specified; so we should check if the actual IVideoProvider changes as well.
2489 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged()
2490 && !Objects.equals(previousVideoProvider, newVideoProvider);
Andrew Lee50aca232014-07-22 16:41:54 -07002491 if (videoCallChanged) {
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002492 if (mVideoCallImpl != null) {
2493 mVideoCallImpl.destroy();
2494 }
2495 mVideoCallImpl = parcelableCall.isVideoCallProviderChanged() ?
2496 parcelableCall.getVideoCallImpl(mCallingPackage, mTargetSdkVersion) : null;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002497 }
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002498
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002499 if (mVideoCallImpl != null) {
2500 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07002501 }
2502
Santos Cordone3c507b2015-04-23 14:44:19 -07002503 int state = parcelableCall.getState();
Hall Liu31de23d2019-10-11 15:38:29 -07002504 if (mTargetSdkVersion < Phone.SDK_VERSION_R && state == Call.STATE_SIMULATED_RINGING) {
2505 state = Call.STATE_RINGING;
2506 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002507 boolean stateChanged = mState != state;
2508 if (stateChanged) {
2509 mState = state;
2510 }
2511
Santos Cordon823fd3c2014-08-07 18:35:18 -07002512 String parentId = parcelableCall.getParentCallId();
2513 boolean parentChanged = !Objects.equals(mParentId, parentId);
2514 if (parentChanged) {
2515 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002516 }
2517
Santos Cordon823fd3c2014-08-07 18:35:18 -07002518 List<String> childCallIds = parcelableCall.getChildCallIds();
2519 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
2520 if (childrenChanged) {
2521 mChildrenIds.clear();
2522 mChildrenIds.addAll(parcelableCall.getChildCallIds());
2523 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07002524 }
2525
Hall Liuef98bf82020-01-09 15:22:44 -08002526 String activeChildCallId = parcelableCall.getActiveChildCallId();
2527 boolean activeChildChanged = !Objects.equals(activeChildCallId,
2528 mActiveGenericConferenceChild);
2529 if (activeChildChanged) {
2530 mActiveGenericConferenceChild = activeChildCallId;
2531 }
2532
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002533 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
2534 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
2535 for (String otherId : conferenceableCallIds) {
2536 if (callIdMap.containsKey(otherId)) {
2537 conferenceableCalls.add(callIdMap.get(otherId));
2538 }
2539 }
2540
2541 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
2542 mConferenceableCalls.clear();
2543 mConferenceableCalls.addAll(conferenceableCalls);
2544 fireConferenceableCallsChanged();
2545 }
2546
Hall Liu95d55872017-01-25 17:12:49 -08002547 boolean isRttChanged = false;
2548 boolean rttModeChanged = false;
Hall Liue9041242018-02-09 16:40:03 -08002549 if (parcelableCall.getIsRttCallChanged()
2550 && mDetails.hasProperty(Details.PROPERTY_RTT)) {
Hall Liu95d55872017-01-25 17:12:49 -08002551 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
2552 InputStreamReader receiveStream = new InputStreamReader(
2553 new ParcelFileDescriptor.AutoCloseInputStream(
2554 parcelableRttCall.getReceiveStream()),
2555 StandardCharsets.UTF_8);
2556 OutputStreamWriter transmitStream = new OutputStreamWriter(
2557 new ParcelFileDescriptor.AutoCloseOutputStream(
2558 parcelableRttCall.getTransmitStream()),
2559 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08002560 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08002561 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
2562 if (mRttCall == null) {
2563 isRttChanged = true;
2564 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
2565 rttModeChanged = true;
2566 }
2567 mRttCall = newRttCall;
2568 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
2569 && parcelableCall.getIsRttCallChanged()) {
2570 isRttChanged = true;
Tyler Gunn4cd42482021-04-30 16:23:15 -07002571 mRttCall.close();
Hall Liu95d55872017-01-25 17:12:49 -08002572 mRttCall = null;
2573 }
2574
Ihab Awade63fadb2014-07-09 21:52:04 -07002575 // Now we fire updates, ensuring that any client who listens to any of these notifications
2576 // gets the most up-to-date state.
2577
2578 if (stateChanged) {
2579 fireStateChanged(mState);
2580 }
2581 if (detailsChanged) {
2582 fireDetailsChanged(mDetails);
2583 }
2584 if (cannedTextResponsesChanged) {
2585 fireCannedTextResponsesLoaded(mCannedTextResponses);
2586 }
Andrew Lee50aca232014-07-22 16:41:54 -07002587 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002588 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07002589 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07002590 if (parentChanged) {
2591 fireParentChanged(getParent());
2592 }
Hall Liuef98bf82020-01-09 15:22:44 -08002593 if (childrenChanged || activeChildChanged) {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002594 fireChildrenChanged(getChildren());
2595 }
Hall Liu95d55872017-01-25 17:12:49 -08002596 if (isRttChanged) {
2597 fireOnIsRttChanged(mRttCall != null, mRttCall);
2598 }
2599 if (rttModeChanged) {
2600 fireOnRttModeChanged(mRttCall.getRttAudioMode());
2601 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002602
2603 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
2604 // remove ourselves from the Phone. Note that we do this after completing all state updates
2605 // so a client can cleanly transition all their UI to the state appropriate for a
2606 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
2607 if (mState == STATE_DISCONNECTED) {
2608 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07002609 }
2610 }
2611
2612 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002613 final void internalSetPostDialWait(String remaining) {
2614 mRemainingPostDialSequence = remaining;
2615 firePostDialWait(mRemainingPostDialSequence);
2616 }
2617
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07002618 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07002619 final void internalSetDisconnected() {
2620 if (mState != Call.STATE_DISCONNECTED) {
2621 mState = Call.STATE_DISCONNECTED;
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002622 if (mDetails != null) {
2623 mDetails = new Details(mState,
2624 mDetails.getTelecomCallId(),
2625 mDetails.getHandle(),
2626 mDetails.getHandlePresentation(),
2627 mDetails.getCallerDisplayName(),
2628 mDetails.getCallerDisplayNamePresentation(),
2629 mDetails.getAccountHandle(),
2630 mDetails.getCallCapabilities(),
2631 mDetails.getCallProperties(),
2632 mDetails.getDisconnectCause(),
2633 mDetails.getConnectTimeMillis(),
2634 mDetails.getGatewayInfo(),
2635 mDetails.getVideoState(),
2636 mDetails.getStatusHints(),
2637 mDetails.getExtras(),
2638 mDetails.getIntentExtras(),
2639 mDetails.getCreationTimeMillis(),
2640 mDetails.getContactDisplayName(),
2641 mDetails.getCallDirection(),
2642 mDetails.getCallerNumberVerificationStatus()
2643 );
2644 fireDetailsChanged(mDetails);
2645 }
Santos Cordonf30d7e92014-08-26 09:54:33 -07002646 fireStateChanged(mState);
2647 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07002648 }
2649 }
2650
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002651 /** {@hide} */
2652 final void internalOnConnectionEvent(String event, Bundle extras) {
2653 fireOnConnectionEvent(event, extras);
2654 }
2655
Hall Liu95d55872017-01-25 17:12:49 -08002656 /** {@hide} */
2657 final void internalOnRttUpgradeRequest(final int requestId) {
2658 for (CallbackRecord<Callback> record : mCallbackRecords) {
2659 final Call call = this;
2660 final Callback callback = record.getCallback();
2661 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
2662 }
2663 }
2664
Hall Liu57006aa2017-02-06 10:49:48 -08002665 /** @hide */
2666 final void internalOnRttInitiationFailure(int reason) {
2667 for (CallbackRecord<Callback> record : mCallbackRecords) {
2668 final Call call = this;
2669 final Callback callback = record.getCallback();
2670 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
2671 }
2672 }
2673
Sanket Padawe85291f62017-12-01 13:59:27 -08002674 /** {@hide} */
2675 final void internalOnHandoverFailed(int error) {
2676 for (CallbackRecord<Callback> record : mCallbackRecords) {
2677 final Call call = this;
2678 final Callback callback = record.getCallback();
2679 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
2680 }
2681 }
2682
Tyler Gunn858bfaf2018-01-22 15:17:54 -08002683 /** {@hide} */
2684 final void internalOnHandoverComplete() {
2685 for (CallbackRecord<Callback> record : mCallbackRecords) {
2686 final Call call = this;
2687 final Callback callback = record.getCallback();
2688 record.getHandler().post(() -> callback.onHandoverComplete(call));
2689 }
2690 }
2691
Andrew Lee011728f2015-04-23 15:47:06 -07002692 private void fireStateChanged(final int newState) {
2693 for (CallbackRecord<Callback> record : mCallbackRecords) {
2694 final Call call = this;
2695 final Callback callback = record.getCallback();
2696 record.getHandler().post(new Runnable() {
2697 @Override
2698 public void run() {
2699 callback.onStateChanged(call, newState);
2700 }
2701 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002702 }
2703 }
2704
Andrew Lee011728f2015-04-23 15:47:06 -07002705 private void fireParentChanged(final Call newParent) {
2706 for (CallbackRecord<Callback> record : mCallbackRecords) {
2707 final Call call = this;
2708 final Callback callback = record.getCallback();
2709 record.getHandler().post(new Runnable() {
2710 @Override
2711 public void run() {
2712 callback.onParentChanged(call, newParent);
2713 }
2714 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002715 }
2716 }
2717
Andrew Lee011728f2015-04-23 15:47:06 -07002718 private void fireChildrenChanged(final List<Call> children) {
2719 for (CallbackRecord<Callback> record : mCallbackRecords) {
2720 final Call call = this;
2721 final Callback callback = record.getCallback();
2722 record.getHandler().post(new Runnable() {
2723 @Override
2724 public void run() {
2725 callback.onChildrenChanged(call, children);
2726 }
2727 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002728 }
2729 }
2730
Andrew Lee011728f2015-04-23 15:47:06 -07002731 private void fireDetailsChanged(final Details details) {
2732 for (CallbackRecord<Callback> record : mCallbackRecords) {
2733 final Call call = this;
2734 final Callback callback = record.getCallback();
2735 record.getHandler().post(new Runnable() {
2736 @Override
2737 public void run() {
2738 callback.onDetailsChanged(call, details);
2739 }
2740 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002741 }
2742 }
2743
Andrew Lee011728f2015-04-23 15:47:06 -07002744 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2745 for (CallbackRecord<Callback> record : mCallbackRecords) {
2746 final Call call = this;
2747 final Callback callback = record.getCallback();
2748 record.getHandler().post(new Runnable() {
2749 @Override
2750 public void run() {
2751 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2752 }
2753 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002754 }
2755 }
2756
Andrew Lee011728f2015-04-23 15:47:06 -07002757 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2758 for (CallbackRecord<Callback> record : mCallbackRecords) {
2759 final Call call = this;
2760 final Callback callback = record.getCallback();
2761 record.getHandler().post(new Runnable() {
2762 @Override
2763 public void run() {
2764 callback.onVideoCallChanged(call, videoCall);
2765 }
2766 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002767 }
2768 }
2769
Andrew Lee011728f2015-04-23 15:47:06 -07002770 private void firePostDialWait(final String remainingPostDialSequence) {
2771 for (CallbackRecord<Callback> record : mCallbackRecords) {
2772 final Call call = this;
2773 final Callback callback = record.getCallback();
2774 record.getHandler().post(new Runnable() {
2775 @Override
2776 public void run() {
2777 callback.onPostDialWait(call, remainingPostDialSequence);
2778 }
2779 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002780 }
2781 }
2782
2783 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002784 /**
2785 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2786 * onCallRemoved callback, we remove this call from the Phone's record
2787 * only once all of the registered onCallDestroyed callbacks are executed.
2788 * All the callbacks get removed from our records as a part of this operation
2789 * since onCallDestroyed is the final callback.
2790 */
2791 final Call call = this;
2792 if (mCallbackRecords.isEmpty()) {
2793 // No callbacks registered, remove the call from Phone's record.
2794 mPhone.internalRemoveCall(call);
2795 }
2796 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002797 final Callback callback = record.getCallback();
2798 record.getHandler().post(new Runnable() {
2799 @Override
2800 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002801 boolean isFinalRemoval = false;
2802 RuntimeException toThrow = null;
2803 try {
2804 callback.onCallDestroyed(call);
2805 } catch (RuntimeException e) {
2806 toThrow = e;
2807 }
2808 synchronized(Call.this) {
2809 mCallbackRecords.remove(record);
2810 if (mCallbackRecords.isEmpty()) {
2811 isFinalRemoval = true;
2812 }
2813 }
2814 if (isFinalRemoval) {
2815 mPhone.internalRemoveCall(call);
2816 }
2817 if (toThrow != null) {
2818 throw toThrow;
2819 }
Andrew Lee011728f2015-04-23 15:47:06 -07002820 }
2821 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002822 }
2823 }
2824
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002825 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002826 for (CallbackRecord<Callback> record : mCallbackRecords) {
2827 final Call call = this;
2828 final Callback callback = record.getCallback();
2829 record.getHandler().post(new Runnable() {
2830 @Override
2831 public void run() {
2832 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2833 }
2834 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002835 }
2836 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002837
2838 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002839 * Notifies listeners of an incoming connection event.
2840 * <p>
2841 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2842 *
2843 * @param event
2844 * @param extras
2845 */
2846 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2847 for (CallbackRecord<Callback> record : mCallbackRecords) {
2848 final Call call = this;
2849 final Callback callback = record.getCallback();
2850 record.getHandler().post(new Runnable() {
2851 @Override
2852 public void run() {
2853 callback.onConnectionEvent(call, event, extras);
2854 }
2855 });
2856 }
2857 }
2858
2859 /**
Hall Liu95d55872017-01-25 17:12:49 -08002860 * Notifies listeners of an RTT on/off change
2861 *
2862 * @param enabled True if RTT is now enabled, false otherwise
2863 */
2864 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2865 for (CallbackRecord<Callback> record : mCallbackRecords) {
2866 final Call call = this;
2867 final Callback callback = record.getCallback();
2868 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2869 }
2870 }
2871
2872 /**
2873 * Notifies listeners of a RTT mode change
2874 *
2875 * @param mode The new RTT mode
2876 */
2877 private void fireOnRttModeChanged(final int mode) {
2878 for (CallbackRecord<Callback> record : mCallbackRecords) {
2879 final Call call = this;
2880 final Callback callback = record.getCallback();
2881 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2882 }
2883 }
2884
2885 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002886 * Determines if two bundles are equal.
2887 *
2888 * @param bundle The original bundle.
2889 * @param newBundle The bundle to compare with.
2890 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2891 */
2892 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2893 if (bundle == null || newBundle == null) {
2894 return bundle == newBundle;
2895 }
2896
2897 if (bundle.size() != newBundle.size()) {
2898 return false;
2899 }
2900
2901 for(String key : bundle.keySet()) {
2902 if (key != null) {
2903 final Object value = bundle.get(key);
2904 final Object newValue = newBundle.get(key);
Grace Jia17005bd2022-05-12 12:49:02 -07002905 if (!newBundle.containsKey(key)) {
2906 return false;
2907 }
2908 if (value instanceof Bundle && newValue instanceof Bundle) {
2909 if (!areBundlesEqual((Bundle) value, (Bundle) newValue)) {
2910 return false;
2911 }
2912 }
2913 if (value instanceof byte[] && newValue instanceof byte[]) {
2914 if (!Arrays.equals((byte[]) value, (byte[]) newValue)) {
2915 return false;
2916 }
2917 } else if (!Objects.equals(value, newValue)) {
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002918 return false;
2919 }
2920 }
2921 }
2922 return true;
2923 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002924}