blob: a7675d694a24a6b5c873c310dbe53e2eb7ef37eb [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
Grant Menke417190a2023-08-30 14:39:29 -070019import android.annotation.FlaggedApi;
Hall Liu95d55872017-01-25 17:12:49 -080020import android.annotation.IntDef;
Ravi Paluri404babb2020-01-23 19:02:44 +053021import android.annotation.NonNull;
Hall Liu95d55872017-01-25 17:12:49 -080022import android.annotation.Nullable;
Andrew Leeda80c872015-04-15 14:09:50 -070023import android.annotation.SystemApi;
Hall Liu6dfa2492019-10-01 17:20:39 -070024import android.annotation.TestApi;
Artur Satayev53ada2a2019-12-10 17:47:56 +000025import android.compat.annotation.UnsupportedAppUsage;
Tyler Gunn460b7d42020-05-15 10:19:32 -070026import android.content.pm.ServiceInfo;
Ihab Awade63fadb2014-07-09 21:52:04 -070027import android.net.Uri;
qing723dac62022-10-28 03:40:43 +000028import android.os.BadParcelableException;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080029import android.os.Build;
Nancy Chen10798dc2014-08-08 14:00:25 -070030import android.os.Bundle;
Andrew Lee011728f2015-04-23 15:47:06 -070031import android.os.Handler;
Hall Liu95d55872017-01-25 17:12:49 -080032import android.os.ParcelFileDescriptor;
Ihab Awade63fadb2014-07-09 21:52:04 -070033
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -080034import com.android.internal.telecom.IVideoProvider;
Grant Menke417190a2023-08-30 14:39:29 -070035import com.android.server.telecom.flags.Flags;
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -080036
Hall Liu95d55872017-01-25 17:12:49 -080037import java.io.IOException;
38import java.io.InputStreamReader;
39import java.io.OutputStreamWriter;
Hall Liu95d55872017-01-25 17:12:49 -080040import java.lang.annotation.Retention;
41import java.lang.annotation.RetentionPolicy;
42import java.nio.charset.StandardCharsets;
Ihab Awade63fadb2014-07-09 21:52:04 -070043import java.util.ArrayList;
Tyler Gunn071be6f2016-05-10 14:52:33 -070044import java.util.Arrays;
Ihab Awade63fadb2014-07-09 21:52:04 -070045import java.util.Collections;
46import java.util.List;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -070047import java.util.Map;
Ihab Awade63fadb2014-07-09 21:52:04 -070048import java.util.Objects;
Jay Shrauner229e3822014-08-15 09:23:07 -070049import java.util.concurrent.CopyOnWriteArrayList;
Ihab Awade63fadb2014-07-09 21:52:04 -070050
51/**
52 * Represents an ongoing phone call that the in-call app should present to the user.
53 */
54public final class Call {
55 /**
56 * The state of a {@code Call} when newly created.
57 */
58 public static final int STATE_NEW = 0;
59
60 /**
61 * The state of an outgoing {@code Call} when dialing the remote number, but not yet connected.
62 */
63 public static final int STATE_DIALING = 1;
64
65 /**
66 * The state of an incoming {@code Call} when ringing locally, but not yet connected.
67 */
68 public static final int STATE_RINGING = 2;
69
70 /**
71 * The state of a {@code Call} when in a holding state.
72 */
73 public static final int STATE_HOLDING = 3;
74
75 /**
76 * The state of a {@code Call} when actively supporting conversation.
77 */
78 public static final int STATE_ACTIVE = 4;
79
80 /**
81 * The state of a {@code Call} when no further voice or other communication is being
82 * transmitted, the remote side has been or will inevitably be informed that the {@code Call}
83 * is no longer active, and the local data transport has or inevitably will release resources
84 * associated with this {@code Call}.
85 */
86 public static final int STATE_DISCONNECTED = 7;
87
Nancy Chen5da0fd52014-07-08 14:16:17 -070088 /**
Santos Cordone3c507b2015-04-23 14:44:19 -070089 * The state of an outgoing {@code Call} when waiting on user to select a
90 * {@link PhoneAccount} through which to place the call.
Nancy Chen5da0fd52014-07-08 14:16:17 -070091 */
Santos Cordone3c507b2015-04-23 14:44:19 -070092 public static final int STATE_SELECT_PHONE_ACCOUNT = 8;
93
94 /**
95 * @hide
96 * @deprecated use STATE_SELECT_PHONE_ACCOUNT.
97 */
98 @Deprecated
99 @SystemApi
100 public static final int STATE_PRE_DIAL_WAIT = STATE_SELECT_PHONE_ACCOUNT;
Nancy Chen5da0fd52014-07-08 14:16:17 -0700101
Nancy Chene20930f2014-08-07 16:17:21 -0700102 /**
Nancy Chene9b7a8e2014-08-08 14:26:27 -0700103 * The initial state of an outgoing {@code Call}.
104 * Common transitions are to {@link #STATE_DIALING} state for a successful call or
105 * {@link #STATE_DISCONNECTED} if it failed.
Nancy Chene20930f2014-08-07 16:17:21 -0700106 */
107 public static final int STATE_CONNECTING = 9;
108
Nancy Chen513c8922014-09-17 14:47:20 -0700109 /**
Tyler Gunn4afc6af2014-10-07 10:14:55 -0700110 * The state of a {@code Call} when the user has initiated a disconnection of the call, but the
111 * call has not yet been disconnected by the underlying {@code ConnectionService}. The next
112 * state of the call is (potentially) {@link #STATE_DISCONNECTED}.
113 */
114 public static final int STATE_DISCONNECTING = 10;
115
116 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700117 * The state of an external call which is in the process of being pulled from a remote device to
118 * the local device.
119 * <p>
120 * A call can only be in this state if the {@link Details#PROPERTY_IS_EXTERNAL_CALL} property
121 * and {@link Details#CAPABILITY_CAN_PULL_CALL} capability are set on the call.
122 * <p>
123 * An {@link InCallService} will only see this state if it has the
124 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true} in its
125 * manifest.
126 */
127 public static final int STATE_PULLING_CALL = 11;
128
129 /**
Hall Liu6dfa2492019-10-01 17:20:39 -0700130 * The state of a call that is active with the network, but the audio from the call is
131 * being intercepted by an app on the local device. Telecom does not hold audio focus in this
132 * state, and the call will be invisible to the user except for a persistent notification.
133 */
134 public static final int STATE_AUDIO_PROCESSING = 12;
135
136 /**
137 * The state of a call that is being presented to the user after being in
138 * {@link #STATE_AUDIO_PROCESSING}. The call is still active with the network in this case, and
139 * Telecom will hold audio focus and play a ringtone if appropriate.
140 */
141 public static final int STATE_SIMULATED_RINGING = 13;
142
143 /**
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700144 * @hide
145 */
146 @IntDef(prefix = { "STATE_" },
147 value = {
148 STATE_NEW,
149 STATE_DIALING,
150 STATE_RINGING,
151 STATE_HOLDING,
152 STATE_ACTIVE,
153 STATE_DISCONNECTED,
154 STATE_SELECT_PHONE_ACCOUNT,
155 STATE_CONNECTING,
156 STATE_DISCONNECTING,
157 STATE_PULLING_CALL,
158 STATE_AUDIO_PROCESSING,
159 STATE_SIMULATED_RINGING
160 })
161 @Retention(RetentionPolicy.SOURCE)
162 public @interface CallState {};
163
164 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700165 * The key to retrieve the optional {@code PhoneAccount}s Telecom can bundle with its Call
166 * extras. Used to pass the phone accounts to display on the front end to the user in order to
167 * select phone accounts to (for example) place a call.
Hall Liu34d9e242018-11-21 17:05:58 -0800168 * @deprecated Use the list from {@link #EXTRA_SUGGESTED_PHONE_ACCOUNTS} instead.
Nancy Chen513c8922014-09-17 14:47:20 -0700169 */
Hall Liu34d9e242018-11-21 17:05:58 -0800170 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -0700171 public static final String AVAILABLE_PHONE_ACCOUNTS = "selectPhoneAccountAccounts";
172
mike dooley4af561f2016-12-20 08:55:17 -0800173 /**
Thomas Stuart5ca875eb2022-08-03 18:39:57 -0700174 * Extra key intended for {@link InCallService}s that notify the user of an incoming call. When
175 * EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB returns true, the {@link InCallService} should not
176 * interrupt the user of the incoming call because the call is being suppressed by Do Not
177 * Disturb settings.
178 *
179 * This extra will be removed from the {@link Call} object for {@link InCallService}s that do
180 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
181 */
182 public static final String EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB =
183 "android.telecom.extra.IS_SUPPRESSED_BY_DO_NOT_DISTURB";
184
185 /**
Hall Liu34d9e242018-11-21 17:05:58 -0800186 * Key for extra used to pass along a list of {@link PhoneAccountSuggestion}s to the in-call
187 * UI when a call enters the {@link #STATE_SELECT_PHONE_ACCOUNT} state. The list included here
188 * will have the same length and be in the same order as the list passed with
189 * {@link #AVAILABLE_PHONE_ACCOUNTS}.
190 */
191 public static final String EXTRA_SUGGESTED_PHONE_ACCOUNTS =
192 "android.telecom.extra.SUGGESTED_PHONE_ACCOUNTS";
193
194 /**
mike dooley91217422017-03-09 12:58:42 -0800195 * Extra key used to indicate the time (in milliseconds since midnight, January 1, 1970 UTC)
196 * when the last outgoing emergency call was made. This is used to identify potential emergency
197 * callbacks.
mike dooley4af561f2016-12-20 08:55:17 -0800198 */
199 public static final String EXTRA_LAST_EMERGENCY_CALLBACK_TIME_MILLIS =
200 "android.telecom.extra.LAST_EMERGENCY_CALLBACK_TIME_MILLIS";
201
Usman Abdullahb0dc29a2019-03-06 15:54:56 -0800202
203 /**
204 * Extra key used to indicate whether a {@link CallScreeningService} has requested to silence
205 * the ringtone for a call. If the {@link InCallService} declares
206 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in its manifest, it should not
207 * play a ringtone for an incoming call with this extra key set.
208 */
209 public static final String EXTRA_SILENT_RINGING_REQUESTED =
210 "android.telecom.extra.SILENT_RINGING_REQUESTED";
211
Tyler Gunn8bf76572017-04-06 15:30:08 -0700212 /**
213 * Call event sent from a {@link Call} via {@link #sendCallEvent(String, Bundle)} to inform
214 * Telecom that the user has requested that the current {@link Call} should be handed over
215 * to another {@link ConnectionService}.
216 * <p>
217 * The caller must specify the {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE} to indicate to
218 * Telecom which {@link PhoneAccountHandle} the {@link Call} should be handed over to.
219 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700220 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
221 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700222 */
223 public static final String EVENT_REQUEST_HANDOVER =
224 "android.telecom.event.REQUEST_HANDOVER";
225
226 /**
227 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
228 * {@link PhoneAccountHandle} to which a call should be handed over to.
229 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700230 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
231 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700232 */
233 public static final String EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE =
234 "android.telecom.extra.HANDOVER_PHONE_ACCOUNT_HANDLE";
235
236 /**
237 * Integer extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
238 * video state of the call when it is handed over to the new {@link PhoneAccount}.
239 * <p>
240 * Valid values: {@link VideoProfile#STATE_AUDIO_ONLY},
241 * {@link VideoProfile#STATE_BIDIRECTIONAL}, {@link VideoProfile#STATE_RX_ENABLED}, and
242 * {@link VideoProfile#STATE_TX_ENABLED}.
243 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700244 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
245 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700246 */
247 public static final String EXTRA_HANDOVER_VIDEO_STATE =
248 "android.telecom.extra.HANDOVER_VIDEO_STATE";
249
250 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700251 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Used by the
252 * {@link InCallService} initiating a handover to provide a {@link Bundle} with extra
253 * information to the handover {@link ConnectionService} specified by
254 * {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE}.
255 * <p>
256 * This {@link Bundle} is not interpreted by Telecom, but passed as-is to the
257 * {@link ConnectionService} via the request extras when
258 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
259 * is called to initate the handover.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700260 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700261 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
262 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700263 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700264 public static final String EXTRA_HANDOVER_EXTRAS = "android.telecom.extra.HANDOVER_EXTRAS";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700265
266 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700267 * Call event sent from Telecom to the handover {@link ConnectionService} via
268 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
269 * to the {@link ConnectionService} has completed successfully.
270 * <p>
271 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700272 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700273 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
274 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700275 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700276 public static final String EVENT_HANDOVER_COMPLETE =
277 "android.telecom.event.HANDOVER_COMPLETE";
Tyler Gunn34a2b312017-06-23 08:32:00 -0700278
279 /**
280 * Call event sent from Telecom to the handover destination {@link ConnectionService} via
281 * {@link Connection#onCallEvent(String, Bundle)} to inform the handover destination that the
282 * source connection has disconnected. The {@link Bundle} parameter for the call event will be
283 * {@code null}.
284 * <p>
285 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
286 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700287 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
288 * APIs instead.
Tyler Gunn34a2b312017-06-23 08:32:00 -0700289 */
290 public static final String EVENT_HANDOVER_SOURCE_DISCONNECTED =
291 "android.telecom.event.HANDOVER_SOURCE_DISCONNECTED";
292
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700293 /**
294 * Call event sent from Telecom to the handover {@link ConnectionService} via
295 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
296 * to the {@link ConnectionService} has failed.
297 * <p>
298 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
299 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700300 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
301 * APIs instead.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700302 */
303 public static final String EVENT_HANDOVER_FAILED =
304 "android.telecom.event.HANDOVER_FAILED";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700305
Tyler Gunnd5821842021-02-05 11:12:57 -0800306 /**
307 * Event reported from the Telecom stack to report an in-call diagnostic message which the
308 * dialer app may opt to display to the user. A diagnostic message is used to communicate
309 * scenarios the device has detected which may impact the quality of the ongoing call.
310 * <p>
311 * For example a problem with a bluetooth headset may generate a recommendation for the user to
312 * try using the speakerphone instead, or if the device detects it has entered a poor service
313 * area, the user might be warned so that they can finish their call prior to it dropping.
314 * <p>
315 * A diagnostic message is considered persistent in nature. When the user enters a poor service
316 * area, for example, the accompanying diagnostic message persists until they leave the area
317 * of poor service. Each message is accompanied with a {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID}
318 * which uniquely identifies the diagnostic condition being reported. The framework raises a
319 * call event of type {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE} when the condition reported has
320 * been cleared. The dialer app should display the diagnostic message until it is cleared.
321 * If multiple diagnostic messages are sent with different IDs (which have not yet been cleared)
322 * the dialer app should prioritize the most recently received message, but still provide the
323 * user with a means to review past messages.
324 * <p>
325 * The text of the message is found in {@link #EXTRA_DIAGNOSTIC_MESSAGE} in the form of a human
326 * readable {@link CharSequence} which is intended for display in the call UX.
327 * <p>
328 * The telecom framework audibly notifies the user of the presence of a diagnostic message, so
329 * the dialer app needs only to concern itself with visually displaying the message.
330 * <p>
331 * The dialer app receives this event via
332 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
333 */
334 public static final String EVENT_DISPLAY_DIAGNOSTIC_MESSAGE =
335 "android.telecom.event.DISPLAY_DIAGNOSTIC_MESSAGE";
336
337 /**
338 * Event reported from the telecom framework when a diagnostic message previously raised with
339 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE} has cleared and is no longer pertinent.
340 * <p>
341 * The {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID} indicates the diagnostic message which has been
342 * cleared.
343 * <p>
344 * The dialer app receives this event via
345 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
346 */
347 public static final String EVENT_CLEAR_DIAGNOSTIC_MESSAGE =
348 "android.telecom.event.CLEAR_DIAGNOSTIC_MESSAGE";
349
350 /**
351 * Integer extra representing a message ID for a message posted via
352 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. Used to ensure that the dialer app knows when
353 * the message in question has cleared via {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE}.
354 */
355 public static final String EXTRA_DIAGNOSTIC_MESSAGE_ID =
356 "android.telecom.extra.DIAGNOSTIC_MESSAGE_ID";
357
358 /**
359 * {@link CharSequence} extra used with {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. This is the
360 * diagnostic message the dialer app should display.
361 */
362 public static final String EXTRA_DIAGNOSTIC_MESSAGE =
363 "android.telecom.extra.DIAGNOSTIC_MESSAGE";
Tyler Gunnfacfdee2020-01-23 13:10:37 -0800364
365 /**
366 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
367 * call because they have declined to answer it. This typically means that they are unable
368 * to answer the call at this time and would prefer it be sent to voicemail.
369 */
370 public static final int REJECT_REASON_DECLINED = 1;
371
372 /**
373 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
374 * call because it is an unwanted call. This allows the user to indicate that they are
375 * rejecting a call because it is likely a nuisance call.
376 */
377 public static final int REJECT_REASON_UNWANTED = 2;
378
379 /**
380 * @hide
381 */
382 @IntDef(prefix = { "REJECT_REASON_" },
383 value = {REJECT_REASON_DECLINED, REJECT_REASON_UNWANTED})
384 @Retention(RetentionPolicy.SOURCE)
385 public @interface RejectReason {};
386
Ihab Awade63fadb2014-07-09 21:52:04 -0700387 public static class Details {
Tyler Gunn94f8f112018-12-17 09:56:11 -0800388 /** @hide */
389 @Retention(RetentionPolicy.SOURCE)
390 @IntDef(
391 prefix = { "DIRECTION_" },
392 value = {DIRECTION_UNKNOWN, DIRECTION_INCOMING, DIRECTION_OUTGOING})
393 public @interface CallDirection {}
394
395 /**
396 * Indicates that the call is neither and incoming nor an outgoing call. This can be the
397 * case for calls reported directly by a {@link ConnectionService} in special cases such as
398 * call handovers.
399 */
400 public static final int DIRECTION_UNKNOWN = -1;
401
402 /**
403 * Indicates that the call is an incoming call.
404 */
405 public static final int DIRECTION_INCOMING = 0;
406
407 /**
408 * Indicates that the call is an outgoing call.
409 */
410 public static final int DIRECTION_OUTGOING = 1;
411
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800412 /** Call can currently be put on hold or unheld. */
413 public static final int CAPABILITY_HOLD = 0x00000001;
414
415 /** Call supports the hold feature. */
416 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
417
418 /**
419 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
420 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
421 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
422 * capability allows a merge button to be shown while the conference call is in the foreground
423 * of the in-call UI.
424 * <p>
425 * This is only intended for use by a {@link Conference}.
426 */
427 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
428
429 /**
430 * Calls within a conference can be swapped between foreground and background.
431 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
432 * <p>
433 * This is only intended for use by a {@link Conference}.
434 */
435 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
436
437 /**
438 * @hide
439 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700440 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800441
442 /** Call supports responding via text option. */
443 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
444
445 /** Call can be muted. */
446 public static final int CAPABILITY_MUTE = 0x00000040;
447
448 /**
449 * Call supports conference call management. This capability only applies to {@link Conference}
450 * calls which can have {@link Connection}s as children.
451 */
452 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
453
454 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700455 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800456 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700457 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800458
459 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700460 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800461 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700462 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800463
464 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700465 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800466 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700467 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700468 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800469
470 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700471 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800472 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700473 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
474
475 /**
476 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700477 */
478 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
479
480 /**
481 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700482 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700483 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700484 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800485
486 /**
487 * Call is able to be separated from its parent {@code Conference}, if any.
488 */
489 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
490
491 /**
492 * Call is able to be individually disconnected when in a {@code Conference}.
493 */
494 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
495
496 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500497 * Speed up audio setup for MT call.
498 * @hide
499 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700500 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
501
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700502 /**
503 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700504 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800505 * @deprecated Use {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
506 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL} to indicate for a call
507 * whether or not video calling is supported.
Rekha Kumar07366812015-03-24 16:42:31 -0700508 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800509 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Rekha Kumar07366812015-03-24 16:42:31 -0700510 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
511
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700512 /**
513 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700514 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700515 */
516 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
517
Bryce Lee81901682015-08-28 16:38:02 -0700518 /**
519 * Call sends responses through connection.
520 * @hide
521 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800522 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
523
524 /**
525 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
526 * <p>
527 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
528 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
529 * downgraded from a video call back to a VideoState of
530 * {@link VideoProfile#STATE_AUDIO_ONLY}.
531 * <p>
532 * Intuitively, a call which can be downgraded to audio should also have local and remote
533 * video
534 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
535 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
536 */
537 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700538
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700539 /**
540 * When set for an external call, indicates that this {@code Call} can be pulled from a
541 * remote device to the current device.
542 * <p>
543 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
544 * <p>
545 * An {@link InCallService} will only see calls with this capability if it has the
546 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
547 * in its manifest.
548 * <p>
549 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700550 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700551 */
552 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
553
Pooja Jaind34698d2017-12-28 14:15:31 +0530554 /** Call supports the deflect feature. */
555 public static final int CAPABILITY_SUPPORT_DEFLECT = 0x01000000;
556
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800557 /**
558 * Call supports adding participants to the call via
Grace Jia8587ee52020-07-10 15:42:32 -0700559 * {@link #addConferenceParticipants(List)}. Once participants are added, the call becomes
560 * an adhoc conference call ({@link #PROPERTY_IS_ADHOC_CONFERENCE}).
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800561 */
Ravi Paluri404babb2020-01-23 19:02:44 +0530562 public static final int CAPABILITY_ADD_PARTICIPANT = 0x02000000;
Ravi Palurif4b38e72020-02-05 12:35:41 +0530563
564 /**
565 * When set for a call, indicates that this {@code Call} can be transferred to another
566 * number.
Tyler Gunn460360d2020-07-29 10:21:45 -0700567 * Call supports the confirmed and unconfirmed call transfer feature.
Ravi Palurif4b38e72020-02-05 12:35:41 +0530568 *
569 * @hide
570 */
571 public static final int CAPABILITY_TRANSFER = 0x04000000;
572
573 /**
574 * When set for a call, indicates that this {@code Call} can be transferred to another
575 * ongoing call.
576 * Call supports the consultative call transfer feature.
577 *
578 * @hide
579 */
580 public static final int CAPABILITY_TRANSFER_CONSULTATIVE = 0x08000000;
581
Alvin Dey2f37d772018-05-18 23:16:10 +0530582 /**
583 * Indicates whether the remote party supports RTT or not to the UI.
584 */
585
586 public static final int CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT = 0x10000000;
587
Tyler Gunnd11a3152015-03-18 13:09:14 -0700588 //******************************************************************************************
Alvin Dey2f37d772018-05-18 23:16:10 +0530589 // Next CAPABILITY value: 0x20000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700590 //******************************************************************************************
591
592 /**
593 * Whether the call is currently a conference.
594 */
595 public static final int PROPERTY_CONFERENCE = 0x00000001;
596
597 /**
598 * Whether the call is a generic conference, where we do not know the precise state of
599 * participants in the conference (eg. on CDMA).
600 */
601 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
602
603 /**
604 * Whether the call is made while the device is in emergency callback mode.
605 */
606 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
607
608 /**
609 * Connection is using WIFI.
610 */
611 public static final int PROPERTY_WIFI = 0x00000008;
612
613 /**
Tyler Gunn6b6ae552018-10-11 10:42:10 -0700614 * When set, the UI should indicate to the user that a call is using high definition
615 * audio.
616 * <p>
617 * The underlying {@link ConnectionService} is responsible for reporting this
618 * property. It is important to note that this property is not intended to report the
619 * actual audio codec being used for a Call, but whether the call should be indicated
620 * to the user as high definition.
621 * <p>
622 * The Android Telephony stack reports this property for calls based on a number
623 * of factors, including which audio codec is used and whether a call is using an HD
624 * codec end-to-end. Some mobile operators choose to suppress display of an HD indication,
625 * and in these cases this property will not be set for a call even if the underlying audio
626 * codec is in fact "high definition".
Andrew Lee2378ea72015-04-29 14:38:11 -0700627 */
628 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
629
Tony Maka68dcce2015-12-17 09:31:18 +0000630 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100631 * Whether the call is associated with the work profile.
632 */
633 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
634
635 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700636 * When set, indicates that this {@code Call} does not actually exist locally for the
637 * {@link ConnectionService}.
638 * <p>
639 * Consider, for example, a scenario where a user has two phones with the same phone number.
640 * When a user places a call on one device, the telephony stack can represent that call on
641 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700642 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700643 * <p>
644 * An {@link InCallService} will only see calls with this property if it has the
645 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
646 * in its manifest.
647 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700648 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700649 */
650 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
651
Brad Ebinger15847072016-05-18 11:08:36 -0700652 /**
653 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
654 */
655 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
656
Tyler Gunn24e18332017-02-10 09:42:49 -0800657 /**
658 * Indicates that the call is from a self-managed {@link ConnectionService}.
659 * <p>
660 * See also {@link Connection#PROPERTY_SELF_MANAGED}
661 */
662 public static final int PROPERTY_SELF_MANAGED = 0x00000100;
663
Eric Erfanianec881872017-12-06 16:27:53 -0800664 /**
665 * Indicates the call used Assisted Dialing.
Tyler Gunn5567d742019-10-31 13:04:37 -0700666 *
667 * @see TelecomManager#EXTRA_USE_ASSISTED_DIALING
Eric Erfanianec881872017-12-06 16:27:53 -0800668 */
Tyler Gunnc9503d62020-01-27 10:30:51 -0800669 public static final int PROPERTY_ASSISTED_DIALING = 0x00000200;
Eric Erfanianec881872017-12-06 16:27:53 -0800670
Hall Liue9041242018-02-09 16:40:03 -0800671 /**
672 * Indicates that the call is an RTT call. Use {@link #getRttCall()} to get the
673 * {@link RttCall} object that is used to send and receive text.
674 */
675 public static final int PROPERTY_RTT = 0x00000400;
676
Tyler Gunn5bd90852018-09-21 09:37:07 -0700677 /**
678 * Indicates that the call has been identified as the network as an emergency call. This
679 * property may be set for both incoming and outgoing calls which the network identifies as
680 * emergency calls.
681 */
682 public static final int PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL = 0x00000800;
683
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700684 /**
685 * Indicates that the call is using VoIP audio mode.
686 * <p>
687 * When this property is set, the {@link android.media.AudioManager} audio mode for this
688 * call will be {@link android.media.AudioManager#MODE_IN_COMMUNICATION}. When this
689 * property is not set, the audio mode for this call will be
690 * {@link android.media.AudioManager#MODE_IN_CALL}.
691 * <p>
692 * This property reflects changes made using {@link Connection#setAudioModeIsVoip(boolean)}.
693 * <p>
694 * You can use this property to determine whether an un-answered incoming call or a held
695 * call will use VoIP audio mode (if the call does not currently have focus, the system
696 * audio mode may not reflect the mode the call will use).
697 */
698 public static final int PROPERTY_VOIP_AUDIO_MODE = 0x00001000;
699
Ravi Paluri80aa2142019-12-02 11:57:37 +0530700 /**
701 * Indicates that the call is an adhoc conference call. This property can be set for both
Grace Jia8587ee52020-07-10 15:42:32 -0700702 * incoming and outgoing calls. An adhoc conference call is formed using
703 * {@link #addConferenceParticipants(List)},
704 * {@link TelecomManager#addNewIncomingConference(PhoneAccountHandle, Bundle)}, or
705 * {@link TelecomManager#startConference(List, Bundle)}, rather than by merging existing
706 * call using {@link #conference(Call)}.
Ravi Paluri80aa2142019-12-02 11:57:37 +0530707 */
708 public static final int PROPERTY_IS_ADHOC_CONFERENCE = 0x00002000;
709
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800710 /**
Sooraj Sasindranfa1e57a2021-03-22 13:44:14 -0700711 * Connection is using cross sim technology.
712 * <p>
713 * Indicates that the {@link Connection} is using a cross sim technology which would
714 * register IMS over internet APN of default data subscription.
715 * <p>
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800716 */
717 public static final int PROPERTY_CROSS_SIM = 0x00004000;
718
Grant Menke6ca706b2023-08-23 07:46:09 -0700719 /**
720 * The connection is using transactional call APIs.
721 * <p>
722 * The underlying connection was added as a transactional call via the
723 * {@link TelecomManager#addCall} API.
724 */
Grant Menke417190a2023-08-30 14:39:29 -0700725 @FlaggedApi(Flags.FLAG_VOIP_APP_ACTIONS_SUPPORT)
Grant Menke6ca706b2023-08-23 07:46:09 -0700726 public static final int PROPERTY_IS_TRANSACTIONAL = 0x00008000;
727
Andrew Lee2378ea72015-04-29 14:38:11 -0700728 //******************************************************************************************
Grant Menke6ca706b2023-08-23 07:46:09 -0700729 // Next PROPERTY value: 0x00010000
Tyler Gunnd11a3152015-03-18 13:09:14 -0700730 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800731
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700732 private final @CallState int mState;
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800733 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700734 private final Uri mHandle;
735 private final int mHandlePresentation;
736 private final String mCallerDisplayName;
737 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700738 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700739 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700740 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800741 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700742 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700743 private final long mConnectTimeMillis;
744 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700745 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700746 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700747 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700748 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700749 private final long mCreationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -0800750 private final String mContactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -0800751 private final @CallDirection int mCallDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -0700752 private final @Connection.VerificationStatus int mCallerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -0700753 private final Uri mContactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -0700754
755 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800756 * Whether the supplied capabilities supports the specified capability.
757 *
758 * @param capabilities A bit field of capabilities.
759 * @param capability The capability to check capabilities for.
760 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800761 */
762 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800763 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800764 }
765
766 /**
767 * Whether the capabilities of this {@code Details} supports the specified capability.
768 *
769 * @param capability The capability to check capabilities for.
770 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800771 */
772 public boolean can(int capability) {
773 return can(mCallCapabilities, capability);
774 }
775
776 /**
777 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
778 *
779 * @param capabilities A capability bit field.
780 * @return A human readable string representation.
781 */
782 public static String capabilitiesToString(int capabilities) {
783 StringBuilder builder = new StringBuilder();
784 builder.append("[Capabilities:");
785 if (can(capabilities, CAPABILITY_HOLD)) {
786 builder.append(" CAPABILITY_HOLD");
787 }
788 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
789 builder.append(" CAPABILITY_SUPPORT_HOLD");
790 }
791 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
792 builder.append(" CAPABILITY_MERGE_CONFERENCE");
793 }
794 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
795 builder.append(" CAPABILITY_SWAP_CONFERENCE");
796 }
797 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
798 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
799 }
800 if (can(capabilities, CAPABILITY_MUTE)) {
801 builder.append(" CAPABILITY_MUTE");
802 }
803 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
804 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
805 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700806 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
807 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
808 }
809 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
810 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
811 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700812 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
813 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800814 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700815 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
816 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
817 }
818 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
819 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
820 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800821 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
822 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
823 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700824 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
825 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800826 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500827 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700828 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500829 }
Rekha Kumar07366812015-03-24 16:42:31 -0700830 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
831 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
832 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700833 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
834 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
835 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700836 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
837 builder.append(" CAPABILITY_CAN_PULL_CALL");
838 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530839 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
840 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
841 }
Ravi Paluri404babb2020-01-23 19:02:44 +0530842 if (can(capabilities, CAPABILITY_ADD_PARTICIPANT)) {
843 builder.append(" CAPABILITY_ADD_PARTICIPANT");
844 }
Ravi Palurif4b38e72020-02-05 12:35:41 +0530845 if (can(capabilities, CAPABILITY_TRANSFER)) {
846 builder.append(" CAPABILITY_TRANSFER");
847 }
848 if (can(capabilities, CAPABILITY_TRANSFER_CONSULTATIVE)) {
849 builder.append(" CAPABILITY_TRANSFER_CONSULTATIVE");
850 }
Alvin Dey2f37d772018-05-18 23:16:10 +0530851 if (can(capabilities, CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT)) {
852 builder.append(" CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT");
853 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800854 builder.append("]");
855 return builder.toString();
856 }
857
858 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700859 * Whether the supplied properties includes the specified property.
860 *
861 * @param properties A bit field of properties.
862 * @param property The property to check properties for.
863 * @return Whether the specified property is supported.
864 */
865 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800866 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700867 }
868
869 /**
870 * Whether the properties of this {@code Details} includes the specified property.
871 *
872 * @param property The property to check properties for.
873 * @return Whether the specified property is supported.
874 */
875 public boolean hasProperty(int property) {
876 return hasProperty(mCallProperties, property);
877 }
878
879 /**
880 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
881 *
882 * @param properties A property bit field.
883 * @return A human readable string representation.
884 */
885 public static String propertiesToString(int properties) {
886 StringBuilder builder = new StringBuilder();
887 builder.append("[Properties:");
888 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
889 builder.append(" PROPERTY_CONFERENCE");
890 }
891 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
892 builder.append(" PROPERTY_GENERIC_CONFERENCE");
893 }
894 if (hasProperty(properties, PROPERTY_WIFI)) {
895 builder.append(" PROPERTY_WIFI");
896 }
897 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
898 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
899 }
900 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700901 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700902 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700903 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
904 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
905 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700906 if (hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
Brad Ebinger15847072016-05-18 11:08:36 -0700907 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
908 }
Tyler Gunnc9503d62020-01-27 10:30:51 -0800909 if (hasProperty(properties, PROPERTY_ASSISTED_DIALING)) {
Eric Erfanianec881872017-12-06 16:27:53 -0800910 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
911 }
Tyler Gunn5bd90852018-09-21 09:37:07 -0700912 if (hasProperty(properties, PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL)) {
913 builder.append(" PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL");
914 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700915 if (hasProperty(properties, PROPERTY_RTT)) {
916 builder.append(" PROPERTY_RTT");
917 }
918 if (hasProperty(properties, PROPERTY_VOIP_AUDIO_MODE)) {
919 builder.append(" PROPERTY_VOIP_AUDIO_MODE");
920 }
Ravi Paluri80aa2142019-12-02 11:57:37 +0530921 if (hasProperty(properties, PROPERTY_IS_ADHOC_CONFERENCE)) {
922 builder.append(" PROPERTY_IS_ADHOC_CONFERENCE");
923 }
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800924 if (hasProperty(properties, PROPERTY_CROSS_SIM)) {
925 builder.append(" PROPERTY_CROSS_SIM");
926 }
Grant Menke6ca706b2023-08-23 07:46:09 -0700927 if (hasProperty(properties, PROPERTY_IS_TRANSACTIONAL)) {
928 builder.append(" PROPERTY_IS_TRANSACTIONAL");
929 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700930 builder.append("]");
931 return builder.toString();
932 }
933
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700934 /**
935 * @return the state of the {@link Call} represented by this {@link Call.Details}.
936 */
937 public final @CallState int getState() {
938 return mState;
939 }
940
Grant Menke626dd262023-07-24 15:19:36 -0700941 /**
942 * @return the Telecom identifier associated with this {@link Call} . This is not a stable
943 * identifier and is not guaranteed to be unique across device reboots.
944 */
945 public @NonNull String getId() { return mTelecomCallId; }
946
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800947 /** {@hide} */
Hall Liu31de23d2019-10-11 15:38:29 -0700948 @TestApi
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800949 public String getTelecomCallId() {
950 return mTelecomCallId;
951 }
952
Andrew Lee2378ea72015-04-29 14:38:11 -0700953 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700954 * @return The handle (e.g., phone number) to which the {@code Call} is currently
955 * connected.
956 */
957 public Uri getHandle() {
958 return mHandle;
959 }
960
961 /**
962 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700963 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700964 */
965 public int getHandlePresentation() {
966 return mHandlePresentation;
967 }
968
969 /**
Edgar Arriagae5bec822022-10-14 14:25:43 -0700970 * @return The contact photo URI which corresponds to
971 * {@link android.provider.ContactsContract.PhoneLookup#PHOTO_URI}, or {@code null} if the
972 * lookup is not yet complete, if there's no contacts entry for the caller,
973 * or if the {@link InCallService} does not hold the
974 * {@link android.Manifest.permission#READ_CONTACTS} permission.
975 */
976 public @Nullable Uri getContactPhotoUri() {
977 return mContactPhotoUri;
978 }
979
980 /**
Tyler Gunnd081f042018-12-04 12:56:45 -0800981 * The display name for the caller.
982 * <p>
983 * This is the name as reported by the {@link ConnectionService} associated with this call.
Tyler Gunnd081f042018-12-04 12:56:45 -0800984 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700985 * @return The display name for the caller.
986 */
987 public String getCallerDisplayName() {
988 return mCallerDisplayName;
989 }
990
991 /**
992 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700993 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700994 */
995 public int getCallerDisplayNamePresentation() {
996 return mCallerDisplayNamePresentation;
997 }
998
999 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -07001000 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
1001 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -07001002 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001003 public PhoneAccountHandle getAccountHandle() {
1004 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -07001005 }
1006
1007 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001008 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
1009 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -07001010 */
Ihab Awad5d0410f2014-07-30 10:07:40 -07001011 public int getCallCapabilities() {
1012 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -07001013 }
1014
1015 /**
Andrew Lee2378ea72015-04-29 14:38:11 -07001016 * @return A bitmask of the properties of the {@code Call}, as defined by the various
1017 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -07001018 */
1019 public int getCallProperties() {
1020 return mCallProperties;
1021 }
1022
1023 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -08001024 * @return a bitmask of the audio routes available for the call.
1025 *
1026 * @hide
1027 */
1028 public int getSupportedAudioRoutes() {
1029 return mSupportedAudioRoutes;
1030 }
1031
1032 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001033 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -07001034 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001035 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001036 public DisconnectCause getDisconnectCause() {
1037 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001038 }
1039
1040 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001041 * Returns the time the {@link Call} connected (i.e. became active). This information is
1042 * updated periodically, but user interfaces should not rely on this to display the "call
1043 * time clock". For the time when the call was first added to Telecom, see
1044 * {@link #getCreationTimeMillis()}.
1045 *
1046 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -07001047 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -07001048 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -07001049 return mConnectTimeMillis;
1050 }
1051
1052 /**
1053 * @return Information about any calling gateway the {@code Call} may be using.
1054 */
1055 public GatewayInfo getGatewayInfo() {
1056 return mGatewayInfo;
1057 }
1058
Andrew Lee7a341382014-07-15 17:05:08 -07001059 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -07001060 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -07001061 */
1062 public int getVideoState() {
1063 return mVideoState;
1064 }
1065
Ihab Awad5d0410f2014-07-30 10:07:40 -07001066 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001067 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -07001068 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -07001069 */
1070 public StatusHints getStatusHints() {
1071 return mStatusHints;
1072 }
1073
Nancy Chen10798dc2014-08-08 14:00:25 -07001074 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -07001075 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -07001076 */
1077 public Bundle getExtras() {
1078 return mExtras;
1079 }
1080
Santos Cordon6b7f9552015-05-27 17:21:45 -07001081 /**
1082 * @return The extras used with the original intent to place this call.
1083 */
1084 public Bundle getIntentExtras() {
1085 return mIntentExtras;
1086 }
1087
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001088 /**
1089 * Returns the time when the call was first created and added to Telecom. This is the same
1090 * time that is logged as the start time in the Call Log (see
1091 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
1092 * (became active), see {@link #getConnectTimeMillis()}.
1093 *
1094 * @return The creation time of the call, in millis since the epoch.
1095 */
1096 public long getCreationTimeMillis() {
1097 return mCreationTimeMillis;
1098 }
1099
Tyler Gunnd081f042018-12-04 12:56:45 -08001100 /**
Hall Liuef98bf82020-01-09 15:22:44 -08001101 * Returns the name of the caller on the remote end, as derived from a
1102 * {@link android.provider.ContactsContract} lookup of the call's handle.
1103 * @return The name of the caller, or {@code null} if the lookup is not yet complete, if
1104 * there's no contacts entry for the caller, or if the {@link InCallService} does
1105 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
1106 */
1107 public @Nullable String getContactDisplayName() {
1108 return mContactDisplayName;
1109 }
1110
1111 /**
Tyler Gunn94f8f112018-12-17 09:56:11 -08001112 * Indicates whether the call is an incoming or outgoing call.
1113 * @return The call's direction.
1114 */
1115 public @CallDirection int getCallDirection() {
1116 return mCallDirection;
1117 }
1118
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001119 /**
1120 * Gets the verification status for the phone number of an incoming call as identified in
1121 * ATIS-1000082.
Tyler Gunn9c642492020-10-08 13:37:03 -07001122 * <p>
1123 * For incoming calls, the number verification status indicates whether the device was
1124 * able to verify the authenticity of the calling number using the STIR process outlined
1125 * in ATIS-1000082. {@link Connection#VERIFICATION_STATUS_NOT_VERIFIED} indicates that
1126 * the network was not able to use STIR to verify the caller's number (i.e. nothing is
1127 * known regarding the authenticity of the number.
1128 * {@link Connection#VERIFICATION_STATUS_PASSED} indicates that the network was able to
1129 * use STIR to verify the caller's number. This indicates that the network has a high
1130 * degree of confidence that the incoming call actually originated from the indicated
1131 * number. {@link Connection#VERIFICATION_STATUS_FAILED} indicates that the network's
1132 * STIR verification did not pass. This indicates that the incoming call may not
1133 * actually be from the indicated number. This could occur if, for example, the caller
1134 * is using an impersonated phone number.
1135 * <p>
1136 * A {@link CallScreeningService} can use this information to help determine if an
1137 * incoming call is potentially an unwanted call. A verification status of
1138 * {@link Connection#VERIFICATION_STATUS_FAILED} indicates that an incoming call may not
1139 * actually be from the number indicated on the call (i.e. impersonated number) and that it
1140 * should potentially be blocked. Likewise,
1141 * {@link Connection#VERIFICATION_STATUS_PASSED} can be used as a positive signal to
1142 * help clarify that the incoming call is originating from the indicated number and it
1143 * is less likely to be an undesirable call.
1144 * <p>
1145 * An {@link InCallService} can use this information to provide a visual indicator to the
1146 * user regarding the verification status of a call and to help identify calls from
1147 * potentially impersonated numbers.
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001148 * @return the verification status.
1149 */
1150 public @Connection.VerificationStatus int getCallerNumberVerificationStatus() {
1151 return mCallerNumberVerificationStatus;
1152 }
1153
Ihab Awade63fadb2014-07-09 21:52:04 -07001154 @Override
1155 public boolean equals(Object o) {
1156 if (o instanceof Details) {
1157 Details d = (Details) o;
1158 return
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001159 Objects.equals(mState, d.mState) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001160 Objects.equals(mHandle, d.mHandle) &&
1161 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
1162 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
1163 Objects.equals(mCallerDisplayNamePresentation,
1164 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -07001165 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -07001166 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -07001167 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001168 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001169 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -07001170 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -07001171 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -07001172 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001173 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001174 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
Tyler Gunnd081f042018-12-04 12:56:45 -08001175 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis) &&
Hall Liuef98bf82020-01-09 15:22:44 -08001176 Objects.equals(mContactDisplayName, d.mContactDisplayName) &&
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001177 Objects.equals(mCallDirection, d.mCallDirection) &&
1178 Objects.equals(mCallerNumberVerificationStatus,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001179 d.mCallerNumberVerificationStatus) &&
1180 Objects.equals(mContactPhotoUri, d.mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001181 }
1182 return false;
1183 }
1184
1185 @Override
1186 public int hashCode() {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001187 return Objects.hash(mState,
1188 mHandle,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001189 mHandlePresentation,
1190 mCallerDisplayName,
1191 mCallerDisplayNamePresentation,
1192 mAccountHandle,
1193 mCallCapabilities,
1194 mCallProperties,
1195 mDisconnectCause,
1196 mConnectTimeMillis,
1197 mGatewayInfo,
1198 mVideoState,
1199 mStatusHints,
1200 mExtras,
1201 mIntentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001202 mCreationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001203 mContactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001204 mCallDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001205 mCallerNumberVerificationStatus,
1206 mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001207 }
1208
1209 /** {@hide} */
1210 public Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001211 @CallState int state,
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001212 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -07001213 Uri handle,
1214 int handlePresentation,
1215 String callerDisplayName,
1216 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -07001217 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -07001218 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -07001219 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001220 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -07001221 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -07001222 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -07001223 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -07001224 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -07001225 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001226 Bundle intentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001227 long creationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001228 String contactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001229 int callDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001230 int callerNumberVerificationStatus,
1231 Uri contactPhotoUri) {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001232 mState = state;
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001233 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001234 mHandle = handle;
1235 mHandlePresentation = handlePresentation;
1236 mCallerDisplayName = callerDisplayName;
1237 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -07001238 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -07001239 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -07001240 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001241 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001242 mConnectTimeMillis = connectTimeMillis;
1243 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -07001244 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -07001245 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -07001246 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -07001247 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001248 mCreationTimeMillis = creationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -08001249 mContactDisplayName = contactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -08001250 mCallDirection = callDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001251 mCallerNumberVerificationStatus = callerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -07001252 mContactPhotoUri = contactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -07001253 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001254
1255 /** {@hide} */
1256 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
1257 return new Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001258 parcelableCall.getState(),
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001259 parcelableCall.getId(),
1260 parcelableCall.getHandle(),
1261 parcelableCall.getHandlePresentation(),
1262 parcelableCall.getCallerDisplayName(),
1263 parcelableCall.getCallerDisplayNamePresentation(),
1264 parcelableCall.getAccountHandle(),
1265 parcelableCall.getCapabilities(),
1266 parcelableCall.getProperties(),
1267 parcelableCall.getDisconnectCause(),
1268 parcelableCall.getConnectTimeMillis(),
1269 parcelableCall.getGatewayInfo(),
1270 parcelableCall.getVideoState(),
1271 parcelableCall.getStatusHints(),
1272 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001273 parcelableCall.getIntentExtras(),
Tyler Gunnd081f042018-12-04 12:56:45 -08001274 parcelableCall.getCreationTimeMillis(),
Hall Liuef98bf82020-01-09 15:22:44 -08001275 parcelableCall.getContactDisplayName(),
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001276 parcelableCall.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07001277 parcelableCall.getCallerNumberVerificationStatus(),
1278 parcelableCall.getContactPhotoUri()
1279 );
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001280 }
Santos Cordon3c20d632016-02-25 16:12:35 -08001281
1282 @Override
1283 public String toString() {
1284 StringBuilder sb = new StringBuilder();
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001285 sb.append("[id: ");
1286 sb.append(mTelecomCallId);
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001287 sb.append(", state: ");
1288 sb.append(Call.stateToString(mState));
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001289 sb.append(", pa: ");
Santos Cordon3c20d632016-02-25 16:12:35 -08001290 sb.append(mAccountHandle);
1291 sb.append(", hdl: ");
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001292 sb.append(Log.piiHandle(mHandle));
1293 sb.append(", hdlPres: ");
1294 sb.append(mHandlePresentation);
1295 sb.append(", videoState: ");
1296 sb.append(VideoProfile.videoStateToString(mVideoState));
Santos Cordon3c20d632016-02-25 16:12:35 -08001297 sb.append(", caps: ");
1298 sb.append(capabilitiesToString(mCallCapabilities));
1299 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -07001300 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -08001301 sb.append("]");
1302 return sb.toString();
1303 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001304 }
1305
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001306 /**
1307 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
1308 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
1309 * implementation.
1310 * <p>
1311 * You can handle these callbacks by extending the {@link Callback} class and overriding the
1312 * callbacks that your {@link InCallService} is interested in. The callback methods include the
1313 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
1314 * {@link Callback} implementation, if desired.
1315 * <p>
1316 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
1317 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
1318 * (typically in {@link InCallService#onCallRemoved(Call)}).
1319 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
1320 * reach your implementation of {@link Callback}, so it is important to register your callback
1321 * as soon as your {@link InCallService} is notified of a new call via
1322 * {@link InCallService#onCallAdded(Call)}.
1323 */
Andrew Leeda80c872015-04-15 14:09:50 -07001324 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -07001325 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001326 * @hide
1327 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001328 @IntDef(prefix = { "HANDOVER_" },
1329 value = {HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_NOT_SUPPORTED,
Tyler Gunn5c60d712018-03-16 09:53:44 -07001330 HANDOVER_FAILURE_USER_REJECTED, HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL,
Tyler Gunn9d127732018-03-02 15:45:51 -08001331 HANDOVER_FAILURE_UNKNOWN})
Sanket Padawea8eddd42017-11-03 11:07:35 -07001332 @Retention(RetentionPolicy.SOURCE)
1333 public @interface HandoverFailureErrors {}
1334
1335 /**
1336 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
Tyler Gunn9d127732018-03-02 15:45:51 -08001337 * to handover the call to rejects the handover request.
1338 * <p>
1339 * Will be returned when {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} is called
1340 * and the destination {@link PhoneAccountHandle}'s {@link ConnectionService} returns a
1341 * {@code null} {@link Connection} from
1342 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
1343 * ConnectionRequest)}.
1344 * <p>
1345 * For more information on call handovers, see
1346 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001347 */
1348 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
1349
1350 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001351 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1352 * is initiated but the source or destination app does not support handover.
1353 * <p>
1354 * Will be returned when a handover is requested via
1355 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)} and the destination
1356 * {@link PhoneAccountHandle} does not declare
1357 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}. May also be returned when a handover is
1358 * requested at the {@link PhoneAccountHandle} for the current call (i.e. the source call's
1359 * {@link Details#getAccountHandle()}) does not declare
1360 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}.
1361 * <p>
1362 * For more information on call handovers, see
1363 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001364 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001365 public static final int HANDOVER_FAILURE_NOT_SUPPORTED = 2;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001366
1367 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001368 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the remote
1369 * user rejects the handover request.
1370 * <p>
1371 * For more information on call handovers, see
1372 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001373 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001374 public static final int HANDOVER_FAILURE_USER_REJECTED = 3;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001375
Sanket Padawe85291f62017-12-01 13:59:27 -08001376 /**
1377 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
1378 * is ongoing emergency call.
Tyler Gunn9d127732018-03-02 15:45:51 -08001379 * <p>
1380 * This error code is returned when {@link #handoverTo(PhoneAccountHandle, int, Bundle)} is
1381 * called on an emergency call, or if any other call is an emergency call.
1382 * <p>
1383 * Handovers are not permitted while there are ongoing emergency calls.
1384 * <p>
1385 * For more information on call handovers, see
1386 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawe85291f62017-12-01 13:59:27 -08001387 */
Tyler Gunn5c60d712018-03-16 09:53:44 -07001388 public static final int HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL = 4;
Sanket Padawe85291f62017-12-01 13:59:27 -08001389
Tyler Gunn9d127732018-03-02 15:45:51 -08001390 /**
1391 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1392 * fails for an unknown reason.
1393 * <p>
1394 * For more information on call handovers, see
1395 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
1396 */
1397 public static final int HANDOVER_FAILURE_UNKNOWN = 5;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001398
1399 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001400 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
1401 *
Ihab Awade63fadb2014-07-09 21:52:04 -07001402 * @param call The {@code Call} invoking this method.
1403 * @param state The new state of the {@code Call}.
1404 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001405 public void onStateChanged(Call call, @CallState int state) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001406
1407 /**
1408 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
1409 *
1410 * @param call The {@code Call} invoking this method.
1411 * @param parent The new parent of the {@code Call}.
1412 */
1413 public void onParentChanged(Call call, Call parent) {}
1414
1415 /**
1416 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
1417 *
1418 * @param call The {@code Call} invoking this method.
1419 * @param children The new children of the {@code Call}.
1420 */
1421 public void onChildrenChanged(Call call, List<Call> children) {}
1422
1423 /**
1424 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
1425 *
1426 * @param call The {@code Call} invoking this method.
1427 * @param details A {@code Details} object describing the {@code Call}.
1428 */
1429 public void onDetailsChanged(Call call, Details details) {}
1430
1431 /**
1432 * Invoked when the text messages that can be used as responses to the incoming
1433 * {@code Call} are loaded from the relevant database.
1434 * See {@link #getCannedTextResponses()}.
1435 *
1436 * @param call The {@code Call} invoking this method.
1437 * @param cannedTextResponses The text messages useable as responses.
1438 */
1439 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
1440
1441 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001442 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
1443 * character. This causes the post-dial signals to stop pending user confirmation. An
1444 * implementation should present this choice to the user and invoke
1445 * {@link #postDialContinue(boolean)} when the user makes the choice.
1446 *
1447 * @param call The {@code Call} invoking this method.
1448 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
1449 */
1450 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
1451
1452 /**
Andrew Lee50aca232014-07-22 16:41:54 -07001453 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -07001454 *
1455 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -07001456 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001457 */
Andrew Lee50aca232014-07-22 16:41:54 -07001458 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001459
1460 /**
1461 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
1462 * up their UI for the {@code Call} in response to state transitions. Specifically,
1463 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
1464 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
1465 * clients should wait for this method to be invoked.
1466 *
1467 * @param call The {@code Call} being destroyed.
1468 */
1469 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001470
1471 /**
1472 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
1473 * conferenced.
1474 *
1475 * @param call The {@code Call} being updated.
1476 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
1477 * conferenced.
1478 */
1479 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001480
1481 /**
Tyler Gunn5567d742019-10-31 13:04:37 -07001482 * Invoked when a {@link Call} receives an event from its associated {@link Connection} or
1483 * {@link Conference}.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001484 * <p>
1485 * Where possible, the Call should make an attempt to handle {@link Connection} events which
1486 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1487 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1488 * possible that a {@link ConnectionService} has defined its own Connection events which a
1489 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001490 * <p>
Tyler Gunn5567d742019-10-31 13:04:37 -07001491 * See {@link Connection#sendConnectionEvent(String, Bundle)},
1492 * {@link Conference#sendConferenceEvent(String, Bundle)}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001493 *
1494 * @param call The {@code Call} receiving the event.
1495 * @param event The event.
1496 * @param extras Extras associated with the connection event.
1497 */
1498 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001499
1500 /**
1501 * Invoked when the RTT mode changes for this call.
1502 * @param call The call whose RTT mode has changed.
1503 * @param mode the new RTT mode, one of
1504 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1505 * or {@link RttCall#RTT_MODE_VCO}
1506 */
1507 public void onRttModeChanged(Call call, int mode) {}
1508
1509 /**
1510 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1511 * @param call The call whose RTT status has changed.
1512 * @param enabled whether RTT is now enabled or disabled
1513 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1514 * on, null otherwise.
1515 */
1516 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1517
1518 /**
1519 * Invoked when the remote end of the connection has requested that an RTT communication
1520 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1521 * with the same ID that this method is invoked with.
1522 * @param call The call which the RTT request was placed on
1523 * @param id The ID of the request.
1524 */
1525 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001526
1527 /**
1528 * Invoked when the RTT session failed to initiate for some reason, including rejection
1529 * by the remote party.
Tyler Gunnb9a04962022-02-17 08:23:54 -08001530 * <p>
1531 * This callback will ONLY be invoked to report a failure related to a user initiated
1532 * session modification request (i.e. {@link Call#sendRttRequest()}).
1533 * <p>
1534 * If a call is initiated with {@link TelecomManager#EXTRA_START_CALL_WITH_RTT} specified,
1535 * the availability of RTT can be determined by checking {@link Details#PROPERTY_RTT}
1536 * once the call enters state {@link Details#STATE_ACTIVE}.
1537 *
Hall Liu57006aa2017-02-06 10:49:48 -08001538 * @param call The call which the RTT initiation failure occurred on.
1539 * @param reason One of the status codes defined in
Tyler Gunnb9a04962022-02-17 08:23:54 -08001540 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1541 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
Hall Liu57006aa2017-02-06 10:49:48 -08001542 */
Tyler Gunnb9a04962022-02-17 08:23:54 -08001543 public void onRttInitiationFailure(Call call,
1544 @android.telecom.Connection.RttModifyStatus.RttSessionModifyStatus int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001545
1546 /**
1547 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1548 * has completed successfully.
Tyler Gunn9d127732018-03-02 15:45:51 -08001549 * <p>
1550 * For a full discussion of the handover process and the APIs involved, see
1551 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1552 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001553 * @param call The call which had initiated handover.
1554 */
1555 public void onHandoverComplete(Call call) {}
1556
1557 /**
1558 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1559 * has failed.
Tyler Gunn9d127732018-03-02 15:45:51 -08001560 * <p>
1561 * For a full discussion of the handover process and the APIs involved, see
1562 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1563 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001564 * @param call The call which had initiated handover.
Tyler Gunn9d127732018-03-02 15:45:51 -08001565 * @param failureReason Error reason for failure.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001566 */
1567 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001568 }
1569
1570 /**
1571 * A class that holds the state that describes the state of the RTT channel to the remote
1572 * party, if it is active.
1573 */
1574 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001575 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001576 @Retention(RetentionPolicy.SOURCE)
1577 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1578 public @interface RttAudioMode {}
1579
1580 /**
1581 * For metrics use. Default value in the proto.
1582 * @hide
1583 */
1584 public static final int RTT_MODE_INVALID = 0;
1585
1586 /**
1587 * Indicates that there should be a bidirectional audio stream between the two parties
1588 * on the call.
1589 */
1590 public static final int RTT_MODE_FULL = 1;
1591
1592 /**
1593 * Indicates that the local user should be able to hear the audio stream from the remote
1594 * user, but not vice versa. Equivalent to muting the microphone.
1595 */
1596 public static final int RTT_MODE_HCO = 2;
1597
1598 /**
1599 * Indicates that the remote user should be able to hear the audio stream from the local
1600 * user, but not vice versa. Equivalent to setting the volume to zero.
1601 */
1602 public static final int RTT_MODE_VCO = 3;
1603
1604 private static final int READ_BUFFER_SIZE = 1000;
1605
1606 private InputStreamReader mReceiveStream;
1607 private OutputStreamWriter mTransmitStream;
1608 private int mRttMode;
1609 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001610 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001611 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1612
1613 /**
1614 * @hide
1615 */
Hall Liu57006aa2017-02-06 10:49:48 -08001616 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1617 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1618 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001619 mReceiveStream = receiveStream;
1620 mTransmitStream = transmitStream;
1621 mRttMode = mode;
1622 mInCallAdapter = inCallAdapter;
1623 }
1624
1625 /**
1626 * Returns the current RTT audio mode.
1627 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1628 * {@link #RTT_MODE_HCO}.
1629 */
1630 public int getRttAudioMode() {
1631 return mRttMode;
1632 }
1633
1634 /**
1635 * Sets the RTT audio mode. The requested mode change will be communicated through
1636 * {@link Callback#onRttModeChanged(Call, int)}.
1637 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1638 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1639 */
1640 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001641 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001642 }
1643
1644 /**
1645 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
Hall Liudc46c852020-10-29 16:15:33 -07001646 * RTT transmits text in real-time, this method should be called once for each user action.
1647 * For example, when the user enters text as discrete characters using the keyboard, this
1648 * method should be called once for each character. However, if the user enters text by
1649 * pasting or autocomplete, the entire contents of the pasted or autocompleted text should
1650 * be sent in one call to this method.
Hall Liu95d55872017-01-25 17:12:49 -08001651 *
1652 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1653 * lead to interleaved text.
1654 * @param input The message to send to the remote user.
1655 */
1656 public void write(String input) throws IOException {
1657 mTransmitStream.write(input);
1658 mTransmitStream.flush();
1659 }
1660
1661 /**
1662 * Reads a string from the remote user, blocking if there is no data available. Returns
1663 * {@code null} if the RTT conversation has been terminated and there is no further data
1664 * to read.
1665 *
1666 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1667 * lead to interleaved text.
1668 * @return A string containing text sent by the remote user, or {@code null} if the
1669 * conversation has been terminated or if there was an error while reading.
1670 */
Hall Liub1c8a772017-07-17 17:04:41 -07001671 public String read() {
1672 try {
1673 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1674 if (numRead < 0) {
1675 return null;
1676 }
1677 return new String(mReadBuffer, 0, numRead);
1678 } catch (IOException e) {
1679 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001680 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001681 }
Hall Liuffa4a812017-03-02 16:11:00 -08001682 }
1683
1684 /**
1685 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1686 * be read.
1687 * @return A string containing text entered by the user, or {@code null} if the user has
1688 * not entered any new text yet.
1689 */
1690 public String readImmediately() throws IOException {
1691 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001692 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1693 if (numRead < 0) {
1694 return null;
1695 }
1696 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001697 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001698 return null;
1699 }
1700 }
Hall Liue9041242018-02-09 16:40:03 -08001701
1702 /**
1703 * Closes the underlying file descriptors
1704 * @hide
1705 */
1706 public void close() {
1707 try {
1708 mReceiveStream.close();
1709 } catch (IOException e) {
1710 // ignore
1711 }
1712 try {
1713 mTransmitStream.close();
1714 } catch (IOException e) {
1715 // ignore
1716 }
1717 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001718 }
1719
Andrew Leeda80c872015-04-15 14:09:50 -07001720 /**
1721 * @deprecated Use {@code Call.Callback} instead.
1722 * @hide
1723 */
1724 @Deprecated
1725 @SystemApi
1726 public static abstract class Listener extends Callback { }
1727
Ihab Awade63fadb2014-07-09 21:52:04 -07001728 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001729 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001730 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001731 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001732 private final List<Call> mChildren = new ArrayList<>();
1733 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001734 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001735 private final List<Call> mConferenceableCalls = new ArrayList<>();
1736 private final List<Call> mUnmodifiableConferenceableCalls =
1737 Collections.unmodifiableList(mConferenceableCalls);
1738
Santos Cordon823fd3c2014-08-07 18:35:18 -07001739 private boolean mChildrenCached;
1740 private String mParentId = null;
Hall Liuef98bf82020-01-09 15:22:44 -08001741 private String mActiveGenericConferenceChild = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001742 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001743 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001744 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001745 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001746 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001747 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001748 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001749 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001750 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001751
1752 /**
1753 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1754 *
1755 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1756 * remaining or this {@code Call} is not in a post-dial state.
1757 */
1758 public String getRemainingPostDialSequence() {
1759 return mRemainingPostDialSequence;
1760 }
1761
1762 /**
1763 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001764 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001765 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001766 public void answer(@VideoProfile.VideoState int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001767 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001768 }
1769
1770 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301771 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1772 *
1773 * @param address The address to which the call will be deflected.
1774 */
1775 public void deflect(Uri address) {
1776 mInCallAdapter.deflectCall(mTelecomCallId, address);
1777 }
1778
1779 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001780 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1781 *
1782 * @param rejectWithMessage Whether to reject with a text message.
1783 * @param textMessage An optional text message with which to respond.
1784 */
1785 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001786 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001787 }
1788
1789 /**
Tyler Gunnfacfdee2020-01-23 13:10:37 -08001790 * Instructs the {@link ConnectionService} providing this {@link #STATE_RINGING} call that the
1791 * user has chosen to reject the call and has indicated a reason why the call is being rejected.
1792 *
1793 * @param rejectReason the reason the call is being rejected.
1794 */
1795 public void reject(@RejectReason int rejectReason) {
1796 mInCallAdapter.rejectCall(mTelecomCallId, rejectReason);
1797 }
1798
1799 /**
Ravi Palurif4b38e72020-02-05 12:35:41 +05301800 * Instructs this {@code Call} to be transferred to another number.
1801 *
1802 * @param targetNumber The address to which the call will be transferred.
Tyler Gunn460360d2020-07-29 10:21:45 -07001803 * @param isConfirmationRequired if {@code true} it will initiate a confirmed transfer,
1804 * if {@code false}, it will initiate an unconfirmed transfer.
Ravi Palurif4b38e72020-02-05 12:35:41 +05301805 *
1806 * @hide
1807 */
1808 public void transfer(@NonNull Uri targetNumber, boolean isConfirmationRequired) {
1809 mInCallAdapter.transferCall(mTelecomCallId, targetNumber, isConfirmationRequired);
1810 }
1811
1812 /**
1813 * Instructs this {@code Call} to be transferred to another ongoing call.
1814 * This will initiate CONSULTATIVE transfer.
1815 * @param toCall The other ongoing {@code Call} to which this call will be transferred.
1816 *
1817 * @hide
1818 */
1819 public void transfer(@NonNull android.telecom.Call toCall) {
1820 mInCallAdapter.transferCall(mTelecomCallId, toCall.mTelecomCallId);
1821 }
1822
1823 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001824 * Instructs this {@code Call} to disconnect.
1825 */
1826 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001827 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001828 }
1829
1830 /**
1831 * Instructs this {@code Call} to go on hold.
1832 */
1833 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001834 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001835 }
1836
1837 /**
1838 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1839 */
1840 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001841 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001842 }
1843
1844 /**
Hall Liu6dfa2492019-10-01 17:20:39 -07001845 * Instructs Telecom to put the call into the background audio processing state.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001846 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001847 * This method can be called either when the call is in {@link #STATE_RINGING} or
1848 * {@link #STATE_ACTIVE}. After Telecom acknowledges the request by setting the call's state to
1849 * {@link #STATE_AUDIO_PROCESSING}, your app may setup the audio paths with the audio stack in
1850 * order to capture and play audio on the call stream.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001851 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001852 * This method can only be called by the default dialer app.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001853 * <p>
1854 * Apps built with SDK version {@link android.os.Build.VERSION_CODES#R} or later which are using
1855 * the microphone as part of audio processing should specify the foreground service type using
1856 * the attribute {@link android.R.attr#foregroundServiceType} in the {@link InCallService}
1857 * service element of the app's manifest file.
1858 * The {@link ServiceInfo#FOREGROUND_SERVICE_TYPE_MICROPHONE} attribute should be specified.
1859 * @see <a href="https://developer.android.com/preview/privacy/foreground-service-types">
1860 * the Android Developer Site</a> for more information.
Hall Liu6dfa2492019-10-01 17:20:39 -07001861 * @hide
1862 */
1863 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001864 public void enterBackgroundAudioProcessing() {
1865 if (mState != STATE_ACTIVE && mState != STATE_RINGING) {
1866 throw new IllegalStateException("Call must be active or ringing");
1867 }
1868 mInCallAdapter.enterBackgroundAudioProcessing(mTelecomCallId);
1869 }
1870
1871 /**
1872 * Instructs Telecom to come out of the background audio processing state requested by
1873 * {@link #enterBackgroundAudioProcessing()} or from the call screening service.
1874 *
1875 * This method can only be called when the call is in {@link #STATE_AUDIO_PROCESSING}.
1876 *
1877 * @param shouldRing If true, Telecom will put the call into the
1878 * {@link #STATE_SIMULATED_RINGING} state and notify other apps that there is
1879 * a ringing call. Otherwise, the call will go into {@link #STATE_ACTIVE}
1880 * immediately.
1881 * @hide
1882 */
1883 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001884 public void exitBackgroundAudioProcessing(boolean shouldRing) {
1885 if (mState != STATE_AUDIO_PROCESSING) {
1886 throw new IllegalStateException("Call must in the audio processing state");
1887 }
1888 mInCallAdapter.exitBackgroundAudioProcessing(mTelecomCallId, shouldRing);
1889 }
1890
1891 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001892 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
Tyler Gunn2517d032023-02-06 16:34:54 +00001893 * <p>
1894 * Tones are both played locally for the user to hear and sent to the network to be relayed
1895 * to the remote device.
1896 * <p>
Anton Hansson84d6d752023-10-05 09:46:37 +00001897 * You must ensure that any call to {@link #playDtmfTone(char)} is followed by a matching
Tyler Gunn2517d032023-02-06 16:34:54 +00001898 * call to {@link #stopDtmfTone()} and that each tone is stopped before a new one is started.
1899 * The play and stop commands are relayed to the underlying
1900 * {@link android.telecom.ConnectionService} as executed; implementations may not correctly
1901 * handle out of order commands.
Ihab Awade63fadb2014-07-09 21:52:04 -07001902 *
1903 * @param digit A character representing the DTMF digit for which to play the tone. This
1904 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1905 */
1906 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001907 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001908 }
1909
1910 /**
1911 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1912 * currently playing.
1913 *
1914 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1915 * currently playing, this method will do nothing.
1916 */
1917 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001918 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001919 }
1920
1921 /**
1922 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1923 *
1924 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1925 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001926 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001927 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001928 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1929 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001930 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001931 * {@code Call} will pause playing the tones and notify callbacks via
1932 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001933 * should display to the user an indication of this state and an affordance to continue
1934 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1935 * app should invoke the {@link #postDialContinue(boolean)} method.
1936 *
1937 * @param proceed Whether or not to continue with the post-dial sequence.
1938 */
1939 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001940 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001941 }
1942
1943 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001944 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001945 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001946 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001947 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1948 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001949
1950 }
1951
1952 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001953 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001954 *
1955 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001956 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001957 public void conference(Call callToConferenceWith) {
1958 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001959 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001960 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001961 }
1962
1963 /**
1964 * Instructs this {@code Call} to split from any conference call with which it may be
1965 * connected.
1966 */
1967 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001968 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001969 }
1970
1971 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001972 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001973 */
1974 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001975 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001976 }
1977
1978 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001979 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001980 */
1981 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001982 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001983 }
1984
1985 /**
Ravi Paluri404babb2020-01-23 19:02:44 +05301986 * Pulls participants to existing call by forming a conference call.
1987 * See {@link Details#CAPABILITY_ADD_PARTICIPANT}.
1988 *
1989 * @param participants participants to be pulled to existing call.
1990 */
1991 public void addConferenceParticipants(@NonNull List<Uri> participants) {
1992 mInCallAdapter.addConferenceParticipants(mTelecomCallId, participants);
1993 }
1994
1995 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001996 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1997 * device.
1998 * <p>
1999 * Calls to this method are ignored if the call does not have the
2000 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
2001 * <p>
2002 * An {@link InCallService} will only see calls which support this method if it has the
2003 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
2004 * in its manifest.
2005 */
2006 public void pullExternalCall() {
2007 // If this isn't an external call, ignore the request.
2008 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
2009 return;
2010 }
2011
2012 mInCallAdapter.pullExternalCall(mTelecomCallId);
2013 }
2014
2015 /**
2016 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
2017 * the {@link ConnectionService}.
2018 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07002019 * Call events are used to communicate point in time information from an {@link InCallService}
2020 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
2021 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
2022 * {@link ConnectionService}.
2023 * <p>
2024 * A {@link ConnectionService} can communicate to the {@link InCallService} using
2025 * {@link Connection#sendConnectionEvent(String, Bundle)}.
2026 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002027 * Events are exposed to {@link ConnectionService} implementations via
2028 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
2029 * <p>
2030 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07002031 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
2032 * ignore some events altogether.
2033 * <p>
2034 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
2035 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
2036 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
2037 * they define their own event types in this namespace. When defining a custom event type,
2038 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
2039 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
2040 * <p>
2041 * When defining events and the associated extras, it is important to keep their behavior
2042 * consistent when the associated {@link InCallService} is updated. Support for deprecated
2043 * events/extras should me maintained to ensure backwards compatibility with older
2044 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002045 *
2046 * @param event The connection event.
2047 * @param extras Bundle containing extra information associated with the event.
2048 */
2049 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002050 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002051 }
2052
2053 /**
Hall Liu95d55872017-01-25 17:12:49 -08002054 * Sends an RTT upgrade request to the remote end of the connection. Success is not
2055 * guaranteed, and notification of success will be via the
2056 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2057 */
2058 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08002059 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002060 }
2061
2062 /**
2063 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
2064 * callback.
2065 * The ID used here should be the same as the ID that was received via the callback.
2066 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
2067 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
2068 */
2069 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08002070 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08002071 }
2072
2073 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07002074 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
2075 * by {@code toHandle}. The videoState specified indicates the desired video state after the
2076 * handover.
2077 * <p>
Tyler Gunn9d127732018-03-02 15:45:51 -08002078 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2079 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2080 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2081 * is referred to as the source of the handover, and the video calling app is referred to as the
2082 * destination.
2083 * <p>
2084 * When considering a handover scenario the device this method is called on is considered the
2085 * <em>initiating</em> device (since the user initiates the handover from this device), and the
2086 * other device is considered the <em>receiving</em> device.
2087 * <p>
2088 * When this method is called on the <em>initiating</em> device, the Telecom framework will bind
2089 * to the {@link ConnectionService} defined by the {@code toHandle} {@link PhoneAccountHandle}
2090 * and invoke
2091 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
2092 * ConnectionRequest)} to inform the destination app that a request has been made to handover a
2093 * call to it. The app returns an instance of {@link Connection} to represent the handover call
2094 * At this point the app should display UI to indicate to the user that a call
2095 * handover is in process.
2096 * <p>
2097 * The destination app is responsible for communicating the handover request from the
2098 * <em>initiating</em> device to the <em>receiving</em> device.
2099 * <p>
2100 * When the app on the <em>receiving</em> device receives the handover request, it calls
2101 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)} to continue the handover
2102 * process from the <em>initiating</em> device to the <em>receiving</em> device. At this point
2103 * the destination app on the <em>receiving</em> device should show UI to allow the user to
2104 * choose whether they want to continue their call in the destination app.
2105 * <p>
2106 * When the destination app on the <em>receiving</em> device calls
2107 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)}, Telecom will bind to its
2108 * {@link ConnectionService} and call
2109 * {@link ConnectionService#onCreateIncomingHandoverConnection(PhoneAccountHandle,
2110 * ConnectionRequest)} to inform it of the handover request. The app returns an instance of
2111 * {@link Connection} to represent the handover call.
2112 * <p>
2113 * If the user of the <em>receiving</em> device accepts the handover, the app calls
2114 * {@link Connection#setActive()} to complete the handover process; Telecom will disconnect the
2115 * original call. If the user rejects the handover, the app calls
2116 * {@link Connection#setDisconnected(DisconnectCause)} and specifies a {@link DisconnectCause}
2117 * of {@link DisconnectCause#CANCELED} to indicate that the handover has been cancelled.
2118 * <p>
2119 * Telecom will only allow handovers from {@link PhoneAccount}s which declare
2120 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}. Similarly, the {@link PhoneAccount}
2121 * specified by {@code toHandle} must declare {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}.
2122 * <p>
2123 * Errors in the handover process are reported to the {@link InCallService} via
2124 * {@link Callback#onHandoverFailed(Call, int)}. Errors in the handover process are reported to
2125 * the involved {@link ConnectionService}s via
2126 * {@link ConnectionService#onHandoverFailed(ConnectionRequest, int)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07002127 *
2128 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
2129 * this call to.
Tyler Gunn9d127732018-03-02 15:45:51 -08002130 * @param videoState Indicates the video state desired after the handover (see the
2131 * {@code STATE_*} constants defined in {@link VideoProfile}).
Sanket Padawea8eddd42017-11-03 11:07:35 -07002132 * @param extras Bundle containing extra information to be passed to the
2133 * {@link ConnectionService}
2134 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002135 public void handoverTo(PhoneAccountHandle toHandle, @VideoProfile.VideoState int videoState,
2136 Bundle extras) {
Sanket Padawea8eddd42017-11-03 11:07:35 -07002137 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
2138 }
2139
2140 /**
Hall Liu95d55872017-01-25 17:12:49 -08002141 * Terminate the RTT session on this call. The resulting state change will be notified via
2142 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2143 */
2144 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08002145 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002146 }
2147
2148 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07002149 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
2150 * added.
2151 * <p>
2152 * No assumptions should be made as to how an In-Call UI or service will handle these
2153 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
Tyler Gunn6c100242023-01-09 11:23:18 -08002154 * <p>
2155 * Extras added using this method will be made available to the {@link ConnectionService}
2156 * associated with this {@link Call} and notified via
2157 * {@link Connection#onExtrasChanged(Bundle)}.
2158 * <p>
2159 * Extras added using this method will also be available to other running {@link InCallService}s
2160 * and notified via {@link Call.Callback#onDetailsChanged(Call, Details)}. The extras can be
2161 * accessed via {@link Details#getExtras()}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002162 *
2163 * @param extras The extras to add.
2164 */
2165 public final void putExtras(Bundle extras) {
2166 if (extras == null) {
2167 return;
2168 }
2169
2170 if (mExtras == null) {
2171 mExtras = new Bundle();
2172 }
2173 mExtras.putAll(extras);
2174 mInCallAdapter.putExtras(mTelecomCallId, extras);
2175 }
2176
2177 /**
2178 * Adds a boolean extra to this {@link Call}.
2179 *
2180 * @param key The extra key.
2181 * @param value The value.
2182 * @hide
2183 */
2184 public final void putExtra(String key, boolean value) {
2185 if (mExtras == null) {
2186 mExtras = new Bundle();
2187 }
2188 mExtras.putBoolean(key, value);
2189 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2190 }
2191
2192 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002193 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002194 *
2195 * @param key The extra key.
2196 * @param value The value.
2197 * @hide
2198 */
2199 public final void putExtra(String key, int value) {
2200 if (mExtras == null) {
2201 mExtras = new Bundle();
2202 }
2203 mExtras.putInt(key, value);
2204 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2205 }
2206
2207 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002208 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002209 *
2210 * @param key The extra key.
2211 * @param value The value.
2212 * @hide
2213 */
2214 public final void putExtra(String key, String value) {
2215 if (mExtras == null) {
2216 mExtras = new Bundle();
2217 }
2218 mExtras.putString(key, value);
2219 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2220 }
2221
2222 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002223 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002224 *
2225 * @param keys The keys of the extras to remove.
2226 */
2227 public final void removeExtras(List<String> keys) {
2228 if (mExtras != null) {
2229 for (String key : keys) {
2230 mExtras.remove(key);
2231 }
2232 if (mExtras.size() == 0) {
2233 mExtras = null;
2234 }
2235 }
2236 mInCallAdapter.removeExtras(mTelecomCallId, keys);
2237 }
2238
2239 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002240 * Removes extras from this {@link Call}.
2241 *
2242 * @param keys The keys of the extras to remove.
2243 */
2244 public final void removeExtras(String ... keys) {
2245 removeExtras(Arrays.asList(keys));
2246 }
2247
2248 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002249 * Obtains the parent of this {@code Call} in a conference, if any.
2250 *
2251 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
2252 * child of any conference {@code Call}s.
2253 */
2254 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002255 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002256 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002257 }
2258 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07002259 }
2260
2261 /**
2262 * Obtains the children of this conference {@code Call}, if any.
2263 *
2264 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
2265 * {@code List} otherwise.
2266 */
2267 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002268 if (!mChildrenCached) {
2269 mChildrenCached = true;
2270 mChildren.clear();
2271
2272 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002273 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002274 if (call == null) {
2275 // At least one child was still not found, so do not save true for "cached"
2276 mChildrenCached = false;
2277 } else {
2278 mChildren.add(call);
2279 }
2280 }
2281 }
2282
Ihab Awade63fadb2014-07-09 21:52:04 -07002283 return mUnmodifiableChildren;
2284 }
2285
2286 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002287 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
2288 *
2289 * @return The list of conferenceable {@code Call}s.
2290 */
2291 public List<Call> getConferenceableCalls() {
2292 return mUnmodifiableConferenceableCalls;
2293 }
2294
2295 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002296 * Obtains the state of this {@code Call}.
2297 *
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002298 * @return The call state.
2299 * @deprecated The call state is available via {@link Call.Details#getState()}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002300 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002301 @Deprecated
2302 public @CallState int getState() {
Ihab Awade63fadb2014-07-09 21:52:04 -07002303 return mState;
2304 }
2305
2306 /**
Hall Liuef98bf82020-01-09 15:22:44 -08002307 * Returns the child {@link Call} in a generic conference that is currently active.
Hall Liu135e53aa2020-02-27 18:34:11 -08002308 *
2309 * A "generic conference" is the mechanism used to support two simultaneous calls on a device
2310 * in CDMA networks. It is effectively equivalent to having one call active and one call on hold
2311 * in GSM or IMS calls. This method returns the currently active call.
2312 *
2313 * In a generic conference, the network exposes the conference to us as a single call, and we
2314 * switch between talking to the two participants using a CDMA flash command. Since the network
2315 * exposes no additional information about the call, the only way we know which caller we're
2316 * currently talking to is by keeping track of the flash commands that we've sent to the
2317 * network.
2318 *
Hall Liuef98bf82020-01-09 15:22:44 -08002319 * For calls that are not generic conferences, or when the generic conference has more than
2320 * 2 children, returns {@code null}.
2321 * @see Details#PROPERTY_GENERIC_CONFERENCE
2322 * @return The active child call.
2323 */
2324 public @Nullable Call getGenericConferenceActiveChildCall() {
2325 if (mActiveGenericConferenceChild != null) {
2326 return mPhone.internalGetCallByTelecomId(mActiveGenericConferenceChild);
2327 }
2328 return null;
2329 }
2330
2331 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002332 * Obtains a list of canned, pre-configured message responses to present to the user as
Tyler Gunn434fc2c2020-10-06 14:23:54 -07002333 * ways of rejecting an incoming {@code Call} using via a text message.
2334 * <p>
2335 * <em>Note:</em> Since canned responses may be loaded from the file system, they are not
2336 * guaranteed to be present when this {@link Call} is first added to the {@link InCallService}
2337 * via {@link InCallService#onCallAdded(Call)}. The callback
2338 * {@link Call.Callback#onCannedTextResponsesLoaded(Call, List)} will be called when/if canned
2339 * responses for the call become available.
Ihab Awade63fadb2014-07-09 21:52:04 -07002340 *
2341 * @see #reject(boolean, String)
2342 *
2343 * @return A list of canned text message responses.
2344 */
2345 public List<String> getCannedTextResponses() {
2346 return mCannedTextResponses;
2347 }
2348
2349 /**
2350 * Obtains an object that can be used to display video from this {@code Call}.
2351 *
Andrew Lee50aca232014-07-22 16:41:54 -07002352 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002353 */
Andrew Lee50aca232014-07-22 16:41:54 -07002354 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002355 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07002356 }
2357
2358 /**
2359 * Obtains an object containing call details.
2360 *
2361 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
2362 * result may be {@code null}.
2363 */
2364 public Details getDetails() {
2365 return mDetails;
2366 }
2367
2368 /**
Hall Liu95d55872017-01-25 17:12:49 -08002369 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
2370 * receive RTT text data, as well as to change the RTT mode.
2371 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
2372 */
2373 public @Nullable RttCall getRttCall() {
2374 return mRttCall;
2375 }
2376
2377 /**
2378 * Returns whether this call has an active RTT connection.
2379 * @return true if there is a connection, false otherwise.
2380 */
2381 public boolean isRttActive() {
Hall Liue9041242018-02-09 16:40:03 -08002382 return mRttCall != null && mDetails.hasProperty(Details.PROPERTY_RTT);
Hall Liu95d55872017-01-25 17:12:49 -08002383 }
2384
2385 /**
Andrew Leeda80c872015-04-15 14:09:50 -07002386 * Registers a callback to this {@code Call}.
2387 *
2388 * @param callback A {@code Callback}.
2389 */
2390 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07002391 registerCallback(callback, new Handler());
2392 }
2393
2394 /**
2395 * Registers a callback to this {@code Call}.
2396 *
2397 * @param callback A {@code Callback}.
2398 * @param handler A handler which command and status changes will be delivered to.
2399 */
2400 public void registerCallback(Callback callback, Handler handler) {
2401 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07002402 // Don't allow new callback registration if the call is already being destroyed.
2403 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002404 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
2405 }
Andrew Leeda80c872015-04-15 14:09:50 -07002406 }
2407
2408 /**
2409 * Unregisters a callback from this {@code Call}.
2410 *
2411 * @param callback A {@code Callback}.
2412 */
2413 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07002414 // Don't allow callback deregistration if the call is already being destroyed.
2415 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002416 for (CallbackRecord<Callback> record : mCallbackRecords) {
2417 if (record.getCallback() == callback) {
2418 mCallbackRecords.remove(record);
2419 break;
2420 }
2421 }
Andrew Leeda80c872015-04-15 14:09:50 -07002422 }
2423 }
2424
Santos Cordon3c20d632016-02-25 16:12:35 -08002425 @Override
2426 public String toString() {
2427 return new StringBuilder().
2428 append("Call [id: ").
2429 append(mTelecomCallId).
2430 append(", state: ").
2431 append(stateToString(mState)).
2432 append(", details: ").
2433 append(mDetails).
2434 append("]").toString();
2435 }
2436
2437 /**
2438 * @param state An integer value of a {@code STATE_*} constant.
2439 * @return A string representation of the value.
2440 */
2441 private static String stateToString(int state) {
2442 switch (state) {
2443 case STATE_NEW:
2444 return "NEW";
2445 case STATE_RINGING:
2446 return "RINGING";
2447 case STATE_DIALING:
2448 return "DIALING";
2449 case STATE_ACTIVE:
2450 return "ACTIVE";
2451 case STATE_HOLDING:
2452 return "HOLDING";
2453 case STATE_DISCONNECTED:
2454 return "DISCONNECTED";
2455 case STATE_CONNECTING:
2456 return "CONNECTING";
2457 case STATE_DISCONNECTING:
2458 return "DISCONNECTING";
2459 case STATE_SELECT_PHONE_ACCOUNT:
2460 return "SELECT_PHONE_ACCOUNT";
Hall Liu4e35b642019-10-14 17:50:45 -07002461 case STATE_SIMULATED_RINGING:
2462 return "SIMULATED_RINGING";
2463 case STATE_AUDIO_PROCESSING:
2464 return "AUDIO_PROCESSING";
Santos Cordon3c20d632016-02-25 16:12:35 -08002465 default:
2466 Log.w(Call.class, "Unknown state %d", state);
2467 return "UNKNOWN";
2468 }
2469 }
2470
Andrew Leeda80c872015-04-15 14:09:50 -07002471 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002472 * Adds a listener to this {@code Call}.
2473 *
2474 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002475 * @deprecated Use {@link #registerCallback} instead.
2476 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002477 */
Andrew Leeda80c872015-04-15 14:09:50 -07002478 @Deprecated
2479 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002480 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002481 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002482 }
2483
2484 /**
2485 * Removes a listener from this {@code Call}.
2486 *
2487 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002488 * @deprecated Use {@link #unregisterCallback} instead.
2489 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002490 */
Andrew Leeda80c872015-04-15 14:09:50 -07002491 @Deprecated
2492 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002493 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002494 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002495 }
2496
2497 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08002498 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
2499 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002500 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002501 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002502 mInCallAdapter = inCallAdapter;
2503 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002504 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002505 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07002506 }
2507
2508 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08002509 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08002510 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002511 mPhone = phone;
2512 mTelecomCallId = telecomCallId;
2513 mInCallAdapter = inCallAdapter;
2514 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002515 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002516 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002517 }
2518
2519 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002520 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002521 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002522 }
2523
2524 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002525 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08002526
Ihab Awade63fadb2014-07-09 21:52:04 -07002527 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08002528 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07002529 boolean detailsChanged = !Objects.equals(mDetails, details);
2530 if (detailsChanged) {
2531 mDetails = details;
2532 }
2533
2534 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07002535 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
2536 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
2537 mCannedTextResponses =
2538 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07002539 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07002540 }
2541
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002542 IVideoProvider previousVideoProvider = mVideoCallImpl == null ? null :
2543 mVideoCallImpl.getVideoProvider();
2544 IVideoProvider newVideoProvider = parcelableCall.getVideoProvider();
2545
2546 // parcelableCall.isVideoCallProviderChanged is only true when we have a video provider
2547 // specified; so we should check if the actual IVideoProvider changes as well.
2548 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged()
2549 && !Objects.equals(previousVideoProvider, newVideoProvider);
Andrew Lee50aca232014-07-22 16:41:54 -07002550 if (videoCallChanged) {
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002551 if (mVideoCallImpl != null) {
2552 mVideoCallImpl.destroy();
2553 }
2554 mVideoCallImpl = parcelableCall.isVideoCallProviderChanged() ?
2555 parcelableCall.getVideoCallImpl(mCallingPackage, mTargetSdkVersion) : null;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002556 }
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002557
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002558 if (mVideoCallImpl != null) {
2559 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07002560 }
2561
Santos Cordone3c507b2015-04-23 14:44:19 -07002562 int state = parcelableCall.getState();
Hall Liu31de23d2019-10-11 15:38:29 -07002563 if (mTargetSdkVersion < Phone.SDK_VERSION_R && state == Call.STATE_SIMULATED_RINGING) {
2564 state = Call.STATE_RINGING;
2565 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002566 boolean stateChanged = mState != state;
2567 if (stateChanged) {
2568 mState = state;
2569 }
2570
Santos Cordon823fd3c2014-08-07 18:35:18 -07002571 String parentId = parcelableCall.getParentCallId();
2572 boolean parentChanged = !Objects.equals(mParentId, parentId);
2573 if (parentChanged) {
2574 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002575 }
2576
Santos Cordon823fd3c2014-08-07 18:35:18 -07002577 List<String> childCallIds = parcelableCall.getChildCallIds();
2578 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
2579 if (childrenChanged) {
2580 mChildrenIds.clear();
2581 mChildrenIds.addAll(parcelableCall.getChildCallIds());
2582 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07002583 }
2584
Hall Liuef98bf82020-01-09 15:22:44 -08002585 String activeChildCallId = parcelableCall.getActiveChildCallId();
2586 boolean activeChildChanged = !Objects.equals(activeChildCallId,
2587 mActiveGenericConferenceChild);
2588 if (activeChildChanged) {
2589 mActiveGenericConferenceChild = activeChildCallId;
2590 }
2591
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002592 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
2593 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
2594 for (String otherId : conferenceableCallIds) {
2595 if (callIdMap.containsKey(otherId)) {
2596 conferenceableCalls.add(callIdMap.get(otherId));
2597 }
2598 }
2599
2600 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
2601 mConferenceableCalls.clear();
2602 mConferenceableCalls.addAll(conferenceableCalls);
2603 fireConferenceableCallsChanged();
2604 }
2605
Hall Liu95d55872017-01-25 17:12:49 -08002606 boolean isRttChanged = false;
2607 boolean rttModeChanged = false;
Hall Liue9041242018-02-09 16:40:03 -08002608 if (parcelableCall.getIsRttCallChanged()
2609 && mDetails.hasProperty(Details.PROPERTY_RTT)) {
Hall Liu95d55872017-01-25 17:12:49 -08002610 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
2611 InputStreamReader receiveStream = new InputStreamReader(
2612 new ParcelFileDescriptor.AutoCloseInputStream(
2613 parcelableRttCall.getReceiveStream()),
2614 StandardCharsets.UTF_8);
2615 OutputStreamWriter transmitStream = new OutputStreamWriter(
2616 new ParcelFileDescriptor.AutoCloseOutputStream(
2617 parcelableRttCall.getTransmitStream()),
2618 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08002619 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08002620 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
2621 if (mRttCall == null) {
2622 isRttChanged = true;
2623 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
2624 rttModeChanged = true;
2625 }
2626 mRttCall = newRttCall;
2627 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
2628 && parcelableCall.getIsRttCallChanged()) {
2629 isRttChanged = true;
Tyler Gunn4cd42482021-04-30 16:23:15 -07002630 mRttCall.close();
Hall Liu95d55872017-01-25 17:12:49 -08002631 mRttCall = null;
2632 }
2633
Ihab Awade63fadb2014-07-09 21:52:04 -07002634 // Now we fire updates, ensuring that any client who listens to any of these notifications
2635 // gets the most up-to-date state.
2636
2637 if (stateChanged) {
2638 fireStateChanged(mState);
2639 }
2640 if (detailsChanged) {
2641 fireDetailsChanged(mDetails);
2642 }
2643 if (cannedTextResponsesChanged) {
2644 fireCannedTextResponsesLoaded(mCannedTextResponses);
2645 }
Andrew Lee50aca232014-07-22 16:41:54 -07002646 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002647 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07002648 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07002649 if (parentChanged) {
2650 fireParentChanged(getParent());
2651 }
Hall Liuef98bf82020-01-09 15:22:44 -08002652 if (childrenChanged || activeChildChanged) {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002653 fireChildrenChanged(getChildren());
2654 }
Hall Liu95d55872017-01-25 17:12:49 -08002655 if (isRttChanged) {
2656 fireOnIsRttChanged(mRttCall != null, mRttCall);
2657 }
2658 if (rttModeChanged) {
2659 fireOnRttModeChanged(mRttCall.getRttAudioMode());
2660 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002661
2662 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
2663 // remove ourselves from the Phone. Note that we do this after completing all state updates
2664 // so a client can cleanly transition all their UI to the state appropriate for a
2665 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
qing278fdb12021-10-26 19:05:51 +00002666 // Check if the original state is already disconnected, otherwise onCallRemoved will be
2667 // triggered before onCallAdded.
2668 if (mState == STATE_DISCONNECTED && stateChanged) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002669 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07002670 }
2671 }
2672
2673 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002674 final void internalSetPostDialWait(String remaining) {
2675 mRemainingPostDialSequence = remaining;
2676 firePostDialWait(mRemainingPostDialSequence);
2677 }
2678
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07002679 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07002680 final void internalSetDisconnected() {
2681 if (mState != Call.STATE_DISCONNECTED) {
2682 mState = Call.STATE_DISCONNECTED;
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002683 if (mDetails != null) {
2684 mDetails = new Details(mState,
2685 mDetails.getTelecomCallId(),
2686 mDetails.getHandle(),
2687 mDetails.getHandlePresentation(),
2688 mDetails.getCallerDisplayName(),
2689 mDetails.getCallerDisplayNamePresentation(),
2690 mDetails.getAccountHandle(),
2691 mDetails.getCallCapabilities(),
2692 mDetails.getCallProperties(),
2693 mDetails.getDisconnectCause(),
2694 mDetails.getConnectTimeMillis(),
2695 mDetails.getGatewayInfo(),
2696 mDetails.getVideoState(),
2697 mDetails.getStatusHints(),
2698 mDetails.getExtras(),
2699 mDetails.getIntentExtras(),
2700 mDetails.getCreationTimeMillis(),
2701 mDetails.getContactDisplayName(),
2702 mDetails.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07002703 mDetails.getCallerNumberVerificationStatus(),
2704 mDetails.getContactPhotoUri()
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002705 );
2706 fireDetailsChanged(mDetails);
2707 }
Santos Cordonf30d7e92014-08-26 09:54:33 -07002708 fireStateChanged(mState);
2709 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07002710 }
2711 }
2712
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002713 /** {@hide} */
2714 final void internalOnConnectionEvent(String event, Bundle extras) {
2715 fireOnConnectionEvent(event, extras);
2716 }
2717
Hall Liu95d55872017-01-25 17:12:49 -08002718 /** {@hide} */
2719 final void internalOnRttUpgradeRequest(final int requestId) {
2720 for (CallbackRecord<Callback> record : mCallbackRecords) {
2721 final Call call = this;
2722 final Callback callback = record.getCallback();
2723 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
2724 }
2725 }
2726
Hall Liu57006aa2017-02-06 10:49:48 -08002727 /** @hide */
2728 final void internalOnRttInitiationFailure(int reason) {
2729 for (CallbackRecord<Callback> record : mCallbackRecords) {
2730 final Call call = this;
2731 final Callback callback = record.getCallback();
2732 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
2733 }
2734 }
2735
Sanket Padawe85291f62017-12-01 13:59:27 -08002736 /** {@hide} */
2737 final void internalOnHandoverFailed(int error) {
2738 for (CallbackRecord<Callback> record : mCallbackRecords) {
2739 final Call call = this;
2740 final Callback callback = record.getCallback();
2741 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
2742 }
2743 }
2744
Tyler Gunn858bfaf2018-01-22 15:17:54 -08002745 /** {@hide} */
2746 final void internalOnHandoverComplete() {
2747 for (CallbackRecord<Callback> record : mCallbackRecords) {
2748 final Call call = this;
2749 final Callback callback = record.getCallback();
2750 record.getHandler().post(() -> callback.onHandoverComplete(call));
2751 }
2752 }
2753
Andrew Lee011728f2015-04-23 15:47:06 -07002754 private void fireStateChanged(final int newState) {
2755 for (CallbackRecord<Callback> record : mCallbackRecords) {
2756 final Call call = this;
2757 final Callback callback = record.getCallback();
2758 record.getHandler().post(new Runnable() {
2759 @Override
2760 public void run() {
2761 callback.onStateChanged(call, newState);
2762 }
2763 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002764 }
2765 }
2766
Andrew Lee011728f2015-04-23 15:47:06 -07002767 private void fireParentChanged(final Call newParent) {
2768 for (CallbackRecord<Callback> record : mCallbackRecords) {
2769 final Call call = this;
2770 final Callback callback = record.getCallback();
2771 record.getHandler().post(new Runnable() {
2772 @Override
2773 public void run() {
2774 callback.onParentChanged(call, newParent);
2775 }
2776 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002777 }
2778 }
2779
Andrew Lee011728f2015-04-23 15:47:06 -07002780 private void fireChildrenChanged(final List<Call> children) {
2781 for (CallbackRecord<Callback> record : mCallbackRecords) {
2782 final Call call = this;
2783 final Callback callback = record.getCallback();
2784 record.getHandler().post(new Runnable() {
2785 @Override
2786 public void run() {
2787 callback.onChildrenChanged(call, children);
2788 }
2789 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002790 }
2791 }
2792
Andrew Lee011728f2015-04-23 15:47:06 -07002793 private void fireDetailsChanged(final Details details) {
2794 for (CallbackRecord<Callback> record : mCallbackRecords) {
2795 final Call call = this;
2796 final Callback callback = record.getCallback();
2797 record.getHandler().post(new Runnable() {
2798 @Override
2799 public void run() {
2800 callback.onDetailsChanged(call, details);
2801 }
2802 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002803 }
2804 }
2805
Andrew Lee011728f2015-04-23 15:47:06 -07002806 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2807 for (CallbackRecord<Callback> record : mCallbackRecords) {
2808 final Call call = this;
2809 final Callback callback = record.getCallback();
2810 record.getHandler().post(new Runnable() {
2811 @Override
2812 public void run() {
2813 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2814 }
2815 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002816 }
2817 }
2818
Andrew Lee011728f2015-04-23 15:47:06 -07002819 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2820 for (CallbackRecord<Callback> record : mCallbackRecords) {
2821 final Call call = this;
2822 final Callback callback = record.getCallback();
2823 record.getHandler().post(new Runnable() {
2824 @Override
2825 public void run() {
2826 callback.onVideoCallChanged(call, videoCall);
2827 }
2828 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002829 }
2830 }
2831
Andrew Lee011728f2015-04-23 15:47:06 -07002832 private void firePostDialWait(final String remainingPostDialSequence) {
2833 for (CallbackRecord<Callback> record : mCallbackRecords) {
2834 final Call call = this;
2835 final Callback callback = record.getCallback();
2836 record.getHandler().post(new Runnable() {
2837 @Override
2838 public void run() {
2839 callback.onPostDialWait(call, remainingPostDialSequence);
2840 }
2841 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002842 }
2843 }
2844
2845 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002846 /**
2847 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2848 * onCallRemoved callback, we remove this call from the Phone's record
2849 * only once all of the registered onCallDestroyed callbacks are executed.
2850 * All the callbacks get removed from our records as a part of this operation
2851 * since onCallDestroyed is the final callback.
2852 */
2853 final Call call = this;
2854 if (mCallbackRecords.isEmpty()) {
2855 // No callbacks registered, remove the call from Phone's record.
2856 mPhone.internalRemoveCall(call);
2857 }
2858 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002859 final Callback callback = record.getCallback();
2860 record.getHandler().post(new Runnable() {
2861 @Override
2862 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002863 boolean isFinalRemoval = false;
2864 RuntimeException toThrow = null;
2865 try {
2866 callback.onCallDestroyed(call);
2867 } catch (RuntimeException e) {
2868 toThrow = e;
2869 }
2870 synchronized(Call.this) {
2871 mCallbackRecords.remove(record);
2872 if (mCallbackRecords.isEmpty()) {
2873 isFinalRemoval = true;
2874 }
2875 }
2876 if (isFinalRemoval) {
2877 mPhone.internalRemoveCall(call);
2878 }
2879 if (toThrow != null) {
2880 throw toThrow;
2881 }
Andrew Lee011728f2015-04-23 15:47:06 -07002882 }
2883 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002884 }
2885 }
2886
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002887 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002888 for (CallbackRecord<Callback> record : mCallbackRecords) {
2889 final Call call = this;
2890 final Callback callback = record.getCallback();
2891 record.getHandler().post(new Runnable() {
2892 @Override
2893 public void run() {
2894 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2895 }
2896 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002897 }
2898 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002899
2900 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002901 * Notifies listeners of an incoming connection event.
2902 * <p>
2903 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2904 *
2905 * @param event
2906 * @param extras
2907 */
2908 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2909 for (CallbackRecord<Callback> record : mCallbackRecords) {
2910 final Call call = this;
2911 final Callback callback = record.getCallback();
2912 record.getHandler().post(new Runnable() {
2913 @Override
2914 public void run() {
2915 callback.onConnectionEvent(call, event, extras);
2916 }
2917 });
2918 }
2919 }
2920
2921 /**
Hall Liu95d55872017-01-25 17:12:49 -08002922 * Notifies listeners of an RTT on/off change
2923 *
2924 * @param enabled True if RTT is now enabled, false otherwise
2925 */
2926 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2927 for (CallbackRecord<Callback> record : mCallbackRecords) {
2928 final Call call = this;
2929 final Callback callback = record.getCallback();
2930 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2931 }
2932 }
2933
2934 /**
2935 * Notifies listeners of a RTT mode change
2936 *
2937 * @param mode The new RTT mode
2938 */
2939 private void fireOnRttModeChanged(final int mode) {
2940 for (CallbackRecord<Callback> record : mCallbackRecords) {
2941 final Call call = this;
2942 final Callback callback = record.getCallback();
2943 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2944 }
2945 }
2946
2947 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002948 * Determines if two bundles are equal.
2949 *
2950 * @param bundle The original bundle.
2951 * @param newBundle The bundle to compare with.
2952 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2953 */
2954 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2955 if (bundle == null || newBundle == null) {
2956 return bundle == newBundle;
2957 }
2958
2959 if (bundle.size() != newBundle.size()) {
2960 return false;
2961 }
2962
2963 for(String key : bundle.keySet()) {
2964 if (key != null) {
Grace Jia17005bd2022-05-12 12:49:02 -07002965 if (!newBundle.containsKey(key)) {
2966 return false;
2967 }
qing723dac62022-10-28 03:40:43 +00002968 // In case new call extra contains non-framework class objects, return false to
2969 // force update the call extra
2970 try {
2971 final Object value = bundle.get(key);
2972 final Object newValue = newBundle.get(key);
2973 if (value instanceof Bundle && newValue instanceof Bundle) {
2974 if (!areBundlesEqual((Bundle) value, (Bundle) newValue)) {
2975 return false;
2976 }
2977 }
2978 if (value instanceof byte[] && newValue instanceof byte[]) {
2979 if (!Arrays.equals((byte[]) value, (byte[]) newValue)) {
2980 return false;
2981 }
2982 } else if (!Objects.equals(value, newValue)) {
Grace Jia17005bd2022-05-12 12:49:02 -07002983 return false;
2984 }
qing723dac62022-10-28 03:40:43 +00002985 } catch (BadParcelableException e) {
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002986 return false;
2987 }
2988 }
2989 }
2990 return true;
2991 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002992}