blob: 95c90612748c6983a0201c6ee2e18928e7fb07c9 [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 /**
Thomas Stuart5ca875eb2022-08-03 18:39:57 -0700171 * Extra key intended for {@link InCallService}s that notify the user of an incoming call. When
172 * EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB returns true, the {@link InCallService} should not
173 * interrupt the user of the incoming call because the call is being suppressed by Do Not
174 * Disturb settings.
175 *
176 * This extra will be removed from the {@link Call} object for {@link InCallService}s that do
177 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
178 */
179 public static final String EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB =
180 "android.telecom.extra.IS_SUPPRESSED_BY_DO_NOT_DISTURB";
181
182 /**
Hall Liu34d9e242018-11-21 17:05:58 -0800183 * Key for extra used to pass along a list of {@link PhoneAccountSuggestion}s to the in-call
184 * UI when a call enters the {@link #STATE_SELECT_PHONE_ACCOUNT} state. The list included here
185 * will have the same length and be in the same order as the list passed with
186 * {@link #AVAILABLE_PHONE_ACCOUNTS}.
187 */
188 public static final String EXTRA_SUGGESTED_PHONE_ACCOUNTS =
189 "android.telecom.extra.SUGGESTED_PHONE_ACCOUNTS";
190
191 /**
mike dooley91217422017-03-09 12:58:42 -0800192 * Extra key used to indicate the time (in milliseconds since midnight, January 1, 1970 UTC)
193 * when the last outgoing emergency call was made. This is used to identify potential emergency
194 * callbacks.
mike dooley4af561f2016-12-20 08:55:17 -0800195 */
196 public static final String EXTRA_LAST_EMERGENCY_CALLBACK_TIME_MILLIS =
197 "android.telecom.extra.LAST_EMERGENCY_CALLBACK_TIME_MILLIS";
198
Usman Abdullahb0dc29a2019-03-06 15:54:56 -0800199
200 /**
201 * Extra key used to indicate whether a {@link CallScreeningService} has requested to silence
202 * the ringtone for a call. If the {@link InCallService} declares
203 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in its manifest, it should not
204 * play a ringtone for an incoming call with this extra key set.
205 */
206 public static final String EXTRA_SILENT_RINGING_REQUESTED =
207 "android.telecom.extra.SILENT_RINGING_REQUESTED";
208
Tyler Gunn8bf76572017-04-06 15:30:08 -0700209 /**
210 * Call event sent from a {@link Call} via {@link #sendCallEvent(String, Bundle)} to inform
211 * Telecom that the user has requested that the current {@link Call} should be handed over
212 * to another {@link ConnectionService}.
213 * <p>
214 * The caller must specify the {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE} to indicate to
215 * Telecom which {@link PhoneAccountHandle} the {@link Call} should be handed over to.
216 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700217 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
218 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700219 */
220 public static final String EVENT_REQUEST_HANDOVER =
221 "android.telecom.event.REQUEST_HANDOVER";
222
223 /**
224 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
225 * {@link PhoneAccountHandle} to which a call should be handed over to.
226 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700227 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
228 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700229 */
230 public static final String EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE =
231 "android.telecom.extra.HANDOVER_PHONE_ACCOUNT_HANDLE";
232
233 /**
234 * Integer extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
235 * video state of the call when it is handed over to the new {@link PhoneAccount}.
236 * <p>
237 * Valid values: {@link VideoProfile#STATE_AUDIO_ONLY},
238 * {@link VideoProfile#STATE_BIDIRECTIONAL}, {@link VideoProfile#STATE_RX_ENABLED}, and
239 * {@link VideoProfile#STATE_TX_ENABLED}.
240 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700241 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
242 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700243 */
244 public static final String EXTRA_HANDOVER_VIDEO_STATE =
245 "android.telecom.extra.HANDOVER_VIDEO_STATE";
246
247 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700248 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Used by the
249 * {@link InCallService} initiating a handover to provide a {@link Bundle} with extra
250 * information to the handover {@link ConnectionService} specified by
251 * {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE}.
252 * <p>
253 * This {@link Bundle} is not interpreted by Telecom, but passed as-is to the
254 * {@link ConnectionService} via the request extras when
255 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
256 * is called to initate the handover.
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 EXTRA_HANDOVER_EXTRAS = "android.telecom.extra.HANDOVER_EXTRAS";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700262
263 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700264 * Call event sent from Telecom to the handover {@link ConnectionService} via
265 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
266 * to the {@link ConnectionService} has completed successfully.
267 * <p>
268 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700269 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700270 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
271 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700272 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700273 public static final String EVENT_HANDOVER_COMPLETE =
274 "android.telecom.event.HANDOVER_COMPLETE";
Tyler Gunn34a2b312017-06-23 08:32:00 -0700275
276 /**
277 * Call event sent from Telecom to the handover destination {@link ConnectionService} via
278 * {@link Connection#onCallEvent(String, Bundle)} to inform the handover destination that the
279 * source connection has disconnected. The {@link Bundle} parameter for the call event will be
280 * {@code null}.
281 * <p>
282 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
283 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700284 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
285 * APIs instead.
Tyler Gunn34a2b312017-06-23 08:32:00 -0700286 */
287 public static final String EVENT_HANDOVER_SOURCE_DISCONNECTED =
288 "android.telecom.event.HANDOVER_SOURCE_DISCONNECTED";
289
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700290 /**
291 * Call event sent from Telecom to the handover {@link ConnectionService} via
292 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
293 * to the {@link ConnectionService} has failed.
294 * <p>
295 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
296 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700297 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
298 * APIs instead.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700299 */
300 public static final String EVENT_HANDOVER_FAILED =
301 "android.telecom.event.HANDOVER_FAILED";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700302
Tyler Gunnd5821842021-02-05 11:12:57 -0800303 /**
304 * Event reported from the Telecom stack to report an in-call diagnostic message which the
305 * dialer app may opt to display to the user. A diagnostic message is used to communicate
306 * scenarios the device has detected which may impact the quality of the ongoing call.
307 * <p>
308 * For example a problem with a bluetooth headset may generate a recommendation for the user to
309 * try using the speakerphone instead, or if the device detects it has entered a poor service
310 * area, the user might be warned so that they can finish their call prior to it dropping.
311 * <p>
312 * A diagnostic message is considered persistent in nature. When the user enters a poor service
313 * area, for example, the accompanying diagnostic message persists until they leave the area
314 * of poor service. Each message is accompanied with a {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID}
315 * which uniquely identifies the diagnostic condition being reported. The framework raises a
316 * call event of type {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE} when the condition reported has
317 * been cleared. The dialer app should display the diagnostic message until it is cleared.
318 * If multiple diagnostic messages are sent with different IDs (which have not yet been cleared)
319 * the dialer app should prioritize the most recently received message, but still provide the
320 * user with a means to review past messages.
321 * <p>
322 * The text of the message is found in {@link #EXTRA_DIAGNOSTIC_MESSAGE} in the form of a human
323 * readable {@link CharSequence} which is intended for display in the call UX.
324 * <p>
325 * The telecom framework audibly notifies the user of the presence of a diagnostic message, so
326 * the dialer app needs only to concern itself with visually displaying the message.
327 * <p>
328 * The dialer app receives this event via
329 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
330 */
331 public static final String EVENT_DISPLAY_DIAGNOSTIC_MESSAGE =
332 "android.telecom.event.DISPLAY_DIAGNOSTIC_MESSAGE";
333
334 /**
335 * Event reported from the telecom framework when a diagnostic message previously raised with
336 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE} has cleared and is no longer pertinent.
337 * <p>
338 * The {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID} indicates the diagnostic message which has been
339 * cleared.
340 * <p>
341 * The dialer app receives this event via
342 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
343 */
344 public static final String EVENT_CLEAR_DIAGNOSTIC_MESSAGE =
345 "android.telecom.event.CLEAR_DIAGNOSTIC_MESSAGE";
346
347 /**
348 * Integer extra representing a message ID for a message posted via
349 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. Used to ensure that the dialer app knows when
350 * the message in question has cleared via {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE}.
351 */
352 public static final String EXTRA_DIAGNOSTIC_MESSAGE_ID =
353 "android.telecom.extra.DIAGNOSTIC_MESSAGE_ID";
354
355 /**
356 * {@link CharSequence} extra used with {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. This is the
357 * diagnostic message the dialer app should display.
358 */
359 public static final String EXTRA_DIAGNOSTIC_MESSAGE =
360 "android.telecom.extra.DIAGNOSTIC_MESSAGE";
Tyler Gunnfacfdee2020-01-23 13:10:37 -0800361
362 /**
363 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
364 * call because they have declined to answer it. This typically means that they are unable
365 * to answer the call at this time and would prefer it be sent to voicemail.
366 */
367 public static final int REJECT_REASON_DECLINED = 1;
368
369 /**
370 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
371 * call because it is an unwanted call. This allows the user to indicate that they are
372 * rejecting a call because it is likely a nuisance call.
373 */
374 public static final int REJECT_REASON_UNWANTED = 2;
375
376 /**
377 * @hide
378 */
379 @IntDef(prefix = { "REJECT_REASON_" },
380 value = {REJECT_REASON_DECLINED, REJECT_REASON_UNWANTED})
381 @Retention(RetentionPolicy.SOURCE)
382 public @interface RejectReason {};
383
Ihab Awade63fadb2014-07-09 21:52:04 -0700384 public static class Details {
Tyler Gunn94f8f112018-12-17 09:56:11 -0800385 /** @hide */
386 @Retention(RetentionPolicy.SOURCE)
387 @IntDef(
388 prefix = { "DIRECTION_" },
389 value = {DIRECTION_UNKNOWN, DIRECTION_INCOMING, DIRECTION_OUTGOING})
390 public @interface CallDirection {}
391
392 /**
393 * Indicates that the call is neither and incoming nor an outgoing call. This can be the
394 * case for calls reported directly by a {@link ConnectionService} in special cases such as
395 * call handovers.
396 */
397 public static final int DIRECTION_UNKNOWN = -1;
398
399 /**
400 * Indicates that the call is an incoming call.
401 */
402 public static final int DIRECTION_INCOMING = 0;
403
404 /**
405 * Indicates that the call is an outgoing call.
406 */
407 public static final int DIRECTION_OUTGOING = 1;
408
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800409 /** Call can currently be put on hold or unheld. */
410 public static final int CAPABILITY_HOLD = 0x00000001;
411
412 /** Call supports the hold feature. */
413 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
414
415 /**
416 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
417 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
418 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
419 * capability allows a merge button to be shown while the conference call is in the foreground
420 * of the in-call UI.
421 * <p>
422 * This is only intended for use by a {@link Conference}.
423 */
424 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
425
426 /**
427 * Calls within a conference can be swapped between foreground and background.
428 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
429 * <p>
430 * This is only intended for use by a {@link Conference}.
431 */
432 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
433
434 /**
435 * @hide
436 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700437 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800438
439 /** Call supports responding via text option. */
440 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
441
442 /** Call can be muted. */
443 public static final int CAPABILITY_MUTE = 0x00000040;
444
445 /**
446 * Call supports conference call management. This capability only applies to {@link Conference}
447 * calls which can have {@link Connection}s as children.
448 */
449 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
450
451 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700452 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800453 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700454 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800455
456 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700457 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800458 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700459 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800460
461 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700462 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800463 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700464 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700465 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800466
467 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700468 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800469 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700470 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
471
472 /**
473 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700474 */
475 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
476
477 /**
478 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700479 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700480 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700481 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800482
483 /**
484 * Call is able to be separated from its parent {@code Conference}, if any.
485 */
486 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
487
488 /**
489 * Call is able to be individually disconnected when in a {@code Conference}.
490 */
491 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
492
493 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500494 * Speed up audio setup for MT call.
495 * @hide
496 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700497 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
498
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700499 /**
500 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700501 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800502 * @deprecated Use {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
503 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL} to indicate for a call
504 * whether or not video calling is supported.
Rekha Kumar07366812015-03-24 16:42:31 -0700505 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800506 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Rekha Kumar07366812015-03-24 16:42:31 -0700507 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
508
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700509 /**
510 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700511 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700512 */
513 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
514
Bryce Lee81901682015-08-28 16:38:02 -0700515 /**
516 * Call sends responses through connection.
517 * @hide
518 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800519 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
520
521 /**
522 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
523 * <p>
524 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
525 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
526 * downgraded from a video call back to a VideoState of
527 * {@link VideoProfile#STATE_AUDIO_ONLY}.
528 * <p>
529 * Intuitively, a call which can be downgraded to audio should also have local and remote
530 * video
531 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
532 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
533 */
534 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700535
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700536 /**
537 * When set for an external call, indicates that this {@code Call} can be pulled from a
538 * remote device to the current device.
539 * <p>
540 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
541 * <p>
542 * An {@link InCallService} will only see calls with this capability if it has the
543 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
544 * in its manifest.
545 * <p>
546 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700547 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700548 */
549 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
550
Pooja Jaind34698d2017-12-28 14:15:31 +0530551 /** Call supports the deflect feature. */
552 public static final int CAPABILITY_SUPPORT_DEFLECT = 0x01000000;
553
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800554 /**
555 * Call supports adding participants to the call via
Grace Jia8587ee52020-07-10 15:42:32 -0700556 * {@link #addConferenceParticipants(List)}. Once participants are added, the call becomes
557 * an adhoc conference call ({@link #PROPERTY_IS_ADHOC_CONFERENCE}).
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800558 */
Ravi Paluri404babb2020-01-23 19:02:44 +0530559 public static final int CAPABILITY_ADD_PARTICIPANT = 0x02000000;
Ravi Palurif4b38e72020-02-05 12:35:41 +0530560
561 /**
562 * When set for a call, indicates that this {@code Call} can be transferred to another
563 * number.
Tyler Gunn460360d2020-07-29 10:21:45 -0700564 * Call supports the confirmed and unconfirmed call transfer feature.
Ravi Palurif4b38e72020-02-05 12:35:41 +0530565 *
566 * @hide
567 */
568 public static final int CAPABILITY_TRANSFER = 0x04000000;
569
570 /**
571 * When set for a call, indicates that this {@code Call} can be transferred to another
572 * ongoing call.
573 * Call supports the consultative call transfer feature.
574 *
575 * @hide
576 */
577 public static final int CAPABILITY_TRANSFER_CONSULTATIVE = 0x08000000;
578
Alvin Dey2f37d772018-05-18 23:16:10 +0530579 /**
580 * Indicates whether the remote party supports RTT or not to the UI.
581 */
582
583 public static final int CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT = 0x10000000;
584
Tyler Gunnd11a3152015-03-18 13:09:14 -0700585 //******************************************************************************************
Alvin Dey2f37d772018-05-18 23:16:10 +0530586 // Next CAPABILITY value: 0x20000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700587 //******************************************************************************************
588
589 /**
590 * Whether the call is currently a conference.
591 */
592 public static final int PROPERTY_CONFERENCE = 0x00000001;
593
594 /**
595 * Whether the call is a generic conference, where we do not know the precise state of
596 * participants in the conference (eg. on CDMA).
597 */
598 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
599
600 /**
601 * Whether the call is made while the device is in emergency callback mode.
602 */
603 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
604
605 /**
606 * Connection is using WIFI.
607 */
608 public static final int PROPERTY_WIFI = 0x00000008;
609
610 /**
Tyler Gunn6b6ae552018-10-11 10:42:10 -0700611 * When set, the UI should indicate to the user that a call is using high definition
612 * audio.
613 * <p>
614 * The underlying {@link ConnectionService} is responsible for reporting this
615 * property. It is important to note that this property is not intended to report the
616 * actual audio codec being used for a Call, but whether the call should be indicated
617 * to the user as high definition.
618 * <p>
619 * The Android Telephony stack reports this property for calls based on a number
620 * of factors, including which audio codec is used and whether a call is using an HD
621 * codec end-to-end. Some mobile operators choose to suppress display of an HD indication,
622 * and in these cases this property will not be set for a call even if the underlying audio
623 * codec is in fact "high definition".
Andrew Lee2378ea72015-04-29 14:38:11 -0700624 */
625 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
626
Tony Maka68dcce2015-12-17 09:31:18 +0000627 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100628 * Whether the call is associated with the work profile.
629 */
630 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
631
632 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700633 * When set, indicates that this {@code Call} does not actually exist locally for the
634 * {@link ConnectionService}.
635 * <p>
636 * Consider, for example, a scenario where a user has two phones with the same phone number.
637 * When a user places a call on one device, the telephony stack can represent that call on
638 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700639 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700640 * <p>
641 * An {@link InCallService} will only see calls with this property if it has the
642 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
643 * in its manifest.
644 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700645 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700646 */
647 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
648
Brad Ebinger15847072016-05-18 11:08:36 -0700649 /**
650 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
651 */
652 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
653
Tyler Gunn24e18332017-02-10 09:42:49 -0800654 /**
655 * Indicates that the call is from a self-managed {@link ConnectionService}.
656 * <p>
657 * See also {@link Connection#PROPERTY_SELF_MANAGED}
658 */
659 public static final int PROPERTY_SELF_MANAGED = 0x00000100;
660
Eric Erfanianec881872017-12-06 16:27:53 -0800661 /**
662 * Indicates the call used Assisted Dialing.
Tyler Gunn5567d742019-10-31 13:04:37 -0700663 *
664 * @see TelecomManager#EXTRA_USE_ASSISTED_DIALING
Eric Erfanianec881872017-12-06 16:27:53 -0800665 */
Tyler Gunnc9503d62020-01-27 10:30:51 -0800666 public static final int PROPERTY_ASSISTED_DIALING = 0x00000200;
Eric Erfanianec881872017-12-06 16:27:53 -0800667
Hall Liue9041242018-02-09 16:40:03 -0800668 /**
669 * Indicates that the call is an RTT call. Use {@link #getRttCall()} to get the
670 * {@link RttCall} object that is used to send and receive text.
671 */
672 public static final int PROPERTY_RTT = 0x00000400;
673
Tyler Gunn5bd90852018-09-21 09:37:07 -0700674 /**
675 * Indicates that the call has been identified as the network as an emergency call. This
676 * property may be set for both incoming and outgoing calls which the network identifies as
677 * emergency calls.
678 */
679 public static final int PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL = 0x00000800;
680
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700681 /**
682 * Indicates that the call is using VoIP audio mode.
683 * <p>
684 * When this property is set, the {@link android.media.AudioManager} audio mode for this
685 * call will be {@link android.media.AudioManager#MODE_IN_COMMUNICATION}. When this
686 * property is not set, the audio mode for this call will be
687 * {@link android.media.AudioManager#MODE_IN_CALL}.
688 * <p>
689 * This property reflects changes made using {@link Connection#setAudioModeIsVoip(boolean)}.
690 * <p>
691 * You can use this property to determine whether an un-answered incoming call or a held
692 * call will use VoIP audio mode (if the call does not currently have focus, the system
693 * audio mode may not reflect the mode the call will use).
694 */
695 public static final int PROPERTY_VOIP_AUDIO_MODE = 0x00001000;
696
Ravi Paluri80aa2142019-12-02 11:57:37 +0530697 /**
698 * Indicates that the call is an adhoc conference call. This property can be set for both
Grace Jia8587ee52020-07-10 15:42:32 -0700699 * incoming and outgoing calls. An adhoc conference call is formed using
700 * {@link #addConferenceParticipants(List)},
701 * {@link TelecomManager#addNewIncomingConference(PhoneAccountHandle, Bundle)}, or
702 * {@link TelecomManager#startConference(List, Bundle)}, rather than by merging existing
703 * call using {@link #conference(Call)}.
Ravi Paluri80aa2142019-12-02 11:57:37 +0530704 */
705 public static final int PROPERTY_IS_ADHOC_CONFERENCE = 0x00002000;
706
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800707 /**
Sooraj Sasindranfa1e57a2021-03-22 13:44:14 -0700708 * Connection is using cross sim technology.
709 * <p>
710 * Indicates that the {@link Connection} is using a cross sim technology which would
711 * register IMS over internet APN of default data subscription.
712 * <p>
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800713 */
714 public static final int PROPERTY_CROSS_SIM = 0x00004000;
715
Andrew Lee2378ea72015-04-29 14:38:11 -0700716 //******************************************************************************************
Ravi Paluri80aa2142019-12-02 11:57:37 +0530717 // Next PROPERTY value: 0x00004000
Tyler Gunnd11a3152015-03-18 13:09:14 -0700718 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800719
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700720 private final @CallState int mState;
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800721 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700722 private final Uri mHandle;
723 private final int mHandlePresentation;
724 private final String mCallerDisplayName;
725 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700726 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700727 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700728 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800729 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700730 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700731 private final long mConnectTimeMillis;
732 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700733 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700734 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700735 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700736 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700737 private final long mCreationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -0800738 private final String mContactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -0800739 private final @CallDirection int mCallDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -0700740 private final @Connection.VerificationStatus int mCallerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -0700741 private final Uri mContactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -0700742
743 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800744 * Whether the supplied capabilities supports the specified capability.
745 *
746 * @param capabilities A bit field of capabilities.
747 * @param capability The capability to check capabilities for.
748 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800749 */
750 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800751 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800752 }
753
754 /**
755 * Whether the capabilities of this {@code Details} supports the specified capability.
756 *
757 * @param capability The capability to check capabilities for.
758 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800759 */
760 public boolean can(int capability) {
761 return can(mCallCapabilities, capability);
762 }
763
764 /**
765 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
766 *
767 * @param capabilities A capability bit field.
768 * @return A human readable string representation.
769 */
770 public static String capabilitiesToString(int capabilities) {
771 StringBuilder builder = new StringBuilder();
772 builder.append("[Capabilities:");
773 if (can(capabilities, CAPABILITY_HOLD)) {
774 builder.append(" CAPABILITY_HOLD");
775 }
776 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
777 builder.append(" CAPABILITY_SUPPORT_HOLD");
778 }
779 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
780 builder.append(" CAPABILITY_MERGE_CONFERENCE");
781 }
782 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
783 builder.append(" CAPABILITY_SWAP_CONFERENCE");
784 }
785 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
786 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
787 }
788 if (can(capabilities, CAPABILITY_MUTE)) {
789 builder.append(" CAPABILITY_MUTE");
790 }
791 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
792 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
793 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700794 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
795 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
796 }
797 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
798 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
799 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700800 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
801 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800802 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700803 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
804 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
805 }
806 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
807 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
808 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800809 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
810 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
811 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700812 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
813 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800814 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500815 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700816 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500817 }
Rekha Kumar07366812015-03-24 16:42:31 -0700818 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
819 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
820 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700821 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
822 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
823 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700824 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
825 builder.append(" CAPABILITY_CAN_PULL_CALL");
826 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530827 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
828 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
829 }
Ravi Paluri404babb2020-01-23 19:02:44 +0530830 if (can(capabilities, CAPABILITY_ADD_PARTICIPANT)) {
831 builder.append(" CAPABILITY_ADD_PARTICIPANT");
832 }
Ravi Palurif4b38e72020-02-05 12:35:41 +0530833 if (can(capabilities, CAPABILITY_TRANSFER)) {
834 builder.append(" CAPABILITY_TRANSFER");
835 }
836 if (can(capabilities, CAPABILITY_TRANSFER_CONSULTATIVE)) {
837 builder.append(" CAPABILITY_TRANSFER_CONSULTATIVE");
838 }
Alvin Dey2f37d772018-05-18 23:16:10 +0530839 if (can(capabilities, CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT)) {
840 builder.append(" CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT");
841 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800842 builder.append("]");
843 return builder.toString();
844 }
845
846 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700847 * Whether the supplied properties includes the specified property.
848 *
849 * @param properties A bit field of properties.
850 * @param property The property to check properties for.
851 * @return Whether the specified property is supported.
852 */
853 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800854 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700855 }
856
857 /**
858 * Whether the properties of this {@code Details} includes the specified property.
859 *
860 * @param property The property to check properties for.
861 * @return Whether the specified property is supported.
862 */
863 public boolean hasProperty(int property) {
864 return hasProperty(mCallProperties, property);
865 }
866
867 /**
868 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
869 *
870 * @param properties A property bit field.
871 * @return A human readable string representation.
872 */
873 public static String propertiesToString(int properties) {
874 StringBuilder builder = new StringBuilder();
875 builder.append("[Properties:");
876 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
877 builder.append(" PROPERTY_CONFERENCE");
878 }
879 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
880 builder.append(" PROPERTY_GENERIC_CONFERENCE");
881 }
882 if (hasProperty(properties, PROPERTY_WIFI)) {
883 builder.append(" PROPERTY_WIFI");
884 }
885 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
886 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
887 }
888 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700889 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700890 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700891 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
892 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
893 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700894 if (hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
Brad Ebinger15847072016-05-18 11:08:36 -0700895 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
896 }
Tyler Gunnc9503d62020-01-27 10:30:51 -0800897 if (hasProperty(properties, PROPERTY_ASSISTED_DIALING)) {
Eric Erfanianec881872017-12-06 16:27:53 -0800898 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
899 }
Tyler Gunn5bd90852018-09-21 09:37:07 -0700900 if (hasProperty(properties, PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL)) {
901 builder.append(" PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL");
902 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700903 if (hasProperty(properties, PROPERTY_RTT)) {
904 builder.append(" PROPERTY_RTT");
905 }
906 if (hasProperty(properties, PROPERTY_VOIP_AUDIO_MODE)) {
907 builder.append(" PROPERTY_VOIP_AUDIO_MODE");
908 }
Ravi Paluri80aa2142019-12-02 11:57:37 +0530909 if (hasProperty(properties, PROPERTY_IS_ADHOC_CONFERENCE)) {
910 builder.append(" PROPERTY_IS_ADHOC_CONFERENCE");
911 }
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800912 if (hasProperty(properties, PROPERTY_CROSS_SIM)) {
913 builder.append(" PROPERTY_CROSS_SIM");
914 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700915 builder.append("]");
916 return builder.toString();
917 }
918
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700919 /**
920 * @return the state of the {@link Call} represented by this {@link Call.Details}.
921 */
922 public final @CallState int getState() {
923 return mState;
924 }
925
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800926 /** {@hide} */
Hall Liu31de23d2019-10-11 15:38:29 -0700927 @TestApi
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800928 public String getTelecomCallId() {
929 return mTelecomCallId;
930 }
931
Andrew Lee2378ea72015-04-29 14:38:11 -0700932 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700933 * @return The handle (e.g., phone number) to which the {@code Call} is currently
934 * connected.
935 */
936 public Uri getHandle() {
937 return mHandle;
938 }
939
940 /**
941 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700942 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700943 */
944 public int getHandlePresentation() {
945 return mHandlePresentation;
946 }
947
948 /**
Edgar Arriagae5bec822022-10-14 14:25:43 -0700949 * @return The contact photo URI which corresponds to
950 * {@link android.provider.ContactsContract.PhoneLookup#PHOTO_URI}, or {@code null} if the
951 * lookup is not yet complete, if there's no contacts entry for the caller,
952 * or if the {@link InCallService} does not hold the
953 * {@link android.Manifest.permission#READ_CONTACTS} permission.
954 */
955 public @Nullable Uri getContactPhotoUri() {
956 return mContactPhotoUri;
957 }
958
959 /**
Tyler Gunnd081f042018-12-04 12:56:45 -0800960 * The display name for the caller.
961 * <p>
962 * This is the name as reported by the {@link ConnectionService} associated with this call.
Tyler Gunnd081f042018-12-04 12:56:45 -0800963 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700964 * @return The display name for the caller.
965 */
966 public String getCallerDisplayName() {
967 return mCallerDisplayName;
968 }
969
970 /**
971 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700972 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700973 */
974 public int getCallerDisplayNamePresentation() {
975 return mCallerDisplayNamePresentation;
976 }
977
978 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700979 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
980 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700981 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700982 public PhoneAccountHandle getAccountHandle() {
983 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -0700984 }
985
986 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800987 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
988 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -0700989 */
Ihab Awad5d0410f2014-07-30 10:07:40 -0700990 public int getCallCapabilities() {
991 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -0700992 }
993
994 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700995 * @return A bitmask of the properties of the {@code Call}, as defined by the various
996 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -0700997 */
998 public int getCallProperties() {
999 return mCallProperties;
1000 }
1001
1002 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -08001003 * @return a bitmask of the audio routes available for the call.
1004 *
1005 * @hide
1006 */
1007 public int getSupportedAudioRoutes() {
1008 return mSupportedAudioRoutes;
1009 }
1010
1011 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001012 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -07001013 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001014 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001015 public DisconnectCause getDisconnectCause() {
1016 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001017 }
1018
1019 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001020 * Returns the time the {@link Call} connected (i.e. became active). This information is
1021 * updated periodically, but user interfaces should not rely on this to display the "call
1022 * time clock". For the time when the call was first added to Telecom, see
1023 * {@link #getCreationTimeMillis()}.
1024 *
1025 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -07001026 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -07001027 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -07001028 return mConnectTimeMillis;
1029 }
1030
1031 /**
1032 * @return Information about any calling gateway the {@code Call} may be using.
1033 */
1034 public GatewayInfo getGatewayInfo() {
1035 return mGatewayInfo;
1036 }
1037
Andrew Lee7a341382014-07-15 17:05:08 -07001038 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -07001039 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -07001040 */
1041 public int getVideoState() {
1042 return mVideoState;
1043 }
1044
Ihab Awad5d0410f2014-07-30 10:07:40 -07001045 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001046 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -07001047 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -07001048 */
1049 public StatusHints getStatusHints() {
1050 return mStatusHints;
1051 }
1052
Nancy Chen10798dc2014-08-08 14:00:25 -07001053 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -07001054 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -07001055 */
1056 public Bundle getExtras() {
1057 return mExtras;
1058 }
1059
Santos Cordon6b7f9552015-05-27 17:21:45 -07001060 /**
1061 * @return The extras used with the original intent to place this call.
1062 */
1063 public Bundle getIntentExtras() {
1064 return mIntentExtras;
1065 }
1066
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001067 /**
1068 * Returns the time when the call was first created and added to Telecom. This is the same
1069 * time that is logged as the start time in the Call Log (see
1070 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
1071 * (became active), see {@link #getConnectTimeMillis()}.
1072 *
1073 * @return The creation time of the call, in millis since the epoch.
1074 */
1075 public long getCreationTimeMillis() {
1076 return mCreationTimeMillis;
1077 }
1078
Tyler Gunnd081f042018-12-04 12:56:45 -08001079 /**
Hall Liuef98bf82020-01-09 15:22:44 -08001080 * Returns the name of the caller on the remote end, as derived from a
1081 * {@link android.provider.ContactsContract} lookup of the call's handle.
1082 * @return The name of the caller, or {@code null} if the lookup is not yet complete, if
1083 * there's no contacts entry for the caller, or if the {@link InCallService} does
1084 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
1085 */
1086 public @Nullable String getContactDisplayName() {
1087 return mContactDisplayName;
1088 }
1089
1090 /**
Tyler Gunn94f8f112018-12-17 09:56:11 -08001091 * Indicates whether the call is an incoming or outgoing call.
1092 * @return The call's direction.
1093 */
1094 public @CallDirection int getCallDirection() {
1095 return mCallDirection;
1096 }
1097
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001098 /**
1099 * Gets the verification status for the phone number of an incoming call as identified in
1100 * ATIS-1000082.
Tyler Gunn9c642492020-10-08 13:37:03 -07001101 * <p>
1102 * For incoming calls, the number verification status indicates whether the device was
1103 * able to verify the authenticity of the calling number using the STIR process outlined
1104 * in ATIS-1000082. {@link Connection#VERIFICATION_STATUS_NOT_VERIFIED} indicates that
1105 * the network was not able to use STIR to verify the caller's number (i.e. nothing is
1106 * known regarding the authenticity of the number.
1107 * {@link Connection#VERIFICATION_STATUS_PASSED} indicates that the network was able to
1108 * use STIR to verify the caller's number. This indicates that the network has a high
1109 * degree of confidence that the incoming call actually originated from the indicated
1110 * number. {@link Connection#VERIFICATION_STATUS_FAILED} indicates that the network's
1111 * STIR verification did not pass. This indicates that the incoming call may not
1112 * actually be from the indicated number. This could occur if, for example, the caller
1113 * is using an impersonated phone number.
1114 * <p>
1115 * A {@link CallScreeningService} can use this information to help determine if an
1116 * incoming call is potentially an unwanted call. A verification status of
1117 * {@link Connection#VERIFICATION_STATUS_FAILED} indicates that an incoming call may not
1118 * actually be from the number indicated on the call (i.e. impersonated number) and that it
1119 * should potentially be blocked. Likewise,
1120 * {@link Connection#VERIFICATION_STATUS_PASSED} can be used as a positive signal to
1121 * help clarify that the incoming call is originating from the indicated number and it
1122 * is less likely to be an undesirable call.
1123 * <p>
1124 * An {@link InCallService} can use this information to provide a visual indicator to the
1125 * user regarding the verification status of a call and to help identify calls from
1126 * potentially impersonated numbers.
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001127 * @return the verification status.
1128 */
1129 public @Connection.VerificationStatus int getCallerNumberVerificationStatus() {
1130 return mCallerNumberVerificationStatus;
1131 }
1132
Ihab Awade63fadb2014-07-09 21:52:04 -07001133 @Override
1134 public boolean equals(Object o) {
1135 if (o instanceof Details) {
1136 Details d = (Details) o;
1137 return
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001138 Objects.equals(mState, d.mState) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001139 Objects.equals(mHandle, d.mHandle) &&
1140 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
1141 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
1142 Objects.equals(mCallerDisplayNamePresentation,
1143 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -07001144 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -07001145 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -07001146 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001147 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001148 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -07001149 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -07001150 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -07001151 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001152 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001153 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
Tyler Gunnd081f042018-12-04 12:56:45 -08001154 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis) &&
Hall Liuef98bf82020-01-09 15:22:44 -08001155 Objects.equals(mContactDisplayName, d.mContactDisplayName) &&
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001156 Objects.equals(mCallDirection, d.mCallDirection) &&
1157 Objects.equals(mCallerNumberVerificationStatus,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001158 d.mCallerNumberVerificationStatus) &&
1159 Objects.equals(mContactPhotoUri, d.mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001160 }
1161 return false;
1162 }
1163
1164 @Override
1165 public int hashCode() {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001166 return Objects.hash(mState,
1167 mHandle,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001168 mHandlePresentation,
1169 mCallerDisplayName,
1170 mCallerDisplayNamePresentation,
1171 mAccountHandle,
1172 mCallCapabilities,
1173 mCallProperties,
1174 mDisconnectCause,
1175 mConnectTimeMillis,
1176 mGatewayInfo,
1177 mVideoState,
1178 mStatusHints,
1179 mExtras,
1180 mIntentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001181 mCreationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001182 mContactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001183 mCallDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001184 mCallerNumberVerificationStatus,
1185 mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001186 }
1187
1188 /** {@hide} */
1189 public Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001190 @CallState int state,
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001191 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -07001192 Uri handle,
1193 int handlePresentation,
1194 String callerDisplayName,
1195 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -07001196 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -07001197 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -07001198 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001199 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -07001200 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -07001201 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -07001202 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -07001203 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -07001204 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001205 Bundle intentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001206 long creationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001207 String contactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001208 int callDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001209 int callerNumberVerificationStatus,
1210 Uri contactPhotoUri) {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001211 mState = state;
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001212 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001213 mHandle = handle;
1214 mHandlePresentation = handlePresentation;
1215 mCallerDisplayName = callerDisplayName;
1216 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -07001217 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -07001218 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -07001219 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001220 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001221 mConnectTimeMillis = connectTimeMillis;
1222 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -07001223 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -07001224 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -07001225 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -07001226 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001227 mCreationTimeMillis = creationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -08001228 mContactDisplayName = contactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -08001229 mCallDirection = callDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001230 mCallerNumberVerificationStatus = callerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -07001231 mContactPhotoUri = contactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -07001232 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001233
1234 /** {@hide} */
1235 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
1236 return new Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001237 parcelableCall.getState(),
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001238 parcelableCall.getId(),
1239 parcelableCall.getHandle(),
1240 parcelableCall.getHandlePresentation(),
1241 parcelableCall.getCallerDisplayName(),
1242 parcelableCall.getCallerDisplayNamePresentation(),
1243 parcelableCall.getAccountHandle(),
1244 parcelableCall.getCapabilities(),
1245 parcelableCall.getProperties(),
1246 parcelableCall.getDisconnectCause(),
1247 parcelableCall.getConnectTimeMillis(),
1248 parcelableCall.getGatewayInfo(),
1249 parcelableCall.getVideoState(),
1250 parcelableCall.getStatusHints(),
1251 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001252 parcelableCall.getIntentExtras(),
Tyler Gunnd081f042018-12-04 12:56:45 -08001253 parcelableCall.getCreationTimeMillis(),
Hall Liuef98bf82020-01-09 15:22:44 -08001254 parcelableCall.getContactDisplayName(),
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001255 parcelableCall.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07001256 parcelableCall.getCallerNumberVerificationStatus(),
1257 parcelableCall.getContactPhotoUri()
1258 );
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001259 }
Santos Cordon3c20d632016-02-25 16:12:35 -08001260
1261 @Override
1262 public String toString() {
1263 StringBuilder sb = new StringBuilder();
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001264 sb.append("[id: ");
1265 sb.append(mTelecomCallId);
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001266 sb.append(", state: ");
1267 sb.append(Call.stateToString(mState));
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001268 sb.append(", pa: ");
Santos Cordon3c20d632016-02-25 16:12:35 -08001269 sb.append(mAccountHandle);
1270 sb.append(", hdl: ");
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001271 sb.append(Log.piiHandle(mHandle));
1272 sb.append(", hdlPres: ");
1273 sb.append(mHandlePresentation);
1274 sb.append(", videoState: ");
1275 sb.append(VideoProfile.videoStateToString(mVideoState));
Santos Cordon3c20d632016-02-25 16:12:35 -08001276 sb.append(", caps: ");
1277 sb.append(capabilitiesToString(mCallCapabilities));
1278 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -07001279 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -08001280 sb.append("]");
1281 return sb.toString();
1282 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001283 }
1284
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001285 /**
1286 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
1287 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
1288 * implementation.
1289 * <p>
1290 * You can handle these callbacks by extending the {@link Callback} class and overriding the
1291 * callbacks that your {@link InCallService} is interested in. The callback methods include the
1292 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
1293 * {@link Callback} implementation, if desired.
1294 * <p>
1295 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
1296 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
1297 * (typically in {@link InCallService#onCallRemoved(Call)}).
1298 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
1299 * reach your implementation of {@link Callback}, so it is important to register your callback
1300 * as soon as your {@link InCallService} is notified of a new call via
1301 * {@link InCallService#onCallAdded(Call)}.
1302 */
Andrew Leeda80c872015-04-15 14:09:50 -07001303 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -07001304 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001305 * @hide
1306 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001307 @IntDef(prefix = { "HANDOVER_" },
1308 value = {HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_NOT_SUPPORTED,
Tyler Gunn5c60d712018-03-16 09:53:44 -07001309 HANDOVER_FAILURE_USER_REJECTED, HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL,
Tyler Gunn9d127732018-03-02 15:45:51 -08001310 HANDOVER_FAILURE_UNKNOWN})
Sanket Padawea8eddd42017-11-03 11:07:35 -07001311 @Retention(RetentionPolicy.SOURCE)
1312 public @interface HandoverFailureErrors {}
1313
1314 /**
1315 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
Tyler Gunn9d127732018-03-02 15:45:51 -08001316 * to handover the call to rejects the handover request.
1317 * <p>
1318 * Will be returned when {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} is called
1319 * and the destination {@link PhoneAccountHandle}'s {@link ConnectionService} returns a
1320 * {@code null} {@link Connection} from
1321 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
1322 * ConnectionRequest)}.
1323 * <p>
1324 * For more information on call handovers, see
1325 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001326 */
1327 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
1328
1329 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001330 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1331 * is initiated but the source or destination app does not support handover.
1332 * <p>
1333 * Will be returned when a handover is requested via
1334 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)} and the destination
1335 * {@link PhoneAccountHandle} does not declare
1336 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}. May also be returned when a handover is
1337 * requested at the {@link PhoneAccountHandle} for the current call (i.e. the source call's
1338 * {@link Details#getAccountHandle()}) does not declare
1339 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}.
1340 * <p>
1341 * For more information on call handovers, see
1342 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001343 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001344 public static final int HANDOVER_FAILURE_NOT_SUPPORTED = 2;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001345
1346 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001347 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the remote
1348 * user rejects the handover request.
1349 * <p>
1350 * For more information on call handovers, see
1351 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001352 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001353 public static final int HANDOVER_FAILURE_USER_REJECTED = 3;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001354
Sanket Padawe85291f62017-12-01 13:59:27 -08001355 /**
1356 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
1357 * is ongoing emergency call.
Tyler Gunn9d127732018-03-02 15:45:51 -08001358 * <p>
1359 * This error code is returned when {@link #handoverTo(PhoneAccountHandle, int, Bundle)} is
1360 * called on an emergency call, or if any other call is an emergency call.
1361 * <p>
1362 * Handovers are not permitted while there are ongoing emergency calls.
1363 * <p>
1364 * For more information on call handovers, see
1365 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawe85291f62017-12-01 13:59:27 -08001366 */
Tyler Gunn5c60d712018-03-16 09:53:44 -07001367 public static final int HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL = 4;
Sanket Padawe85291f62017-12-01 13:59:27 -08001368
Tyler Gunn9d127732018-03-02 15:45:51 -08001369 /**
1370 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1371 * fails for an unknown reason.
1372 * <p>
1373 * For more information on call handovers, see
1374 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
1375 */
1376 public static final int HANDOVER_FAILURE_UNKNOWN = 5;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001377
1378 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001379 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
1380 *
Ihab Awade63fadb2014-07-09 21:52:04 -07001381 * @param call The {@code Call} invoking this method.
1382 * @param state The new state of the {@code Call}.
1383 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001384 public void onStateChanged(Call call, @CallState int state) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001385
1386 /**
1387 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
1388 *
1389 * @param call The {@code Call} invoking this method.
1390 * @param parent The new parent of the {@code Call}.
1391 */
1392 public void onParentChanged(Call call, Call parent) {}
1393
1394 /**
1395 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
1396 *
1397 * @param call The {@code Call} invoking this method.
1398 * @param children The new children of the {@code Call}.
1399 */
1400 public void onChildrenChanged(Call call, List<Call> children) {}
1401
1402 /**
1403 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
1404 *
1405 * @param call The {@code Call} invoking this method.
1406 * @param details A {@code Details} object describing the {@code Call}.
1407 */
1408 public void onDetailsChanged(Call call, Details details) {}
1409
1410 /**
1411 * Invoked when the text messages that can be used as responses to the incoming
1412 * {@code Call} are loaded from the relevant database.
1413 * See {@link #getCannedTextResponses()}.
1414 *
1415 * @param call The {@code Call} invoking this method.
1416 * @param cannedTextResponses The text messages useable as responses.
1417 */
1418 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
1419
1420 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001421 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
1422 * character. This causes the post-dial signals to stop pending user confirmation. An
1423 * implementation should present this choice to the user and invoke
1424 * {@link #postDialContinue(boolean)} when the user makes the choice.
1425 *
1426 * @param call The {@code Call} invoking this method.
1427 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
1428 */
1429 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
1430
1431 /**
Andrew Lee50aca232014-07-22 16:41:54 -07001432 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -07001433 *
1434 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -07001435 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001436 */
Andrew Lee50aca232014-07-22 16:41:54 -07001437 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001438
1439 /**
1440 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
1441 * up their UI for the {@code Call} in response to state transitions. Specifically,
1442 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
1443 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
1444 * clients should wait for this method to be invoked.
1445 *
1446 * @param call The {@code Call} being destroyed.
1447 */
1448 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001449
1450 /**
1451 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
1452 * conferenced.
1453 *
1454 * @param call The {@code Call} being updated.
1455 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
1456 * conferenced.
1457 */
1458 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001459
1460 /**
Tyler Gunn5567d742019-10-31 13:04:37 -07001461 * Invoked when a {@link Call} receives an event from its associated {@link Connection} or
1462 * {@link Conference}.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001463 * <p>
1464 * Where possible, the Call should make an attempt to handle {@link Connection} events which
1465 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1466 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1467 * possible that a {@link ConnectionService} has defined its own Connection events which a
1468 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001469 * <p>
Tyler Gunn5567d742019-10-31 13:04:37 -07001470 * See {@link Connection#sendConnectionEvent(String, Bundle)},
1471 * {@link Conference#sendConferenceEvent(String, Bundle)}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001472 *
1473 * @param call The {@code Call} receiving the event.
1474 * @param event The event.
1475 * @param extras Extras associated with the connection event.
1476 */
1477 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001478
1479 /**
1480 * Invoked when the RTT mode changes for this call.
1481 * @param call The call whose RTT mode has changed.
1482 * @param mode the new RTT mode, one of
1483 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1484 * or {@link RttCall#RTT_MODE_VCO}
1485 */
1486 public void onRttModeChanged(Call call, int mode) {}
1487
1488 /**
1489 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1490 * @param call The call whose RTT status has changed.
1491 * @param enabled whether RTT is now enabled or disabled
1492 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1493 * on, null otherwise.
1494 */
1495 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1496
1497 /**
1498 * Invoked when the remote end of the connection has requested that an RTT communication
1499 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1500 * with the same ID that this method is invoked with.
1501 * @param call The call which the RTT request was placed on
1502 * @param id The ID of the request.
1503 */
1504 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001505
1506 /**
1507 * Invoked when the RTT session failed to initiate for some reason, including rejection
1508 * by the remote party.
Tyler Gunnb9a04962022-02-17 08:23:54 -08001509 * <p>
1510 * This callback will ONLY be invoked to report a failure related to a user initiated
1511 * session modification request (i.e. {@link Call#sendRttRequest()}).
1512 * <p>
1513 * If a call is initiated with {@link TelecomManager#EXTRA_START_CALL_WITH_RTT} specified,
1514 * the availability of RTT can be determined by checking {@link Details#PROPERTY_RTT}
1515 * once the call enters state {@link Details#STATE_ACTIVE}.
1516 *
Hall Liu57006aa2017-02-06 10:49:48 -08001517 * @param call The call which the RTT initiation failure occurred on.
1518 * @param reason One of the status codes defined in
Tyler Gunnb9a04962022-02-17 08:23:54 -08001519 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1520 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
Hall Liu57006aa2017-02-06 10:49:48 -08001521 */
Tyler Gunnb9a04962022-02-17 08:23:54 -08001522 public void onRttInitiationFailure(Call call,
1523 @android.telecom.Connection.RttModifyStatus.RttSessionModifyStatus int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001524
1525 /**
1526 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1527 * has completed successfully.
Tyler Gunn9d127732018-03-02 15:45:51 -08001528 * <p>
1529 * For a full discussion of the handover process and the APIs involved, see
1530 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1531 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001532 * @param call The call which had initiated handover.
1533 */
1534 public void onHandoverComplete(Call call) {}
1535
1536 /**
1537 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1538 * has failed.
Tyler Gunn9d127732018-03-02 15:45:51 -08001539 * <p>
1540 * For a full discussion of the handover process and the APIs involved, see
1541 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1542 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001543 * @param call The call which had initiated handover.
Tyler Gunn9d127732018-03-02 15:45:51 -08001544 * @param failureReason Error reason for failure.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001545 */
1546 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001547 }
1548
1549 /**
1550 * A class that holds the state that describes the state of the RTT channel to the remote
1551 * party, if it is active.
1552 */
1553 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001554 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001555 @Retention(RetentionPolicy.SOURCE)
1556 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1557 public @interface RttAudioMode {}
1558
1559 /**
1560 * For metrics use. Default value in the proto.
1561 * @hide
1562 */
1563 public static final int RTT_MODE_INVALID = 0;
1564
1565 /**
1566 * Indicates that there should be a bidirectional audio stream between the two parties
1567 * on the call.
1568 */
1569 public static final int RTT_MODE_FULL = 1;
1570
1571 /**
1572 * Indicates that the local user should be able to hear the audio stream from the remote
1573 * user, but not vice versa. Equivalent to muting the microphone.
1574 */
1575 public static final int RTT_MODE_HCO = 2;
1576
1577 /**
1578 * Indicates that the remote user should be able to hear the audio stream from the local
1579 * user, but not vice versa. Equivalent to setting the volume to zero.
1580 */
1581 public static final int RTT_MODE_VCO = 3;
1582
1583 private static final int READ_BUFFER_SIZE = 1000;
1584
1585 private InputStreamReader mReceiveStream;
1586 private OutputStreamWriter mTransmitStream;
1587 private int mRttMode;
1588 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001589 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001590 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1591
1592 /**
1593 * @hide
1594 */
Hall Liu57006aa2017-02-06 10:49:48 -08001595 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1596 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1597 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001598 mReceiveStream = receiveStream;
1599 mTransmitStream = transmitStream;
1600 mRttMode = mode;
1601 mInCallAdapter = inCallAdapter;
1602 }
1603
1604 /**
1605 * Returns the current RTT audio mode.
1606 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1607 * {@link #RTT_MODE_HCO}.
1608 */
1609 public int getRttAudioMode() {
1610 return mRttMode;
1611 }
1612
1613 /**
1614 * Sets the RTT audio mode. The requested mode change will be communicated through
1615 * {@link Callback#onRttModeChanged(Call, int)}.
1616 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1617 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1618 */
1619 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001620 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001621 }
1622
1623 /**
1624 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
Hall Liudc46c852020-10-29 16:15:33 -07001625 * RTT transmits text in real-time, this method should be called once for each user action.
1626 * For example, when the user enters text as discrete characters using the keyboard, this
1627 * method should be called once for each character. However, if the user enters text by
1628 * pasting or autocomplete, the entire contents of the pasted or autocompleted text should
1629 * be sent in one call to this method.
Hall Liu95d55872017-01-25 17:12:49 -08001630 *
1631 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1632 * lead to interleaved text.
1633 * @param input The message to send to the remote user.
1634 */
1635 public void write(String input) throws IOException {
1636 mTransmitStream.write(input);
1637 mTransmitStream.flush();
1638 }
1639
1640 /**
1641 * Reads a string from the remote user, blocking if there is no data available. Returns
1642 * {@code null} if the RTT conversation has been terminated and there is no further data
1643 * to read.
1644 *
1645 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1646 * lead to interleaved text.
1647 * @return A string containing text sent by the remote user, or {@code null} if the
1648 * conversation has been terminated or if there was an error while reading.
1649 */
Hall Liub1c8a772017-07-17 17:04:41 -07001650 public String read() {
1651 try {
1652 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1653 if (numRead < 0) {
1654 return null;
1655 }
1656 return new String(mReadBuffer, 0, numRead);
1657 } catch (IOException e) {
1658 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001659 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001660 }
Hall Liuffa4a812017-03-02 16:11:00 -08001661 }
1662
1663 /**
1664 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1665 * be read.
1666 * @return A string containing text entered by the user, or {@code null} if the user has
1667 * not entered any new text yet.
1668 */
1669 public String readImmediately() throws IOException {
1670 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001671 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1672 if (numRead < 0) {
1673 return null;
1674 }
1675 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001676 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001677 return null;
1678 }
1679 }
Hall Liue9041242018-02-09 16:40:03 -08001680
1681 /**
1682 * Closes the underlying file descriptors
1683 * @hide
1684 */
1685 public void close() {
1686 try {
1687 mReceiveStream.close();
1688 } catch (IOException e) {
1689 // ignore
1690 }
1691 try {
1692 mTransmitStream.close();
1693 } catch (IOException e) {
1694 // ignore
1695 }
1696 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001697 }
1698
Andrew Leeda80c872015-04-15 14:09:50 -07001699 /**
1700 * @deprecated Use {@code Call.Callback} instead.
1701 * @hide
1702 */
1703 @Deprecated
1704 @SystemApi
1705 public static abstract class Listener extends Callback { }
1706
Ihab Awade63fadb2014-07-09 21:52:04 -07001707 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001708 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001709 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001710 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001711 private final List<Call> mChildren = new ArrayList<>();
1712 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001713 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001714 private final List<Call> mConferenceableCalls = new ArrayList<>();
1715 private final List<Call> mUnmodifiableConferenceableCalls =
1716 Collections.unmodifiableList(mConferenceableCalls);
1717
Santos Cordon823fd3c2014-08-07 18:35:18 -07001718 private boolean mChildrenCached;
1719 private String mParentId = null;
Hall Liuef98bf82020-01-09 15:22:44 -08001720 private String mActiveGenericConferenceChild = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001721 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001722 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001723 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001724 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001725 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001726 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001727 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001728 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001729 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001730
1731 /**
1732 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1733 *
1734 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1735 * remaining or this {@code Call} is not in a post-dial state.
1736 */
1737 public String getRemainingPostDialSequence() {
1738 return mRemainingPostDialSequence;
1739 }
1740
1741 /**
1742 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001743 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001744 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001745 public void answer(@VideoProfile.VideoState int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001746 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001747 }
1748
1749 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301750 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1751 *
1752 * @param address The address to which the call will be deflected.
1753 */
1754 public void deflect(Uri address) {
1755 mInCallAdapter.deflectCall(mTelecomCallId, address);
1756 }
1757
1758 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001759 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1760 *
1761 * @param rejectWithMessage Whether to reject with a text message.
1762 * @param textMessage An optional text message with which to respond.
1763 */
1764 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001765 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001766 }
1767
1768 /**
Tyler Gunnfacfdee2020-01-23 13:10:37 -08001769 * Instructs the {@link ConnectionService} providing this {@link #STATE_RINGING} call that the
1770 * user has chosen to reject the call and has indicated a reason why the call is being rejected.
1771 *
1772 * @param rejectReason the reason the call is being rejected.
1773 */
1774 public void reject(@RejectReason int rejectReason) {
1775 mInCallAdapter.rejectCall(mTelecomCallId, rejectReason);
1776 }
1777
1778 /**
Ravi Palurif4b38e72020-02-05 12:35:41 +05301779 * Instructs this {@code Call} to be transferred to another number.
1780 *
1781 * @param targetNumber The address to which the call will be transferred.
Tyler Gunn460360d2020-07-29 10:21:45 -07001782 * @param isConfirmationRequired if {@code true} it will initiate a confirmed transfer,
1783 * if {@code false}, it will initiate an unconfirmed transfer.
Ravi Palurif4b38e72020-02-05 12:35:41 +05301784 *
1785 * @hide
1786 */
1787 public void transfer(@NonNull Uri targetNumber, boolean isConfirmationRequired) {
1788 mInCallAdapter.transferCall(mTelecomCallId, targetNumber, isConfirmationRequired);
1789 }
1790
1791 /**
1792 * Instructs this {@code Call} to be transferred to another ongoing call.
1793 * This will initiate CONSULTATIVE transfer.
1794 * @param toCall The other ongoing {@code Call} to which this call will be transferred.
1795 *
1796 * @hide
1797 */
1798 public void transfer(@NonNull android.telecom.Call toCall) {
1799 mInCallAdapter.transferCall(mTelecomCallId, toCall.mTelecomCallId);
1800 }
1801
1802 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001803 * Instructs this {@code Call} to disconnect.
1804 */
1805 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001806 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001807 }
1808
1809 /**
1810 * Instructs this {@code Call} to go on hold.
1811 */
1812 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001813 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001814 }
1815
1816 /**
1817 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1818 */
1819 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001820 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001821 }
1822
1823 /**
Hall Liu6dfa2492019-10-01 17:20:39 -07001824 * Instructs Telecom to put the call into the background audio processing state.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001825 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001826 * This method can be called either when the call is in {@link #STATE_RINGING} or
1827 * {@link #STATE_ACTIVE}. After Telecom acknowledges the request by setting the call's state to
1828 * {@link #STATE_AUDIO_PROCESSING}, your app may setup the audio paths with the audio stack in
1829 * order to capture and play audio on the call stream.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001830 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001831 * This method can only be called by the default dialer app.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001832 * <p>
1833 * Apps built with SDK version {@link android.os.Build.VERSION_CODES#R} or later which are using
1834 * the microphone as part of audio processing should specify the foreground service type using
1835 * the attribute {@link android.R.attr#foregroundServiceType} in the {@link InCallService}
1836 * service element of the app's manifest file.
1837 * The {@link ServiceInfo#FOREGROUND_SERVICE_TYPE_MICROPHONE} attribute should be specified.
1838 * @see <a href="https://developer.android.com/preview/privacy/foreground-service-types">
1839 * the Android Developer Site</a> for more information.
Hall Liu6dfa2492019-10-01 17:20:39 -07001840 * @hide
1841 */
1842 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001843 public void enterBackgroundAudioProcessing() {
1844 if (mState != STATE_ACTIVE && mState != STATE_RINGING) {
1845 throw new IllegalStateException("Call must be active or ringing");
1846 }
1847 mInCallAdapter.enterBackgroundAudioProcessing(mTelecomCallId);
1848 }
1849
1850 /**
1851 * Instructs Telecom to come out of the background audio processing state requested by
1852 * {@link #enterBackgroundAudioProcessing()} or from the call screening service.
1853 *
1854 * This method can only be called when the call is in {@link #STATE_AUDIO_PROCESSING}.
1855 *
1856 * @param shouldRing If true, Telecom will put the call into the
1857 * {@link #STATE_SIMULATED_RINGING} state and notify other apps that there is
1858 * a ringing call. Otherwise, the call will go into {@link #STATE_ACTIVE}
1859 * immediately.
1860 * @hide
1861 */
1862 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001863 public void exitBackgroundAudioProcessing(boolean shouldRing) {
1864 if (mState != STATE_AUDIO_PROCESSING) {
1865 throw new IllegalStateException("Call must in the audio processing state");
1866 }
1867 mInCallAdapter.exitBackgroundAudioProcessing(mTelecomCallId, shouldRing);
1868 }
1869
1870 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001871 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
1872 *
1873 * Any other currently playing DTMF tone in the specified call is immediately stopped.
1874 *
1875 * @param digit A character representing the DTMF digit for which to play the tone. This
1876 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1877 */
1878 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001879 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001880 }
1881
1882 /**
1883 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1884 * currently playing.
1885 *
1886 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1887 * currently playing, this method will do nothing.
1888 */
1889 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001890 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001891 }
1892
1893 /**
1894 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1895 *
1896 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1897 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001898 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001899 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001900 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1901 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001902 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001903 * {@code Call} will pause playing the tones and notify callbacks via
1904 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001905 * should display to the user an indication of this state and an affordance to continue
1906 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1907 * app should invoke the {@link #postDialContinue(boolean)} method.
1908 *
1909 * @param proceed Whether or not to continue with the post-dial sequence.
1910 */
1911 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001912 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001913 }
1914
1915 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001916 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001917 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001918 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001919 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1920 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001921
1922 }
1923
1924 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001925 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001926 *
1927 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001928 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001929 public void conference(Call callToConferenceWith) {
1930 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001931 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001932 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001933 }
1934
1935 /**
1936 * Instructs this {@code Call} to split from any conference call with which it may be
1937 * connected.
1938 */
1939 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001940 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001941 }
1942
1943 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001944 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001945 */
1946 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001947 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001948 }
1949
1950 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001951 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001952 */
1953 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001954 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001955 }
1956
1957 /**
Ravi Paluri404babb2020-01-23 19:02:44 +05301958 * Pulls participants to existing call by forming a conference call.
1959 * See {@link Details#CAPABILITY_ADD_PARTICIPANT}.
1960 *
1961 * @param participants participants to be pulled to existing call.
1962 */
1963 public void addConferenceParticipants(@NonNull List<Uri> participants) {
1964 mInCallAdapter.addConferenceParticipants(mTelecomCallId, participants);
1965 }
1966
1967 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001968 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1969 * device.
1970 * <p>
1971 * Calls to this method are ignored if the call does not have the
1972 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
1973 * <p>
1974 * An {@link InCallService} will only see calls which support this method if it has the
1975 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
1976 * in its manifest.
1977 */
1978 public void pullExternalCall() {
1979 // If this isn't an external call, ignore the request.
1980 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
1981 return;
1982 }
1983
1984 mInCallAdapter.pullExternalCall(mTelecomCallId);
1985 }
1986
1987 /**
1988 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
1989 * the {@link ConnectionService}.
1990 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001991 * Call events are used to communicate point in time information from an {@link InCallService}
1992 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
1993 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
1994 * {@link ConnectionService}.
1995 * <p>
1996 * A {@link ConnectionService} can communicate to the {@link InCallService} using
1997 * {@link Connection#sendConnectionEvent(String, Bundle)}.
1998 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001999 * Events are exposed to {@link ConnectionService} implementations via
2000 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
2001 * <p>
2002 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07002003 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
2004 * ignore some events altogether.
2005 * <p>
2006 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
2007 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
2008 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
2009 * they define their own event types in this namespace. When defining a custom event type,
2010 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
2011 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
2012 * <p>
2013 * When defining events and the associated extras, it is important to keep their behavior
2014 * consistent when the associated {@link InCallService} is updated. Support for deprecated
2015 * events/extras should me maintained to ensure backwards compatibility with older
2016 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002017 *
2018 * @param event The connection event.
2019 * @param extras Bundle containing extra information associated with the event.
2020 */
2021 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002022 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002023 }
2024
2025 /**
Hall Liu95d55872017-01-25 17:12:49 -08002026 * Sends an RTT upgrade request to the remote end of the connection. Success is not
2027 * guaranteed, and notification of success will be via the
2028 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2029 */
2030 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08002031 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002032 }
2033
2034 /**
2035 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
2036 * callback.
2037 * The ID used here should be the same as the ID that was received via the callback.
2038 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
2039 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
2040 */
2041 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08002042 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08002043 }
2044
2045 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07002046 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
2047 * by {@code toHandle}. The videoState specified indicates the desired video state after the
2048 * handover.
2049 * <p>
Tyler Gunn9d127732018-03-02 15:45:51 -08002050 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2051 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2052 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2053 * is referred to as the source of the handover, and the video calling app is referred to as the
2054 * destination.
2055 * <p>
2056 * When considering a handover scenario the device this method is called on is considered the
2057 * <em>initiating</em> device (since the user initiates the handover from this device), and the
2058 * other device is considered the <em>receiving</em> device.
2059 * <p>
2060 * When this method is called on the <em>initiating</em> device, the Telecom framework will bind
2061 * to the {@link ConnectionService} defined by the {@code toHandle} {@link PhoneAccountHandle}
2062 * and invoke
2063 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
2064 * ConnectionRequest)} to inform the destination app that a request has been made to handover a
2065 * call to it. The app returns an instance of {@link Connection} to represent the handover call
2066 * At this point the app should display UI to indicate to the user that a call
2067 * handover is in process.
2068 * <p>
2069 * The destination app is responsible for communicating the handover request from the
2070 * <em>initiating</em> device to the <em>receiving</em> device.
2071 * <p>
2072 * When the app on the <em>receiving</em> device receives the handover request, it calls
2073 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)} to continue the handover
2074 * process from the <em>initiating</em> device to the <em>receiving</em> device. At this point
2075 * the destination app on the <em>receiving</em> device should show UI to allow the user to
2076 * choose whether they want to continue their call in the destination app.
2077 * <p>
2078 * When the destination app on the <em>receiving</em> device calls
2079 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)}, Telecom will bind to its
2080 * {@link ConnectionService} and call
2081 * {@link ConnectionService#onCreateIncomingHandoverConnection(PhoneAccountHandle,
2082 * ConnectionRequest)} to inform it of the handover request. The app returns an instance of
2083 * {@link Connection} to represent the handover call.
2084 * <p>
2085 * If the user of the <em>receiving</em> device accepts the handover, the app calls
2086 * {@link Connection#setActive()} to complete the handover process; Telecom will disconnect the
2087 * original call. If the user rejects the handover, the app calls
2088 * {@link Connection#setDisconnected(DisconnectCause)} and specifies a {@link DisconnectCause}
2089 * of {@link DisconnectCause#CANCELED} to indicate that the handover has been cancelled.
2090 * <p>
2091 * Telecom will only allow handovers from {@link PhoneAccount}s which declare
2092 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}. Similarly, the {@link PhoneAccount}
2093 * specified by {@code toHandle} must declare {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}.
2094 * <p>
2095 * Errors in the handover process are reported to the {@link InCallService} via
2096 * {@link Callback#onHandoverFailed(Call, int)}. Errors in the handover process are reported to
2097 * the involved {@link ConnectionService}s via
2098 * {@link ConnectionService#onHandoverFailed(ConnectionRequest, int)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07002099 *
2100 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
2101 * this call to.
Tyler Gunn9d127732018-03-02 15:45:51 -08002102 * @param videoState Indicates the video state desired after the handover (see the
2103 * {@code STATE_*} constants defined in {@link VideoProfile}).
Sanket Padawea8eddd42017-11-03 11:07:35 -07002104 * @param extras Bundle containing extra information to be passed to the
2105 * {@link ConnectionService}
2106 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002107 public void handoverTo(PhoneAccountHandle toHandle, @VideoProfile.VideoState int videoState,
2108 Bundle extras) {
Sanket Padawea8eddd42017-11-03 11:07:35 -07002109 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
2110 }
2111
2112 /**
Hall Liu95d55872017-01-25 17:12:49 -08002113 * Terminate the RTT session on this call. The resulting state change will be notified via
2114 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2115 */
2116 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08002117 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002118 }
2119
2120 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07002121 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
2122 * added.
2123 * <p>
2124 * No assumptions should be made as to how an In-Call UI or service will handle these
2125 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
Tyler Gunn6c100242023-01-09 11:23:18 -08002126 * <p>
2127 * Extras added using this method will be made available to the {@link ConnectionService}
2128 * associated with this {@link Call} and notified via
2129 * {@link Connection#onExtrasChanged(Bundle)}.
2130 * <p>
2131 * Extras added using this method will also be available to other running {@link InCallService}s
2132 * and notified via {@link Call.Callback#onDetailsChanged(Call, Details)}. The extras can be
2133 * accessed via {@link Details#getExtras()}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002134 *
2135 * @param extras The extras to add.
2136 */
2137 public final void putExtras(Bundle extras) {
2138 if (extras == null) {
2139 return;
2140 }
2141
2142 if (mExtras == null) {
2143 mExtras = new Bundle();
2144 }
2145 mExtras.putAll(extras);
2146 mInCallAdapter.putExtras(mTelecomCallId, extras);
2147 }
2148
2149 /**
2150 * Adds a boolean extra to this {@link Call}.
2151 *
2152 * @param key The extra key.
2153 * @param value The value.
2154 * @hide
2155 */
2156 public final void putExtra(String key, boolean value) {
2157 if (mExtras == null) {
2158 mExtras = new Bundle();
2159 }
2160 mExtras.putBoolean(key, value);
2161 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2162 }
2163
2164 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002165 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002166 *
2167 * @param key The extra key.
2168 * @param value The value.
2169 * @hide
2170 */
2171 public final void putExtra(String key, int value) {
2172 if (mExtras == null) {
2173 mExtras = new Bundle();
2174 }
2175 mExtras.putInt(key, value);
2176 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2177 }
2178
2179 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002180 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002181 *
2182 * @param key The extra key.
2183 * @param value The value.
2184 * @hide
2185 */
2186 public final void putExtra(String key, String value) {
2187 if (mExtras == null) {
2188 mExtras = new Bundle();
2189 }
2190 mExtras.putString(key, value);
2191 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2192 }
2193
2194 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002195 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002196 *
2197 * @param keys The keys of the extras to remove.
2198 */
2199 public final void removeExtras(List<String> keys) {
2200 if (mExtras != null) {
2201 for (String key : keys) {
2202 mExtras.remove(key);
2203 }
2204 if (mExtras.size() == 0) {
2205 mExtras = null;
2206 }
2207 }
2208 mInCallAdapter.removeExtras(mTelecomCallId, keys);
2209 }
2210
2211 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002212 * Removes extras from this {@link Call}.
2213 *
2214 * @param keys The keys of the extras to remove.
2215 */
2216 public final void removeExtras(String ... keys) {
2217 removeExtras(Arrays.asList(keys));
2218 }
2219
2220 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002221 * Obtains the parent of this {@code Call} in a conference, if any.
2222 *
2223 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
2224 * child of any conference {@code Call}s.
2225 */
2226 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002227 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002228 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002229 }
2230 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07002231 }
2232
2233 /**
2234 * Obtains the children of this conference {@code Call}, if any.
2235 *
2236 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
2237 * {@code List} otherwise.
2238 */
2239 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002240 if (!mChildrenCached) {
2241 mChildrenCached = true;
2242 mChildren.clear();
2243
2244 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002245 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002246 if (call == null) {
2247 // At least one child was still not found, so do not save true for "cached"
2248 mChildrenCached = false;
2249 } else {
2250 mChildren.add(call);
2251 }
2252 }
2253 }
2254
Ihab Awade63fadb2014-07-09 21:52:04 -07002255 return mUnmodifiableChildren;
2256 }
2257
2258 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002259 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
2260 *
2261 * @return The list of conferenceable {@code Call}s.
2262 */
2263 public List<Call> getConferenceableCalls() {
2264 return mUnmodifiableConferenceableCalls;
2265 }
2266
2267 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002268 * Obtains the state of this {@code Call}.
2269 *
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002270 * @return The call state.
2271 * @deprecated The call state is available via {@link Call.Details#getState()}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002272 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002273 @Deprecated
2274 public @CallState int getState() {
Ihab Awade63fadb2014-07-09 21:52:04 -07002275 return mState;
2276 }
2277
2278 /**
Hall Liuef98bf82020-01-09 15:22:44 -08002279 * Returns the child {@link Call} in a generic conference that is currently active.
Hall Liu135e53aa2020-02-27 18:34:11 -08002280 *
2281 * A "generic conference" is the mechanism used to support two simultaneous calls on a device
2282 * in CDMA networks. It is effectively equivalent to having one call active and one call on hold
2283 * in GSM or IMS calls. This method returns the currently active call.
2284 *
2285 * In a generic conference, the network exposes the conference to us as a single call, and we
2286 * switch between talking to the two participants using a CDMA flash command. Since the network
2287 * exposes no additional information about the call, the only way we know which caller we're
2288 * currently talking to is by keeping track of the flash commands that we've sent to the
2289 * network.
2290 *
Hall Liuef98bf82020-01-09 15:22:44 -08002291 * For calls that are not generic conferences, or when the generic conference has more than
2292 * 2 children, returns {@code null}.
2293 * @see Details#PROPERTY_GENERIC_CONFERENCE
2294 * @return The active child call.
2295 */
2296 public @Nullable Call getGenericConferenceActiveChildCall() {
2297 if (mActiveGenericConferenceChild != null) {
2298 return mPhone.internalGetCallByTelecomId(mActiveGenericConferenceChild);
2299 }
2300 return null;
2301 }
2302
2303 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002304 * Obtains a list of canned, pre-configured message responses to present to the user as
Tyler Gunn434fc2c2020-10-06 14:23:54 -07002305 * ways of rejecting an incoming {@code Call} using via a text message.
2306 * <p>
2307 * <em>Note:</em> Since canned responses may be loaded from the file system, they are not
2308 * guaranteed to be present when this {@link Call} is first added to the {@link InCallService}
2309 * via {@link InCallService#onCallAdded(Call)}. The callback
2310 * {@link Call.Callback#onCannedTextResponsesLoaded(Call, List)} will be called when/if canned
2311 * responses for the call become available.
Ihab Awade63fadb2014-07-09 21:52:04 -07002312 *
2313 * @see #reject(boolean, String)
2314 *
2315 * @return A list of canned text message responses.
2316 */
2317 public List<String> getCannedTextResponses() {
2318 return mCannedTextResponses;
2319 }
2320
2321 /**
2322 * Obtains an object that can be used to display video from this {@code Call}.
2323 *
Andrew Lee50aca232014-07-22 16:41:54 -07002324 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002325 */
Andrew Lee50aca232014-07-22 16:41:54 -07002326 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002327 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07002328 }
2329
2330 /**
2331 * Obtains an object containing call details.
2332 *
2333 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
2334 * result may be {@code null}.
2335 */
2336 public Details getDetails() {
2337 return mDetails;
2338 }
2339
2340 /**
Hall Liu95d55872017-01-25 17:12:49 -08002341 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
2342 * receive RTT text data, as well as to change the RTT mode.
2343 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
2344 */
2345 public @Nullable RttCall getRttCall() {
2346 return mRttCall;
2347 }
2348
2349 /**
2350 * Returns whether this call has an active RTT connection.
2351 * @return true if there is a connection, false otherwise.
2352 */
2353 public boolean isRttActive() {
Hall Liue9041242018-02-09 16:40:03 -08002354 return mRttCall != null && mDetails.hasProperty(Details.PROPERTY_RTT);
Hall Liu95d55872017-01-25 17:12:49 -08002355 }
2356
2357 /**
Andrew Leeda80c872015-04-15 14:09:50 -07002358 * Registers a callback to this {@code Call}.
2359 *
2360 * @param callback A {@code Callback}.
2361 */
2362 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07002363 registerCallback(callback, new Handler());
2364 }
2365
2366 /**
2367 * Registers a callback to this {@code Call}.
2368 *
2369 * @param callback A {@code Callback}.
2370 * @param handler A handler which command and status changes will be delivered to.
2371 */
2372 public void registerCallback(Callback callback, Handler handler) {
2373 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07002374 // Don't allow new callback registration if the call is already being destroyed.
2375 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002376 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
2377 }
Andrew Leeda80c872015-04-15 14:09:50 -07002378 }
2379
2380 /**
2381 * Unregisters a callback from this {@code Call}.
2382 *
2383 * @param callback A {@code Callback}.
2384 */
2385 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07002386 // Don't allow callback deregistration if the call is already being destroyed.
2387 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002388 for (CallbackRecord<Callback> record : mCallbackRecords) {
2389 if (record.getCallback() == callback) {
2390 mCallbackRecords.remove(record);
2391 break;
2392 }
2393 }
Andrew Leeda80c872015-04-15 14:09:50 -07002394 }
2395 }
2396
Santos Cordon3c20d632016-02-25 16:12:35 -08002397 @Override
2398 public String toString() {
2399 return new StringBuilder().
2400 append("Call [id: ").
2401 append(mTelecomCallId).
2402 append(", state: ").
2403 append(stateToString(mState)).
2404 append(", details: ").
2405 append(mDetails).
2406 append("]").toString();
2407 }
2408
2409 /**
2410 * @param state An integer value of a {@code STATE_*} constant.
2411 * @return A string representation of the value.
2412 */
2413 private static String stateToString(int state) {
2414 switch (state) {
2415 case STATE_NEW:
2416 return "NEW";
2417 case STATE_RINGING:
2418 return "RINGING";
2419 case STATE_DIALING:
2420 return "DIALING";
2421 case STATE_ACTIVE:
2422 return "ACTIVE";
2423 case STATE_HOLDING:
2424 return "HOLDING";
2425 case STATE_DISCONNECTED:
2426 return "DISCONNECTED";
2427 case STATE_CONNECTING:
2428 return "CONNECTING";
2429 case STATE_DISCONNECTING:
2430 return "DISCONNECTING";
2431 case STATE_SELECT_PHONE_ACCOUNT:
2432 return "SELECT_PHONE_ACCOUNT";
Hall Liu4e35b642019-10-14 17:50:45 -07002433 case STATE_SIMULATED_RINGING:
2434 return "SIMULATED_RINGING";
2435 case STATE_AUDIO_PROCESSING:
2436 return "AUDIO_PROCESSING";
Santos Cordon3c20d632016-02-25 16:12:35 -08002437 default:
2438 Log.w(Call.class, "Unknown state %d", state);
2439 return "UNKNOWN";
2440 }
2441 }
2442
Andrew Leeda80c872015-04-15 14:09:50 -07002443 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002444 * Adds a listener to this {@code Call}.
2445 *
2446 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002447 * @deprecated Use {@link #registerCallback} instead.
2448 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002449 */
Andrew Leeda80c872015-04-15 14:09:50 -07002450 @Deprecated
2451 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002452 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002453 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002454 }
2455
2456 /**
2457 * Removes a listener from this {@code Call}.
2458 *
2459 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002460 * @deprecated Use {@link #unregisterCallback} instead.
2461 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002462 */
Andrew Leeda80c872015-04-15 14:09:50 -07002463 @Deprecated
2464 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002465 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002466 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002467 }
2468
2469 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08002470 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
2471 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002472 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002473 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002474 mInCallAdapter = inCallAdapter;
2475 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002476 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002477 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07002478 }
2479
2480 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08002481 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08002482 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002483 mPhone = phone;
2484 mTelecomCallId = telecomCallId;
2485 mInCallAdapter = inCallAdapter;
2486 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002487 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002488 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002489 }
2490
2491 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002492 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002493 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002494 }
2495
2496 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002497 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08002498
Ihab Awade63fadb2014-07-09 21:52:04 -07002499 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08002500 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07002501 boolean detailsChanged = !Objects.equals(mDetails, details);
2502 if (detailsChanged) {
2503 mDetails = details;
2504 }
2505
2506 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07002507 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
2508 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
2509 mCannedTextResponses =
2510 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07002511 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07002512 }
2513
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002514 IVideoProvider previousVideoProvider = mVideoCallImpl == null ? null :
2515 mVideoCallImpl.getVideoProvider();
2516 IVideoProvider newVideoProvider = parcelableCall.getVideoProvider();
2517
2518 // parcelableCall.isVideoCallProviderChanged is only true when we have a video provider
2519 // specified; so we should check if the actual IVideoProvider changes as well.
2520 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged()
2521 && !Objects.equals(previousVideoProvider, newVideoProvider);
Andrew Lee50aca232014-07-22 16:41:54 -07002522 if (videoCallChanged) {
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002523 if (mVideoCallImpl != null) {
2524 mVideoCallImpl.destroy();
2525 }
2526 mVideoCallImpl = parcelableCall.isVideoCallProviderChanged() ?
2527 parcelableCall.getVideoCallImpl(mCallingPackage, mTargetSdkVersion) : null;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002528 }
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002529
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002530 if (mVideoCallImpl != null) {
2531 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07002532 }
2533
Santos Cordone3c507b2015-04-23 14:44:19 -07002534 int state = parcelableCall.getState();
Hall Liu31de23d2019-10-11 15:38:29 -07002535 if (mTargetSdkVersion < Phone.SDK_VERSION_R && state == Call.STATE_SIMULATED_RINGING) {
2536 state = Call.STATE_RINGING;
2537 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002538 boolean stateChanged = mState != state;
2539 if (stateChanged) {
2540 mState = state;
2541 }
2542
Santos Cordon823fd3c2014-08-07 18:35:18 -07002543 String parentId = parcelableCall.getParentCallId();
2544 boolean parentChanged = !Objects.equals(mParentId, parentId);
2545 if (parentChanged) {
2546 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002547 }
2548
Santos Cordon823fd3c2014-08-07 18:35:18 -07002549 List<String> childCallIds = parcelableCall.getChildCallIds();
2550 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
2551 if (childrenChanged) {
2552 mChildrenIds.clear();
2553 mChildrenIds.addAll(parcelableCall.getChildCallIds());
2554 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07002555 }
2556
Hall Liuef98bf82020-01-09 15:22:44 -08002557 String activeChildCallId = parcelableCall.getActiveChildCallId();
2558 boolean activeChildChanged = !Objects.equals(activeChildCallId,
2559 mActiveGenericConferenceChild);
2560 if (activeChildChanged) {
2561 mActiveGenericConferenceChild = activeChildCallId;
2562 }
2563
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002564 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
2565 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
2566 for (String otherId : conferenceableCallIds) {
2567 if (callIdMap.containsKey(otherId)) {
2568 conferenceableCalls.add(callIdMap.get(otherId));
2569 }
2570 }
2571
2572 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
2573 mConferenceableCalls.clear();
2574 mConferenceableCalls.addAll(conferenceableCalls);
2575 fireConferenceableCallsChanged();
2576 }
2577
Hall Liu95d55872017-01-25 17:12:49 -08002578 boolean isRttChanged = false;
2579 boolean rttModeChanged = false;
Hall Liue9041242018-02-09 16:40:03 -08002580 if (parcelableCall.getIsRttCallChanged()
2581 && mDetails.hasProperty(Details.PROPERTY_RTT)) {
Hall Liu95d55872017-01-25 17:12:49 -08002582 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
2583 InputStreamReader receiveStream = new InputStreamReader(
2584 new ParcelFileDescriptor.AutoCloseInputStream(
2585 parcelableRttCall.getReceiveStream()),
2586 StandardCharsets.UTF_8);
2587 OutputStreamWriter transmitStream = new OutputStreamWriter(
2588 new ParcelFileDescriptor.AutoCloseOutputStream(
2589 parcelableRttCall.getTransmitStream()),
2590 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08002591 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08002592 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
2593 if (mRttCall == null) {
2594 isRttChanged = true;
2595 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
2596 rttModeChanged = true;
2597 }
2598 mRttCall = newRttCall;
2599 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
2600 && parcelableCall.getIsRttCallChanged()) {
2601 isRttChanged = true;
Tyler Gunn4cd42482021-04-30 16:23:15 -07002602 mRttCall.close();
Hall Liu95d55872017-01-25 17:12:49 -08002603 mRttCall = null;
2604 }
2605
Ihab Awade63fadb2014-07-09 21:52:04 -07002606 // Now we fire updates, ensuring that any client who listens to any of these notifications
2607 // gets the most up-to-date state.
2608
2609 if (stateChanged) {
2610 fireStateChanged(mState);
2611 }
2612 if (detailsChanged) {
2613 fireDetailsChanged(mDetails);
2614 }
2615 if (cannedTextResponsesChanged) {
2616 fireCannedTextResponsesLoaded(mCannedTextResponses);
2617 }
Andrew Lee50aca232014-07-22 16:41:54 -07002618 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002619 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07002620 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07002621 if (parentChanged) {
2622 fireParentChanged(getParent());
2623 }
Hall Liuef98bf82020-01-09 15:22:44 -08002624 if (childrenChanged || activeChildChanged) {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002625 fireChildrenChanged(getChildren());
2626 }
Hall Liu95d55872017-01-25 17:12:49 -08002627 if (isRttChanged) {
2628 fireOnIsRttChanged(mRttCall != null, mRttCall);
2629 }
2630 if (rttModeChanged) {
2631 fireOnRttModeChanged(mRttCall.getRttAudioMode());
2632 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002633
2634 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
2635 // remove ourselves from the Phone. Note that we do this after completing all state updates
2636 // so a client can cleanly transition all their UI to the state appropriate for a
2637 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
2638 if (mState == STATE_DISCONNECTED) {
2639 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07002640 }
2641 }
2642
2643 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002644 final void internalSetPostDialWait(String remaining) {
2645 mRemainingPostDialSequence = remaining;
2646 firePostDialWait(mRemainingPostDialSequence);
2647 }
2648
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07002649 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07002650 final void internalSetDisconnected() {
2651 if (mState != Call.STATE_DISCONNECTED) {
2652 mState = Call.STATE_DISCONNECTED;
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002653 if (mDetails != null) {
2654 mDetails = new Details(mState,
2655 mDetails.getTelecomCallId(),
2656 mDetails.getHandle(),
2657 mDetails.getHandlePresentation(),
2658 mDetails.getCallerDisplayName(),
2659 mDetails.getCallerDisplayNamePresentation(),
2660 mDetails.getAccountHandle(),
2661 mDetails.getCallCapabilities(),
2662 mDetails.getCallProperties(),
2663 mDetails.getDisconnectCause(),
2664 mDetails.getConnectTimeMillis(),
2665 mDetails.getGatewayInfo(),
2666 mDetails.getVideoState(),
2667 mDetails.getStatusHints(),
2668 mDetails.getExtras(),
2669 mDetails.getIntentExtras(),
2670 mDetails.getCreationTimeMillis(),
2671 mDetails.getContactDisplayName(),
2672 mDetails.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07002673 mDetails.getCallerNumberVerificationStatus(),
2674 mDetails.getContactPhotoUri()
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002675 );
2676 fireDetailsChanged(mDetails);
2677 }
Santos Cordonf30d7e92014-08-26 09:54:33 -07002678 fireStateChanged(mState);
2679 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07002680 }
2681 }
2682
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002683 /** {@hide} */
2684 final void internalOnConnectionEvent(String event, Bundle extras) {
2685 fireOnConnectionEvent(event, extras);
2686 }
2687
Hall Liu95d55872017-01-25 17:12:49 -08002688 /** {@hide} */
2689 final void internalOnRttUpgradeRequest(final int requestId) {
2690 for (CallbackRecord<Callback> record : mCallbackRecords) {
2691 final Call call = this;
2692 final Callback callback = record.getCallback();
2693 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
2694 }
2695 }
2696
Hall Liu57006aa2017-02-06 10:49:48 -08002697 /** @hide */
2698 final void internalOnRttInitiationFailure(int reason) {
2699 for (CallbackRecord<Callback> record : mCallbackRecords) {
2700 final Call call = this;
2701 final Callback callback = record.getCallback();
2702 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
2703 }
2704 }
2705
Sanket Padawe85291f62017-12-01 13:59:27 -08002706 /** {@hide} */
2707 final void internalOnHandoverFailed(int error) {
2708 for (CallbackRecord<Callback> record : mCallbackRecords) {
2709 final Call call = this;
2710 final Callback callback = record.getCallback();
2711 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
2712 }
2713 }
2714
Tyler Gunn858bfaf2018-01-22 15:17:54 -08002715 /** {@hide} */
2716 final void internalOnHandoverComplete() {
2717 for (CallbackRecord<Callback> record : mCallbackRecords) {
2718 final Call call = this;
2719 final Callback callback = record.getCallback();
2720 record.getHandler().post(() -> callback.onHandoverComplete(call));
2721 }
2722 }
2723
Andrew Lee011728f2015-04-23 15:47:06 -07002724 private void fireStateChanged(final int newState) {
2725 for (CallbackRecord<Callback> record : mCallbackRecords) {
2726 final Call call = this;
2727 final Callback callback = record.getCallback();
2728 record.getHandler().post(new Runnable() {
2729 @Override
2730 public void run() {
2731 callback.onStateChanged(call, newState);
2732 }
2733 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002734 }
2735 }
2736
Andrew Lee011728f2015-04-23 15:47:06 -07002737 private void fireParentChanged(final Call newParent) {
2738 for (CallbackRecord<Callback> record : mCallbackRecords) {
2739 final Call call = this;
2740 final Callback callback = record.getCallback();
2741 record.getHandler().post(new Runnable() {
2742 @Override
2743 public void run() {
2744 callback.onParentChanged(call, newParent);
2745 }
2746 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002747 }
2748 }
2749
Andrew Lee011728f2015-04-23 15:47:06 -07002750 private void fireChildrenChanged(final List<Call> children) {
2751 for (CallbackRecord<Callback> record : mCallbackRecords) {
2752 final Call call = this;
2753 final Callback callback = record.getCallback();
2754 record.getHandler().post(new Runnable() {
2755 @Override
2756 public void run() {
2757 callback.onChildrenChanged(call, children);
2758 }
2759 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002760 }
2761 }
2762
Andrew Lee011728f2015-04-23 15:47:06 -07002763 private void fireDetailsChanged(final Details details) {
2764 for (CallbackRecord<Callback> record : mCallbackRecords) {
2765 final Call call = this;
2766 final Callback callback = record.getCallback();
2767 record.getHandler().post(new Runnable() {
2768 @Override
2769 public void run() {
2770 callback.onDetailsChanged(call, details);
2771 }
2772 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002773 }
2774 }
2775
Andrew Lee011728f2015-04-23 15:47:06 -07002776 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2777 for (CallbackRecord<Callback> record : mCallbackRecords) {
2778 final Call call = this;
2779 final Callback callback = record.getCallback();
2780 record.getHandler().post(new Runnable() {
2781 @Override
2782 public void run() {
2783 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2784 }
2785 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002786 }
2787 }
2788
Andrew Lee011728f2015-04-23 15:47:06 -07002789 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2790 for (CallbackRecord<Callback> record : mCallbackRecords) {
2791 final Call call = this;
2792 final Callback callback = record.getCallback();
2793 record.getHandler().post(new Runnable() {
2794 @Override
2795 public void run() {
2796 callback.onVideoCallChanged(call, videoCall);
2797 }
2798 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002799 }
2800 }
2801
Andrew Lee011728f2015-04-23 15:47:06 -07002802 private void firePostDialWait(final String remainingPostDialSequence) {
2803 for (CallbackRecord<Callback> record : mCallbackRecords) {
2804 final Call call = this;
2805 final Callback callback = record.getCallback();
2806 record.getHandler().post(new Runnable() {
2807 @Override
2808 public void run() {
2809 callback.onPostDialWait(call, remainingPostDialSequence);
2810 }
2811 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002812 }
2813 }
2814
2815 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002816 /**
2817 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2818 * onCallRemoved callback, we remove this call from the Phone's record
2819 * only once all of the registered onCallDestroyed callbacks are executed.
2820 * All the callbacks get removed from our records as a part of this operation
2821 * since onCallDestroyed is the final callback.
2822 */
2823 final Call call = this;
2824 if (mCallbackRecords.isEmpty()) {
2825 // No callbacks registered, remove the call from Phone's record.
2826 mPhone.internalRemoveCall(call);
2827 }
2828 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002829 final Callback callback = record.getCallback();
2830 record.getHandler().post(new Runnable() {
2831 @Override
2832 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002833 boolean isFinalRemoval = false;
2834 RuntimeException toThrow = null;
2835 try {
2836 callback.onCallDestroyed(call);
2837 } catch (RuntimeException e) {
2838 toThrow = e;
2839 }
2840 synchronized(Call.this) {
2841 mCallbackRecords.remove(record);
2842 if (mCallbackRecords.isEmpty()) {
2843 isFinalRemoval = true;
2844 }
2845 }
2846 if (isFinalRemoval) {
2847 mPhone.internalRemoveCall(call);
2848 }
2849 if (toThrow != null) {
2850 throw toThrow;
2851 }
Andrew Lee011728f2015-04-23 15:47:06 -07002852 }
2853 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002854 }
2855 }
2856
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002857 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002858 for (CallbackRecord<Callback> record : mCallbackRecords) {
2859 final Call call = this;
2860 final Callback callback = record.getCallback();
2861 record.getHandler().post(new Runnable() {
2862 @Override
2863 public void run() {
2864 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2865 }
2866 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002867 }
2868 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002869
2870 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002871 * Notifies listeners of an incoming connection event.
2872 * <p>
2873 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2874 *
2875 * @param event
2876 * @param extras
2877 */
2878 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2879 for (CallbackRecord<Callback> record : mCallbackRecords) {
2880 final Call call = this;
2881 final Callback callback = record.getCallback();
2882 record.getHandler().post(new Runnable() {
2883 @Override
2884 public void run() {
2885 callback.onConnectionEvent(call, event, extras);
2886 }
2887 });
2888 }
2889 }
2890
2891 /**
Hall Liu95d55872017-01-25 17:12:49 -08002892 * Notifies listeners of an RTT on/off change
2893 *
2894 * @param enabled True if RTT is now enabled, false otherwise
2895 */
2896 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2897 for (CallbackRecord<Callback> record : mCallbackRecords) {
2898 final Call call = this;
2899 final Callback callback = record.getCallback();
2900 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2901 }
2902 }
2903
2904 /**
2905 * Notifies listeners of a RTT mode change
2906 *
2907 * @param mode The new RTT mode
2908 */
2909 private void fireOnRttModeChanged(final int mode) {
2910 for (CallbackRecord<Callback> record : mCallbackRecords) {
2911 final Call call = this;
2912 final Callback callback = record.getCallback();
2913 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2914 }
2915 }
2916
2917 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002918 * Determines if two bundles are equal.
2919 *
2920 * @param bundle The original bundle.
2921 * @param newBundle The bundle to compare with.
2922 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2923 */
2924 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2925 if (bundle == null || newBundle == null) {
2926 return bundle == newBundle;
2927 }
2928
2929 if (bundle.size() != newBundle.size()) {
2930 return false;
2931 }
2932
2933 for(String key : bundle.keySet()) {
2934 if (key != null) {
2935 final Object value = bundle.get(key);
2936 final Object newValue = newBundle.get(key);
Grace Jia17005bd2022-05-12 12:49:02 -07002937 if (!newBundle.containsKey(key)) {
2938 return false;
2939 }
2940 if (value instanceof Bundle && newValue instanceof Bundle) {
2941 if (!areBundlesEqual((Bundle) value, (Bundle) newValue)) {
2942 return false;
2943 }
2944 }
2945 if (value instanceof byte[] && newValue instanceof byte[]) {
2946 if (!Arrays.equals((byte[]) value, (byte[]) newValue)) {
2947 return false;
2948 }
2949 } else if (!Objects.equals(value, newValue)) {
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002950 return false;
2951 }
2952 }
2953 }
2954 return true;
2955 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002956}