blob: 1da4ea92c8f7829a8463364699f842db9fefc219 [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;
qing723dac62022-10-28 03:40:43 +000027import android.os.BadParcelableException;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080028import android.os.Build;
Nancy Chen10798dc2014-08-08 14:00:25 -070029import android.os.Bundle;
Andrew Lee011728f2015-04-23 15:47:06 -070030import android.os.Handler;
Hall Liu95d55872017-01-25 17:12:49 -080031import android.os.ParcelFileDescriptor;
Ihab Awade63fadb2014-07-09 21:52:04 -070032
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -080033import com.android.internal.telecom.IVideoProvider;
34
Hall Liu95d55872017-01-25 17:12:49 -080035import java.io.IOException;
36import java.io.InputStreamReader;
37import java.io.OutputStreamWriter;
Hall Liu95d55872017-01-25 17:12:49 -080038import java.lang.annotation.Retention;
39import java.lang.annotation.RetentionPolicy;
40import java.nio.charset.StandardCharsets;
Ihab Awade63fadb2014-07-09 21:52:04 -070041import java.util.ArrayList;
Tyler Gunn071be6f2016-05-10 14:52:33 -070042import java.util.Arrays;
Ihab Awade63fadb2014-07-09 21:52:04 -070043import java.util.Collections;
44import java.util.List;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -070045import java.util.Map;
Ihab Awade63fadb2014-07-09 21:52:04 -070046import java.util.Objects;
Jay Shrauner229e3822014-08-15 09:23:07 -070047import java.util.concurrent.CopyOnWriteArrayList;
Ihab Awade63fadb2014-07-09 21:52:04 -070048
49/**
50 * Represents an ongoing phone call that the in-call app should present to the user.
51 */
52public final class Call {
53 /**
54 * The state of a {@code Call} when newly created.
55 */
56 public static final int STATE_NEW = 0;
57
58 /**
59 * The state of an outgoing {@code Call} when dialing the remote number, but not yet connected.
60 */
61 public static final int STATE_DIALING = 1;
62
63 /**
64 * The state of an incoming {@code Call} when ringing locally, but not yet connected.
65 */
66 public static final int STATE_RINGING = 2;
67
68 /**
69 * The state of a {@code Call} when in a holding state.
70 */
71 public static final int STATE_HOLDING = 3;
72
73 /**
74 * The state of a {@code Call} when actively supporting conversation.
75 */
76 public static final int STATE_ACTIVE = 4;
77
78 /**
79 * The state of a {@code Call} when no further voice or other communication is being
80 * transmitted, the remote side has been or will inevitably be informed that the {@code Call}
81 * is no longer active, and the local data transport has or inevitably will release resources
82 * associated with this {@code Call}.
83 */
84 public static final int STATE_DISCONNECTED = 7;
85
Nancy Chen5da0fd52014-07-08 14:16:17 -070086 /**
Santos Cordone3c507b2015-04-23 14:44:19 -070087 * The state of an outgoing {@code Call} when waiting on user to select a
88 * {@link PhoneAccount} through which to place the call.
Nancy Chen5da0fd52014-07-08 14:16:17 -070089 */
Santos Cordone3c507b2015-04-23 14:44:19 -070090 public static final int STATE_SELECT_PHONE_ACCOUNT = 8;
91
92 /**
93 * @hide
94 * @deprecated use STATE_SELECT_PHONE_ACCOUNT.
95 */
96 @Deprecated
97 @SystemApi
98 public static final int STATE_PRE_DIAL_WAIT = STATE_SELECT_PHONE_ACCOUNT;
Nancy Chen5da0fd52014-07-08 14:16:17 -070099
Nancy Chene20930f2014-08-07 16:17:21 -0700100 /**
Nancy Chene9b7a8e2014-08-08 14:26:27 -0700101 * The initial state of an outgoing {@code Call}.
102 * Common transitions are to {@link #STATE_DIALING} state for a successful call or
103 * {@link #STATE_DISCONNECTED} if it failed.
Nancy Chene20930f2014-08-07 16:17:21 -0700104 */
105 public static final int STATE_CONNECTING = 9;
106
Nancy Chen513c8922014-09-17 14:47:20 -0700107 /**
Tyler Gunn4afc6af2014-10-07 10:14:55 -0700108 * The state of a {@code Call} when the user has initiated a disconnection of the call, but the
109 * call has not yet been disconnected by the underlying {@code ConnectionService}. The next
110 * state of the call is (potentially) {@link #STATE_DISCONNECTED}.
111 */
112 public static final int STATE_DISCONNECTING = 10;
113
114 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700115 * The state of an external call which is in the process of being pulled from a remote device to
116 * the local device.
117 * <p>
118 * A call can only be in this state if the {@link Details#PROPERTY_IS_EXTERNAL_CALL} property
119 * and {@link Details#CAPABILITY_CAN_PULL_CALL} capability are set on the call.
120 * <p>
121 * An {@link InCallService} will only see this state if it has the
122 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true} in its
123 * manifest.
124 */
125 public static final int STATE_PULLING_CALL = 11;
126
127 /**
Hall Liu6dfa2492019-10-01 17:20:39 -0700128 * The state of a call that is active with the network, but the audio from the call is
129 * being intercepted by an app on the local device. Telecom does not hold audio focus in this
130 * state, and the call will be invisible to the user except for a persistent notification.
131 */
132 public static final int STATE_AUDIO_PROCESSING = 12;
133
134 /**
135 * The state of a call that is being presented to the user after being in
136 * {@link #STATE_AUDIO_PROCESSING}. The call is still active with the network in this case, and
137 * Telecom will hold audio focus and play a ringtone if appropriate.
138 */
139 public static final int STATE_SIMULATED_RINGING = 13;
140
141 /**
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700142 * @hide
143 */
144 @IntDef(prefix = { "STATE_" },
145 value = {
146 STATE_NEW,
147 STATE_DIALING,
148 STATE_RINGING,
149 STATE_HOLDING,
150 STATE_ACTIVE,
151 STATE_DISCONNECTED,
152 STATE_SELECT_PHONE_ACCOUNT,
153 STATE_CONNECTING,
154 STATE_DISCONNECTING,
155 STATE_PULLING_CALL,
156 STATE_AUDIO_PROCESSING,
157 STATE_SIMULATED_RINGING
158 })
159 @Retention(RetentionPolicy.SOURCE)
160 public @interface CallState {};
161
162 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700163 * The key to retrieve the optional {@code PhoneAccount}s Telecom can bundle with its Call
164 * extras. Used to pass the phone accounts to display on the front end to the user in order to
165 * select phone accounts to (for example) place a call.
Hall Liu34d9e242018-11-21 17:05:58 -0800166 * @deprecated Use the list from {@link #EXTRA_SUGGESTED_PHONE_ACCOUNTS} instead.
Nancy Chen513c8922014-09-17 14:47:20 -0700167 */
Hall Liu34d9e242018-11-21 17:05:58 -0800168 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -0700169 public static final String AVAILABLE_PHONE_ACCOUNTS = "selectPhoneAccountAccounts";
170
mike dooley4af561f2016-12-20 08:55:17 -0800171 /**
Thomas Stuart5ca875eb2022-08-03 18:39:57 -0700172 * Extra key intended for {@link InCallService}s that notify the user of an incoming call. When
173 * EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB returns true, the {@link InCallService} should not
174 * interrupt the user of the incoming call because the call is being suppressed by Do Not
175 * Disturb settings.
176 *
177 * This extra will be removed from the {@link Call} object for {@link InCallService}s that do
178 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
179 */
180 public static final String EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB =
181 "android.telecom.extra.IS_SUPPRESSED_BY_DO_NOT_DISTURB";
182
183 /**
Hall Liu34d9e242018-11-21 17:05:58 -0800184 * Key for extra used to pass along a list of {@link PhoneAccountSuggestion}s to the in-call
185 * UI when a call enters the {@link #STATE_SELECT_PHONE_ACCOUNT} state. The list included here
186 * will have the same length and be in the same order as the list passed with
187 * {@link #AVAILABLE_PHONE_ACCOUNTS}.
188 */
189 public static final String EXTRA_SUGGESTED_PHONE_ACCOUNTS =
190 "android.telecom.extra.SUGGESTED_PHONE_ACCOUNTS";
191
192 /**
mike dooley91217422017-03-09 12:58:42 -0800193 * Extra key used to indicate the time (in milliseconds since midnight, January 1, 1970 UTC)
194 * when the last outgoing emergency call was made. This is used to identify potential emergency
195 * callbacks.
mike dooley4af561f2016-12-20 08:55:17 -0800196 */
197 public static final String EXTRA_LAST_EMERGENCY_CALLBACK_TIME_MILLIS =
198 "android.telecom.extra.LAST_EMERGENCY_CALLBACK_TIME_MILLIS";
199
Usman Abdullahb0dc29a2019-03-06 15:54:56 -0800200
201 /**
202 * Extra key used to indicate whether a {@link CallScreeningService} has requested to silence
203 * the ringtone for a call. If the {@link InCallService} declares
204 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in its manifest, it should not
205 * play a ringtone for an incoming call with this extra key set.
206 */
207 public static final String EXTRA_SILENT_RINGING_REQUESTED =
208 "android.telecom.extra.SILENT_RINGING_REQUESTED";
209
Tyler Gunn8bf76572017-04-06 15:30:08 -0700210 /**
211 * Call event sent from a {@link Call} via {@link #sendCallEvent(String, Bundle)} to inform
212 * Telecom that the user has requested that the current {@link Call} should be handed over
213 * to another {@link ConnectionService}.
214 * <p>
215 * The caller must specify the {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE} to indicate to
216 * Telecom which {@link PhoneAccountHandle} the {@link Call} should be handed over to.
217 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700218 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
219 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700220 */
221 public static final String EVENT_REQUEST_HANDOVER =
222 "android.telecom.event.REQUEST_HANDOVER";
223
224 /**
225 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
226 * {@link PhoneAccountHandle} to which a call should be handed over to.
227 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700228 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
229 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700230 */
231 public static final String EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE =
232 "android.telecom.extra.HANDOVER_PHONE_ACCOUNT_HANDLE";
233
234 /**
235 * Integer extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
236 * video state of the call when it is handed over to the new {@link PhoneAccount}.
237 * <p>
238 * Valid values: {@link VideoProfile#STATE_AUDIO_ONLY},
239 * {@link VideoProfile#STATE_BIDIRECTIONAL}, {@link VideoProfile#STATE_RX_ENABLED}, and
240 * {@link VideoProfile#STATE_TX_ENABLED}.
241 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700242 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
243 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700244 */
245 public static final String EXTRA_HANDOVER_VIDEO_STATE =
246 "android.telecom.extra.HANDOVER_VIDEO_STATE";
247
248 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700249 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Used by the
250 * {@link InCallService} initiating a handover to provide a {@link Bundle} with extra
251 * information to the handover {@link ConnectionService} specified by
252 * {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE}.
253 * <p>
254 * This {@link Bundle} is not interpreted by Telecom, but passed as-is to the
255 * {@link ConnectionService} via the request extras when
256 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
257 * is called to initate the handover.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700258 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700259 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
260 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700261 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700262 public static final String EXTRA_HANDOVER_EXTRAS = "android.telecom.extra.HANDOVER_EXTRAS";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700263
264 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700265 * Call event sent from Telecom to the handover {@link ConnectionService} via
266 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
267 * to the {@link ConnectionService} has completed successfully.
268 * <p>
269 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700270 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700271 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
272 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700273 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700274 public static final String EVENT_HANDOVER_COMPLETE =
275 "android.telecom.event.HANDOVER_COMPLETE";
Tyler Gunn34a2b312017-06-23 08:32:00 -0700276
277 /**
278 * Call event sent from Telecom to the handover destination {@link ConnectionService} via
279 * {@link Connection#onCallEvent(String, Bundle)} to inform the handover destination that the
280 * source connection has disconnected. The {@link Bundle} parameter for the call event will be
281 * {@code null}.
282 * <p>
283 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
284 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700285 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
286 * APIs instead.
Tyler Gunn34a2b312017-06-23 08:32:00 -0700287 */
288 public static final String EVENT_HANDOVER_SOURCE_DISCONNECTED =
289 "android.telecom.event.HANDOVER_SOURCE_DISCONNECTED";
290
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700291 /**
292 * Call event sent from Telecom to the handover {@link ConnectionService} via
293 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
294 * to the {@link ConnectionService} has failed.
295 * <p>
296 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
297 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700298 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
299 * APIs instead.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700300 */
301 public static final String EVENT_HANDOVER_FAILED =
302 "android.telecom.event.HANDOVER_FAILED";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700303
Tyler Gunnd5821842021-02-05 11:12:57 -0800304 /**
305 * Event reported from the Telecom stack to report an in-call diagnostic message which the
306 * dialer app may opt to display to the user. A diagnostic message is used to communicate
307 * scenarios the device has detected which may impact the quality of the ongoing call.
308 * <p>
309 * For example a problem with a bluetooth headset may generate a recommendation for the user to
310 * try using the speakerphone instead, or if the device detects it has entered a poor service
311 * area, the user might be warned so that they can finish their call prior to it dropping.
312 * <p>
313 * A diagnostic message is considered persistent in nature. When the user enters a poor service
314 * area, for example, the accompanying diagnostic message persists until they leave the area
315 * of poor service. Each message is accompanied with a {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID}
316 * which uniquely identifies the diagnostic condition being reported. The framework raises a
317 * call event of type {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE} when the condition reported has
318 * been cleared. The dialer app should display the diagnostic message until it is cleared.
319 * If multiple diagnostic messages are sent with different IDs (which have not yet been cleared)
320 * the dialer app should prioritize the most recently received message, but still provide the
321 * user with a means to review past messages.
322 * <p>
323 * The text of the message is found in {@link #EXTRA_DIAGNOSTIC_MESSAGE} in the form of a human
324 * readable {@link CharSequence} which is intended for display in the call UX.
325 * <p>
326 * The telecom framework audibly notifies the user of the presence of a diagnostic message, so
327 * the dialer app needs only to concern itself with visually displaying the message.
328 * <p>
329 * The dialer app receives this event via
330 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
331 */
332 public static final String EVENT_DISPLAY_DIAGNOSTIC_MESSAGE =
333 "android.telecom.event.DISPLAY_DIAGNOSTIC_MESSAGE";
334
335 /**
336 * Event reported from the telecom framework when a diagnostic message previously raised with
337 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE} has cleared and is no longer pertinent.
338 * <p>
339 * The {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID} indicates the diagnostic message which has been
340 * cleared.
341 * <p>
342 * The dialer app receives this event via
343 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
344 */
345 public static final String EVENT_CLEAR_DIAGNOSTIC_MESSAGE =
346 "android.telecom.event.CLEAR_DIAGNOSTIC_MESSAGE";
347
348 /**
349 * Integer extra representing a message ID for a message posted via
350 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. Used to ensure that the dialer app knows when
351 * the message in question has cleared via {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE}.
352 */
353 public static final String EXTRA_DIAGNOSTIC_MESSAGE_ID =
354 "android.telecom.extra.DIAGNOSTIC_MESSAGE_ID";
355
356 /**
357 * {@link CharSequence} extra used with {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. This is the
358 * diagnostic message the dialer app should display.
359 */
360 public static final String EXTRA_DIAGNOSTIC_MESSAGE =
361 "android.telecom.extra.DIAGNOSTIC_MESSAGE";
Tyler Gunnfacfdee2020-01-23 13:10:37 -0800362
363 /**
Thomas Nguyeneb427672023-02-15 15:42:34 -0800364 * Event reported from the Telecom stack to indicate that the {@link Connection} is not able to
365 * find any network and likely will not get connected. Upon receiving this event, the dialer
366 * app should show satellite SOS button if satellite is provisioned.
367 * <p>
368 * The dialer app receives this event via
369 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
370 * @hide
371 */
372 public static final String EVENT_DISPLAY_SOS_MESSAGE =
373 "android.telecom.event.DISPLAY_SOS_MESSAGE";
374
375 /**
Tyler Gunnfacfdee2020-01-23 13:10:37 -0800376 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
377 * call because they have declined to answer it. This typically means that they are unable
378 * to answer the call at this time and would prefer it be sent to voicemail.
379 */
380 public static final int REJECT_REASON_DECLINED = 1;
381
382 /**
383 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
384 * call because it is an unwanted call. This allows the user to indicate that they are
385 * rejecting a call because it is likely a nuisance call.
386 */
387 public static final int REJECT_REASON_UNWANTED = 2;
388
389 /**
390 * @hide
391 */
392 @IntDef(prefix = { "REJECT_REASON_" },
393 value = {REJECT_REASON_DECLINED, REJECT_REASON_UNWANTED})
394 @Retention(RetentionPolicy.SOURCE)
395 public @interface RejectReason {};
396
Ihab Awade63fadb2014-07-09 21:52:04 -0700397 public static class Details {
Tyler Gunn94f8f112018-12-17 09:56:11 -0800398 /** @hide */
399 @Retention(RetentionPolicy.SOURCE)
400 @IntDef(
401 prefix = { "DIRECTION_" },
402 value = {DIRECTION_UNKNOWN, DIRECTION_INCOMING, DIRECTION_OUTGOING})
403 public @interface CallDirection {}
404
405 /**
406 * Indicates that the call is neither and incoming nor an outgoing call. This can be the
407 * case for calls reported directly by a {@link ConnectionService} in special cases such as
408 * call handovers.
409 */
410 public static final int DIRECTION_UNKNOWN = -1;
411
412 /**
413 * Indicates that the call is an incoming call.
414 */
415 public static final int DIRECTION_INCOMING = 0;
416
417 /**
418 * Indicates that the call is an outgoing call.
419 */
420 public static final int DIRECTION_OUTGOING = 1;
421
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800422 /** Call can currently be put on hold or unheld. */
423 public static final int CAPABILITY_HOLD = 0x00000001;
424
425 /** Call supports the hold feature. */
426 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
427
428 /**
429 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
430 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
431 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
432 * capability allows a merge button to be shown while the conference call is in the foreground
433 * of the in-call UI.
434 * <p>
435 * This is only intended for use by a {@link Conference}.
436 */
437 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
438
439 /**
440 * Calls within a conference can be swapped between foreground and background.
441 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
442 * <p>
443 * This is only intended for use by a {@link Conference}.
444 */
445 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
446
447 /**
448 * @hide
449 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700450 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800451
452 /** Call supports responding via text option. */
453 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
454
455 /** Call can be muted. */
456 public static final int CAPABILITY_MUTE = 0x00000040;
457
458 /**
459 * Call supports conference call management. This capability only applies to {@link Conference}
460 * calls which can have {@link Connection}s as children.
461 */
462 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
463
464 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700465 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800466 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700467 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800468
469 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700470 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800471 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700472 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800473
474 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700475 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800476 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700477 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700478 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800479
480 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700481 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800482 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700483 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
484
485 /**
486 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700487 */
488 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
489
490 /**
491 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700492 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700493 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700494 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800495
496 /**
497 * Call is able to be separated from its parent {@code Conference}, if any.
498 */
499 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
500
501 /**
502 * Call is able to be individually disconnected when in a {@code Conference}.
503 */
504 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
505
506 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500507 * Speed up audio setup for MT call.
508 * @hide
509 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700510 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
511
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700512 /**
513 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700514 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800515 * @deprecated Use {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
516 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL} to indicate for a call
517 * whether or not video calling is supported.
Rekha Kumar07366812015-03-24 16:42:31 -0700518 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800519 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Rekha Kumar07366812015-03-24 16:42:31 -0700520 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
521
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700522 /**
523 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700524 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700525 */
526 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
527
Bryce Lee81901682015-08-28 16:38:02 -0700528 /**
529 * Call sends responses through connection.
530 * @hide
531 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800532 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
533
534 /**
535 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
536 * <p>
537 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
538 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
539 * downgraded from a video call back to a VideoState of
540 * {@link VideoProfile#STATE_AUDIO_ONLY}.
541 * <p>
542 * Intuitively, a call which can be downgraded to audio should also have local and remote
543 * video
544 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
545 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
546 */
547 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700548
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700549 /**
550 * When set for an external call, indicates that this {@code Call} can be pulled from a
551 * remote device to the current device.
552 * <p>
553 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
554 * <p>
555 * An {@link InCallService} will only see calls with this capability if it has the
556 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
557 * in its manifest.
558 * <p>
559 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700560 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700561 */
562 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
563
Pooja Jaind34698d2017-12-28 14:15:31 +0530564 /** Call supports the deflect feature. */
565 public static final int CAPABILITY_SUPPORT_DEFLECT = 0x01000000;
566
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800567 /**
568 * Call supports adding participants to the call via
Grace Jia8587ee52020-07-10 15:42:32 -0700569 * {@link #addConferenceParticipants(List)}. Once participants are added, the call becomes
570 * an adhoc conference call ({@link #PROPERTY_IS_ADHOC_CONFERENCE}).
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800571 */
Ravi Paluri404babb2020-01-23 19:02:44 +0530572 public static final int CAPABILITY_ADD_PARTICIPANT = 0x02000000;
Ravi Palurif4b38e72020-02-05 12:35:41 +0530573
574 /**
575 * When set for a call, indicates that this {@code Call} can be transferred to another
576 * number.
Tyler Gunn460360d2020-07-29 10:21:45 -0700577 * Call supports the confirmed and unconfirmed call transfer feature.
Ravi Palurif4b38e72020-02-05 12:35:41 +0530578 *
579 * @hide
580 */
581 public static final int CAPABILITY_TRANSFER = 0x04000000;
582
583 /**
584 * When set for a call, indicates that this {@code Call} can be transferred to another
585 * ongoing call.
586 * Call supports the consultative call transfer feature.
587 *
588 * @hide
589 */
590 public static final int CAPABILITY_TRANSFER_CONSULTATIVE = 0x08000000;
591
Alvin Dey2f37d772018-05-18 23:16:10 +0530592 /**
593 * Indicates whether the remote party supports RTT or not to the UI.
594 */
595
596 public static final int CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT = 0x10000000;
597
Tyler Gunnd11a3152015-03-18 13:09:14 -0700598 //******************************************************************************************
Alvin Dey2f37d772018-05-18 23:16:10 +0530599 // Next CAPABILITY value: 0x20000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700600 //******************************************************************************************
601
602 /**
603 * Whether the call is currently a conference.
604 */
605 public static final int PROPERTY_CONFERENCE = 0x00000001;
606
607 /**
608 * Whether the call is a generic conference, where we do not know the precise state of
609 * participants in the conference (eg. on CDMA).
610 */
611 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
612
613 /**
614 * Whether the call is made while the device is in emergency callback mode.
615 */
616 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
617
618 /**
619 * Connection is using WIFI.
620 */
621 public static final int PROPERTY_WIFI = 0x00000008;
622
623 /**
Tyler Gunn6b6ae552018-10-11 10:42:10 -0700624 * When set, the UI should indicate to the user that a call is using high definition
625 * audio.
626 * <p>
627 * The underlying {@link ConnectionService} is responsible for reporting this
628 * property. It is important to note that this property is not intended to report the
629 * actual audio codec being used for a Call, but whether the call should be indicated
630 * to the user as high definition.
631 * <p>
632 * The Android Telephony stack reports this property for calls based on a number
633 * of factors, including which audio codec is used and whether a call is using an HD
634 * codec end-to-end. Some mobile operators choose to suppress display of an HD indication,
635 * and in these cases this property will not be set for a call even if the underlying audio
636 * codec is in fact "high definition".
Andrew Lee2378ea72015-04-29 14:38:11 -0700637 */
638 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
639
Tony Maka68dcce2015-12-17 09:31:18 +0000640 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100641 * Whether the call is associated with the work profile.
642 */
643 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
644
645 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700646 * When set, indicates that this {@code Call} does not actually exist locally for the
647 * {@link ConnectionService}.
648 * <p>
649 * Consider, for example, a scenario where a user has two phones with the same phone number.
650 * When a user places a call on one device, the telephony stack can represent that call on
651 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700652 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700653 * <p>
654 * An {@link InCallService} will only see calls with this property if it has the
655 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
656 * in its manifest.
657 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700658 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700659 */
660 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
661
Brad Ebinger15847072016-05-18 11:08:36 -0700662 /**
663 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
664 */
665 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
666
Tyler Gunn24e18332017-02-10 09:42:49 -0800667 /**
668 * Indicates that the call is from a self-managed {@link ConnectionService}.
669 * <p>
670 * See also {@link Connection#PROPERTY_SELF_MANAGED}
671 */
672 public static final int PROPERTY_SELF_MANAGED = 0x00000100;
673
Eric Erfanianec881872017-12-06 16:27:53 -0800674 /**
675 * Indicates the call used Assisted Dialing.
Tyler Gunn5567d742019-10-31 13:04:37 -0700676 *
677 * @see TelecomManager#EXTRA_USE_ASSISTED_DIALING
Eric Erfanianec881872017-12-06 16:27:53 -0800678 */
Tyler Gunnc9503d62020-01-27 10:30:51 -0800679 public static final int PROPERTY_ASSISTED_DIALING = 0x00000200;
Eric Erfanianec881872017-12-06 16:27:53 -0800680
Hall Liue9041242018-02-09 16:40:03 -0800681 /**
682 * Indicates that the call is an RTT call. Use {@link #getRttCall()} to get the
683 * {@link RttCall} object that is used to send and receive text.
684 */
685 public static final int PROPERTY_RTT = 0x00000400;
686
Tyler Gunn5bd90852018-09-21 09:37:07 -0700687 /**
688 * Indicates that the call has been identified as the network as an emergency call. This
689 * property may be set for both incoming and outgoing calls which the network identifies as
690 * emergency calls.
691 */
692 public static final int PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL = 0x00000800;
693
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700694 /**
695 * Indicates that the call is using VoIP audio mode.
696 * <p>
697 * When this property is set, the {@link android.media.AudioManager} audio mode for this
698 * call will be {@link android.media.AudioManager#MODE_IN_COMMUNICATION}. When this
699 * property is not set, the audio mode for this call will be
700 * {@link android.media.AudioManager#MODE_IN_CALL}.
701 * <p>
702 * This property reflects changes made using {@link Connection#setAudioModeIsVoip(boolean)}.
703 * <p>
704 * You can use this property to determine whether an un-answered incoming call or a held
705 * call will use VoIP audio mode (if the call does not currently have focus, the system
706 * audio mode may not reflect the mode the call will use).
707 */
708 public static final int PROPERTY_VOIP_AUDIO_MODE = 0x00001000;
709
Ravi Paluri80aa2142019-12-02 11:57:37 +0530710 /**
711 * Indicates that the call is an adhoc conference call. This property can be set for both
Grace Jia8587ee52020-07-10 15:42:32 -0700712 * incoming and outgoing calls. An adhoc conference call is formed using
713 * {@link #addConferenceParticipants(List)},
714 * {@link TelecomManager#addNewIncomingConference(PhoneAccountHandle, Bundle)}, or
715 * {@link TelecomManager#startConference(List, Bundle)}, rather than by merging existing
716 * call using {@link #conference(Call)}.
Ravi Paluri80aa2142019-12-02 11:57:37 +0530717 */
718 public static final int PROPERTY_IS_ADHOC_CONFERENCE = 0x00002000;
719
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800720 /**
Sooraj Sasindranfa1e57a2021-03-22 13:44:14 -0700721 * Connection is using cross sim technology.
722 * <p>
723 * Indicates that the {@link Connection} is using a cross sim technology which would
724 * register IMS over internet APN of default data subscription.
725 * <p>
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800726 */
727 public static final int PROPERTY_CROSS_SIM = 0x00004000;
728
Andrew Lee2378ea72015-04-29 14:38:11 -0700729 //******************************************************************************************
Ravi Paluri80aa2142019-12-02 11:57:37 +0530730 // Next PROPERTY value: 0x00004000
Tyler Gunnd11a3152015-03-18 13:09:14 -0700731 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800732
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700733 private final @CallState int mState;
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800734 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700735 private final Uri mHandle;
736 private final int mHandlePresentation;
737 private final String mCallerDisplayName;
738 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700739 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700740 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700741 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800742 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700743 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700744 private final long mConnectTimeMillis;
745 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700746 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700747 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700748 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700749 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700750 private final long mCreationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -0800751 private final String mContactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -0800752 private final @CallDirection int mCallDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -0700753 private final @Connection.VerificationStatus int mCallerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -0700754 private final Uri mContactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -0700755
756 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800757 * Whether the supplied capabilities supports the specified capability.
758 *
759 * @param capabilities A bit field of capabilities.
760 * @param capability The capability to check capabilities for.
761 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800762 */
763 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800764 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800765 }
766
767 /**
768 * Whether the capabilities of this {@code Details} supports the specified capability.
769 *
770 * @param capability The capability to check capabilities for.
771 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800772 */
773 public boolean can(int capability) {
774 return can(mCallCapabilities, capability);
775 }
776
777 /**
778 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
779 *
780 * @param capabilities A capability bit field.
781 * @return A human readable string representation.
782 */
783 public static String capabilitiesToString(int capabilities) {
784 StringBuilder builder = new StringBuilder();
785 builder.append("[Capabilities:");
786 if (can(capabilities, CAPABILITY_HOLD)) {
787 builder.append(" CAPABILITY_HOLD");
788 }
789 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
790 builder.append(" CAPABILITY_SUPPORT_HOLD");
791 }
792 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
793 builder.append(" CAPABILITY_MERGE_CONFERENCE");
794 }
795 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
796 builder.append(" CAPABILITY_SWAP_CONFERENCE");
797 }
798 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
799 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
800 }
801 if (can(capabilities, CAPABILITY_MUTE)) {
802 builder.append(" CAPABILITY_MUTE");
803 }
804 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
805 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
806 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700807 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
808 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
809 }
810 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
811 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
812 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700813 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
814 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800815 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700816 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
817 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
818 }
819 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
820 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
821 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800822 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
823 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
824 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700825 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
826 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800827 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500828 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700829 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500830 }
Rekha Kumar07366812015-03-24 16:42:31 -0700831 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
832 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
833 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700834 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
835 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
836 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700837 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
838 builder.append(" CAPABILITY_CAN_PULL_CALL");
839 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530840 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
841 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
842 }
Ravi Paluri404babb2020-01-23 19:02:44 +0530843 if (can(capabilities, CAPABILITY_ADD_PARTICIPANT)) {
844 builder.append(" CAPABILITY_ADD_PARTICIPANT");
845 }
Ravi Palurif4b38e72020-02-05 12:35:41 +0530846 if (can(capabilities, CAPABILITY_TRANSFER)) {
847 builder.append(" CAPABILITY_TRANSFER");
848 }
849 if (can(capabilities, CAPABILITY_TRANSFER_CONSULTATIVE)) {
850 builder.append(" CAPABILITY_TRANSFER_CONSULTATIVE");
851 }
Alvin Dey2f37d772018-05-18 23:16:10 +0530852 if (can(capabilities, CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT)) {
853 builder.append(" CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT");
854 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800855 builder.append("]");
856 return builder.toString();
857 }
858
859 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700860 * Whether the supplied properties includes the specified property.
861 *
862 * @param properties A bit field of properties.
863 * @param property The property to check properties for.
864 * @return Whether the specified property is supported.
865 */
866 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800867 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700868 }
869
870 /**
871 * Whether the properties of this {@code Details} includes the specified property.
872 *
873 * @param property The property to check properties for.
874 * @return Whether the specified property is supported.
875 */
876 public boolean hasProperty(int property) {
877 return hasProperty(mCallProperties, property);
878 }
879
880 /**
881 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
882 *
883 * @param properties A property bit field.
884 * @return A human readable string representation.
885 */
886 public static String propertiesToString(int properties) {
887 StringBuilder builder = new StringBuilder();
888 builder.append("[Properties:");
889 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
890 builder.append(" PROPERTY_CONFERENCE");
891 }
892 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
893 builder.append(" PROPERTY_GENERIC_CONFERENCE");
894 }
895 if (hasProperty(properties, PROPERTY_WIFI)) {
896 builder.append(" PROPERTY_WIFI");
897 }
898 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
899 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
900 }
901 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700902 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700903 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700904 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
905 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
906 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700907 if (hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
Brad Ebinger15847072016-05-18 11:08:36 -0700908 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
909 }
Tyler Gunnc9503d62020-01-27 10:30:51 -0800910 if (hasProperty(properties, PROPERTY_ASSISTED_DIALING)) {
Eric Erfanianec881872017-12-06 16:27:53 -0800911 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
912 }
Tyler Gunn5bd90852018-09-21 09:37:07 -0700913 if (hasProperty(properties, PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL)) {
914 builder.append(" PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL");
915 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700916 if (hasProperty(properties, PROPERTY_RTT)) {
917 builder.append(" PROPERTY_RTT");
918 }
919 if (hasProperty(properties, PROPERTY_VOIP_AUDIO_MODE)) {
920 builder.append(" PROPERTY_VOIP_AUDIO_MODE");
921 }
Ravi Paluri80aa2142019-12-02 11:57:37 +0530922 if (hasProperty(properties, PROPERTY_IS_ADHOC_CONFERENCE)) {
923 builder.append(" PROPERTY_IS_ADHOC_CONFERENCE");
924 }
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800925 if (hasProperty(properties, PROPERTY_CROSS_SIM)) {
926 builder.append(" PROPERTY_CROSS_SIM");
927 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700928 builder.append("]");
929 return builder.toString();
930 }
931
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700932 /**
933 * @return the state of the {@link Call} represented by this {@link Call.Details}.
934 */
935 public final @CallState int getState() {
936 return mState;
937 }
938
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800939 /** {@hide} */
Hall Liu31de23d2019-10-11 15:38:29 -0700940 @TestApi
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800941 public String getTelecomCallId() {
942 return mTelecomCallId;
943 }
944
Andrew Lee2378ea72015-04-29 14:38:11 -0700945 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700946 * @return The handle (e.g., phone number) to which the {@code Call} is currently
947 * connected.
948 */
949 public Uri getHandle() {
950 return mHandle;
951 }
952
953 /**
954 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700955 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700956 */
957 public int getHandlePresentation() {
958 return mHandlePresentation;
959 }
960
961 /**
Edgar Arriagae5bec822022-10-14 14:25:43 -0700962 * @return The contact photo URI which corresponds to
963 * {@link android.provider.ContactsContract.PhoneLookup#PHOTO_URI}, or {@code null} if the
964 * lookup is not yet complete, if there's no contacts entry for the caller,
965 * or if the {@link InCallService} does not hold the
966 * {@link android.Manifest.permission#READ_CONTACTS} permission.
967 */
968 public @Nullable Uri getContactPhotoUri() {
969 return mContactPhotoUri;
970 }
971
972 /**
Tyler Gunnd081f042018-12-04 12:56:45 -0800973 * The display name for the caller.
974 * <p>
975 * This is the name as reported by the {@link ConnectionService} associated with this call.
Tyler Gunnd081f042018-12-04 12:56:45 -0800976 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700977 * @return The display name for the caller.
978 */
979 public String getCallerDisplayName() {
980 return mCallerDisplayName;
981 }
982
983 /**
984 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700985 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700986 */
987 public int getCallerDisplayNamePresentation() {
988 return mCallerDisplayNamePresentation;
989 }
990
991 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700992 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
993 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700994 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700995 public PhoneAccountHandle getAccountHandle() {
996 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -0700997 }
998
999 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001000 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
1001 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -07001002 */
Ihab Awad5d0410f2014-07-30 10:07:40 -07001003 public int getCallCapabilities() {
1004 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -07001005 }
1006
1007 /**
Andrew Lee2378ea72015-04-29 14:38:11 -07001008 * @return A bitmask of the properties of the {@code Call}, as defined by the various
1009 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -07001010 */
1011 public int getCallProperties() {
1012 return mCallProperties;
1013 }
1014
1015 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -08001016 * @return a bitmask of the audio routes available for the call.
1017 *
1018 * @hide
1019 */
1020 public int getSupportedAudioRoutes() {
1021 return mSupportedAudioRoutes;
1022 }
1023
1024 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001025 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -07001026 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001027 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001028 public DisconnectCause getDisconnectCause() {
1029 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001030 }
1031
1032 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001033 * Returns the time the {@link Call} connected (i.e. became active). This information is
1034 * updated periodically, but user interfaces should not rely on this to display the "call
1035 * time clock". For the time when the call was first added to Telecom, see
1036 * {@link #getCreationTimeMillis()}.
1037 *
1038 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -07001039 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -07001040 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -07001041 return mConnectTimeMillis;
1042 }
1043
1044 /**
1045 * @return Information about any calling gateway the {@code Call} may be using.
1046 */
1047 public GatewayInfo getGatewayInfo() {
1048 return mGatewayInfo;
1049 }
1050
Andrew Lee7a341382014-07-15 17:05:08 -07001051 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -07001052 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -07001053 */
1054 public int getVideoState() {
1055 return mVideoState;
1056 }
1057
Ihab Awad5d0410f2014-07-30 10:07:40 -07001058 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001059 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -07001060 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -07001061 */
1062 public StatusHints getStatusHints() {
1063 return mStatusHints;
1064 }
1065
Nancy Chen10798dc2014-08-08 14:00:25 -07001066 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -07001067 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -07001068 */
1069 public Bundle getExtras() {
1070 return mExtras;
1071 }
1072
Santos Cordon6b7f9552015-05-27 17:21:45 -07001073 /**
1074 * @return The extras used with the original intent to place this call.
1075 */
1076 public Bundle getIntentExtras() {
1077 return mIntentExtras;
1078 }
1079
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001080 /**
1081 * Returns the time when the call was first created and added to Telecom. This is the same
1082 * time that is logged as the start time in the Call Log (see
1083 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
1084 * (became active), see {@link #getConnectTimeMillis()}.
1085 *
1086 * @return The creation time of the call, in millis since the epoch.
1087 */
1088 public long getCreationTimeMillis() {
1089 return mCreationTimeMillis;
1090 }
1091
Tyler Gunnd081f042018-12-04 12:56:45 -08001092 /**
Hall Liuef98bf82020-01-09 15:22:44 -08001093 * Returns the name of the caller on the remote end, as derived from a
1094 * {@link android.provider.ContactsContract} lookup of the call's handle.
1095 * @return The name of the caller, or {@code null} if the lookup is not yet complete, if
1096 * there's no contacts entry for the caller, or if the {@link InCallService} does
1097 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
1098 */
1099 public @Nullable String getContactDisplayName() {
1100 return mContactDisplayName;
1101 }
1102
1103 /**
Tyler Gunn94f8f112018-12-17 09:56:11 -08001104 * Indicates whether the call is an incoming or outgoing call.
1105 * @return The call's direction.
1106 */
1107 public @CallDirection int getCallDirection() {
1108 return mCallDirection;
1109 }
1110
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001111 /**
1112 * Gets the verification status for the phone number of an incoming call as identified in
1113 * ATIS-1000082.
Tyler Gunn9c642492020-10-08 13:37:03 -07001114 * <p>
1115 * For incoming calls, the number verification status indicates whether the device was
1116 * able to verify the authenticity of the calling number using the STIR process outlined
1117 * in ATIS-1000082. {@link Connection#VERIFICATION_STATUS_NOT_VERIFIED} indicates that
1118 * the network was not able to use STIR to verify the caller's number (i.e. nothing is
1119 * known regarding the authenticity of the number.
1120 * {@link Connection#VERIFICATION_STATUS_PASSED} indicates that the network was able to
1121 * use STIR to verify the caller's number. This indicates that the network has a high
1122 * degree of confidence that the incoming call actually originated from the indicated
1123 * number. {@link Connection#VERIFICATION_STATUS_FAILED} indicates that the network's
1124 * STIR verification did not pass. This indicates that the incoming call may not
1125 * actually be from the indicated number. This could occur if, for example, the caller
1126 * is using an impersonated phone number.
1127 * <p>
1128 * A {@link CallScreeningService} can use this information to help determine if an
1129 * incoming call is potentially an unwanted call. A verification status of
1130 * {@link Connection#VERIFICATION_STATUS_FAILED} indicates that an incoming call may not
1131 * actually be from the number indicated on the call (i.e. impersonated number) and that it
1132 * should potentially be blocked. Likewise,
1133 * {@link Connection#VERIFICATION_STATUS_PASSED} can be used as a positive signal to
1134 * help clarify that the incoming call is originating from the indicated number and it
1135 * is less likely to be an undesirable call.
1136 * <p>
1137 * An {@link InCallService} can use this information to provide a visual indicator to the
1138 * user regarding the verification status of a call and to help identify calls from
1139 * potentially impersonated numbers.
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001140 * @return the verification status.
1141 */
1142 public @Connection.VerificationStatus int getCallerNumberVerificationStatus() {
1143 return mCallerNumberVerificationStatus;
1144 }
1145
Ihab Awade63fadb2014-07-09 21:52:04 -07001146 @Override
1147 public boolean equals(Object o) {
1148 if (o instanceof Details) {
1149 Details d = (Details) o;
1150 return
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001151 Objects.equals(mState, d.mState) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001152 Objects.equals(mHandle, d.mHandle) &&
1153 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
1154 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
1155 Objects.equals(mCallerDisplayNamePresentation,
1156 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -07001157 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -07001158 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -07001159 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001160 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001161 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -07001162 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -07001163 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -07001164 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001165 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001166 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
Tyler Gunnd081f042018-12-04 12:56:45 -08001167 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis) &&
Hall Liuef98bf82020-01-09 15:22:44 -08001168 Objects.equals(mContactDisplayName, d.mContactDisplayName) &&
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001169 Objects.equals(mCallDirection, d.mCallDirection) &&
1170 Objects.equals(mCallerNumberVerificationStatus,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001171 d.mCallerNumberVerificationStatus) &&
1172 Objects.equals(mContactPhotoUri, d.mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001173 }
1174 return false;
1175 }
1176
1177 @Override
1178 public int hashCode() {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001179 return Objects.hash(mState,
1180 mHandle,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001181 mHandlePresentation,
1182 mCallerDisplayName,
1183 mCallerDisplayNamePresentation,
1184 mAccountHandle,
1185 mCallCapabilities,
1186 mCallProperties,
1187 mDisconnectCause,
1188 mConnectTimeMillis,
1189 mGatewayInfo,
1190 mVideoState,
1191 mStatusHints,
1192 mExtras,
1193 mIntentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001194 mCreationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001195 mContactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001196 mCallDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001197 mCallerNumberVerificationStatus,
1198 mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001199 }
1200
1201 /** {@hide} */
1202 public Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001203 @CallState int state,
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001204 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -07001205 Uri handle,
1206 int handlePresentation,
1207 String callerDisplayName,
1208 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -07001209 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -07001210 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -07001211 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001212 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -07001213 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -07001214 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -07001215 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -07001216 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -07001217 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001218 Bundle intentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001219 long creationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001220 String contactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001221 int callDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001222 int callerNumberVerificationStatus,
1223 Uri contactPhotoUri) {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001224 mState = state;
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001225 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001226 mHandle = handle;
1227 mHandlePresentation = handlePresentation;
1228 mCallerDisplayName = callerDisplayName;
1229 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -07001230 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -07001231 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -07001232 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001233 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001234 mConnectTimeMillis = connectTimeMillis;
1235 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -07001236 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -07001237 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -07001238 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -07001239 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001240 mCreationTimeMillis = creationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -08001241 mContactDisplayName = contactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -08001242 mCallDirection = callDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001243 mCallerNumberVerificationStatus = callerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -07001244 mContactPhotoUri = contactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -07001245 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001246
1247 /** {@hide} */
1248 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
1249 return new Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001250 parcelableCall.getState(),
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001251 parcelableCall.getId(),
1252 parcelableCall.getHandle(),
1253 parcelableCall.getHandlePresentation(),
1254 parcelableCall.getCallerDisplayName(),
1255 parcelableCall.getCallerDisplayNamePresentation(),
1256 parcelableCall.getAccountHandle(),
1257 parcelableCall.getCapabilities(),
1258 parcelableCall.getProperties(),
1259 parcelableCall.getDisconnectCause(),
1260 parcelableCall.getConnectTimeMillis(),
1261 parcelableCall.getGatewayInfo(),
1262 parcelableCall.getVideoState(),
1263 parcelableCall.getStatusHints(),
1264 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001265 parcelableCall.getIntentExtras(),
Tyler Gunnd081f042018-12-04 12:56:45 -08001266 parcelableCall.getCreationTimeMillis(),
Hall Liuef98bf82020-01-09 15:22:44 -08001267 parcelableCall.getContactDisplayName(),
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001268 parcelableCall.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07001269 parcelableCall.getCallerNumberVerificationStatus(),
1270 parcelableCall.getContactPhotoUri()
1271 );
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001272 }
Santos Cordon3c20d632016-02-25 16:12:35 -08001273
1274 @Override
1275 public String toString() {
1276 StringBuilder sb = new StringBuilder();
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001277 sb.append("[id: ");
1278 sb.append(mTelecomCallId);
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001279 sb.append(", state: ");
1280 sb.append(Call.stateToString(mState));
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001281 sb.append(", pa: ");
Santos Cordon3c20d632016-02-25 16:12:35 -08001282 sb.append(mAccountHandle);
1283 sb.append(", hdl: ");
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001284 sb.append(Log.piiHandle(mHandle));
1285 sb.append(", hdlPres: ");
1286 sb.append(mHandlePresentation);
1287 sb.append(", videoState: ");
1288 sb.append(VideoProfile.videoStateToString(mVideoState));
Santos Cordon3c20d632016-02-25 16:12:35 -08001289 sb.append(", caps: ");
1290 sb.append(capabilitiesToString(mCallCapabilities));
1291 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -07001292 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -08001293 sb.append("]");
1294 return sb.toString();
1295 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001296 }
1297
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001298 /**
1299 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
1300 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
1301 * implementation.
1302 * <p>
1303 * You can handle these callbacks by extending the {@link Callback} class and overriding the
1304 * callbacks that your {@link InCallService} is interested in. The callback methods include the
1305 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
1306 * {@link Callback} implementation, if desired.
1307 * <p>
1308 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
1309 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
1310 * (typically in {@link InCallService#onCallRemoved(Call)}).
1311 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
1312 * reach your implementation of {@link Callback}, so it is important to register your callback
1313 * as soon as your {@link InCallService} is notified of a new call via
1314 * {@link InCallService#onCallAdded(Call)}.
1315 */
Andrew Leeda80c872015-04-15 14:09:50 -07001316 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -07001317 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001318 * @hide
1319 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001320 @IntDef(prefix = { "HANDOVER_" },
1321 value = {HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_NOT_SUPPORTED,
Tyler Gunn5c60d712018-03-16 09:53:44 -07001322 HANDOVER_FAILURE_USER_REJECTED, HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL,
Tyler Gunn9d127732018-03-02 15:45:51 -08001323 HANDOVER_FAILURE_UNKNOWN})
Sanket Padawea8eddd42017-11-03 11:07:35 -07001324 @Retention(RetentionPolicy.SOURCE)
1325 public @interface HandoverFailureErrors {}
1326
1327 /**
1328 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
Tyler Gunn9d127732018-03-02 15:45:51 -08001329 * to handover the call to rejects the handover request.
1330 * <p>
1331 * Will be returned when {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} is called
1332 * and the destination {@link PhoneAccountHandle}'s {@link ConnectionService} returns a
1333 * {@code null} {@link Connection} from
1334 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
1335 * ConnectionRequest)}.
1336 * <p>
1337 * For more information on call handovers, see
1338 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001339 */
1340 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
1341
1342 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001343 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1344 * is initiated but the source or destination app does not support handover.
1345 * <p>
1346 * Will be returned when a handover is requested via
1347 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)} and the destination
1348 * {@link PhoneAccountHandle} does not declare
1349 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}. May also be returned when a handover is
1350 * requested at the {@link PhoneAccountHandle} for the current call (i.e. the source call's
1351 * {@link Details#getAccountHandle()}) does not declare
1352 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}.
1353 * <p>
1354 * For more information on call handovers, see
1355 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001356 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001357 public static final int HANDOVER_FAILURE_NOT_SUPPORTED = 2;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001358
1359 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001360 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the remote
1361 * user rejects the handover request.
1362 * <p>
1363 * For more information on call handovers, see
1364 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001365 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001366 public static final int HANDOVER_FAILURE_USER_REJECTED = 3;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001367
Sanket Padawe85291f62017-12-01 13:59:27 -08001368 /**
1369 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
1370 * is ongoing emergency call.
Tyler Gunn9d127732018-03-02 15:45:51 -08001371 * <p>
1372 * This error code is returned when {@link #handoverTo(PhoneAccountHandle, int, Bundle)} is
1373 * called on an emergency call, or if any other call is an emergency call.
1374 * <p>
1375 * Handovers are not permitted while there are ongoing emergency calls.
1376 * <p>
1377 * For more information on call handovers, see
1378 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawe85291f62017-12-01 13:59:27 -08001379 */
Tyler Gunn5c60d712018-03-16 09:53:44 -07001380 public static final int HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL = 4;
Sanket Padawe85291f62017-12-01 13:59:27 -08001381
Tyler Gunn9d127732018-03-02 15:45:51 -08001382 /**
1383 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1384 * fails for an unknown reason.
1385 * <p>
1386 * For more information on call handovers, see
1387 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
1388 */
1389 public static final int HANDOVER_FAILURE_UNKNOWN = 5;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001390
1391 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001392 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
1393 *
Ihab Awade63fadb2014-07-09 21:52:04 -07001394 * @param call The {@code Call} invoking this method.
1395 * @param state The new state of the {@code Call}.
1396 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001397 public void onStateChanged(Call call, @CallState int state) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001398
1399 /**
1400 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
1401 *
1402 * @param call The {@code Call} invoking this method.
1403 * @param parent The new parent of the {@code Call}.
1404 */
1405 public void onParentChanged(Call call, Call parent) {}
1406
1407 /**
1408 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
1409 *
1410 * @param call The {@code Call} invoking this method.
1411 * @param children The new children of the {@code Call}.
1412 */
1413 public void onChildrenChanged(Call call, List<Call> children) {}
1414
1415 /**
1416 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
1417 *
1418 * @param call The {@code Call} invoking this method.
1419 * @param details A {@code Details} object describing the {@code Call}.
1420 */
1421 public void onDetailsChanged(Call call, Details details) {}
1422
1423 /**
1424 * Invoked when the text messages that can be used as responses to the incoming
1425 * {@code Call} are loaded from the relevant database.
1426 * See {@link #getCannedTextResponses()}.
1427 *
1428 * @param call The {@code Call} invoking this method.
1429 * @param cannedTextResponses The text messages useable as responses.
1430 */
1431 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
1432
1433 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001434 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
1435 * character. This causes the post-dial signals to stop pending user confirmation. An
1436 * implementation should present this choice to the user and invoke
1437 * {@link #postDialContinue(boolean)} when the user makes the choice.
1438 *
1439 * @param call The {@code Call} invoking this method.
1440 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
1441 */
1442 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
1443
1444 /**
Andrew Lee50aca232014-07-22 16:41:54 -07001445 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -07001446 *
1447 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -07001448 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001449 */
Andrew Lee50aca232014-07-22 16:41:54 -07001450 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001451
1452 /**
1453 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
1454 * up their UI for the {@code Call} in response to state transitions. Specifically,
1455 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
1456 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
1457 * clients should wait for this method to be invoked.
1458 *
1459 * @param call The {@code Call} being destroyed.
1460 */
1461 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001462
1463 /**
1464 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
1465 * conferenced.
1466 *
1467 * @param call The {@code Call} being updated.
1468 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
1469 * conferenced.
1470 */
1471 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001472
1473 /**
Tyler Gunn5567d742019-10-31 13:04:37 -07001474 * Invoked when a {@link Call} receives an event from its associated {@link Connection} or
1475 * {@link Conference}.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001476 * <p>
1477 * Where possible, the Call should make an attempt to handle {@link Connection} events which
1478 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1479 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1480 * possible that a {@link ConnectionService} has defined its own Connection events which a
1481 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001482 * <p>
Tyler Gunn5567d742019-10-31 13:04:37 -07001483 * See {@link Connection#sendConnectionEvent(String, Bundle)},
1484 * {@link Conference#sendConferenceEvent(String, Bundle)}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001485 *
1486 * @param call The {@code Call} receiving the event.
1487 * @param event The event.
1488 * @param extras Extras associated with the connection event.
1489 */
1490 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001491
1492 /**
1493 * Invoked when the RTT mode changes for this call.
1494 * @param call The call whose RTT mode has changed.
1495 * @param mode the new RTT mode, one of
1496 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1497 * or {@link RttCall#RTT_MODE_VCO}
1498 */
1499 public void onRttModeChanged(Call call, int mode) {}
1500
1501 /**
1502 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1503 * @param call The call whose RTT status has changed.
1504 * @param enabled whether RTT is now enabled or disabled
1505 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1506 * on, null otherwise.
1507 */
1508 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1509
1510 /**
1511 * Invoked when the remote end of the connection has requested that an RTT communication
1512 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1513 * with the same ID that this method is invoked with.
1514 * @param call The call which the RTT request was placed on
1515 * @param id The ID of the request.
1516 */
1517 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001518
1519 /**
1520 * Invoked when the RTT session failed to initiate for some reason, including rejection
1521 * by the remote party.
Tyler Gunnb9a04962022-02-17 08:23:54 -08001522 * <p>
1523 * This callback will ONLY be invoked to report a failure related to a user initiated
1524 * session modification request (i.e. {@link Call#sendRttRequest()}).
1525 * <p>
1526 * If a call is initiated with {@link TelecomManager#EXTRA_START_CALL_WITH_RTT} specified,
1527 * the availability of RTT can be determined by checking {@link Details#PROPERTY_RTT}
1528 * once the call enters state {@link Details#STATE_ACTIVE}.
1529 *
Hall Liu57006aa2017-02-06 10:49:48 -08001530 * @param call The call which the RTT initiation failure occurred on.
1531 * @param reason One of the status codes defined in
Tyler Gunnb9a04962022-02-17 08:23:54 -08001532 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1533 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
Hall Liu57006aa2017-02-06 10:49:48 -08001534 */
Tyler Gunnb9a04962022-02-17 08:23:54 -08001535 public void onRttInitiationFailure(Call call,
1536 @android.telecom.Connection.RttModifyStatus.RttSessionModifyStatus int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001537
1538 /**
1539 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1540 * has completed successfully.
Tyler Gunn9d127732018-03-02 15:45:51 -08001541 * <p>
1542 * For a full discussion of the handover process and the APIs involved, see
1543 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1544 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001545 * @param call The call which had initiated handover.
1546 */
1547 public void onHandoverComplete(Call call) {}
1548
1549 /**
1550 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1551 * has failed.
Tyler Gunn9d127732018-03-02 15:45:51 -08001552 * <p>
1553 * For a full discussion of the handover process and the APIs involved, see
1554 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1555 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001556 * @param call The call which had initiated handover.
Tyler Gunn9d127732018-03-02 15:45:51 -08001557 * @param failureReason Error reason for failure.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001558 */
1559 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001560 }
1561
1562 /**
1563 * A class that holds the state that describes the state of the RTT channel to the remote
1564 * party, if it is active.
1565 */
1566 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001567 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001568 @Retention(RetentionPolicy.SOURCE)
1569 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1570 public @interface RttAudioMode {}
1571
1572 /**
1573 * For metrics use. Default value in the proto.
1574 * @hide
1575 */
1576 public static final int RTT_MODE_INVALID = 0;
1577
1578 /**
1579 * Indicates that there should be a bidirectional audio stream between the two parties
1580 * on the call.
1581 */
1582 public static final int RTT_MODE_FULL = 1;
1583
1584 /**
1585 * Indicates that the local user should be able to hear the audio stream from the remote
1586 * user, but not vice versa. Equivalent to muting the microphone.
1587 */
1588 public static final int RTT_MODE_HCO = 2;
1589
1590 /**
1591 * Indicates that the remote user should be able to hear the audio stream from the local
1592 * user, but not vice versa. Equivalent to setting the volume to zero.
1593 */
1594 public static final int RTT_MODE_VCO = 3;
1595
1596 private static final int READ_BUFFER_SIZE = 1000;
1597
1598 private InputStreamReader mReceiveStream;
1599 private OutputStreamWriter mTransmitStream;
1600 private int mRttMode;
1601 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001602 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001603 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1604
1605 /**
1606 * @hide
1607 */
Hall Liu57006aa2017-02-06 10:49:48 -08001608 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1609 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1610 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001611 mReceiveStream = receiveStream;
1612 mTransmitStream = transmitStream;
1613 mRttMode = mode;
1614 mInCallAdapter = inCallAdapter;
1615 }
1616
1617 /**
1618 * Returns the current RTT audio mode.
1619 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1620 * {@link #RTT_MODE_HCO}.
1621 */
1622 public int getRttAudioMode() {
1623 return mRttMode;
1624 }
1625
1626 /**
1627 * Sets the RTT audio mode. The requested mode change will be communicated through
1628 * {@link Callback#onRttModeChanged(Call, int)}.
1629 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1630 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1631 */
1632 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001633 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001634 }
1635
1636 /**
1637 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
Hall Liudc46c852020-10-29 16:15:33 -07001638 * RTT transmits text in real-time, this method should be called once for each user action.
1639 * For example, when the user enters text as discrete characters using the keyboard, this
1640 * method should be called once for each character. However, if the user enters text by
1641 * pasting or autocomplete, the entire contents of the pasted or autocompleted text should
1642 * be sent in one call to this method.
Hall Liu95d55872017-01-25 17:12:49 -08001643 *
1644 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1645 * lead to interleaved text.
1646 * @param input The message to send to the remote user.
1647 */
1648 public void write(String input) throws IOException {
1649 mTransmitStream.write(input);
1650 mTransmitStream.flush();
1651 }
1652
1653 /**
1654 * Reads a string from the remote user, blocking if there is no data available. Returns
1655 * {@code null} if the RTT conversation has been terminated and there is no further data
1656 * to read.
1657 *
1658 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1659 * lead to interleaved text.
1660 * @return A string containing text sent by the remote user, or {@code null} if the
1661 * conversation has been terminated or if there was an error while reading.
1662 */
Hall Liub1c8a772017-07-17 17:04:41 -07001663 public String read() {
1664 try {
1665 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1666 if (numRead < 0) {
1667 return null;
1668 }
1669 return new String(mReadBuffer, 0, numRead);
1670 } catch (IOException e) {
1671 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001672 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001673 }
Hall Liuffa4a812017-03-02 16:11:00 -08001674 }
1675
1676 /**
1677 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1678 * be read.
1679 * @return A string containing text entered by the user, or {@code null} if the user has
1680 * not entered any new text yet.
1681 */
1682 public String readImmediately() throws IOException {
1683 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001684 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1685 if (numRead < 0) {
1686 return null;
1687 }
1688 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001689 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001690 return null;
1691 }
1692 }
Hall Liue9041242018-02-09 16:40:03 -08001693
1694 /**
1695 * Closes the underlying file descriptors
1696 * @hide
1697 */
1698 public void close() {
1699 try {
1700 mReceiveStream.close();
1701 } catch (IOException e) {
1702 // ignore
1703 }
1704 try {
1705 mTransmitStream.close();
1706 } catch (IOException e) {
1707 // ignore
1708 }
1709 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001710 }
1711
Andrew Leeda80c872015-04-15 14:09:50 -07001712 /**
1713 * @deprecated Use {@code Call.Callback} instead.
1714 * @hide
1715 */
1716 @Deprecated
1717 @SystemApi
1718 public static abstract class Listener extends Callback { }
1719
Ihab Awade63fadb2014-07-09 21:52:04 -07001720 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001721 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001722 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001723 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001724 private final List<Call> mChildren = new ArrayList<>();
1725 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001726 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001727 private final List<Call> mConferenceableCalls = new ArrayList<>();
1728 private final List<Call> mUnmodifiableConferenceableCalls =
1729 Collections.unmodifiableList(mConferenceableCalls);
1730
Santos Cordon823fd3c2014-08-07 18:35:18 -07001731 private boolean mChildrenCached;
1732 private String mParentId = null;
Hall Liuef98bf82020-01-09 15:22:44 -08001733 private String mActiveGenericConferenceChild = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001734 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001735 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001736 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001737 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001738 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001739 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001740 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001741 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001742 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001743
1744 /**
1745 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1746 *
1747 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1748 * remaining or this {@code Call} is not in a post-dial state.
1749 */
1750 public String getRemainingPostDialSequence() {
1751 return mRemainingPostDialSequence;
1752 }
1753
1754 /**
1755 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001756 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001757 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001758 public void answer(@VideoProfile.VideoState int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001759 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001760 }
1761
1762 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301763 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1764 *
1765 * @param address The address to which the call will be deflected.
1766 */
1767 public void deflect(Uri address) {
1768 mInCallAdapter.deflectCall(mTelecomCallId, address);
1769 }
1770
1771 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001772 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1773 *
1774 * @param rejectWithMessage Whether to reject with a text message.
1775 * @param textMessage An optional text message with which to respond.
1776 */
1777 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001778 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001779 }
1780
1781 /**
Tyler Gunnfacfdee2020-01-23 13:10:37 -08001782 * Instructs the {@link ConnectionService} providing this {@link #STATE_RINGING} call that the
1783 * user has chosen to reject the call and has indicated a reason why the call is being rejected.
1784 *
1785 * @param rejectReason the reason the call is being rejected.
1786 */
1787 public void reject(@RejectReason int rejectReason) {
1788 mInCallAdapter.rejectCall(mTelecomCallId, rejectReason);
1789 }
1790
1791 /**
Ravi Palurif4b38e72020-02-05 12:35:41 +05301792 * Instructs this {@code Call} to be transferred to another number.
1793 *
1794 * @param targetNumber The address to which the call will be transferred.
Tyler Gunn460360d2020-07-29 10:21:45 -07001795 * @param isConfirmationRequired if {@code true} it will initiate a confirmed transfer,
1796 * if {@code false}, it will initiate an unconfirmed transfer.
Ravi Palurif4b38e72020-02-05 12:35:41 +05301797 *
1798 * @hide
1799 */
1800 public void transfer(@NonNull Uri targetNumber, boolean isConfirmationRequired) {
1801 mInCallAdapter.transferCall(mTelecomCallId, targetNumber, isConfirmationRequired);
1802 }
1803
1804 /**
1805 * Instructs this {@code Call} to be transferred to another ongoing call.
1806 * This will initiate CONSULTATIVE transfer.
1807 * @param toCall The other ongoing {@code Call} to which this call will be transferred.
1808 *
1809 * @hide
1810 */
1811 public void transfer(@NonNull android.telecom.Call toCall) {
1812 mInCallAdapter.transferCall(mTelecomCallId, toCall.mTelecomCallId);
1813 }
1814
1815 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001816 * Instructs this {@code Call} to disconnect.
1817 */
1818 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001819 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001820 }
1821
1822 /**
1823 * Instructs this {@code Call} to go on hold.
1824 */
1825 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001826 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001827 }
1828
1829 /**
1830 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1831 */
1832 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001833 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001834 }
1835
1836 /**
Hall Liu6dfa2492019-10-01 17:20:39 -07001837 * Instructs Telecom to put the call into the background audio processing state.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001838 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001839 * This method can be called either when the call is in {@link #STATE_RINGING} or
1840 * {@link #STATE_ACTIVE}. After Telecom acknowledges the request by setting the call's state to
1841 * {@link #STATE_AUDIO_PROCESSING}, your app may setup the audio paths with the audio stack in
1842 * order to capture and play audio on the call stream.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001843 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001844 * This method can only be called by the default dialer app.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001845 * <p>
1846 * Apps built with SDK version {@link android.os.Build.VERSION_CODES#R} or later which are using
1847 * the microphone as part of audio processing should specify the foreground service type using
1848 * the attribute {@link android.R.attr#foregroundServiceType} in the {@link InCallService}
1849 * service element of the app's manifest file.
1850 * The {@link ServiceInfo#FOREGROUND_SERVICE_TYPE_MICROPHONE} attribute should be specified.
1851 * @see <a href="https://developer.android.com/preview/privacy/foreground-service-types">
1852 * the Android Developer Site</a> for more information.
Hall Liu6dfa2492019-10-01 17:20:39 -07001853 * @hide
1854 */
1855 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001856 public void enterBackgroundAudioProcessing() {
1857 if (mState != STATE_ACTIVE && mState != STATE_RINGING) {
1858 throw new IllegalStateException("Call must be active or ringing");
1859 }
1860 mInCallAdapter.enterBackgroundAudioProcessing(mTelecomCallId);
1861 }
1862
1863 /**
1864 * Instructs Telecom to come out of the background audio processing state requested by
1865 * {@link #enterBackgroundAudioProcessing()} or from the call screening service.
1866 *
1867 * This method can only be called when the call is in {@link #STATE_AUDIO_PROCESSING}.
1868 *
1869 * @param shouldRing If true, Telecom will put the call into the
1870 * {@link #STATE_SIMULATED_RINGING} state and notify other apps that there is
1871 * a ringing call. Otherwise, the call will go into {@link #STATE_ACTIVE}
1872 * immediately.
1873 * @hide
1874 */
1875 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001876 public void exitBackgroundAudioProcessing(boolean shouldRing) {
1877 if (mState != STATE_AUDIO_PROCESSING) {
1878 throw new IllegalStateException("Call must in the audio processing state");
1879 }
1880 mInCallAdapter.exitBackgroundAudioProcessing(mTelecomCallId, shouldRing);
1881 }
1882
1883 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001884 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
Tyler Gunn2517d032023-02-06 16:34:54 +00001885 * <p>
1886 * Tones are both played locally for the user to hear and sent to the network to be relayed
1887 * to the remote device.
1888 * <p>
1889 * You must ensure that any call to {@link #playDtmfTone(char}) is followed by a matching
1890 * call to {@link #stopDtmfTone()} and that each tone is stopped before a new one is started.
1891 * The play and stop commands are relayed to the underlying
1892 * {@link android.telecom.ConnectionService} as executed; implementations may not correctly
1893 * handle out of order commands.
Ihab Awade63fadb2014-07-09 21:52:04 -07001894 *
1895 * @param digit A character representing the DTMF digit for which to play the tone. This
1896 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1897 */
1898 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001899 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001900 }
1901
1902 /**
1903 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1904 * currently playing.
1905 *
1906 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1907 * currently playing, this method will do nothing.
1908 */
1909 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001910 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001911 }
1912
1913 /**
1914 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1915 *
1916 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1917 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001918 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001919 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001920 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1921 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001922 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001923 * {@code Call} will pause playing the tones and notify callbacks via
1924 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001925 * should display to the user an indication of this state and an affordance to continue
1926 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1927 * app should invoke the {@link #postDialContinue(boolean)} method.
1928 *
1929 * @param proceed Whether or not to continue with the post-dial sequence.
1930 */
1931 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001932 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001933 }
1934
1935 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001936 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001937 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001938 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001939 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1940 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001941
1942 }
1943
1944 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001945 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001946 *
1947 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001948 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001949 public void conference(Call callToConferenceWith) {
1950 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001951 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001952 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001953 }
1954
1955 /**
1956 * Instructs this {@code Call} to split from any conference call with which it may be
1957 * connected.
1958 */
1959 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001960 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001961 }
1962
1963 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001964 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001965 */
1966 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001967 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001968 }
1969
1970 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001971 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001972 */
1973 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001974 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001975 }
1976
1977 /**
Ravi Paluri404babb2020-01-23 19:02:44 +05301978 * Pulls participants to existing call by forming a conference call.
1979 * See {@link Details#CAPABILITY_ADD_PARTICIPANT}.
1980 *
1981 * @param participants participants to be pulled to existing call.
1982 */
1983 public void addConferenceParticipants(@NonNull List<Uri> participants) {
1984 mInCallAdapter.addConferenceParticipants(mTelecomCallId, participants);
1985 }
1986
1987 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001988 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1989 * device.
1990 * <p>
1991 * Calls to this method are ignored if the call does not have the
1992 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
1993 * <p>
1994 * An {@link InCallService} will only see calls which support this method if it has the
1995 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
1996 * in its manifest.
1997 */
1998 public void pullExternalCall() {
1999 // If this isn't an external call, ignore the request.
2000 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
2001 return;
2002 }
2003
2004 mInCallAdapter.pullExternalCall(mTelecomCallId);
2005 }
2006
2007 /**
2008 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
2009 * the {@link ConnectionService}.
2010 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07002011 * Call events are used to communicate point in time information from an {@link InCallService}
2012 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
2013 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
2014 * {@link ConnectionService}.
2015 * <p>
2016 * A {@link ConnectionService} can communicate to the {@link InCallService} using
2017 * {@link Connection#sendConnectionEvent(String, Bundle)}.
2018 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002019 * Events are exposed to {@link ConnectionService} implementations via
2020 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
2021 * <p>
2022 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07002023 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
2024 * ignore some events altogether.
2025 * <p>
2026 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
2027 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
2028 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
2029 * they define their own event types in this namespace. When defining a custom event type,
2030 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
2031 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
2032 * <p>
2033 * When defining events and the associated extras, it is important to keep their behavior
2034 * consistent when the associated {@link InCallService} is updated. Support for deprecated
2035 * events/extras should me maintained to ensure backwards compatibility with older
2036 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002037 *
2038 * @param event The connection event.
2039 * @param extras Bundle containing extra information associated with the event.
2040 */
2041 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002042 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002043 }
2044
2045 /**
Hall Liu95d55872017-01-25 17:12:49 -08002046 * Sends an RTT upgrade request to the remote end of the connection. Success is not
2047 * guaranteed, and notification of success will be via the
2048 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2049 */
2050 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08002051 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002052 }
2053
2054 /**
2055 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
2056 * callback.
2057 * The ID used here should be the same as the ID that was received via the callback.
2058 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
2059 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
2060 */
2061 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08002062 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08002063 }
2064
2065 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07002066 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
2067 * by {@code toHandle}. The videoState specified indicates the desired video state after the
2068 * handover.
2069 * <p>
Tyler Gunn9d127732018-03-02 15:45:51 -08002070 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2071 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2072 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2073 * is referred to as the source of the handover, and the video calling app is referred to as the
2074 * destination.
2075 * <p>
2076 * When considering a handover scenario the device this method is called on is considered the
2077 * <em>initiating</em> device (since the user initiates the handover from this device), and the
2078 * other device is considered the <em>receiving</em> device.
2079 * <p>
2080 * When this method is called on the <em>initiating</em> device, the Telecom framework will bind
2081 * to the {@link ConnectionService} defined by the {@code toHandle} {@link PhoneAccountHandle}
2082 * and invoke
2083 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
2084 * ConnectionRequest)} to inform the destination app that a request has been made to handover a
2085 * call to it. The app returns an instance of {@link Connection} to represent the handover call
2086 * At this point the app should display UI to indicate to the user that a call
2087 * handover is in process.
2088 * <p>
2089 * The destination app is responsible for communicating the handover request from the
2090 * <em>initiating</em> device to the <em>receiving</em> device.
2091 * <p>
2092 * When the app on the <em>receiving</em> device receives the handover request, it calls
2093 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)} to continue the handover
2094 * process from the <em>initiating</em> device to the <em>receiving</em> device. At this point
2095 * the destination app on the <em>receiving</em> device should show UI to allow the user to
2096 * choose whether they want to continue their call in the destination app.
2097 * <p>
2098 * When the destination app on the <em>receiving</em> device calls
2099 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)}, Telecom will bind to its
2100 * {@link ConnectionService} and call
2101 * {@link ConnectionService#onCreateIncomingHandoverConnection(PhoneAccountHandle,
2102 * ConnectionRequest)} to inform it of the handover request. The app returns an instance of
2103 * {@link Connection} to represent the handover call.
2104 * <p>
2105 * If the user of the <em>receiving</em> device accepts the handover, the app calls
2106 * {@link Connection#setActive()} to complete the handover process; Telecom will disconnect the
2107 * original call. If the user rejects the handover, the app calls
2108 * {@link Connection#setDisconnected(DisconnectCause)} and specifies a {@link DisconnectCause}
2109 * of {@link DisconnectCause#CANCELED} to indicate that the handover has been cancelled.
2110 * <p>
2111 * Telecom will only allow handovers from {@link PhoneAccount}s which declare
2112 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}. Similarly, the {@link PhoneAccount}
2113 * specified by {@code toHandle} must declare {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}.
2114 * <p>
2115 * Errors in the handover process are reported to the {@link InCallService} via
2116 * {@link Callback#onHandoverFailed(Call, int)}. Errors in the handover process are reported to
2117 * the involved {@link ConnectionService}s via
2118 * {@link ConnectionService#onHandoverFailed(ConnectionRequest, int)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07002119 *
2120 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
2121 * this call to.
Tyler Gunn9d127732018-03-02 15:45:51 -08002122 * @param videoState Indicates the video state desired after the handover (see the
2123 * {@code STATE_*} constants defined in {@link VideoProfile}).
Sanket Padawea8eddd42017-11-03 11:07:35 -07002124 * @param extras Bundle containing extra information to be passed to the
2125 * {@link ConnectionService}
2126 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002127 public void handoverTo(PhoneAccountHandle toHandle, @VideoProfile.VideoState int videoState,
2128 Bundle extras) {
Sanket Padawea8eddd42017-11-03 11:07:35 -07002129 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
2130 }
2131
2132 /**
Hall Liu95d55872017-01-25 17:12:49 -08002133 * Terminate the RTT session on this call. The resulting state change will be notified via
2134 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2135 */
2136 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08002137 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002138 }
2139
2140 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07002141 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
2142 * added.
2143 * <p>
2144 * No assumptions should be made as to how an In-Call UI or service will handle these
2145 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
Tyler Gunn6c100242023-01-09 11:23:18 -08002146 * <p>
2147 * Extras added using this method will be made available to the {@link ConnectionService}
2148 * associated with this {@link Call} and notified via
2149 * {@link Connection#onExtrasChanged(Bundle)}.
2150 * <p>
2151 * Extras added using this method will also be available to other running {@link InCallService}s
2152 * and notified via {@link Call.Callback#onDetailsChanged(Call, Details)}. The extras can be
2153 * accessed via {@link Details#getExtras()}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002154 *
2155 * @param extras The extras to add.
2156 */
2157 public final void putExtras(Bundle extras) {
2158 if (extras == null) {
2159 return;
2160 }
2161
2162 if (mExtras == null) {
2163 mExtras = new Bundle();
2164 }
2165 mExtras.putAll(extras);
2166 mInCallAdapter.putExtras(mTelecomCallId, extras);
2167 }
2168
2169 /**
2170 * Adds a boolean extra to this {@link Call}.
2171 *
2172 * @param key The extra key.
2173 * @param value The value.
2174 * @hide
2175 */
2176 public final void putExtra(String key, boolean value) {
2177 if (mExtras == null) {
2178 mExtras = new Bundle();
2179 }
2180 mExtras.putBoolean(key, value);
2181 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2182 }
2183
2184 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002185 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002186 *
2187 * @param key The extra key.
2188 * @param value The value.
2189 * @hide
2190 */
2191 public final void putExtra(String key, int value) {
2192 if (mExtras == null) {
2193 mExtras = new Bundle();
2194 }
2195 mExtras.putInt(key, value);
2196 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2197 }
2198
2199 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002200 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002201 *
2202 * @param key The extra key.
2203 * @param value The value.
2204 * @hide
2205 */
2206 public final void putExtra(String key, String value) {
2207 if (mExtras == null) {
2208 mExtras = new Bundle();
2209 }
2210 mExtras.putString(key, value);
2211 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2212 }
2213
2214 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002215 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002216 *
2217 * @param keys The keys of the extras to remove.
2218 */
2219 public final void removeExtras(List<String> keys) {
2220 if (mExtras != null) {
2221 for (String key : keys) {
2222 mExtras.remove(key);
2223 }
2224 if (mExtras.size() == 0) {
2225 mExtras = null;
2226 }
2227 }
2228 mInCallAdapter.removeExtras(mTelecomCallId, keys);
2229 }
2230
2231 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002232 * Removes extras from this {@link Call}.
2233 *
2234 * @param keys The keys of the extras to remove.
2235 */
2236 public final void removeExtras(String ... keys) {
2237 removeExtras(Arrays.asList(keys));
2238 }
2239
2240 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002241 * Obtains the parent of this {@code Call} in a conference, if any.
2242 *
2243 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
2244 * child of any conference {@code Call}s.
2245 */
2246 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002247 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002248 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002249 }
2250 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07002251 }
2252
2253 /**
2254 * Obtains the children of this conference {@code Call}, if any.
2255 *
2256 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
2257 * {@code List} otherwise.
2258 */
2259 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002260 if (!mChildrenCached) {
2261 mChildrenCached = true;
2262 mChildren.clear();
2263
2264 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002265 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002266 if (call == null) {
2267 // At least one child was still not found, so do not save true for "cached"
2268 mChildrenCached = false;
2269 } else {
2270 mChildren.add(call);
2271 }
2272 }
2273 }
2274
Ihab Awade63fadb2014-07-09 21:52:04 -07002275 return mUnmodifiableChildren;
2276 }
2277
2278 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002279 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
2280 *
2281 * @return The list of conferenceable {@code Call}s.
2282 */
2283 public List<Call> getConferenceableCalls() {
2284 return mUnmodifiableConferenceableCalls;
2285 }
2286
2287 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002288 * Obtains the state of this {@code Call}.
2289 *
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002290 * @return The call state.
2291 * @deprecated The call state is available via {@link Call.Details#getState()}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002292 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002293 @Deprecated
2294 public @CallState int getState() {
Ihab Awade63fadb2014-07-09 21:52:04 -07002295 return mState;
2296 }
2297
2298 /**
Hall Liuef98bf82020-01-09 15:22:44 -08002299 * Returns the child {@link Call} in a generic conference that is currently active.
Hall Liu135e53aa2020-02-27 18:34:11 -08002300 *
2301 * A "generic conference" is the mechanism used to support two simultaneous calls on a device
2302 * in CDMA networks. It is effectively equivalent to having one call active and one call on hold
2303 * in GSM or IMS calls. This method returns the currently active call.
2304 *
2305 * In a generic conference, the network exposes the conference to us as a single call, and we
2306 * switch between talking to the two participants using a CDMA flash command. Since the network
2307 * exposes no additional information about the call, the only way we know which caller we're
2308 * currently talking to is by keeping track of the flash commands that we've sent to the
2309 * network.
2310 *
Hall Liuef98bf82020-01-09 15:22:44 -08002311 * For calls that are not generic conferences, or when the generic conference has more than
2312 * 2 children, returns {@code null}.
2313 * @see Details#PROPERTY_GENERIC_CONFERENCE
2314 * @return The active child call.
2315 */
2316 public @Nullable Call getGenericConferenceActiveChildCall() {
2317 if (mActiveGenericConferenceChild != null) {
2318 return mPhone.internalGetCallByTelecomId(mActiveGenericConferenceChild);
2319 }
2320 return null;
2321 }
2322
2323 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002324 * Obtains a list of canned, pre-configured message responses to present to the user as
Tyler Gunn434fc2c2020-10-06 14:23:54 -07002325 * ways of rejecting an incoming {@code Call} using via a text message.
2326 * <p>
2327 * <em>Note:</em> Since canned responses may be loaded from the file system, they are not
2328 * guaranteed to be present when this {@link Call} is first added to the {@link InCallService}
2329 * via {@link InCallService#onCallAdded(Call)}. The callback
2330 * {@link Call.Callback#onCannedTextResponsesLoaded(Call, List)} will be called when/if canned
2331 * responses for the call become available.
Ihab Awade63fadb2014-07-09 21:52:04 -07002332 *
2333 * @see #reject(boolean, String)
2334 *
2335 * @return A list of canned text message responses.
2336 */
2337 public List<String> getCannedTextResponses() {
2338 return mCannedTextResponses;
2339 }
2340
2341 /**
2342 * Obtains an object that can be used to display video from this {@code Call}.
2343 *
Andrew Lee50aca232014-07-22 16:41:54 -07002344 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002345 */
Andrew Lee50aca232014-07-22 16:41:54 -07002346 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002347 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07002348 }
2349
2350 /**
2351 * Obtains an object containing call details.
2352 *
2353 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
2354 * result may be {@code null}.
2355 */
2356 public Details getDetails() {
2357 return mDetails;
2358 }
2359
2360 /**
Hall Liu95d55872017-01-25 17:12:49 -08002361 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
2362 * receive RTT text data, as well as to change the RTT mode.
2363 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
2364 */
2365 public @Nullable RttCall getRttCall() {
2366 return mRttCall;
2367 }
2368
2369 /**
2370 * Returns whether this call has an active RTT connection.
2371 * @return true if there is a connection, false otherwise.
2372 */
2373 public boolean isRttActive() {
Hall Liue9041242018-02-09 16:40:03 -08002374 return mRttCall != null && mDetails.hasProperty(Details.PROPERTY_RTT);
Hall Liu95d55872017-01-25 17:12:49 -08002375 }
2376
2377 /**
Andrew Leeda80c872015-04-15 14:09:50 -07002378 * Registers a callback to this {@code Call}.
2379 *
2380 * @param callback A {@code Callback}.
2381 */
2382 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07002383 registerCallback(callback, new Handler());
2384 }
2385
2386 /**
2387 * Registers a callback to this {@code Call}.
2388 *
2389 * @param callback A {@code Callback}.
2390 * @param handler A handler which command and status changes will be delivered to.
2391 */
2392 public void registerCallback(Callback callback, Handler handler) {
2393 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07002394 // Don't allow new callback registration if the call is already being destroyed.
2395 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002396 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
2397 }
Andrew Leeda80c872015-04-15 14:09:50 -07002398 }
2399
2400 /**
2401 * Unregisters a callback from this {@code Call}.
2402 *
2403 * @param callback A {@code Callback}.
2404 */
2405 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07002406 // Don't allow callback deregistration if the call is already being destroyed.
2407 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002408 for (CallbackRecord<Callback> record : mCallbackRecords) {
2409 if (record.getCallback() == callback) {
2410 mCallbackRecords.remove(record);
2411 break;
2412 }
2413 }
Andrew Leeda80c872015-04-15 14:09:50 -07002414 }
2415 }
2416
Santos Cordon3c20d632016-02-25 16:12:35 -08002417 @Override
2418 public String toString() {
2419 return new StringBuilder().
2420 append("Call [id: ").
2421 append(mTelecomCallId).
2422 append(", state: ").
2423 append(stateToString(mState)).
2424 append(", details: ").
2425 append(mDetails).
2426 append("]").toString();
2427 }
2428
2429 /**
2430 * @param state An integer value of a {@code STATE_*} constant.
2431 * @return A string representation of the value.
2432 */
2433 private static String stateToString(int state) {
2434 switch (state) {
2435 case STATE_NEW:
2436 return "NEW";
2437 case STATE_RINGING:
2438 return "RINGING";
2439 case STATE_DIALING:
2440 return "DIALING";
2441 case STATE_ACTIVE:
2442 return "ACTIVE";
2443 case STATE_HOLDING:
2444 return "HOLDING";
2445 case STATE_DISCONNECTED:
2446 return "DISCONNECTED";
2447 case STATE_CONNECTING:
2448 return "CONNECTING";
2449 case STATE_DISCONNECTING:
2450 return "DISCONNECTING";
2451 case STATE_SELECT_PHONE_ACCOUNT:
2452 return "SELECT_PHONE_ACCOUNT";
Hall Liu4e35b642019-10-14 17:50:45 -07002453 case STATE_SIMULATED_RINGING:
2454 return "SIMULATED_RINGING";
2455 case STATE_AUDIO_PROCESSING:
2456 return "AUDIO_PROCESSING";
Santos Cordon3c20d632016-02-25 16:12:35 -08002457 default:
2458 Log.w(Call.class, "Unknown state %d", state);
2459 return "UNKNOWN";
2460 }
2461 }
2462
Andrew Leeda80c872015-04-15 14:09:50 -07002463 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002464 * Adds a listener to this {@code Call}.
2465 *
2466 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002467 * @deprecated Use {@link #registerCallback} instead.
2468 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002469 */
Andrew Leeda80c872015-04-15 14:09:50 -07002470 @Deprecated
2471 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002472 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002473 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002474 }
2475
2476 /**
2477 * Removes a listener from this {@code Call}.
2478 *
2479 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002480 * @deprecated Use {@link #unregisterCallback} instead.
2481 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002482 */
Andrew Leeda80c872015-04-15 14:09:50 -07002483 @Deprecated
2484 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002485 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002486 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002487 }
2488
2489 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08002490 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
2491 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002492 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002493 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002494 mInCallAdapter = inCallAdapter;
2495 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002496 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002497 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07002498 }
2499
2500 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08002501 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08002502 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002503 mPhone = phone;
2504 mTelecomCallId = telecomCallId;
2505 mInCallAdapter = inCallAdapter;
2506 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002507 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002508 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002509 }
2510
2511 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002512 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002513 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002514 }
2515
2516 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002517 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08002518
Ihab Awade63fadb2014-07-09 21:52:04 -07002519 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08002520 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07002521 boolean detailsChanged = !Objects.equals(mDetails, details);
2522 if (detailsChanged) {
2523 mDetails = details;
2524 }
2525
2526 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07002527 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
2528 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
2529 mCannedTextResponses =
2530 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07002531 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07002532 }
2533
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002534 IVideoProvider previousVideoProvider = mVideoCallImpl == null ? null :
2535 mVideoCallImpl.getVideoProvider();
2536 IVideoProvider newVideoProvider = parcelableCall.getVideoProvider();
2537
2538 // parcelableCall.isVideoCallProviderChanged is only true when we have a video provider
2539 // specified; so we should check if the actual IVideoProvider changes as well.
2540 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged()
2541 && !Objects.equals(previousVideoProvider, newVideoProvider);
Andrew Lee50aca232014-07-22 16:41:54 -07002542 if (videoCallChanged) {
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002543 if (mVideoCallImpl != null) {
2544 mVideoCallImpl.destroy();
2545 }
2546 mVideoCallImpl = parcelableCall.isVideoCallProviderChanged() ?
2547 parcelableCall.getVideoCallImpl(mCallingPackage, mTargetSdkVersion) : null;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002548 }
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002549
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002550 if (mVideoCallImpl != null) {
2551 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07002552 }
2553
Santos Cordone3c507b2015-04-23 14:44:19 -07002554 int state = parcelableCall.getState();
Hall Liu31de23d2019-10-11 15:38:29 -07002555 if (mTargetSdkVersion < Phone.SDK_VERSION_R && state == Call.STATE_SIMULATED_RINGING) {
2556 state = Call.STATE_RINGING;
2557 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002558 boolean stateChanged = mState != state;
2559 if (stateChanged) {
2560 mState = state;
2561 }
2562
Santos Cordon823fd3c2014-08-07 18:35:18 -07002563 String parentId = parcelableCall.getParentCallId();
2564 boolean parentChanged = !Objects.equals(mParentId, parentId);
2565 if (parentChanged) {
2566 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002567 }
2568
Santos Cordon823fd3c2014-08-07 18:35:18 -07002569 List<String> childCallIds = parcelableCall.getChildCallIds();
2570 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
2571 if (childrenChanged) {
2572 mChildrenIds.clear();
2573 mChildrenIds.addAll(parcelableCall.getChildCallIds());
2574 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07002575 }
2576
Hall Liuef98bf82020-01-09 15:22:44 -08002577 String activeChildCallId = parcelableCall.getActiveChildCallId();
2578 boolean activeChildChanged = !Objects.equals(activeChildCallId,
2579 mActiveGenericConferenceChild);
2580 if (activeChildChanged) {
2581 mActiveGenericConferenceChild = activeChildCallId;
2582 }
2583
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002584 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
2585 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
2586 for (String otherId : conferenceableCallIds) {
2587 if (callIdMap.containsKey(otherId)) {
2588 conferenceableCalls.add(callIdMap.get(otherId));
2589 }
2590 }
2591
2592 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
2593 mConferenceableCalls.clear();
2594 mConferenceableCalls.addAll(conferenceableCalls);
2595 fireConferenceableCallsChanged();
2596 }
2597
Hall Liu95d55872017-01-25 17:12:49 -08002598 boolean isRttChanged = false;
2599 boolean rttModeChanged = false;
Hall Liue9041242018-02-09 16:40:03 -08002600 if (parcelableCall.getIsRttCallChanged()
2601 && mDetails.hasProperty(Details.PROPERTY_RTT)) {
Hall Liu95d55872017-01-25 17:12:49 -08002602 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
2603 InputStreamReader receiveStream = new InputStreamReader(
2604 new ParcelFileDescriptor.AutoCloseInputStream(
2605 parcelableRttCall.getReceiveStream()),
2606 StandardCharsets.UTF_8);
2607 OutputStreamWriter transmitStream = new OutputStreamWriter(
2608 new ParcelFileDescriptor.AutoCloseOutputStream(
2609 parcelableRttCall.getTransmitStream()),
2610 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08002611 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08002612 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
2613 if (mRttCall == null) {
2614 isRttChanged = true;
2615 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
2616 rttModeChanged = true;
2617 }
2618 mRttCall = newRttCall;
2619 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
2620 && parcelableCall.getIsRttCallChanged()) {
2621 isRttChanged = true;
Tyler Gunn4cd42482021-04-30 16:23:15 -07002622 mRttCall.close();
Hall Liu95d55872017-01-25 17:12:49 -08002623 mRttCall = null;
2624 }
2625
Ihab Awade63fadb2014-07-09 21:52:04 -07002626 // Now we fire updates, ensuring that any client who listens to any of these notifications
2627 // gets the most up-to-date state.
2628
2629 if (stateChanged) {
2630 fireStateChanged(mState);
2631 }
2632 if (detailsChanged) {
2633 fireDetailsChanged(mDetails);
2634 }
2635 if (cannedTextResponsesChanged) {
2636 fireCannedTextResponsesLoaded(mCannedTextResponses);
2637 }
Andrew Lee50aca232014-07-22 16:41:54 -07002638 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002639 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07002640 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07002641 if (parentChanged) {
2642 fireParentChanged(getParent());
2643 }
Hall Liuef98bf82020-01-09 15:22:44 -08002644 if (childrenChanged || activeChildChanged) {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002645 fireChildrenChanged(getChildren());
2646 }
Hall Liu95d55872017-01-25 17:12:49 -08002647 if (isRttChanged) {
2648 fireOnIsRttChanged(mRttCall != null, mRttCall);
2649 }
2650 if (rttModeChanged) {
2651 fireOnRttModeChanged(mRttCall.getRttAudioMode());
2652 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002653
2654 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
2655 // remove ourselves from the Phone. Note that we do this after completing all state updates
2656 // so a client can cleanly transition all their UI to the state appropriate for a
2657 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
2658 if (mState == STATE_DISCONNECTED) {
2659 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07002660 }
2661 }
2662
2663 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002664 final void internalSetPostDialWait(String remaining) {
2665 mRemainingPostDialSequence = remaining;
2666 firePostDialWait(mRemainingPostDialSequence);
2667 }
2668
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07002669 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07002670 final void internalSetDisconnected() {
2671 if (mState != Call.STATE_DISCONNECTED) {
2672 mState = Call.STATE_DISCONNECTED;
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002673 if (mDetails != null) {
2674 mDetails = new Details(mState,
2675 mDetails.getTelecomCallId(),
2676 mDetails.getHandle(),
2677 mDetails.getHandlePresentation(),
2678 mDetails.getCallerDisplayName(),
2679 mDetails.getCallerDisplayNamePresentation(),
2680 mDetails.getAccountHandle(),
2681 mDetails.getCallCapabilities(),
2682 mDetails.getCallProperties(),
2683 mDetails.getDisconnectCause(),
2684 mDetails.getConnectTimeMillis(),
2685 mDetails.getGatewayInfo(),
2686 mDetails.getVideoState(),
2687 mDetails.getStatusHints(),
2688 mDetails.getExtras(),
2689 mDetails.getIntentExtras(),
2690 mDetails.getCreationTimeMillis(),
2691 mDetails.getContactDisplayName(),
2692 mDetails.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07002693 mDetails.getCallerNumberVerificationStatus(),
2694 mDetails.getContactPhotoUri()
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002695 );
2696 fireDetailsChanged(mDetails);
2697 }
Santos Cordonf30d7e92014-08-26 09:54:33 -07002698 fireStateChanged(mState);
2699 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07002700 }
2701 }
2702
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002703 /** {@hide} */
2704 final void internalOnConnectionEvent(String event, Bundle extras) {
2705 fireOnConnectionEvent(event, extras);
2706 }
2707
Hall Liu95d55872017-01-25 17:12:49 -08002708 /** {@hide} */
2709 final void internalOnRttUpgradeRequest(final int requestId) {
2710 for (CallbackRecord<Callback> record : mCallbackRecords) {
2711 final Call call = this;
2712 final Callback callback = record.getCallback();
2713 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
2714 }
2715 }
2716
Hall Liu57006aa2017-02-06 10:49:48 -08002717 /** @hide */
2718 final void internalOnRttInitiationFailure(int reason) {
2719 for (CallbackRecord<Callback> record : mCallbackRecords) {
2720 final Call call = this;
2721 final Callback callback = record.getCallback();
2722 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
2723 }
2724 }
2725
Sanket Padawe85291f62017-12-01 13:59:27 -08002726 /** {@hide} */
2727 final void internalOnHandoverFailed(int error) {
2728 for (CallbackRecord<Callback> record : mCallbackRecords) {
2729 final Call call = this;
2730 final Callback callback = record.getCallback();
2731 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
2732 }
2733 }
2734
Tyler Gunn858bfaf2018-01-22 15:17:54 -08002735 /** {@hide} */
2736 final void internalOnHandoverComplete() {
2737 for (CallbackRecord<Callback> record : mCallbackRecords) {
2738 final Call call = this;
2739 final Callback callback = record.getCallback();
2740 record.getHandler().post(() -> callback.onHandoverComplete(call));
2741 }
2742 }
2743
Andrew Lee011728f2015-04-23 15:47:06 -07002744 private void fireStateChanged(final int newState) {
2745 for (CallbackRecord<Callback> record : mCallbackRecords) {
2746 final Call call = this;
2747 final Callback callback = record.getCallback();
2748 record.getHandler().post(new Runnable() {
2749 @Override
2750 public void run() {
2751 callback.onStateChanged(call, newState);
2752 }
2753 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002754 }
2755 }
2756
Andrew Lee011728f2015-04-23 15:47:06 -07002757 private void fireParentChanged(final Call newParent) {
2758 for (CallbackRecord<Callback> record : mCallbackRecords) {
2759 final Call call = this;
2760 final Callback callback = record.getCallback();
2761 record.getHandler().post(new Runnable() {
2762 @Override
2763 public void run() {
2764 callback.onParentChanged(call, newParent);
2765 }
2766 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002767 }
2768 }
2769
Andrew Lee011728f2015-04-23 15:47:06 -07002770 private void fireChildrenChanged(final List<Call> children) {
2771 for (CallbackRecord<Callback> record : mCallbackRecords) {
2772 final Call call = this;
2773 final Callback callback = record.getCallback();
2774 record.getHandler().post(new Runnable() {
2775 @Override
2776 public void run() {
2777 callback.onChildrenChanged(call, children);
2778 }
2779 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002780 }
2781 }
2782
Andrew Lee011728f2015-04-23 15:47:06 -07002783 private void fireDetailsChanged(final Details details) {
2784 for (CallbackRecord<Callback> record : mCallbackRecords) {
2785 final Call call = this;
2786 final Callback callback = record.getCallback();
2787 record.getHandler().post(new Runnable() {
2788 @Override
2789 public void run() {
2790 callback.onDetailsChanged(call, details);
2791 }
2792 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002793 }
2794 }
2795
Andrew Lee011728f2015-04-23 15:47:06 -07002796 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2797 for (CallbackRecord<Callback> record : mCallbackRecords) {
2798 final Call call = this;
2799 final Callback callback = record.getCallback();
2800 record.getHandler().post(new Runnable() {
2801 @Override
2802 public void run() {
2803 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2804 }
2805 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002806 }
2807 }
2808
Andrew Lee011728f2015-04-23 15:47:06 -07002809 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2810 for (CallbackRecord<Callback> record : mCallbackRecords) {
2811 final Call call = this;
2812 final Callback callback = record.getCallback();
2813 record.getHandler().post(new Runnable() {
2814 @Override
2815 public void run() {
2816 callback.onVideoCallChanged(call, videoCall);
2817 }
2818 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002819 }
2820 }
2821
Andrew Lee011728f2015-04-23 15:47:06 -07002822 private void firePostDialWait(final String remainingPostDialSequence) {
2823 for (CallbackRecord<Callback> record : mCallbackRecords) {
2824 final Call call = this;
2825 final Callback callback = record.getCallback();
2826 record.getHandler().post(new Runnable() {
2827 @Override
2828 public void run() {
2829 callback.onPostDialWait(call, remainingPostDialSequence);
2830 }
2831 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002832 }
2833 }
2834
2835 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002836 /**
2837 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2838 * onCallRemoved callback, we remove this call from the Phone's record
2839 * only once all of the registered onCallDestroyed callbacks are executed.
2840 * All the callbacks get removed from our records as a part of this operation
2841 * since onCallDestroyed is the final callback.
2842 */
2843 final Call call = this;
2844 if (mCallbackRecords.isEmpty()) {
2845 // No callbacks registered, remove the call from Phone's record.
2846 mPhone.internalRemoveCall(call);
2847 }
2848 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002849 final Callback callback = record.getCallback();
2850 record.getHandler().post(new Runnable() {
2851 @Override
2852 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002853 boolean isFinalRemoval = false;
2854 RuntimeException toThrow = null;
2855 try {
2856 callback.onCallDestroyed(call);
2857 } catch (RuntimeException e) {
2858 toThrow = e;
2859 }
2860 synchronized(Call.this) {
2861 mCallbackRecords.remove(record);
2862 if (mCallbackRecords.isEmpty()) {
2863 isFinalRemoval = true;
2864 }
2865 }
2866 if (isFinalRemoval) {
2867 mPhone.internalRemoveCall(call);
2868 }
2869 if (toThrow != null) {
2870 throw toThrow;
2871 }
Andrew Lee011728f2015-04-23 15:47:06 -07002872 }
2873 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002874 }
2875 }
2876
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002877 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002878 for (CallbackRecord<Callback> record : mCallbackRecords) {
2879 final Call call = this;
2880 final Callback callback = record.getCallback();
2881 record.getHandler().post(new Runnable() {
2882 @Override
2883 public void run() {
2884 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2885 }
2886 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002887 }
2888 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002889
2890 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002891 * Notifies listeners of an incoming connection event.
2892 * <p>
2893 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2894 *
2895 * @param event
2896 * @param extras
2897 */
2898 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2899 for (CallbackRecord<Callback> record : mCallbackRecords) {
2900 final Call call = this;
2901 final Callback callback = record.getCallback();
2902 record.getHandler().post(new Runnable() {
2903 @Override
2904 public void run() {
2905 callback.onConnectionEvent(call, event, extras);
2906 }
2907 });
2908 }
2909 }
2910
2911 /**
Hall Liu95d55872017-01-25 17:12:49 -08002912 * Notifies listeners of an RTT on/off change
2913 *
2914 * @param enabled True if RTT is now enabled, false otherwise
2915 */
2916 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2917 for (CallbackRecord<Callback> record : mCallbackRecords) {
2918 final Call call = this;
2919 final Callback callback = record.getCallback();
2920 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2921 }
2922 }
2923
2924 /**
2925 * Notifies listeners of a RTT mode change
2926 *
2927 * @param mode The new RTT mode
2928 */
2929 private void fireOnRttModeChanged(final int mode) {
2930 for (CallbackRecord<Callback> record : mCallbackRecords) {
2931 final Call call = this;
2932 final Callback callback = record.getCallback();
2933 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2934 }
2935 }
2936
2937 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002938 * Determines if two bundles are equal.
2939 *
2940 * @param bundle The original bundle.
2941 * @param newBundle The bundle to compare with.
2942 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2943 */
2944 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2945 if (bundle == null || newBundle == null) {
2946 return bundle == newBundle;
2947 }
2948
2949 if (bundle.size() != newBundle.size()) {
2950 return false;
2951 }
2952
2953 for(String key : bundle.keySet()) {
2954 if (key != null) {
Grace Jia17005bd2022-05-12 12:49:02 -07002955 if (!newBundle.containsKey(key)) {
2956 return false;
2957 }
qing723dac62022-10-28 03:40:43 +00002958 // In case new call extra contains non-framework class objects, return false to
2959 // force update the call extra
2960 try {
2961 final Object value = bundle.get(key);
2962 final Object newValue = newBundle.get(key);
2963 if (value instanceof Bundle && newValue instanceof Bundle) {
2964 if (!areBundlesEqual((Bundle) value, (Bundle) newValue)) {
2965 return false;
2966 }
2967 }
2968 if (value instanceof byte[] && newValue instanceof byte[]) {
2969 if (!Arrays.equals((byte[]) value, (byte[]) newValue)) {
2970 return false;
2971 }
2972 } else if (!Objects.equals(value, newValue)) {
Grace Jia17005bd2022-05-12 12:49:02 -07002973 return false;
2974 }
qing723dac62022-10-28 03:40:43 +00002975 } catch (BadParcelableException e) {
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002976 return false;
2977 }
2978 }
2979 }
2980 return true;
2981 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002982}