blob: e51696e58f5745d6e0ef9e6b31d72966cc066006 [file] [log] [blame]
Ihab Awade63fadb2014-07-09 21:52:04 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Tyler Gunnef9f6f92014-09-12 22:16:17 -070017package android.telecom;
Ihab Awade63fadb2014-07-09 21:52:04 -070018
Hall Liu95d55872017-01-25 17:12:49 -080019import android.annotation.IntDef;
Ravi Paluri404babb2020-01-23 19:02:44 +053020import android.annotation.NonNull;
Hall Liu95d55872017-01-25 17:12:49 -080021import android.annotation.Nullable;
Andrew Leeda80c872015-04-15 14:09:50 -070022import android.annotation.SystemApi;
Hall Liu6dfa2492019-10-01 17:20:39 -070023import android.annotation.TestApi;
Artur Satayev53ada2a2019-12-10 17:47:56 +000024import android.compat.annotation.UnsupportedAppUsage;
Tyler Gunn460b7d42020-05-15 10:19:32 -070025import android.content.pm.ServiceInfo;
Ihab Awade63fadb2014-07-09 21:52:04 -070026import android.net.Uri;
qing723dac62022-10-28 03:40:43 +000027import android.os.BadParcelableException;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080028import android.os.Build;
Nancy Chen10798dc2014-08-08 14:00:25 -070029import android.os.Bundle;
Andrew Lee011728f2015-04-23 15:47:06 -070030import android.os.Handler;
Hall Liu95d55872017-01-25 17:12:49 -080031import android.os.ParcelFileDescriptor;
Ihab Awade63fadb2014-07-09 21:52:04 -070032
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -080033import com.android.internal.telecom.IVideoProvider;
34
Hall Liu95d55872017-01-25 17:12:49 -080035import java.io.IOException;
36import java.io.InputStreamReader;
37import java.io.OutputStreamWriter;
Hall Liu95d55872017-01-25 17:12:49 -080038import java.lang.annotation.Retention;
39import java.lang.annotation.RetentionPolicy;
40import java.nio.charset.StandardCharsets;
Ihab Awade63fadb2014-07-09 21:52:04 -070041import java.util.ArrayList;
Tyler Gunn071be6f2016-05-10 14:52:33 -070042import java.util.Arrays;
Ihab Awade63fadb2014-07-09 21:52:04 -070043import java.util.Collections;
44import java.util.List;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -070045import java.util.Map;
Ihab Awade63fadb2014-07-09 21:52:04 -070046import java.util.Objects;
Jay Shrauner229e3822014-08-15 09:23:07 -070047import java.util.concurrent.CopyOnWriteArrayList;
Ihab Awade63fadb2014-07-09 21:52:04 -070048
49/**
50 * Represents an ongoing phone call that the in-call app should present to the user.
51 */
52public final class Call {
53 /**
54 * The state of a {@code Call} when newly created.
55 */
56 public static final int STATE_NEW = 0;
57
58 /**
59 * The state of an outgoing {@code Call} when dialing the remote number, but not yet connected.
60 */
61 public static final int STATE_DIALING = 1;
62
63 /**
64 * The state of an incoming {@code Call} when ringing locally, but not yet connected.
65 */
66 public static final int STATE_RINGING = 2;
67
68 /**
69 * The state of a {@code Call} when in a holding state.
70 */
71 public static final int STATE_HOLDING = 3;
72
73 /**
74 * The state of a {@code Call} when actively supporting conversation.
75 */
76 public static final int STATE_ACTIVE = 4;
77
78 /**
79 * The state of a {@code Call} when no further voice or other communication is being
80 * transmitted, the remote side has been or will inevitably be informed that the {@code Call}
81 * is no longer active, and the local data transport has or inevitably will release resources
82 * associated with this {@code Call}.
83 */
84 public static final int STATE_DISCONNECTED = 7;
85
Nancy Chen5da0fd52014-07-08 14:16:17 -070086 /**
Santos Cordone3c507b2015-04-23 14:44:19 -070087 * The state of an outgoing {@code Call} when waiting on user to select a
88 * {@link PhoneAccount} through which to place the call.
Nancy Chen5da0fd52014-07-08 14:16:17 -070089 */
Santos Cordone3c507b2015-04-23 14:44:19 -070090 public static final int STATE_SELECT_PHONE_ACCOUNT = 8;
91
92 /**
93 * @hide
94 * @deprecated use STATE_SELECT_PHONE_ACCOUNT.
95 */
96 @Deprecated
97 @SystemApi
98 public static final int STATE_PRE_DIAL_WAIT = STATE_SELECT_PHONE_ACCOUNT;
Nancy Chen5da0fd52014-07-08 14:16:17 -070099
Nancy Chene20930f2014-08-07 16:17:21 -0700100 /**
Nancy Chene9b7a8e2014-08-08 14:26:27 -0700101 * The initial state of an outgoing {@code Call}.
102 * Common transitions are to {@link #STATE_DIALING} state for a successful call or
103 * {@link #STATE_DISCONNECTED} if it failed.
Nancy Chene20930f2014-08-07 16:17:21 -0700104 */
105 public static final int STATE_CONNECTING = 9;
106
Nancy Chen513c8922014-09-17 14:47:20 -0700107 /**
Tyler Gunn4afc6af2014-10-07 10:14:55 -0700108 * The state of a {@code Call} when the user has initiated a disconnection of the call, but the
109 * call has not yet been disconnected by the underlying {@code ConnectionService}. The next
110 * state of the call is (potentially) {@link #STATE_DISCONNECTED}.
111 */
112 public static final int STATE_DISCONNECTING = 10;
113
114 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700115 * The state of an external call which is in the process of being pulled from a remote device to
116 * the local device.
117 * <p>
118 * A call can only be in this state if the {@link Details#PROPERTY_IS_EXTERNAL_CALL} property
119 * and {@link Details#CAPABILITY_CAN_PULL_CALL} capability are set on the call.
120 * <p>
121 * An {@link InCallService} will only see this state if it has the
122 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true} in its
123 * manifest.
124 */
125 public static final int STATE_PULLING_CALL = 11;
126
127 /**
Hall Liu6dfa2492019-10-01 17:20:39 -0700128 * The state of a call that is active with the network, but the audio from the call is
129 * being intercepted by an app on the local device. Telecom does not hold audio focus in this
130 * state, and the call will be invisible to the user except for a persistent notification.
131 */
132 public static final int STATE_AUDIO_PROCESSING = 12;
133
134 /**
135 * The state of a call that is being presented to the user after being in
136 * {@link #STATE_AUDIO_PROCESSING}. The call is still active with the network in this case, and
137 * Telecom will hold audio focus and play a ringtone if appropriate.
138 */
139 public static final int STATE_SIMULATED_RINGING = 13;
140
141 /**
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700142 * @hide
143 */
144 @IntDef(prefix = { "STATE_" },
145 value = {
146 STATE_NEW,
147 STATE_DIALING,
148 STATE_RINGING,
149 STATE_HOLDING,
150 STATE_ACTIVE,
151 STATE_DISCONNECTED,
152 STATE_SELECT_PHONE_ACCOUNT,
153 STATE_CONNECTING,
154 STATE_DISCONNECTING,
155 STATE_PULLING_CALL,
156 STATE_AUDIO_PROCESSING,
157 STATE_SIMULATED_RINGING
158 })
159 @Retention(RetentionPolicy.SOURCE)
160 public @interface CallState {};
161
162 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700163 * The key to retrieve the optional {@code PhoneAccount}s Telecom can bundle with its Call
164 * extras. Used to pass the phone accounts to display on the front end to the user in order to
165 * select phone accounts to (for example) place a call.
Hall Liu34d9e242018-11-21 17:05:58 -0800166 * @deprecated Use the list from {@link #EXTRA_SUGGESTED_PHONE_ACCOUNTS} instead.
Nancy Chen513c8922014-09-17 14:47:20 -0700167 */
Hall Liu34d9e242018-11-21 17:05:58 -0800168 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -0700169 public static final String AVAILABLE_PHONE_ACCOUNTS = "selectPhoneAccountAccounts";
170
mike dooley4af561f2016-12-20 08:55:17 -0800171 /**
Thomas Stuart5ca875eb2022-08-03 18:39:57 -0700172 * Extra key intended for {@link InCallService}s that notify the user of an incoming call. When
173 * EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB returns true, the {@link InCallService} should not
174 * interrupt the user of the incoming call because the call is being suppressed by Do Not
175 * Disturb settings.
176 *
177 * This extra will be removed from the {@link Call} object for {@link InCallService}s that do
178 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
179 */
180 public static final String EXTRA_IS_SUPPRESSED_BY_DO_NOT_DISTURB =
181 "android.telecom.extra.IS_SUPPRESSED_BY_DO_NOT_DISTURB";
182
183 /**
Hall Liu34d9e242018-11-21 17:05:58 -0800184 * Key for extra used to pass along a list of {@link PhoneAccountSuggestion}s to the in-call
185 * UI when a call enters the {@link #STATE_SELECT_PHONE_ACCOUNT} state. The list included here
186 * will have the same length and be in the same order as the list passed with
187 * {@link #AVAILABLE_PHONE_ACCOUNTS}.
188 */
189 public static final String EXTRA_SUGGESTED_PHONE_ACCOUNTS =
190 "android.telecom.extra.SUGGESTED_PHONE_ACCOUNTS";
191
192 /**
mike dooley91217422017-03-09 12:58:42 -0800193 * Extra key used to indicate the time (in milliseconds since midnight, January 1, 1970 UTC)
194 * when the last outgoing emergency call was made. This is used to identify potential emergency
195 * callbacks.
mike dooley4af561f2016-12-20 08:55:17 -0800196 */
197 public static final String EXTRA_LAST_EMERGENCY_CALLBACK_TIME_MILLIS =
198 "android.telecom.extra.LAST_EMERGENCY_CALLBACK_TIME_MILLIS";
199
Usman Abdullahb0dc29a2019-03-06 15:54:56 -0800200
201 /**
202 * Extra key used to indicate whether a {@link CallScreeningService} has requested to silence
203 * the ringtone for a call. If the {@link InCallService} declares
204 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in its manifest, it should not
205 * play a ringtone for an incoming call with this extra key set.
206 */
207 public static final String EXTRA_SILENT_RINGING_REQUESTED =
208 "android.telecom.extra.SILENT_RINGING_REQUESTED";
209
Tyler Gunn8bf76572017-04-06 15:30:08 -0700210 /**
211 * Call event sent from a {@link Call} via {@link #sendCallEvent(String, Bundle)} to inform
212 * Telecom that the user has requested that the current {@link Call} should be handed over
213 * to another {@link ConnectionService}.
214 * <p>
215 * The caller must specify the {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE} to indicate to
216 * Telecom which {@link PhoneAccountHandle} the {@link Call} should be handed over to.
217 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700218 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
219 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700220 */
221 public static final String EVENT_REQUEST_HANDOVER =
222 "android.telecom.event.REQUEST_HANDOVER";
223
224 /**
225 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
226 * {@link PhoneAccountHandle} to which a call should be handed over to.
227 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700228 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
229 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700230 */
231 public static final String EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE =
232 "android.telecom.extra.HANDOVER_PHONE_ACCOUNT_HANDLE";
233
234 /**
235 * Integer extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
236 * video state of the call when it is handed over to the new {@link PhoneAccount}.
237 * <p>
238 * Valid values: {@link VideoProfile#STATE_AUDIO_ONLY},
239 * {@link VideoProfile#STATE_BIDIRECTIONAL}, {@link VideoProfile#STATE_RX_ENABLED}, and
240 * {@link VideoProfile#STATE_TX_ENABLED}.
241 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700242 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
243 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700244 */
245 public static final String EXTRA_HANDOVER_VIDEO_STATE =
246 "android.telecom.extra.HANDOVER_VIDEO_STATE";
247
248 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700249 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Used by the
250 * {@link InCallService} initiating a handover to provide a {@link Bundle} with extra
251 * information to the handover {@link ConnectionService} specified by
252 * {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE}.
253 * <p>
254 * This {@link Bundle} is not interpreted by Telecom, but passed as-is to the
255 * {@link ConnectionService} via the request extras when
256 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
257 * is called to initate the handover.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700258 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700259 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
260 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700261 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700262 public static final String EXTRA_HANDOVER_EXTRAS = "android.telecom.extra.HANDOVER_EXTRAS";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700263
264 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700265 * Call event sent from Telecom to the handover {@link ConnectionService} via
266 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
267 * to the {@link ConnectionService} has completed successfully.
268 * <p>
269 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700270 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700271 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
272 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700273 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700274 public static final String EVENT_HANDOVER_COMPLETE =
275 "android.telecom.event.HANDOVER_COMPLETE";
Tyler Gunn34a2b312017-06-23 08:32:00 -0700276
277 /**
278 * Call event sent from Telecom to the handover destination {@link ConnectionService} via
279 * {@link Connection#onCallEvent(String, Bundle)} to inform the handover destination that the
280 * source connection has disconnected. The {@link Bundle} parameter for the call event will be
281 * {@code null}.
282 * <p>
283 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
284 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700285 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
286 * APIs instead.
Tyler Gunn34a2b312017-06-23 08:32:00 -0700287 */
288 public static final String EVENT_HANDOVER_SOURCE_DISCONNECTED =
289 "android.telecom.event.HANDOVER_SOURCE_DISCONNECTED";
290
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700291 /**
292 * Call event sent from Telecom to the handover {@link ConnectionService} via
293 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
294 * to the {@link ConnectionService} has failed.
295 * <p>
296 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
297 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700298 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
299 * APIs instead.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700300 */
301 public static final String EVENT_HANDOVER_FAILED =
302 "android.telecom.event.HANDOVER_FAILED";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700303
Tyler Gunnd5821842021-02-05 11:12:57 -0800304 /**
305 * Event reported from the Telecom stack to report an in-call diagnostic message which the
306 * dialer app may opt to display to the user. A diagnostic message is used to communicate
307 * scenarios the device has detected which may impact the quality of the ongoing call.
308 * <p>
309 * For example a problem with a bluetooth headset may generate a recommendation for the user to
310 * try using the speakerphone instead, or if the device detects it has entered a poor service
311 * area, the user might be warned so that they can finish their call prior to it dropping.
312 * <p>
313 * A diagnostic message is considered persistent in nature. When the user enters a poor service
314 * area, for example, the accompanying diagnostic message persists until they leave the area
315 * of poor service. Each message is accompanied with a {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID}
316 * which uniquely identifies the diagnostic condition being reported. The framework raises a
317 * call event of type {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE} when the condition reported has
318 * been cleared. The dialer app should display the diagnostic message until it is cleared.
319 * If multiple diagnostic messages are sent with different IDs (which have not yet been cleared)
320 * the dialer app should prioritize the most recently received message, but still provide the
321 * user with a means to review past messages.
322 * <p>
323 * The text of the message is found in {@link #EXTRA_DIAGNOSTIC_MESSAGE} in the form of a human
324 * readable {@link CharSequence} which is intended for display in the call UX.
325 * <p>
326 * The telecom framework audibly notifies the user of the presence of a diagnostic message, so
327 * the dialer app needs only to concern itself with visually displaying the message.
328 * <p>
329 * The dialer app receives this event via
330 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
331 */
332 public static final String EVENT_DISPLAY_DIAGNOSTIC_MESSAGE =
333 "android.telecom.event.DISPLAY_DIAGNOSTIC_MESSAGE";
334
335 /**
336 * Event reported from the telecom framework when a diagnostic message previously raised with
337 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE} has cleared and is no longer pertinent.
338 * <p>
339 * The {@link #EXTRA_DIAGNOSTIC_MESSAGE_ID} indicates the diagnostic message which has been
340 * cleared.
341 * <p>
342 * The dialer app receives this event via
343 * {@link Call.Callback#onConnectionEvent(Call, String, Bundle)}.
344 */
345 public static final String EVENT_CLEAR_DIAGNOSTIC_MESSAGE =
346 "android.telecom.event.CLEAR_DIAGNOSTIC_MESSAGE";
347
348 /**
349 * Integer extra representing a message ID for a message posted via
350 * {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. Used to ensure that the dialer app knows when
351 * the message in question has cleared via {@link #EVENT_CLEAR_DIAGNOSTIC_MESSAGE}.
352 */
353 public static final String EXTRA_DIAGNOSTIC_MESSAGE_ID =
354 "android.telecom.extra.DIAGNOSTIC_MESSAGE_ID";
355
356 /**
357 * {@link CharSequence} extra used with {@link #EVENT_DISPLAY_DIAGNOSTIC_MESSAGE}. This is the
358 * diagnostic message the dialer app should display.
359 */
360 public static final String EXTRA_DIAGNOSTIC_MESSAGE =
361 "android.telecom.extra.DIAGNOSTIC_MESSAGE";
Tyler Gunnfacfdee2020-01-23 13:10:37 -0800362
363 /**
364 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
365 * call because they have declined to answer it. This typically means that they are unable
366 * to answer the call at this time and would prefer it be sent to voicemail.
367 */
368 public static final int REJECT_REASON_DECLINED = 1;
369
370 /**
371 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
372 * call because it is an unwanted call. This allows the user to indicate that they are
373 * rejecting a call because it is likely a nuisance call.
374 */
375 public static final int REJECT_REASON_UNWANTED = 2;
376
377 /**
378 * @hide
379 */
380 @IntDef(prefix = { "REJECT_REASON_" },
381 value = {REJECT_REASON_DECLINED, REJECT_REASON_UNWANTED})
382 @Retention(RetentionPolicy.SOURCE)
383 public @interface RejectReason {};
384
Ihab Awade63fadb2014-07-09 21:52:04 -0700385 public static class Details {
Tyler Gunn94f8f112018-12-17 09:56:11 -0800386 /** @hide */
387 @Retention(RetentionPolicy.SOURCE)
388 @IntDef(
389 prefix = { "DIRECTION_" },
390 value = {DIRECTION_UNKNOWN, DIRECTION_INCOMING, DIRECTION_OUTGOING})
391 public @interface CallDirection {}
392
393 /**
394 * Indicates that the call is neither and incoming nor an outgoing call. This can be the
395 * case for calls reported directly by a {@link ConnectionService} in special cases such as
396 * call handovers.
397 */
398 public static final int DIRECTION_UNKNOWN = -1;
399
400 /**
401 * Indicates that the call is an incoming call.
402 */
403 public static final int DIRECTION_INCOMING = 0;
404
405 /**
406 * Indicates that the call is an outgoing call.
407 */
408 public static final int DIRECTION_OUTGOING = 1;
409
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800410 /** Call can currently be put on hold or unheld. */
411 public static final int CAPABILITY_HOLD = 0x00000001;
412
413 /** Call supports the hold feature. */
414 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
415
416 /**
417 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
418 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
419 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
420 * capability allows a merge button to be shown while the conference call is in the foreground
421 * of the in-call UI.
422 * <p>
423 * This is only intended for use by a {@link Conference}.
424 */
425 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
426
427 /**
428 * Calls within a conference can be swapped between foreground and background.
429 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
430 * <p>
431 * This is only intended for use by a {@link Conference}.
432 */
433 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
434
435 /**
436 * @hide
437 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700438 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800439
440 /** Call supports responding via text option. */
441 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
442
443 /** Call can be muted. */
444 public static final int CAPABILITY_MUTE = 0x00000040;
445
446 /**
447 * Call supports conference call management. This capability only applies to {@link Conference}
448 * calls which can have {@link Connection}s as children.
449 */
450 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
451
452 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700453 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800454 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700455 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800456
457 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700458 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800459 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700460 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800461
462 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700463 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800464 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700465 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700466 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800467
468 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700469 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800470 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700471 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
472
473 /**
474 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700475 */
476 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
477
478 /**
479 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700480 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700481 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700482 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800483
484 /**
485 * Call is able to be separated from its parent {@code Conference}, if any.
486 */
487 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
488
489 /**
490 * Call is able to be individually disconnected when in a {@code Conference}.
491 */
492 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
493
494 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500495 * Speed up audio setup for MT call.
496 * @hide
497 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700498 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
499
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700500 /**
501 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700502 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800503 * @deprecated Use {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
504 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL} to indicate for a call
505 * whether or not video calling is supported.
Rekha Kumar07366812015-03-24 16:42:31 -0700506 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800507 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Rekha Kumar07366812015-03-24 16:42:31 -0700508 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
509
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700510 /**
511 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700512 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700513 */
514 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
515
Bryce Lee81901682015-08-28 16:38:02 -0700516 /**
517 * Call sends responses through connection.
518 * @hide
519 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800520 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
521
522 /**
523 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
524 * <p>
525 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
526 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
527 * downgraded from a video call back to a VideoState of
528 * {@link VideoProfile#STATE_AUDIO_ONLY}.
529 * <p>
530 * Intuitively, a call which can be downgraded to audio should also have local and remote
531 * video
532 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
533 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
534 */
535 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700536
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700537 /**
538 * When set for an external call, indicates that this {@code Call} can be pulled from a
539 * remote device to the current device.
540 * <p>
541 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
542 * <p>
543 * An {@link InCallService} will only see calls with this capability if it has the
544 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
545 * in its manifest.
546 * <p>
547 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700548 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700549 */
550 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
551
Pooja Jaind34698d2017-12-28 14:15:31 +0530552 /** Call supports the deflect feature. */
553 public static final int CAPABILITY_SUPPORT_DEFLECT = 0x01000000;
554
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800555 /**
556 * Call supports adding participants to the call via
Grace Jia8587ee52020-07-10 15:42:32 -0700557 * {@link #addConferenceParticipants(List)}. Once participants are added, the call becomes
558 * an adhoc conference call ({@link #PROPERTY_IS_ADHOC_CONFERENCE}).
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800559 */
Ravi Paluri404babb2020-01-23 19:02:44 +0530560 public static final int CAPABILITY_ADD_PARTICIPANT = 0x02000000;
Ravi Palurif4b38e72020-02-05 12:35:41 +0530561
562 /**
563 * When set for a call, indicates that this {@code Call} can be transferred to another
564 * number.
Tyler Gunn460360d2020-07-29 10:21:45 -0700565 * Call supports the confirmed and unconfirmed call transfer feature.
Ravi Palurif4b38e72020-02-05 12:35:41 +0530566 *
567 * @hide
568 */
569 public static final int CAPABILITY_TRANSFER = 0x04000000;
570
571 /**
572 * When set for a call, indicates that this {@code Call} can be transferred to another
573 * ongoing call.
574 * Call supports the consultative call transfer feature.
575 *
576 * @hide
577 */
578 public static final int CAPABILITY_TRANSFER_CONSULTATIVE = 0x08000000;
579
Alvin Dey2f37d772018-05-18 23:16:10 +0530580 /**
581 * Indicates whether the remote party supports RTT or not to the UI.
582 */
583
584 public static final int CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT = 0x10000000;
585
Tyler Gunnd11a3152015-03-18 13:09:14 -0700586 //******************************************************************************************
Alvin Dey2f37d772018-05-18 23:16:10 +0530587 // Next CAPABILITY value: 0x20000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700588 //******************************************************************************************
589
590 /**
591 * Whether the call is currently a conference.
592 */
593 public static final int PROPERTY_CONFERENCE = 0x00000001;
594
595 /**
596 * Whether the call is a generic conference, where we do not know the precise state of
597 * participants in the conference (eg. on CDMA).
598 */
599 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
600
601 /**
602 * Whether the call is made while the device is in emergency callback mode.
603 */
604 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
605
606 /**
607 * Connection is using WIFI.
608 */
609 public static final int PROPERTY_WIFI = 0x00000008;
610
611 /**
Tyler Gunn6b6ae552018-10-11 10:42:10 -0700612 * When set, the UI should indicate to the user that a call is using high definition
613 * audio.
614 * <p>
615 * The underlying {@link ConnectionService} is responsible for reporting this
616 * property. It is important to note that this property is not intended to report the
617 * actual audio codec being used for a Call, but whether the call should be indicated
618 * to the user as high definition.
619 * <p>
620 * The Android Telephony stack reports this property for calls based on a number
621 * of factors, including which audio codec is used and whether a call is using an HD
622 * codec end-to-end. Some mobile operators choose to suppress display of an HD indication,
623 * and in these cases this property will not be set for a call even if the underlying audio
624 * codec is in fact "high definition".
Andrew Lee2378ea72015-04-29 14:38:11 -0700625 */
626 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
627
Tony Maka68dcce2015-12-17 09:31:18 +0000628 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100629 * Whether the call is associated with the work profile.
630 */
631 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
632
633 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700634 * When set, indicates that this {@code Call} does not actually exist locally for the
635 * {@link ConnectionService}.
636 * <p>
637 * Consider, for example, a scenario where a user has two phones with the same phone number.
638 * When a user places a call on one device, the telephony stack can represent that call on
639 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700640 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700641 * <p>
642 * An {@link InCallService} will only see calls with this property if it has the
643 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
644 * in its manifest.
645 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700646 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700647 */
648 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
649
Brad Ebinger15847072016-05-18 11:08:36 -0700650 /**
651 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
652 */
653 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
654
Tyler Gunn24e18332017-02-10 09:42:49 -0800655 /**
656 * Indicates that the call is from a self-managed {@link ConnectionService}.
657 * <p>
658 * See also {@link Connection#PROPERTY_SELF_MANAGED}
659 */
660 public static final int PROPERTY_SELF_MANAGED = 0x00000100;
661
Eric Erfanianec881872017-12-06 16:27:53 -0800662 /**
663 * Indicates the call used Assisted Dialing.
Tyler Gunn5567d742019-10-31 13:04:37 -0700664 *
665 * @see TelecomManager#EXTRA_USE_ASSISTED_DIALING
Eric Erfanianec881872017-12-06 16:27:53 -0800666 */
Tyler Gunnc9503d62020-01-27 10:30:51 -0800667 public static final int PROPERTY_ASSISTED_DIALING = 0x00000200;
Eric Erfanianec881872017-12-06 16:27:53 -0800668
Hall Liue9041242018-02-09 16:40:03 -0800669 /**
670 * Indicates that the call is an RTT call. Use {@link #getRttCall()} to get the
671 * {@link RttCall} object that is used to send and receive text.
672 */
673 public static final int PROPERTY_RTT = 0x00000400;
674
Tyler Gunn5bd90852018-09-21 09:37:07 -0700675 /**
676 * Indicates that the call has been identified as the network as an emergency call. This
677 * property may be set for both incoming and outgoing calls which the network identifies as
678 * emergency calls.
679 */
680 public static final int PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL = 0x00000800;
681
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700682 /**
683 * Indicates that the call is using VoIP audio mode.
684 * <p>
685 * When this property is set, the {@link android.media.AudioManager} audio mode for this
686 * call will be {@link android.media.AudioManager#MODE_IN_COMMUNICATION}. When this
687 * property is not set, the audio mode for this call will be
688 * {@link android.media.AudioManager#MODE_IN_CALL}.
689 * <p>
690 * This property reflects changes made using {@link Connection#setAudioModeIsVoip(boolean)}.
691 * <p>
692 * You can use this property to determine whether an un-answered incoming call or a held
693 * call will use VoIP audio mode (if the call does not currently have focus, the system
694 * audio mode may not reflect the mode the call will use).
695 */
696 public static final int PROPERTY_VOIP_AUDIO_MODE = 0x00001000;
697
Ravi Paluri80aa2142019-12-02 11:57:37 +0530698 /**
699 * Indicates that the call is an adhoc conference call. This property can be set for both
Grace Jia8587ee52020-07-10 15:42:32 -0700700 * incoming and outgoing calls. An adhoc conference call is formed using
701 * {@link #addConferenceParticipants(List)},
702 * {@link TelecomManager#addNewIncomingConference(PhoneAccountHandle, Bundle)}, or
703 * {@link TelecomManager#startConference(List, Bundle)}, rather than by merging existing
704 * call using {@link #conference(Call)}.
Ravi Paluri80aa2142019-12-02 11:57:37 +0530705 */
706 public static final int PROPERTY_IS_ADHOC_CONFERENCE = 0x00002000;
707
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800708 /**
Sooraj Sasindranfa1e57a2021-03-22 13:44:14 -0700709 * Connection is using cross sim technology.
710 * <p>
711 * Indicates that the {@link Connection} is using a cross sim technology which would
712 * register IMS over internet APN of default data subscription.
713 * <p>
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800714 */
715 public static final int PROPERTY_CROSS_SIM = 0x00004000;
716
Grant Menke6ca706b2023-08-23 07:46:09 -0700717 /**
718 * The connection is using transactional call APIs.
719 * <p>
720 * The underlying connection was added as a transactional call via the
721 * {@link TelecomManager#addCall} API.
722 */
723 public static final int PROPERTY_IS_TRANSACTIONAL = 0x00008000;
724
Andrew Lee2378ea72015-04-29 14:38:11 -0700725 //******************************************************************************************
Grant Menke6ca706b2023-08-23 07:46:09 -0700726 // Next PROPERTY value: 0x00010000
Tyler Gunnd11a3152015-03-18 13:09:14 -0700727 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800728
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700729 private final @CallState int mState;
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800730 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700731 private final Uri mHandle;
732 private final int mHandlePresentation;
733 private final String mCallerDisplayName;
734 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700735 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700736 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700737 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800738 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700739 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700740 private final long mConnectTimeMillis;
741 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700742 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700743 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700744 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700745 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700746 private final long mCreationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -0800747 private final String mContactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -0800748 private final @CallDirection int mCallDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -0700749 private final @Connection.VerificationStatus int mCallerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -0700750 private final Uri mContactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -0700751
752 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800753 * Whether the supplied capabilities supports the specified capability.
754 *
755 * @param capabilities A bit field of capabilities.
756 * @param capability The capability to check capabilities for.
757 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800758 */
759 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800760 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800761 }
762
763 /**
764 * Whether the capabilities of this {@code Details} supports the specified capability.
765 *
766 * @param capability The capability to check capabilities for.
767 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800768 */
769 public boolean can(int capability) {
770 return can(mCallCapabilities, capability);
771 }
772
773 /**
774 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
775 *
776 * @param capabilities A capability bit field.
777 * @return A human readable string representation.
778 */
779 public static String capabilitiesToString(int capabilities) {
780 StringBuilder builder = new StringBuilder();
781 builder.append("[Capabilities:");
782 if (can(capabilities, CAPABILITY_HOLD)) {
783 builder.append(" CAPABILITY_HOLD");
784 }
785 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
786 builder.append(" CAPABILITY_SUPPORT_HOLD");
787 }
788 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
789 builder.append(" CAPABILITY_MERGE_CONFERENCE");
790 }
791 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
792 builder.append(" CAPABILITY_SWAP_CONFERENCE");
793 }
794 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
795 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
796 }
797 if (can(capabilities, CAPABILITY_MUTE)) {
798 builder.append(" CAPABILITY_MUTE");
799 }
800 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
801 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
802 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700803 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
804 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
805 }
806 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
807 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
808 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700809 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
810 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800811 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700812 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
813 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
814 }
815 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
816 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
817 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800818 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
819 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
820 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700821 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
822 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800823 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500824 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700825 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500826 }
Rekha Kumar07366812015-03-24 16:42:31 -0700827 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
828 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
829 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700830 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
831 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
832 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700833 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
834 builder.append(" CAPABILITY_CAN_PULL_CALL");
835 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530836 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
837 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
838 }
Ravi Paluri404babb2020-01-23 19:02:44 +0530839 if (can(capabilities, CAPABILITY_ADD_PARTICIPANT)) {
840 builder.append(" CAPABILITY_ADD_PARTICIPANT");
841 }
Ravi Palurif4b38e72020-02-05 12:35:41 +0530842 if (can(capabilities, CAPABILITY_TRANSFER)) {
843 builder.append(" CAPABILITY_TRANSFER");
844 }
845 if (can(capabilities, CAPABILITY_TRANSFER_CONSULTATIVE)) {
846 builder.append(" CAPABILITY_TRANSFER_CONSULTATIVE");
847 }
Alvin Dey2f37d772018-05-18 23:16:10 +0530848 if (can(capabilities, CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT)) {
849 builder.append(" CAPABILITY_REMOTE_PARTY_SUPPORTS_RTT");
850 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800851 builder.append("]");
852 return builder.toString();
853 }
854
855 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700856 * Whether the supplied properties includes the specified property.
857 *
858 * @param properties A bit field of properties.
859 * @param property The property to check properties for.
860 * @return Whether the specified property is supported.
861 */
862 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800863 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700864 }
865
866 /**
867 * Whether the properties of this {@code Details} includes the specified property.
868 *
869 * @param property The property to check properties for.
870 * @return Whether the specified property is supported.
871 */
872 public boolean hasProperty(int property) {
873 return hasProperty(mCallProperties, property);
874 }
875
876 /**
877 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
878 *
879 * @param properties A property bit field.
880 * @return A human readable string representation.
881 */
882 public static String propertiesToString(int properties) {
883 StringBuilder builder = new StringBuilder();
884 builder.append("[Properties:");
885 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
886 builder.append(" PROPERTY_CONFERENCE");
887 }
888 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
889 builder.append(" PROPERTY_GENERIC_CONFERENCE");
890 }
891 if (hasProperty(properties, PROPERTY_WIFI)) {
892 builder.append(" PROPERTY_WIFI");
893 }
894 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
895 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
896 }
897 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700898 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700899 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700900 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
901 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
902 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700903 if (hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
Brad Ebinger15847072016-05-18 11:08:36 -0700904 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
905 }
Tyler Gunnc9503d62020-01-27 10:30:51 -0800906 if (hasProperty(properties, PROPERTY_ASSISTED_DIALING)) {
Eric Erfanianec881872017-12-06 16:27:53 -0800907 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
908 }
Tyler Gunn5bd90852018-09-21 09:37:07 -0700909 if (hasProperty(properties, PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL)) {
910 builder.append(" PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL");
911 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700912 if (hasProperty(properties, PROPERTY_RTT)) {
913 builder.append(" PROPERTY_RTT");
914 }
915 if (hasProperty(properties, PROPERTY_VOIP_AUDIO_MODE)) {
916 builder.append(" PROPERTY_VOIP_AUDIO_MODE");
917 }
Ravi Paluri80aa2142019-12-02 11:57:37 +0530918 if (hasProperty(properties, PROPERTY_IS_ADHOC_CONFERENCE)) {
919 builder.append(" PROPERTY_IS_ADHOC_CONFERENCE");
920 }
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800921 if (hasProperty(properties, PROPERTY_CROSS_SIM)) {
922 builder.append(" PROPERTY_CROSS_SIM");
923 }
Grant Menke6ca706b2023-08-23 07:46:09 -0700924 if (hasProperty(properties, PROPERTY_IS_TRANSACTIONAL)) {
925 builder.append(" PROPERTY_IS_TRANSACTIONAL");
926 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700927 builder.append("]");
928 return builder.toString();
929 }
930
Tyler Gunn1e406ca2021-03-18 16:47:14 -0700931 /**
932 * @return the state of the {@link Call} represented by this {@link Call.Details}.
933 */
934 public final @CallState int getState() {
935 return mState;
936 }
937
Grant Menke626dd262023-07-24 15:19:36 -0700938 /**
939 * @return the Telecom identifier associated with this {@link Call} . This is not a stable
940 * identifier and is not guaranteed to be unique across device reboots.
941 */
942 public @NonNull String getId() { return mTelecomCallId; }
943
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800944 /** {@hide} */
Hall Liu31de23d2019-10-11 15:38:29 -0700945 @TestApi
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800946 public String getTelecomCallId() {
947 return mTelecomCallId;
948 }
949
Andrew Lee2378ea72015-04-29 14:38:11 -0700950 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700951 * @return The handle (e.g., phone number) to which the {@code Call} is currently
952 * connected.
953 */
954 public Uri getHandle() {
955 return mHandle;
956 }
957
958 /**
959 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700960 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700961 */
962 public int getHandlePresentation() {
963 return mHandlePresentation;
964 }
965
966 /**
Edgar Arriagae5bec822022-10-14 14:25:43 -0700967 * @return The contact photo URI which corresponds to
968 * {@link android.provider.ContactsContract.PhoneLookup#PHOTO_URI}, or {@code null} if the
969 * lookup is not yet complete, if there's no contacts entry for the caller,
970 * or if the {@link InCallService} does not hold the
971 * {@link android.Manifest.permission#READ_CONTACTS} permission.
972 */
973 public @Nullable Uri getContactPhotoUri() {
974 return mContactPhotoUri;
975 }
976
977 /**
Tyler Gunnd081f042018-12-04 12:56:45 -0800978 * The display name for the caller.
979 * <p>
980 * This is the name as reported by the {@link ConnectionService} associated with this call.
Tyler Gunnd081f042018-12-04 12:56:45 -0800981 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700982 * @return The display name for the caller.
983 */
984 public String getCallerDisplayName() {
985 return mCallerDisplayName;
986 }
987
988 /**
989 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700990 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700991 */
992 public int getCallerDisplayNamePresentation() {
993 return mCallerDisplayNamePresentation;
994 }
995
996 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700997 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
998 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700999 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001000 public PhoneAccountHandle getAccountHandle() {
1001 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -07001002 }
1003
1004 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001005 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
1006 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -07001007 */
Ihab Awad5d0410f2014-07-30 10:07:40 -07001008 public int getCallCapabilities() {
1009 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -07001010 }
1011
1012 /**
Andrew Lee2378ea72015-04-29 14:38:11 -07001013 * @return A bitmask of the properties of the {@code Call}, as defined by the various
1014 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -07001015 */
1016 public int getCallProperties() {
1017 return mCallProperties;
1018 }
1019
1020 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -08001021 * @return a bitmask of the audio routes available for the call.
1022 *
1023 * @hide
1024 */
1025 public int getSupportedAudioRoutes() {
1026 return mSupportedAudioRoutes;
1027 }
1028
1029 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001030 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -07001031 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001032 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001033 public DisconnectCause getDisconnectCause() {
1034 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001035 }
1036
1037 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001038 * Returns the time the {@link Call} connected (i.e. became active). This information is
1039 * updated periodically, but user interfaces should not rely on this to display the "call
1040 * time clock". For the time when the call was first added to Telecom, see
1041 * {@link #getCreationTimeMillis()}.
1042 *
1043 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -07001044 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -07001045 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -07001046 return mConnectTimeMillis;
1047 }
1048
1049 /**
1050 * @return Information about any calling gateway the {@code Call} may be using.
1051 */
1052 public GatewayInfo getGatewayInfo() {
1053 return mGatewayInfo;
1054 }
1055
Andrew Lee7a341382014-07-15 17:05:08 -07001056 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -07001057 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -07001058 */
1059 public int getVideoState() {
1060 return mVideoState;
1061 }
1062
Ihab Awad5d0410f2014-07-30 10:07:40 -07001063 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001064 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -07001065 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -07001066 */
1067 public StatusHints getStatusHints() {
1068 return mStatusHints;
1069 }
1070
Nancy Chen10798dc2014-08-08 14:00:25 -07001071 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -07001072 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -07001073 */
1074 public Bundle getExtras() {
1075 return mExtras;
1076 }
1077
Santos Cordon6b7f9552015-05-27 17:21:45 -07001078 /**
1079 * @return The extras used with the original intent to place this call.
1080 */
1081 public Bundle getIntentExtras() {
1082 return mIntentExtras;
1083 }
1084
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001085 /**
1086 * Returns the time when the call was first created and added to Telecom. This is the same
1087 * time that is logged as the start time in the Call Log (see
1088 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
1089 * (became active), see {@link #getConnectTimeMillis()}.
1090 *
1091 * @return The creation time of the call, in millis since the epoch.
1092 */
1093 public long getCreationTimeMillis() {
1094 return mCreationTimeMillis;
1095 }
1096
Tyler Gunnd081f042018-12-04 12:56:45 -08001097 /**
Hall Liuef98bf82020-01-09 15:22:44 -08001098 * Returns the name of the caller on the remote end, as derived from a
1099 * {@link android.provider.ContactsContract} lookup of the call's handle.
1100 * @return The name of the caller, or {@code null} if the lookup is not yet complete, if
1101 * there's no contacts entry for the caller, or if the {@link InCallService} does
1102 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
1103 */
1104 public @Nullable String getContactDisplayName() {
1105 return mContactDisplayName;
1106 }
1107
1108 /**
Tyler Gunn94f8f112018-12-17 09:56:11 -08001109 * Indicates whether the call is an incoming or outgoing call.
1110 * @return The call's direction.
1111 */
1112 public @CallDirection int getCallDirection() {
1113 return mCallDirection;
1114 }
1115
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001116 /**
1117 * Gets the verification status for the phone number of an incoming call as identified in
1118 * ATIS-1000082.
Tyler Gunn9c642492020-10-08 13:37:03 -07001119 * <p>
1120 * For incoming calls, the number verification status indicates whether the device was
1121 * able to verify the authenticity of the calling number using the STIR process outlined
1122 * in ATIS-1000082. {@link Connection#VERIFICATION_STATUS_NOT_VERIFIED} indicates that
1123 * the network was not able to use STIR to verify the caller's number (i.e. nothing is
1124 * known regarding the authenticity of the number.
1125 * {@link Connection#VERIFICATION_STATUS_PASSED} indicates that the network was able to
1126 * use STIR to verify the caller's number. This indicates that the network has a high
1127 * degree of confidence that the incoming call actually originated from the indicated
1128 * number. {@link Connection#VERIFICATION_STATUS_FAILED} indicates that the network's
1129 * STIR verification did not pass. This indicates that the incoming call may not
1130 * actually be from the indicated number. This could occur if, for example, the caller
1131 * is using an impersonated phone number.
1132 * <p>
1133 * A {@link CallScreeningService} can use this information to help determine if an
1134 * incoming call is potentially an unwanted call. A verification status of
1135 * {@link Connection#VERIFICATION_STATUS_FAILED} indicates that an incoming call may not
1136 * actually be from the number indicated on the call (i.e. impersonated number) and that it
1137 * should potentially be blocked. Likewise,
1138 * {@link Connection#VERIFICATION_STATUS_PASSED} can be used as a positive signal to
1139 * help clarify that the incoming call is originating from the indicated number and it
1140 * is less likely to be an undesirable call.
1141 * <p>
1142 * An {@link InCallService} can use this information to provide a visual indicator to the
1143 * user regarding the verification status of a call and to help identify calls from
1144 * potentially impersonated numbers.
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001145 * @return the verification status.
1146 */
1147 public @Connection.VerificationStatus int getCallerNumberVerificationStatus() {
1148 return mCallerNumberVerificationStatus;
1149 }
1150
Ihab Awade63fadb2014-07-09 21:52:04 -07001151 @Override
1152 public boolean equals(Object o) {
1153 if (o instanceof Details) {
1154 Details d = (Details) o;
1155 return
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001156 Objects.equals(mState, d.mState) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001157 Objects.equals(mHandle, d.mHandle) &&
1158 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
1159 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
1160 Objects.equals(mCallerDisplayNamePresentation,
1161 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -07001162 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -07001163 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -07001164 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001165 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001166 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -07001167 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -07001168 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -07001169 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001170 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001171 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
Tyler Gunnd081f042018-12-04 12:56:45 -08001172 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis) &&
Hall Liuef98bf82020-01-09 15:22:44 -08001173 Objects.equals(mContactDisplayName, d.mContactDisplayName) &&
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001174 Objects.equals(mCallDirection, d.mCallDirection) &&
1175 Objects.equals(mCallerNumberVerificationStatus,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001176 d.mCallerNumberVerificationStatus) &&
1177 Objects.equals(mContactPhotoUri, d.mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001178 }
1179 return false;
1180 }
1181
1182 @Override
1183 public int hashCode() {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001184 return Objects.hash(mState,
1185 mHandle,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001186 mHandlePresentation,
1187 mCallerDisplayName,
1188 mCallerDisplayNamePresentation,
1189 mAccountHandle,
1190 mCallCapabilities,
1191 mCallProperties,
1192 mDisconnectCause,
1193 mConnectTimeMillis,
1194 mGatewayInfo,
1195 mVideoState,
1196 mStatusHints,
1197 mExtras,
1198 mIntentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001199 mCreationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001200 mContactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001201 mCallDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001202 mCallerNumberVerificationStatus,
1203 mContactPhotoUri);
Ihab Awade63fadb2014-07-09 21:52:04 -07001204 }
1205
1206 /** {@hide} */
1207 public Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001208 @CallState int state,
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001209 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -07001210 Uri handle,
1211 int handlePresentation,
1212 String callerDisplayName,
1213 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -07001214 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -07001215 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -07001216 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001217 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -07001218 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -07001219 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -07001220 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -07001221 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -07001222 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001223 Bundle intentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001224 long creationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001225 String contactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001226 int callDirection,
Edgar Arriagae5bec822022-10-14 14:25:43 -07001227 int callerNumberVerificationStatus,
1228 Uri contactPhotoUri) {
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001229 mState = state;
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001230 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001231 mHandle = handle;
1232 mHandlePresentation = handlePresentation;
1233 mCallerDisplayName = callerDisplayName;
1234 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -07001235 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -07001236 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -07001237 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001238 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001239 mConnectTimeMillis = connectTimeMillis;
1240 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -07001241 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -07001242 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -07001243 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -07001244 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001245 mCreationTimeMillis = creationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -08001246 mContactDisplayName = contactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -08001247 mCallDirection = callDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001248 mCallerNumberVerificationStatus = callerNumberVerificationStatus;
Edgar Arriagae5bec822022-10-14 14:25:43 -07001249 mContactPhotoUri = contactPhotoUri;
Ihab Awade63fadb2014-07-09 21:52:04 -07001250 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001251
1252 /** {@hide} */
1253 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
1254 return new Details(
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001255 parcelableCall.getState(),
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001256 parcelableCall.getId(),
1257 parcelableCall.getHandle(),
1258 parcelableCall.getHandlePresentation(),
1259 parcelableCall.getCallerDisplayName(),
1260 parcelableCall.getCallerDisplayNamePresentation(),
1261 parcelableCall.getAccountHandle(),
1262 parcelableCall.getCapabilities(),
1263 parcelableCall.getProperties(),
1264 parcelableCall.getDisconnectCause(),
1265 parcelableCall.getConnectTimeMillis(),
1266 parcelableCall.getGatewayInfo(),
1267 parcelableCall.getVideoState(),
1268 parcelableCall.getStatusHints(),
1269 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001270 parcelableCall.getIntentExtras(),
Tyler Gunnd081f042018-12-04 12:56:45 -08001271 parcelableCall.getCreationTimeMillis(),
Hall Liuef98bf82020-01-09 15:22:44 -08001272 parcelableCall.getContactDisplayName(),
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001273 parcelableCall.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07001274 parcelableCall.getCallerNumberVerificationStatus(),
1275 parcelableCall.getContactPhotoUri()
1276 );
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001277 }
Santos Cordon3c20d632016-02-25 16:12:35 -08001278
1279 @Override
1280 public String toString() {
1281 StringBuilder sb = new StringBuilder();
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001282 sb.append("[id: ");
1283 sb.append(mTelecomCallId);
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001284 sb.append(", state: ");
1285 sb.append(Call.stateToString(mState));
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001286 sb.append(", pa: ");
Santos Cordon3c20d632016-02-25 16:12:35 -08001287 sb.append(mAccountHandle);
1288 sb.append(", hdl: ");
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001289 sb.append(Log.piiHandle(mHandle));
1290 sb.append(", hdlPres: ");
1291 sb.append(mHandlePresentation);
1292 sb.append(", videoState: ");
1293 sb.append(VideoProfile.videoStateToString(mVideoState));
Santos Cordon3c20d632016-02-25 16:12:35 -08001294 sb.append(", caps: ");
1295 sb.append(capabilitiesToString(mCallCapabilities));
1296 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -07001297 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -08001298 sb.append("]");
1299 return sb.toString();
1300 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001301 }
1302
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001303 /**
1304 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
1305 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
1306 * implementation.
1307 * <p>
1308 * You can handle these callbacks by extending the {@link Callback} class and overriding the
1309 * callbacks that your {@link InCallService} is interested in. The callback methods include the
1310 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
1311 * {@link Callback} implementation, if desired.
1312 * <p>
1313 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
1314 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
1315 * (typically in {@link InCallService#onCallRemoved(Call)}).
1316 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
1317 * reach your implementation of {@link Callback}, so it is important to register your callback
1318 * as soon as your {@link InCallService} is notified of a new call via
1319 * {@link InCallService#onCallAdded(Call)}.
1320 */
Andrew Leeda80c872015-04-15 14:09:50 -07001321 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -07001322 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001323 * @hide
1324 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001325 @IntDef(prefix = { "HANDOVER_" },
1326 value = {HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_NOT_SUPPORTED,
Tyler Gunn5c60d712018-03-16 09:53:44 -07001327 HANDOVER_FAILURE_USER_REJECTED, HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL,
Tyler Gunn9d127732018-03-02 15:45:51 -08001328 HANDOVER_FAILURE_UNKNOWN})
Sanket Padawea8eddd42017-11-03 11:07:35 -07001329 @Retention(RetentionPolicy.SOURCE)
1330 public @interface HandoverFailureErrors {}
1331
1332 /**
1333 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
Tyler Gunn9d127732018-03-02 15:45:51 -08001334 * to handover the call to rejects the handover request.
1335 * <p>
1336 * Will be returned when {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} is called
1337 * and the destination {@link PhoneAccountHandle}'s {@link ConnectionService} returns a
1338 * {@code null} {@link Connection} from
1339 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
1340 * ConnectionRequest)}.
1341 * <p>
1342 * For more information on call handovers, see
1343 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001344 */
1345 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
1346
1347 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001348 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1349 * is initiated but the source or destination app does not support handover.
1350 * <p>
1351 * Will be returned when a handover is requested via
1352 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)} and the destination
1353 * {@link PhoneAccountHandle} does not declare
1354 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}. May also be returned when a handover is
1355 * requested at the {@link PhoneAccountHandle} for the current call (i.e. the source call's
1356 * {@link Details#getAccountHandle()}) does not declare
1357 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}.
1358 * <p>
1359 * For more information on call handovers, see
1360 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001361 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001362 public static final int HANDOVER_FAILURE_NOT_SUPPORTED = 2;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001363
1364 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001365 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the remote
1366 * user rejects the handover request.
1367 * <p>
1368 * For more information on call handovers, see
1369 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001370 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001371 public static final int HANDOVER_FAILURE_USER_REJECTED = 3;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001372
Sanket Padawe85291f62017-12-01 13:59:27 -08001373 /**
1374 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
1375 * is ongoing emergency call.
Tyler Gunn9d127732018-03-02 15:45:51 -08001376 * <p>
1377 * This error code is returned when {@link #handoverTo(PhoneAccountHandle, int, Bundle)} is
1378 * called on an emergency call, or if any other call is an emergency call.
1379 * <p>
1380 * Handovers are not permitted while there are ongoing emergency calls.
1381 * <p>
1382 * For more information on call handovers, see
1383 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawe85291f62017-12-01 13:59:27 -08001384 */
Tyler Gunn5c60d712018-03-16 09:53:44 -07001385 public static final int HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL = 4;
Sanket Padawe85291f62017-12-01 13:59:27 -08001386
Tyler Gunn9d127732018-03-02 15:45:51 -08001387 /**
1388 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1389 * fails for an unknown reason.
1390 * <p>
1391 * For more information on call handovers, see
1392 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
1393 */
1394 public static final int HANDOVER_FAILURE_UNKNOWN = 5;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001395
1396 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001397 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
1398 *
Ihab Awade63fadb2014-07-09 21:52:04 -07001399 * @param call The {@code Call} invoking this method.
1400 * @param state The new state of the {@code Call}.
1401 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07001402 public void onStateChanged(Call call, @CallState int state) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001403
1404 /**
1405 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
1406 *
1407 * @param call The {@code Call} invoking this method.
1408 * @param parent The new parent of the {@code Call}.
1409 */
1410 public void onParentChanged(Call call, Call parent) {}
1411
1412 /**
1413 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
1414 *
1415 * @param call The {@code Call} invoking this method.
1416 * @param children The new children of the {@code Call}.
1417 */
1418 public void onChildrenChanged(Call call, List<Call> children) {}
1419
1420 /**
1421 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
1422 *
1423 * @param call The {@code Call} invoking this method.
1424 * @param details A {@code Details} object describing the {@code Call}.
1425 */
1426 public void onDetailsChanged(Call call, Details details) {}
1427
1428 /**
1429 * Invoked when the text messages that can be used as responses to the incoming
1430 * {@code Call} are loaded from the relevant database.
1431 * See {@link #getCannedTextResponses()}.
1432 *
1433 * @param call The {@code Call} invoking this method.
1434 * @param cannedTextResponses The text messages useable as responses.
1435 */
1436 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
1437
1438 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001439 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
1440 * character. This causes the post-dial signals to stop pending user confirmation. An
1441 * implementation should present this choice to the user and invoke
1442 * {@link #postDialContinue(boolean)} when the user makes the choice.
1443 *
1444 * @param call The {@code Call} invoking this method.
1445 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
1446 */
1447 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
1448
1449 /**
Andrew Lee50aca232014-07-22 16:41:54 -07001450 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -07001451 *
1452 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -07001453 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001454 */
Andrew Lee50aca232014-07-22 16:41:54 -07001455 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001456
1457 /**
1458 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
1459 * up their UI for the {@code Call} in response to state transitions. Specifically,
1460 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
1461 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
1462 * clients should wait for this method to be invoked.
1463 *
1464 * @param call The {@code Call} being destroyed.
1465 */
1466 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001467
1468 /**
1469 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
1470 * conferenced.
1471 *
1472 * @param call The {@code Call} being updated.
1473 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
1474 * conferenced.
1475 */
1476 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001477
1478 /**
Tyler Gunn5567d742019-10-31 13:04:37 -07001479 * Invoked when a {@link Call} receives an event from its associated {@link Connection} or
1480 * {@link Conference}.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001481 * <p>
1482 * Where possible, the Call should make an attempt to handle {@link Connection} events which
1483 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1484 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1485 * possible that a {@link ConnectionService} has defined its own Connection events which a
1486 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001487 * <p>
Tyler Gunn5567d742019-10-31 13:04:37 -07001488 * See {@link Connection#sendConnectionEvent(String, Bundle)},
1489 * {@link Conference#sendConferenceEvent(String, Bundle)}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001490 *
1491 * @param call The {@code Call} receiving the event.
1492 * @param event The event.
1493 * @param extras Extras associated with the connection event.
1494 */
1495 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001496
1497 /**
1498 * Invoked when the RTT mode changes for this call.
1499 * @param call The call whose RTT mode has changed.
1500 * @param mode the new RTT mode, one of
1501 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1502 * or {@link RttCall#RTT_MODE_VCO}
1503 */
1504 public void onRttModeChanged(Call call, int mode) {}
1505
1506 /**
1507 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1508 * @param call The call whose RTT status has changed.
1509 * @param enabled whether RTT is now enabled or disabled
1510 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1511 * on, null otherwise.
1512 */
1513 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1514
1515 /**
1516 * Invoked when the remote end of the connection has requested that an RTT communication
1517 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1518 * with the same ID that this method is invoked with.
1519 * @param call The call which the RTT request was placed on
1520 * @param id The ID of the request.
1521 */
1522 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001523
1524 /**
1525 * Invoked when the RTT session failed to initiate for some reason, including rejection
1526 * by the remote party.
Tyler Gunnb9a04962022-02-17 08:23:54 -08001527 * <p>
1528 * This callback will ONLY be invoked to report a failure related to a user initiated
1529 * session modification request (i.e. {@link Call#sendRttRequest()}).
1530 * <p>
1531 * If a call is initiated with {@link TelecomManager#EXTRA_START_CALL_WITH_RTT} specified,
1532 * the availability of RTT can be determined by checking {@link Details#PROPERTY_RTT}
1533 * once the call enters state {@link Details#STATE_ACTIVE}.
1534 *
Hall Liu57006aa2017-02-06 10:49:48 -08001535 * @param call The call which the RTT initiation failure occurred on.
1536 * @param reason One of the status codes defined in
Tyler Gunnb9a04962022-02-17 08:23:54 -08001537 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1538 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
Hall Liu57006aa2017-02-06 10:49:48 -08001539 */
Tyler Gunnb9a04962022-02-17 08:23:54 -08001540 public void onRttInitiationFailure(Call call,
1541 @android.telecom.Connection.RttModifyStatus.RttSessionModifyStatus int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001542
1543 /**
1544 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1545 * has completed successfully.
Tyler Gunn9d127732018-03-02 15:45:51 -08001546 * <p>
1547 * For a full discussion of the handover process and the APIs involved, see
1548 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1549 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001550 * @param call The call which had initiated handover.
1551 */
1552 public void onHandoverComplete(Call call) {}
1553
1554 /**
1555 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1556 * has failed.
Tyler Gunn9d127732018-03-02 15:45:51 -08001557 * <p>
1558 * For a full discussion of the handover process and the APIs involved, see
1559 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1560 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001561 * @param call The call which had initiated handover.
Tyler Gunn9d127732018-03-02 15:45:51 -08001562 * @param failureReason Error reason for failure.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001563 */
1564 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001565 }
1566
1567 /**
1568 * A class that holds the state that describes the state of the RTT channel to the remote
1569 * party, if it is active.
1570 */
1571 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001572 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001573 @Retention(RetentionPolicy.SOURCE)
1574 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1575 public @interface RttAudioMode {}
1576
1577 /**
1578 * For metrics use. Default value in the proto.
1579 * @hide
1580 */
1581 public static final int RTT_MODE_INVALID = 0;
1582
1583 /**
1584 * Indicates that there should be a bidirectional audio stream between the two parties
1585 * on the call.
1586 */
1587 public static final int RTT_MODE_FULL = 1;
1588
1589 /**
1590 * Indicates that the local user should be able to hear the audio stream from the remote
1591 * user, but not vice versa. Equivalent to muting the microphone.
1592 */
1593 public static final int RTT_MODE_HCO = 2;
1594
1595 /**
1596 * Indicates that the remote user should be able to hear the audio stream from the local
1597 * user, but not vice versa. Equivalent to setting the volume to zero.
1598 */
1599 public static final int RTT_MODE_VCO = 3;
1600
1601 private static final int READ_BUFFER_SIZE = 1000;
1602
1603 private InputStreamReader mReceiveStream;
1604 private OutputStreamWriter mTransmitStream;
1605 private int mRttMode;
1606 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001607 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001608 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1609
1610 /**
1611 * @hide
1612 */
Hall Liu57006aa2017-02-06 10:49:48 -08001613 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1614 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1615 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001616 mReceiveStream = receiveStream;
1617 mTransmitStream = transmitStream;
1618 mRttMode = mode;
1619 mInCallAdapter = inCallAdapter;
1620 }
1621
1622 /**
1623 * Returns the current RTT audio mode.
1624 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1625 * {@link #RTT_MODE_HCO}.
1626 */
1627 public int getRttAudioMode() {
1628 return mRttMode;
1629 }
1630
1631 /**
1632 * Sets the RTT audio mode. The requested mode change will be communicated through
1633 * {@link Callback#onRttModeChanged(Call, int)}.
1634 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1635 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1636 */
1637 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001638 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001639 }
1640
1641 /**
1642 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
Hall Liudc46c852020-10-29 16:15:33 -07001643 * RTT transmits text in real-time, this method should be called once for each user action.
1644 * For example, when the user enters text as discrete characters using the keyboard, this
1645 * method should be called once for each character. However, if the user enters text by
1646 * pasting or autocomplete, the entire contents of the pasted or autocompleted text should
1647 * be sent in one call to this method.
Hall Liu95d55872017-01-25 17:12:49 -08001648 *
1649 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1650 * lead to interleaved text.
1651 * @param input The message to send to the remote user.
1652 */
1653 public void write(String input) throws IOException {
1654 mTransmitStream.write(input);
1655 mTransmitStream.flush();
1656 }
1657
1658 /**
1659 * Reads a string from the remote user, blocking if there is no data available. Returns
1660 * {@code null} if the RTT conversation has been terminated and there is no further data
1661 * to read.
1662 *
1663 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1664 * lead to interleaved text.
1665 * @return A string containing text sent by the remote user, or {@code null} if the
1666 * conversation has been terminated or if there was an error while reading.
1667 */
Hall Liub1c8a772017-07-17 17:04:41 -07001668 public String read() {
1669 try {
1670 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1671 if (numRead < 0) {
1672 return null;
1673 }
1674 return new String(mReadBuffer, 0, numRead);
1675 } catch (IOException e) {
1676 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001677 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001678 }
Hall Liuffa4a812017-03-02 16:11:00 -08001679 }
1680
1681 /**
1682 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1683 * be read.
1684 * @return A string containing text entered by the user, or {@code null} if the user has
1685 * not entered any new text yet.
1686 */
1687 public String readImmediately() throws IOException {
1688 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001689 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1690 if (numRead < 0) {
1691 return null;
1692 }
1693 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001694 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001695 return null;
1696 }
1697 }
Hall Liue9041242018-02-09 16:40:03 -08001698
1699 /**
1700 * Closes the underlying file descriptors
1701 * @hide
1702 */
1703 public void close() {
1704 try {
1705 mReceiveStream.close();
1706 } catch (IOException e) {
1707 // ignore
1708 }
1709 try {
1710 mTransmitStream.close();
1711 } catch (IOException e) {
1712 // ignore
1713 }
1714 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001715 }
1716
Andrew Leeda80c872015-04-15 14:09:50 -07001717 /**
1718 * @deprecated Use {@code Call.Callback} instead.
1719 * @hide
1720 */
1721 @Deprecated
1722 @SystemApi
1723 public static abstract class Listener extends Callback { }
1724
Ihab Awade63fadb2014-07-09 21:52:04 -07001725 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001726 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001727 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001728 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001729 private final List<Call> mChildren = new ArrayList<>();
1730 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001731 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001732 private final List<Call> mConferenceableCalls = new ArrayList<>();
1733 private final List<Call> mUnmodifiableConferenceableCalls =
1734 Collections.unmodifiableList(mConferenceableCalls);
1735
Santos Cordon823fd3c2014-08-07 18:35:18 -07001736 private boolean mChildrenCached;
1737 private String mParentId = null;
Hall Liuef98bf82020-01-09 15:22:44 -08001738 private String mActiveGenericConferenceChild = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001739 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001740 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001741 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001742 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001743 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001744 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001745 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001746 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001747 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001748
1749 /**
1750 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1751 *
1752 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1753 * remaining or this {@code Call} is not in a post-dial state.
1754 */
1755 public String getRemainingPostDialSequence() {
1756 return mRemainingPostDialSequence;
1757 }
1758
1759 /**
1760 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001761 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001762 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001763 public void answer(@VideoProfile.VideoState int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001764 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001765 }
1766
1767 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301768 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1769 *
1770 * @param address The address to which the call will be deflected.
1771 */
1772 public void deflect(Uri address) {
1773 mInCallAdapter.deflectCall(mTelecomCallId, address);
1774 }
1775
1776 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001777 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1778 *
1779 * @param rejectWithMessage Whether to reject with a text message.
1780 * @param textMessage An optional text message with which to respond.
1781 */
1782 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001783 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001784 }
1785
1786 /**
Tyler Gunnfacfdee2020-01-23 13:10:37 -08001787 * Instructs the {@link ConnectionService} providing this {@link #STATE_RINGING} call that the
1788 * user has chosen to reject the call and has indicated a reason why the call is being rejected.
1789 *
1790 * @param rejectReason the reason the call is being rejected.
1791 */
1792 public void reject(@RejectReason int rejectReason) {
1793 mInCallAdapter.rejectCall(mTelecomCallId, rejectReason);
1794 }
1795
1796 /**
Ravi Palurif4b38e72020-02-05 12:35:41 +05301797 * Instructs this {@code Call} to be transferred to another number.
1798 *
1799 * @param targetNumber The address to which the call will be transferred.
Tyler Gunn460360d2020-07-29 10:21:45 -07001800 * @param isConfirmationRequired if {@code true} it will initiate a confirmed transfer,
1801 * if {@code false}, it will initiate an unconfirmed transfer.
Ravi Palurif4b38e72020-02-05 12:35:41 +05301802 *
1803 * @hide
1804 */
1805 public void transfer(@NonNull Uri targetNumber, boolean isConfirmationRequired) {
1806 mInCallAdapter.transferCall(mTelecomCallId, targetNumber, isConfirmationRequired);
1807 }
1808
1809 /**
1810 * Instructs this {@code Call} to be transferred to another ongoing call.
1811 * This will initiate CONSULTATIVE transfer.
1812 * @param toCall The other ongoing {@code Call} to which this call will be transferred.
1813 *
1814 * @hide
1815 */
1816 public void transfer(@NonNull android.telecom.Call toCall) {
1817 mInCallAdapter.transferCall(mTelecomCallId, toCall.mTelecomCallId);
1818 }
1819
1820 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001821 * Instructs this {@code Call} to disconnect.
1822 */
1823 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001824 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001825 }
1826
1827 /**
1828 * Instructs this {@code Call} to go on hold.
1829 */
1830 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001831 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001832 }
1833
1834 /**
1835 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1836 */
1837 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001838 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001839 }
1840
1841 /**
Hall Liu6dfa2492019-10-01 17:20:39 -07001842 * Instructs Telecom to put the call into the background audio processing state.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001843 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001844 * This method can be called either when the call is in {@link #STATE_RINGING} or
1845 * {@link #STATE_ACTIVE}. After Telecom acknowledges the request by setting the call's state to
1846 * {@link #STATE_AUDIO_PROCESSING}, your app may setup the audio paths with the audio stack in
1847 * order to capture and play audio on the call stream.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001848 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001849 * This method can only be called by the default dialer app.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001850 * <p>
1851 * Apps built with SDK version {@link android.os.Build.VERSION_CODES#R} or later which are using
1852 * the microphone as part of audio processing should specify the foreground service type using
1853 * the attribute {@link android.R.attr#foregroundServiceType} in the {@link InCallService}
1854 * service element of the app's manifest file.
1855 * The {@link ServiceInfo#FOREGROUND_SERVICE_TYPE_MICROPHONE} attribute should be specified.
1856 * @see <a href="https://developer.android.com/preview/privacy/foreground-service-types">
1857 * the Android Developer Site</a> for more information.
Hall Liu6dfa2492019-10-01 17:20:39 -07001858 * @hide
1859 */
1860 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001861 public void enterBackgroundAudioProcessing() {
1862 if (mState != STATE_ACTIVE && mState != STATE_RINGING) {
1863 throw new IllegalStateException("Call must be active or ringing");
1864 }
1865 mInCallAdapter.enterBackgroundAudioProcessing(mTelecomCallId);
1866 }
1867
1868 /**
1869 * Instructs Telecom to come out of the background audio processing state requested by
1870 * {@link #enterBackgroundAudioProcessing()} or from the call screening service.
1871 *
1872 * This method can only be called when the call is in {@link #STATE_AUDIO_PROCESSING}.
1873 *
1874 * @param shouldRing If true, Telecom will put the call into the
1875 * {@link #STATE_SIMULATED_RINGING} state and notify other apps that there is
1876 * a ringing call. Otherwise, the call will go into {@link #STATE_ACTIVE}
1877 * immediately.
1878 * @hide
1879 */
1880 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001881 public void exitBackgroundAudioProcessing(boolean shouldRing) {
1882 if (mState != STATE_AUDIO_PROCESSING) {
1883 throw new IllegalStateException("Call must in the audio processing state");
1884 }
1885 mInCallAdapter.exitBackgroundAudioProcessing(mTelecomCallId, shouldRing);
1886 }
1887
1888 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001889 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
Tyler Gunn2517d032023-02-06 16:34:54 +00001890 * <p>
1891 * Tones are both played locally for the user to hear and sent to the network to be relayed
1892 * to the remote device.
1893 * <p>
1894 * You must ensure that any call to {@link #playDtmfTone(char}) is followed by a matching
1895 * call to {@link #stopDtmfTone()} and that each tone is stopped before a new one is started.
1896 * The play and stop commands are relayed to the underlying
1897 * {@link android.telecom.ConnectionService} as executed; implementations may not correctly
1898 * handle out of order commands.
Ihab Awade63fadb2014-07-09 21:52:04 -07001899 *
1900 * @param digit A character representing the DTMF digit for which to play the tone. This
1901 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1902 */
1903 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001904 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001905 }
1906
1907 /**
1908 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1909 * currently playing.
1910 *
1911 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1912 * currently playing, this method will do nothing.
1913 */
1914 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001915 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001916 }
1917
1918 /**
1919 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1920 *
1921 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1922 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001923 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001924 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001925 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1926 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001927 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001928 * {@code Call} will pause playing the tones and notify callbacks via
1929 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001930 * should display to the user an indication of this state and an affordance to continue
1931 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1932 * app should invoke the {@link #postDialContinue(boolean)} method.
1933 *
1934 * @param proceed Whether or not to continue with the post-dial sequence.
1935 */
1936 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001937 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001938 }
1939
1940 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001941 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001942 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001943 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001944 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1945 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001946
1947 }
1948
1949 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001950 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001951 *
1952 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001953 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001954 public void conference(Call callToConferenceWith) {
1955 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001956 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001957 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001958 }
1959
1960 /**
1961 * Instructs this {@code Call} to split from any conference call with which it may be
1962 * connected.
1963 */
1964 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001965 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001966 }
1967
1968 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001969 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001970 */
1971 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001972 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001973 }
1974
1975 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001976 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001977 */
1978 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001979 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001980 }
1981
1982 /**
Ravi Paluri404babb2020-01-23 19:02:44 +05301983 * Pulls participants to existing call by forming a conference call.
1984 * See {@link Details#CAPABILITY_ADD_PARTICIPANT}.
1985 *
1986 * @param participants participants to be pulled to existing call.
1987 */
1988 public void addConferenceParticipants(@NonNull List<Uri> participants) {
1989 mInCallAdapter.addConferenceParticipants(mTelecomCallId, participants);
1990 }
1991
1992 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001993 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1994 * device.
1995 * <p>
1996 * Calls to this method are ignored if the call does not have the
1997 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
1998 * <p>
1999 * An {@link InCallService} will only see calls which support this method if it has the
2000 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
2001 * in its manifest.
2002 */
2003 public void pullExternalCall() {
2004 // If this isn't an external call, ignore the request.
2005 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
2006 return;
2007 }
2008
2009 mInCallAdapter.pullExternalCall(mTelecomCallId);
2010 }
2011
2012 /**
2013 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
2014 * the {@link ConnectionService}.
2015 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07002016 * Call events are used to communicate point in time information from an {@link InCallService}
2017 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
2018 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
2019 * {@link ConnectionService}.
2020 * <p>
2021 * A {@link ConnectionService} can communicate to the {@link InCallService} using
2022 * {@link Connection#sendConnectionEvent(String, Bundle)}.
2023 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002024 * Events are exposed to {@link ConnectionService} implementations via
2025 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
2026 * <p>
2027 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07002028 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
2029 * ignore some events altogether.
2030 * <p>
2031 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
2032 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
2033 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
2034 * they define their own event types in this namespace. When defining a custom event type,
2035 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
2036 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
2037 * <p>
2038 * When defining events and the associated extras, it is important to keep their behavior
2039 * consistent when the associated {@link InCallService} is updated. Support for deprecated
2040 * events/extras should me maintained to ensure backwards compatibility with older
2041 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002042 *
2043 * @param event The connection event.
2044 * @param extras Bundle containing extra information associated with the event.
2045 */
2046 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002047 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002048 }
2049
2050 /**
Hall Liu95d55872017-01-25 17:12:49 -08002051 * Sends an RTT upgrade request to the remote end of the connection. Success is not
2052 * guaranteed, and notification of success will be via the
2053 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2054 */
2055 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08002056 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002057 }
2058
2059 /**
2060 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
2061 * callback.
2062 * The ID used here should be the same as the ID that was received via the callback.
2063 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
2064 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
2065 */
2066 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08002067 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08002068 }
2069
2070 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07002071 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
2072 * by {@code toHandle}. The videoState specified indicates the desired video state after the
2073 * handover.
2074 * <p>
Tyler Gunn9d127732018-03-02 15:45:51 -08002075 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2076 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2077 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2078 * is referred to as the source of the handover, and the video calling app is referred to as the
2079 * destination.
2080 * <p>
2081 * When considering a handover scenario the device this method is called on is considered the
2082 * <em>initiating</em> device (since the user initiates the handover from this device), and the
2083 * other device is considered the <em>receiving</em> device.
2084 * <p>
2085 * When this method is called on the <em>initiating</em> device, the Telecom framework will bind
2086 * to the {@link ConnectionService} defined by the {@code toHandle} {@link PhoneAccountHandle}
2087 * and invoke
2088 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
2089 * ConnectionRequest)} to inform the destination app that a request has been made to handover a
2090 * call to it. The app returns an instance of {@link Connection} to represent the handover call
2091 * At this point the app should display UI to indicate to the user that a call
2092 * handover is in process.
2093 * <p>
2094 * The destination app is responsible for communicating the handover request from the
2095 * <em>initiating</em> device to the <em>receiving</em> device.
2096 * <p>
2097 * When the app on the <em>receiving</em> device receives the handover request, it calls
2098 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)} to continue the handover
2099 * process from the <em>initiating</em> device to the <em>receiving</em> device. At this point
2100 * the destination app on the <em>receiving</em> device should show UI to allow the user to
2101 * choose whether they want to continue their call in the destination app.
2102 * <p>
2103 * When the destination app on the <em>receiving</em> device calls
2104 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)}, Telecom will bind to its
2105 * {@link ConnectionService} and call
2106 * {@link ConnectionService#onCreateIncomingHandoverConnection(PhoneAccountHandle,
2107 * ConnectionRequest)} to inform it of the handover request. The app returns an instance of
2108 * {@link Connection} to represent the handover call.
2109 * <p>
2110 * If the user of the <em>receiving</em> device accepts the handover, the app calls
2111 * {@link Connection#setActive()} to complete the handover process; Telecom will disconnect the
2112 * original call. If the user rejects the handover, the app calls
2113 * {@link Connection#setDisconnected(DisconnectCause)} and specifies a {@link DisconnectCause}
2114 * of {@link DisconnectCause#CANCELED} to indicate that the handover has been cancelled.
2115 * <p>
2116 * Telecom will only allow handovers from {@link PhoneAccount}s which declare
2117 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}. Similarly, the {@link PhoneAccount}
2118 * specified by {@code toHandle} must declare {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}.
2119 * <p>
2120 * Errors in the handover process are reported to the {@link InCallService} via
2121 * {@link Callback#onHandoverFailed(Call, int)}. Errors in the handover process are reported to
2122 * the involved {@link ConnectionService}s via
2123 * {@link ConnectionService#onHandoverFailed(ConnectionRequest, int)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07002124 *
2125 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
2126 * this call to.
Tyler Gunn9d127732018-03-02 15:45:51 -08002127 * @param videoState Indicates the video state desired after the handover (see the
2128 * {@code STATE_*} constants defined in {@link VideoProfile}).
Sanket Padawea8eddd42017-11-03 11:07:35 -07002129 * @param extras Bundle containing extra information to be passed to the
2130 * {@link ConnectionService}
2131 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002132 public void handoverTo(PhoneAccountHandle toHandle, @VideoProfile.VideoState int videoState,
2133 Bundle extras) {
Sanket Padawea8eddd42017-11-03 11:07:35 -07002134 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
2135 }
2136
2137 /**
Hall Liu95d55872017-01-25 17:12:49 -08002138 * Terminate the RTT session on this call. The resulting state change will be notified via
2139 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
2140 */
2141 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08002142 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08002143 }
2144
2145 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07002146 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
2147 * added.
2148 * <p>
2149 * No assumptions should be made as to how an In-Call UI or service will handle these
2150 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
Tyler Gunn6c100242023-01-09 11:23:18 -08002151 * <p>
2152 * Extras added using this method will be made available to the {@link ConnectionService}
2153 * associated with this {@link Call} and notified via
2154 * {@link Connection#onExtrasChanged(Bundle)}.
2155 * <p>
2156 * Extras added using this method will also be available to other running {@link InCallService}s
2157 * and notified via {@link Call.Callback#onDetailsChanged(Call, Details)}. The extras can be
2158 * accessed via {@link Details#getExtras()}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002159 *
2160 * @param extras The extras to add.
2161 */
2162 public final void putExtras(Bundle extras) {
2163 if (extras == null) {
2164 return;
2165 }
2166
2167 if (mExtras == null) {
2168 mExtras = new Bundle();
2169 }
2170 mExtras.putAll(extras);
2171 mInCallAdapter.putExtras(mTelecomCallId, extras);
2172 }
2173
2174 /**
2175 * Adds a boolean extra to this {@link Call}.
2176 *
2177 * @param key The extra key.
2178 * @param value The value.
2179 * @hide
2180 */
2181 public final void putExtra(String key, boolean value) {
2182 if (mExtras == null) {
2183 mExtras = new Bundle();
2184 }
2185 mExtras.putBoolean(key, value);
2186 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2187 }
2188
2189 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002190 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002191 *
2192 * @param key The extra key.
2193 * @param value The value.
2194 * @hide
2195 */
2196 public final void putExtra(String key, int value) {
2197 if (mExtras == null) {
2198 mExtras = new Bundle();
2199 }
2200 mExtras.putInt(key, value);
2201 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2202 }
2203
2204 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002205 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002206 *
2207 * @param key The extra key.
2208 * @param value The value.
2209 * @hide
2210 */
2211 public final void putExtra(String key, String value) {
2212 if (mExtras == null) {
2213 mExtras = new Bundle();
2214 }
2215 mExtras.putString(key, value);
2216 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2217 }
2218
2219 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002220 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002221 *
2222 * @param keys The keys of the extras to remove.
2223 */
2224 public final void removeExtras(List<String> keys) {
2225 if (mExtras != null) {
2226 for (String key : keys) {
2227 mExtras.remove(key);
2228 }
2229 if (mExtras.size() == 0) {
2230 mExtras = null;
2231 }
2232 }
2233 mInCallAdapter.removeExtras(mTelecomCallId, keys);
2234 }
2235
2236 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002237 * Removes extras from this {@link Call}.
2238 *
2239 * @param keys The keys of the extras to remove.
2240 */
2241 public final void removeExtras(String ... keys) {
2242 removeExtras(Arrays.asList(keys));
2243 }
2244
2245 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002246 * Obtains the parent of this {@code Call} in a conference, if any.
2247 *
2248 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
2249 * child of any conference {@code Call}s.
2250 */
2251 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002252 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002253 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002254 }
2255 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07002256 }
2257
2258 /**
2259 * Obtains the children of this conference {@code Call}, if any.
2260 *
2261 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
2262 * {@code List} otherwise.
2263 */
2264 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002265 if (!mChildrenCached) {
2266 mChildrenCached = true;
2267 mChildren.clear();
2268
2269 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002270 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002271 if (call == null) {
2272 // At least one child was still not found, so do not save true for "cached"
2273 mChildrenCached = false;
2274 } else {
2275 mChildren.add(call);
2276 }
2277 }
2278 }
2279
Ihab Awade63fadb2014-07-09 21:52:04 -07002280 return mUnmodifiableChildren;
2281 }
2282
2283 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002284 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
2285 *
2286 * @return The list of conferenceable {@code Call}s.
2287 */
2288 public List<Call> getConferenceableCalls() {
2289 return mUnmodifiableConferenceableCalls;
2290 }
2291
2292 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002293 * Obtains the state of this {@code Call}.
2294 *
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002295 * @return The call state.
2296 * @deprecated The call state is available via {@link Call.Details#getState()}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002297 */
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002298 @Deprecated
2299 public @CallState int getState() {
Ihab Awade63fadb2014-07-09 21:52:04 -07002300 return mState;
2301 }
2302
2303 /**
Hall Liuef98bf82020-01-09 15:22:44 -08002304 * Returns the child {@link Call} in a generic conference that is currently active.
Hall Liu135e53aa2020-02-27 18:34:11 -08002305 *
2306 * A "generic conference" is the mechanism used to support two simultaneous calls on a device
2307 * in CDMA networks. It is effectively equivalent to having one call active and one call on hold
2308 * in GSM or IMS calls. This method returns the currently active call.
2309 *
2310 * In a generic conference, the network exposes the conference to us as a single call, and we
2311 * switch between talking to the two participants using a CDMA flash command. Since the network
2312 * exposes no additional information about the call, the only way we know which caller we're
2313 * currently talking to is by keeping track of the flash commands that we've sent to the
2314 * network.
2315 *
Hall Liuef98bf82020-01-09 15:22:44 -08002316 * For calls that are not generic conferences, or when the generic conference has more than
2317 * 2 children, returns {@code null}.
2318 * @see Details#PROPERTY_GENERIC_CONFERENCE
2319 * @return The active child call.
2320 */
2321 public @Nullable Call getGenericConferenceActiveChildCall() {
2322 if (mActiveGenericConferenceChild != null) {
2323 return mPhone.internalGetCallByTelecomId(mActiveGenericConferenceChild);
2324 }
2325 return null;
2326 }
2327
2328 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002329 * Obtains a list of canned, pre-configured message responses to present to the user as
Tyler Gunn434fc2c2020-10-06 14:23:54 -07002330 * ways of rejecting an incoming {@code Call} using via a text message.
2331 * <p>
2332 * <em>Note:</em> Since canned responses may be loaded from the file system, they are not
2333 * guaranteed to be present when this {@link Call} is first added to the {@link InCallService}
2334 * via {@link InCallService#onCallAdded(Call)}. The callback
2335 * {@link Call.Callback#onCannedTextResponsesLoaded(Call, List)} will be called when/if canned
2336 * responses for the call become available.
Ihab Awade63fadb2014-07-09 21:52:04 -07002337 *
2338 * @see #reject(boolean, String)
2339 *
2340 * @return A list of canned text message responses.
2341 */
2342 public List<String> getCannedTextResponses() {
2343 return mCannedTextResponses;
2344 }
2345
2346 /**
2347 * Obtains an object that can be used to display video from this {@code Call}.
2348 *
Andrew Lee50aca232014-07-22 16:41:54 -07002349 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002350 */
Andrew Lee50aca232014-07-22 16:41:54 -07002351 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002352 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07002353 }
2354
2355 /**
2356 * Obtains an object containing call details.
2357 *
2358 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
2359 * result may be {@code null}.
2360 */
2361 public Details getDetails() {
2362 return mDetails;
2363 }
2364
2365 /**
Hall Liu95d55872017-01-25 17:12:49 -08002366 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
2367 * receive RTT text data, as well as to change the RTT mode.
2368 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
2369 */
2370 public @Nullable RttCall getRttCall() {
2371 return mRttCall;
2372 }
2373
2374 /**
2375 * Returns whether this call has an active RTT connection.
2376 * @return true if there is a connection, false otherwise.
2377 */
2378 public boolean isRttActive() {
Hall Liue9041242018-02-09 16:40:03 -08002379 return mRttCall != null && mDetails.hasProperty(Details.PROPERTY_RTT);
Hall Liu95d55872017-01-25 17:12:49 -08002380 }
2381
2382 /**
Andrew Leeda80c872015-04-15 14:09:50 -07002383 * Registers a callback to this {@code Call}.
2384 *
2385 * @param callback A {@code Callback}.
2386 */
2387 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07002388 registerCallback(callback, new Handler());
2389 }
2390
2391 /**
2392 * Registers a callback to this {@code Call}.
2393 *
2394 * @param callback A {@code Callback}.
2395 * @param handler A handler which command and status changes will be delivered to.
2396 */
2397 public void registerCallback(Callback callback, Handler handler) {
2398 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07002399 // Don't allow new callback registration if the call is already being destroyed.
2400 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002401 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
2402 }
Andrew Leeda80c872015-04-15 14:09:50 -07002403 }
2404
2405 /**
2406 * Unregisters a callback from this {@code Call}.
2407 *
2408 * @param callback A {@code Callback}.
2409 */
2410 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07002411 // Don't allow callback deregistration if the call is already being destroyed.
2412 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002413 for (CallbackRecord<Callback> record : mCallbackRecords) {
2414 if (record.getCallback() == callback) {
2415 mCallbackRecords.remove(record);
2416 break;
2417 }
2418 }
Andrew Leeda80c872015-04-15 14:09:50 -07002419 }
2420 }
2421
Santos Cordon3c20d632016-02-25 16:12:35 -08002422 @Override
2423 public String toString() {
2424 return new StringBuilder().
2425 append("Call [id: ").
2426 append(mTelecomCallId).
2427 append(", state: ").
2428 append(stateToString(mState)).
2429 append(", details: ").
2430 append(mDetails).
2431 append("]").toString();
2432 }
2433
2434 /**
2435 * @param state An integer value of a {@code STATE_*} constant.
2436 * @return A string representation of the value.
2437 */
2438 private static String stateToString(int state) {
2439 switch (state) {
2440 case STATE_NEW:
2441 return "NEW";
2442 case STATE_RINGING:
2443 return "RINGING";
2444 case STATE_DIALING:
2445 return "DIALING";
2446 case STATE_ACTIVE:
2447 return "ACTIVE";
2448 case STATE_HOLDING:
2449 return "HOLDING";
2450 case STATE_DISCONNECTED:
2451 return "DISCONNECTED";
2452 case STATE_CONNECTING:
2453 return "CONNECTING";
2454 case STATE_DISCONNECTING:
2455 return "DISCONNECTING";
2456 case STATE_SELECT_PHONE_ACCOUNT:
2457 return "SELECT_PHONE_ACCOUNT";
Hall Liu4e35b642019-10-14 17:50:45 -07002458 case STATE_SIMULATED_RINGING:
2459 return "SIMULATED_RINGING";
2460 case STATE_AUDIO_PROCESSING:
2461 return "AUDIO_PROCESSING";
Santos Cordon3c20d632016-02-25 16:12:35 -08002462 default:
2463 Log.w(Call.class, "Unknown state %d", state);
2464 return "UNKNOWN";
2465 }
2466 }
2467
Andrew Leeda80c872015-04-15 14:09:50 -07002468 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002469 * Adds a listener to this {@code Call}.
2470 *
2471 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002472 * @deprecated Use {@link #registerCallback} instead.
2473 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002474 */
Andrew Leeda80c872015-04-15 14:09:50 -07002475 @Deprecated
2476 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002477 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002478 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002479 }
2480
2481 /**
2482 * Removes a listener from this {@code Call}.
2483 *
2484 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002485 * @deprecated Use {@link #unregisterCallback} instead.
2486 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002487 */
Andrew Leeda80c872015-04-15 14:09:50 -07002488 @Deprecated
2489 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002490 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002491 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002492 }
2493
2494 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08002495 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
2496 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002497 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002498 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002499 mInCallAdapter = inCallAdapter;
2500 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002501 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002502 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07002503 }
2504
2505 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08002506 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08002507 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002508 mPhone = phone;
2509 mTelecomCallId = telecomCallId;
2510 mInCallAdapter = inCallAdapter;
2511 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002512 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002513 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002514 }
2515
2516 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002517 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002518 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002519 }
2520
2521 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002522 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08002523
Ihab Awade63fadb2014-07-09 21:52:04 -07002524 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08002525 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07002526 boolean detailsChanged = !Objects.equals(mDetails, details);
2527 if (detailsChanged) {
2528 mDetails = details;
2529 }
2530
2531 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07002532 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
2533 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
2534 mCannedTextResponses =
2535 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07002536 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07002537 }
2538
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002539 IVideoProvider previousVideoProvider = mVideoCallImpl == null ? null :
2540 mVideoCallImpl.getVideoProvider();
2541 IVideoProvider newVideoProvider = parcelableCall.getVideoProvider();
2542
2543 // parcelableCall.isVideoCallProviderChanged is only true when we have a video provider
2544 // specified; so we should check if the actual IVideoProvider changes as well.
2545 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged()
2546 && !Objects.equals(previousVideoProvider, newVideoProvider);
Andrew Lee50aca232014-07-22 16:41:54 -07002547 if (videoCallChanged) {
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002548 if (mVideoCallImpl != null) {
2549 mVideoCallImpl.destroy();
2550 }
2551 mVideoCallImpl = parcelableCall.isVideoCallProviderChanged() ?
2552 parcelableCall.getVideoCallImpl(mCallingPackage, mTargetSdkVersion) : null;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002553 }
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002554
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002555 if (mVideoCallImpl != null) {
2556 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07002557 }
2558
Santos Cordone3c507b2015-04-23 14:44:19 -07002559 int state = parcelableCall.getState();
Hall Liu31de23d2019-10-11 15:38:29 -07002560 if (mTargetSdkVersion < Phone.SDK_VERSION_R && state == Call.STATE_SIMULATED_RINGING) {
2561 state = Call.STATE_RINGING;
2562 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002563 boolean stateChanged = mState != state;
2564 if (stateChanged) {
2565 mState = state;
2566 }
2567
Santos Cordon823fd3c2014-08-07 18:35:18 -07002568 String parentId = parcelableCall.getParentCallId();
2569 boolean parentChanged = !Objects.equals(mParentId, parentId);
2570 if (parentChanged) {
2571 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002572 }
2573
Santos Cordon823fd3c2014-08-07 18:35:18 -07002574 List<String> childCallIds = parcelableCall.getChildCallIds();
2575 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
2576 if (childrenChanged) {
2577 mChildrenIds.clear();
2578 mChildrenIds.addAll(parcelableCall.getChildCallIds());
2579 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07002580 }
2581
Hall Liuef98bf82020-01-09 15:22:44 -08002582 String activeChildCallId = parcelableCall.getActiveChildCallId();
2583 boolean activeChildChanged = !Objects.equals(activeChildCallId,
2584 mActiveGenericConferenceChild);
2585 if (activeChildChanged) {
2586 mActiveGenericConferenceChild = activeChildCallId;
2587 }
2588
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002589 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
2590 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
2591 for (String otherId : conferenceableCallIds) {
2592 if (callIdMap.containsKey(otherId)) {
2593 conferenceableCalls.add(callIdMap.get(otherId));
2594 }
2595 }
2596
2597 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
2598 mConferenceableCalls.clear();
2599 mConferenceableCalls.addAll(conferenceableCalls);
2600 fireConferenceableCallsChanged();
2601 }
2602
Hall Liu95d55872017-01-25 17:12:49 -08002603 boolean isRttChanged = false;
2604 boolean rttModeChanged = false;
Hall Liue9041242018-02-09 16:40:03 -08002605 if (parcelableCall.getIsRttCallChanged()
2606 && mDetails.hasProperty(Details.PROPERTY_RTT)) {
Hall Liu95d55872017-01-25 17:12:49 -08002607 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
2608 InputStreamReader receiveStream = new InputStreamReader(
2609 new ParcelFileDescriptor.AutoCloseInputStream(
2610 parcelableRttCall.getReceiveStream()),
2611 StandardCharsets.UTF_8);
2612 OutputStreamWriter transmitStream = new OutputStreamWriter(
2613 new ParcelFileDescriptor.AutoCloseOutputStream(
2614 parcelableRttCall.getTransmitStream()),
2615 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08002616 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08002617 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
2618 if (mRttCall == null) {
2619 isRttChanged = true;
2620 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
2621 rttModeChanged = true;
2622 }
2623 mRttCall = newRttCall;
2624 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
2625 && parcelableCall.getIsRttCallChanged()) {
2626 isRttChanged = true;
Tyler Gunn4cd42482021-04-30 16:23:15 -07002627 mRttCall.close();
Hall Liu95d55872017-01-25 17:12:49 -08002628 mRttCall = null;
2629 }
2630
Ihab Awade63fadb2014-07-09 21:52:04 -07002631 // Now we fire updates, ensuring that any client who listens to any of these notifications
2632 // gets the most up-to-date state.
2633
2634 if (stateChanged) {
2635 fireStateChanged(mState);
2636 }
2637 if (detailsChanged) {
2638 fireDetailsChanged(mDetails);
2639 }
2640 if (cannedTextResponsesChanged) {
2641 fireCannedTextResponsesLoaded(mCannedTextResponses);
2642 }
Andrew Lee50aca232014-07-22 16:41:54 -07002643 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002644 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07002645 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07002646 if (parentChanged) {
2647 fireParentChanged(getParent());
2648 }
Hall Liuef98bf82020-01-09 15:22:44 -08002649 if (childrenChanged || activeChildChanged) {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002650 fireChildrenChanged(getChildren());
2651 }
Hall Liu95d55872017-01-25 17:12:49 -08002652 if (isRttChanged) {
2653 fireOnIsRttChanged(mRttCall != null, mRttCall);
2654 }
2655 if (rttModeChanged) {
2656 fireOnRttModeChanged(mRttCall.getRttAudioMode());
2657 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002658
2659 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
2660 // remove ourselves from the Phone. Note that we do this after completing all state updates
2661 // so a client can cleanly transition all their UI to the state appropriate for a
2662 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
qing278fdb12021-10-26 19:05:51 +00002663 // Check if the original state is already disconnected, otherwise onCallRemoved will be
2664 // triggered before onCallAdded.
2665 if (mState == STATE_DISCONNECTED && stateChanged) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002666 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07002667 }
2668 }
2669
2670 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002671 final void internalSetPostDialWait(String remaining) {
2672 mRemainingPostDialSequence = remaining;
2673 firePostDialWait(mRemainingPostDialSequence);
2674 }
2675
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07002676 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07002677 final void internalSetDisconnected() {
2678 if (mState != Call.STATE_DISCONNECTED) {
2679 mState = Call.STATE_DISCONNECTED;
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002680 if (mDetails != null) {
2681 mDetails = new Details(mState,
2682 mDetails.getTelecomCallId(),
2683 mDetails.getHandle(),
2684 mDetails.getHandlePresentation(),
2685 mDetails.getCallerDisplayName(),
2686 mDetails.getCallerDisplayNamePresentation(),
2687 mDetails.getAccountHandle(),
2688 mDetails.getCallCapabilities(),
2689 mDetails.getCallProperties(),
2690 mDetails.getDisconnectCause(),
2691 mDetails.getConnectTimeMillis(),
2692 mDetails.getGatewayInfo(),
2693 mDetails.getVideoState(),
2694 mDetails.getStatusHints(),
2695 mDetails.getExtras(),
2696 mDetails.getIntentExtras(),
2697 mDetails.getCreationTimeMillis(),
2698 mDetails.getContactDisplayName(),
2699 mDetails.getCallDirection(),
Edgar Arriagae5bec822022-10-14 14:25:43 -07002700 mDetails.getCallerNumberVerificationStatus(),
2701 mDetails.getContactPhotoUri()
Tyler Gunn1e406ca2021-03-18 16:47:14 -07002702 );
2703 fireDetailsChanged(mDetails);
2704 }
Santos Cordonf30d7e92014-08-26 09:54:33 -07002705 fireStateChanged(mState);
2706 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07002707 }
2708 }
2709
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002710 /** {@hide} */
2711 final void internalOnConnectionEvent(String event, Bundle extras) {
2712 fireOnConnectionEvent(event, extras);
2713 }
2714
Hall Liu95d55872017-01-25 17:12:49 -08002715 /** {@hide} */
2716 final void internalOnRttUpgradeRequest(final int requestId) {
2717 for (CallbackRecord<Callback> record : mCallbackRecords) {
2718 final Call call = this;
2719 final Callback callback = record.getCallback();
2720 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
2721 }
2722 }
2723
Hall Liu57006aa2017-02-06 10:49:48 -08002724 /** @hide */
2725 final void internalOnRttInitiationFailure(int reason) {
2726 for (CallbackRecord<Callback> record : mCallbackRecords) {
2727 final Call call = this;
2728 final Callback callback = record.getCallback();
2729 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
2730 }
2731 }
2732
Sanket Padawe85291f62017-12-01 13:59:27 -08002733 /** {@hide} */
2734 final void internalOnHandoverFailed(int error) {
2735 for (CallbackRecord<Callback> record : mCallbackRecords) {
2736 final Call call = this;
2737 final Callback callback = record.getCallback();
2738 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
2739 }
2740 }
2741
Tyler Gunn858bfaf2018-01-22 15:17:54 -08002742 /** {@hide} */
2743 final void internalOnHandoverComplete() {
2744 for (CallbackRecord<Callback> record : mCallbackRecords) {
2745 final Call call = this;
2746 final Callback callback = record.getCallback();
2747 record.getHandler().post(() -> callback.onHandoverComplete(call));
2748 }
2749 }
2750
Andrew Lee011728f2015-04-23 15:47:06 -07002751 private void fireStateChanged(final int newState) {
2752 for (CallbackRecord<Callback> record : mCallbackRecords) {
2753 final Call call = this;
2754 final Callback callback = record.getCallback();
2755 record.getHandler().post(new Runnable() {
2756 @Override
2757 public void run() {
2758 callback.onStateChanged(call, newState);
2759 }
2760 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002761 }
2762 }
2763
Andrew Lee011728f2015-04-23 15:47:06 -07002764 private void fireParentChanged(final Call newParent) {
2765 for (CallbackRecord<Callback> record : mCallbackRecords) {
2766 final Call call = this;
2767 final Callback callback = record.getCallback();
2768 record.getHandler().post(new Runnable() {
2769 @Override
2770 public void run() {
2771 callback.onParentChanged(call, newParent);
2772 }
2773 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002774 }
2775 }
2776
Andrew Lee011728f2015-04-23 15:47:06 -07002777 private void fireChildrenChanged(final List<Call> children) {
2778 for (CallbackRecord<Callback> record : mCallbackRecords) {
2779 final Call call = this;
2780 final Callback callback = record.getCallback();
2781 record.getHandler().post(new Runnable() {
2782 @Override
2783 public void run() {
2784 callback.onChildrenChanged(call, children);
2785 }
2786 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002787 }
2788 }
2789
Andrew Lee011728f2015-04-23 15:47:06 -07002790 private void fireDetailsChanged(final Details details) {
2791 for (CallbackRecord<Callback> record : mCallbackRecords) {
2792 final Call call = this;
2793 final Callback callback = record.getCallback();
2794 record.getHandler().post(new Runnable() {
2795 @Override
2796 public void run() {
2797 callback.onDetailsChanged(call, details);
2798 }
2799 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002800 }
2801 }
2802
Andrew Lee011728f2015-04-23 15:47:06 -07002803 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2804 for (CallbackRecord<Callback> record : mCallbackRecords) {
2805 final Call call = this;
2806 final Callback callback = record.getCallback();
2807 record.getHandler().post(new Runnable() {
2808 @Override
2809 public void run() {
2810 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2811 }
2812 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002813 }
2814 }
2815
Andrew Lee011728f2015-04-23 15:47:06 -07002816 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2817 for (CallbackRecord<Callback> record : mCallbackRecords) {
2818 final Call call = this;
2819 final Callback callback = record.getCallback();
2820 record.getHandler().post(new Runnable() {
2821 @Override
2822 public void run() {
2823 callback.onVideoCallChanged(call, videoCall);
2824 }
2825 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002826 }
2827 }
2828
Andrew Lee011728f2015-04-23 15:47:06 -07002829 private void firePostDialWait(final String remainingPostDialSequence) {
2830 for (CallbackRecord<Callback> record : mCallbackRecords) {
2831 final Call call = this;
2832 final Callback callback = record.getCallback();
2833 record.getHandler().post(new Runnable() {
2834 @Override
2835 public void run() {
2836 callback.onPostDialWait(call, remainingPostDialSequence);
2837 }
2838 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002839 }
2840 }
2841
2842 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002843 /**
2844 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2845 * onCallRemoved callback, we remove this call from the Phone's record
2846 * only once all of the registered onCallDestroyed callbacks are executed.
2847 * All the callbacks get removed from our records as a part of this operation
2848 * since onCallDestroyed is the final callback.
2849 */
2850 final Call call = this;
2851 if (mCallbackRecords.isEmpty()) {
2852 // No callbacks registered, remove the call from Phone's record.
2853 mPhone.internalRemoveCall(call);
2854 }
2855 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002856 final Callback callback = record.getCallback();
2857 record.getHandler().post(new Runnable() {
2858 @Override
2859 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002860 boolean isFinalRemoval = false;
2861 RuntimeException toThrow = null;
2862 try {
2863 callback.onCallDestroyed(call);
2864 } catch (RuntimeException e) {
2865 toThrow = e;
2866 }
2867 synchronized(Call.this) {
2868 mCallbackRecords.remove(record);
2869 if (mCallbackRecords.isEmpty()) {
2870 isFinalRemoval = true;
2871 }
2872 }
2873 if (isFinalRemoval) {
2874 mPhone.internalRemoveCall(call);
2875 }
2876 if (toThrow != null) {
2877 throw toThrow;
2878 }
Andrew Lee011728f2015-04-23 15:47:06 -07002879 }
2880 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002881 }
2882 }
2883
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002884 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002885 for (CallbackRecord<Callback> record : mCallbackRecords) {
2886 final Call call = this;
2887 final Callback callback = record.getCallback();
2888 record.getHandler().post(new Runnable() {
2889 @Override
2890 public void run() {
2891 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2892 }
2893 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002894 }
2895 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002896
2897 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002898 * Notifies listeners of an incoming connection event.
2899 * <p>
2900 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2901 *
2902 * @param event
2903 * @param extras
2904 */
2905 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2906 for (CallbackRecord<Callback> record : mCallbackRecords) {
2907 final Call call = this;
2908 final Callback callback = record.getCallback();
2909 record.getHandler().post(new Runnable() {
2910 @Override
2911 public void run() {
2912 callback.onConnectionEvent(call, event, extras);
2913 }
2914 });
2915 }
2916 }
2917
2918 /**
Hall Liu95d55872017-01-25 17:12:49 -08002919 * Notifies listeners of an RTT on/off change
2920 *
2921 * @param enabled True if RTT is now enabled, false otherwise
2922 */
2923 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2924 for (CallbackRecord<Callback> record : mCallbackRecords) {
2925 final Call call = this;
2926 final Callback callback = record.getCallback();
2927 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2928 }
2929 }
2930
2931 /**
2932 * Notifies listeners of a RTT mode change
2933 *
2934 * @param mode The new RTT mode
2935 */
2936 private void fireOnRttModeChanged(final int mode) {
2937 for (CallbackRecord<Callback> record : mCallbackRecords) {
2938 final Call call = this;
2939 final Callback callback = record.getCallback();
2940 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2941 }
2942 }
2943
2944 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002945 * Determines if two bundles are equal.
2946 *
2947 * @param bundle The original bundle.
2948 * @param newBundle The bundle to compare with.
2949 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2950 */
2951 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2952 if (bundle == null || newBundle == null) {
2953 return bundle == newBundle;
2954 }
2955
2956 if (bundle.size() != newBundle.size()) {
2957 return false;
2958 }
2959
2960 for(String key : bundle.keySet()) {
2961 if (key != null) {
Grace Jia17005bd2022-05-12 12:49:02 -07002962 if (!newBundle.containsKey(key)) {
2963 return false;
2964 }
qing723dac62022-10-28 03:40:43 +00002965 // In case new call extra contains non-framework class objects, return false to
2966 // force update the call extra
2967 try {
2968 final Object value = bundle.get(key);
2969 final Object newValue = newBundle.get(key);
2970 if (value instanceof Bundle && newValue instanceof Bundle) {
2971 if (!areBundlesEqual((Bundle) value, (Bundle) newValue)) {
2972 return false;
2973 }
2974 }
2975 if (value instanceof byte[] && newValue instanceof byte[]) {
2976 if (!Arrays.equals((byte[]) value, (byte[]) newValue)) {
2977 return false;
2978 }
2979 } else if (!Objects.equals(value, newValue)) {
Grace Jia17005bd2022-05-12 12:49:02 -07002980 return false;
2981 }
qing723dac62022-10-28 03:40:43 +00002982 } catch (BadParcelableException e) {
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002983 return false;
2984 }
2985 }
2986 }
2987 return true;
2988 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002989}