blob: 044ea80cba4bd28ceba223420ca2cc069bc6fb93 [file] [log] [blame]
Ihab Awade63fadb2014-07-09 21:52:04 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Tyler Gunnef9f6f92014-09-12 22:16:17 -070017package android.telecom;
Ihab Awade63fadb2014-07-09 21:52:04 -070018
Hall Liu95d55872017-01-25 17:12:49 -080019import android.annotation.IntDef;
Ravi Paluri404babb2020-01-23 19:02:44 +053020import android.annotation.NonNull;
Hall Liu95d55872017-01-25 17:12:49 -080021import android.annotation.Nullable;
Andrew Leeda80c872015-04-15 14:09:50 -070022import android.annotation.SystemApi;
Hall Liu6dfa2492019-10-01 17:20:39 -070023import android.annotation.TestApi;
Artur Satayev53ada2a2019-12-10 17:47:56 +000024import android.compat.annotation.UnsupportedAppUsage;
Tyler Gunn460b7d42020-05-15 10:19:32 -070025import android.content.pm.ServiceInfo;
Ihab Awade63fadb2014-07-09 21:52:04 -070026import android.net.Uri;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080027import android.os.Build;
Nancy Chen10798dc2014-08-08 14:00:25 -070028import android.os.Bundle;
Andrew Lee011728f2015-04-23 15:47:06 -070029import android.os.Handler;
Hall Liu95d55872017-01-25 17:12:49 -080030import android.os.ParcelFileDescriptor;
Ihab Awade63fadb2014-07-09 21:52:04 -070031
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -080032import com.android.internal.telecom.IVideoProvider;
33
Hall Liu95d55872017-01-25 17:12:49 -080034import java.io.IOException;
35import java.io.InputStreamReader;
36import java.io.OutputStreamWriter;
Hall Liu95d55872017-01-25 17:12:49 -080037import java.lang.annotation.Retention;
38import java.lang.annotation.RetentionPolicy;
39import java.nio.charset.StandardCharsets;
Ihab Awade63fadb2014-07-09 21:52:04 -070040import java.util.ArrayList;
Tyler Gunn071be6f2016-05-10 14:52:33 -070041import java.util.Arrays;
Ihab Awade63fadb2014-07-09 21:52:04 -070042import java.util.Collections;
43import java.util.List;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -070044import java.util.Map;
Ihab Awade63fadb2014-07-09 21:52:04 -070045import java.util.Objects;
Jay Shrauner229e3822014-08-15 09:23:07 -070046import java.util.concurrent.CopyOnWriteArrayList;
Ihab Awade63fadb2014-07-09 21:52:04 -070047
48/**
49 * Represents an ongoing phone call that the in-call app should present to the user.
50 */
51public final class Call {
52 /**
53 * The state of a {@code Call} when newly created.
54 */
55 public static final int STATE_NEW = 0;
56
57 /**
58 * The state of an outgoing {@code Call} when dialing the remote number, but not yet connected.
59 */
60 public static final int STATE_DIALING = 1;
61
62 /**
63 * The state of an incoming {@code Call} when ringing locally, but not yet connected.
64 */
65 public static final int STATE_RINGING = 2;
66
67 /**
68 * The state of a {@code Call} when in a holding state.
69 */
70 public static final int STATE_HOLDING = 3;
71
72 /**
73 * The state of a {@code Call} when actively supporting conversation.
74 */
75 public static final int STATE_ACTIVE = 4;
76
77 /**
78 * The state of a {@code Call} when no further voice or other communication is being
79 * transmitted, the remote side has been or will inevitably be informed that the {@code Call}
80 * is no longer active, and the local data transport has or inevitably will release resources
81 * associated with this {@code Call}.
82 */
83 public static final int STATE_DISCONNECTED = 7;
84
Nancy Chen5da0fd52014-07-08 14:16:17 -070085 /**
Santos Cordone3c507b2015-04-23 14:44:19 -070086 * The state of an outgoing {@code Call} when waiting on user to select a
87 * {@link PhoneAccount} through which to place the call.
Nancy Chen5da0fd52014-07-08 14:16:17 -070088 */
Santos Cordone3c507b2015-04-23 14:44:19 -070089 public static final int STATE_SELECT_PHONE_ACCOUNT = 8;
90
91 /**
92 * @hide
93 * @deprecated use STATE_SELECT_PHONE_ACCOUNT.
94 */
95 @Deprecated
96 @SystemApi
97 public static final int STATE_PRE_DIAL_WAIT = STATE_SELECT_PHONE_ACCOUNT;
Nancy Chen5da0fd52014-07-08 14:16:17 -070098
Nancy Chene20930f2014-08-07 16:17:21 -070099 /**
Nancy Chene9b7a8e2014-08-08 14:26:27 -0700100 * The initial state of an outgoing {@code Call}.
101 * Common transitions are to {@link #STATE_DIALING} state for a successful call or
102 * {@link #STATE_DISCONNECTED} if it failed.
Nancy Chene20930f2014-08-07 16:17:21 -0700103 */
104 public static final int STATE_CONNECTING = 9;
105
Nancy Chen513c8922014-09-17 14:47:20 -0700106 /**
Tyler Gunn4afc6af2014-10-07 10:14:55 -0700107 * The state of a {@code Call} when the user has initiated a disconnection of the call, but the
108 * call has not yet been disconnected by the underlying {@code ConnectionService}. The next
109 * state of the call is (potentially) {@link #STATE_DISCONNECTED}.
110 */
111 public static final int STATE_DISCONNECTING = 10;
112
113 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700114 * The state of an external call which is in the process of being pulled from a remote device to
115 * the local device.
116 * <p>
117 * A call can only be in this state if the {@link Details#PROPERTY_IS_EXTERNAL_CALL} property
118 * and {@link Details#CAPABILITY_CAN_PULL_CALL} capability are set on the call.
119 * <p>
120 * An {@link InCallService} will only see this state if it has the
121 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true} in its
122 * manifest.
123 */
124 public static final int STATE_PULLING_CALL = 11;
125
126 /**
Hall Liu6dfa2492019-10-01 17:20:39 -0700127 * The state of a call that is active with the network, but the audio from the call is
128 * being intercepted by an app on the local device. Telecom does not hold audio focus in this
129 * state, and the call will be invisible to the user except for a persistent notification.
130 */
131 public static final int STATE_AUDIO_PROCESSING = 12;
132
133 /**
134 * The state of a call that is being presented to the user after being in
135 * {@link #STATE_AUDIO_PROCESSING}. The call is still active with the network in this case, and
136 * Telecom will hold audio focus and play a ringtone if appropriate.
137 */
138 public static final int STATE_SIMULATED_RINGING = 13;
139
140 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700141 * The key to retrieve the optional {@code PhoneAccount}s Telecom can bundle with its Call
142 * extras. Used to pass the phone accounts to display on the front end to the user in order to
143 * select phone accounts to (for example) place a call.
Hall Liu34d9e242018-11-21 17:05:58 -0800144 * @deprecated Use the list from {@link #EXTRA_SUGGESTED_PHONE_ACCOUNTS} instead.
Nancy Chen513c8922014-09-17 14:47:20 -0700145 */
Hall Liu34d9e242018-11-21 17:05:58 -0800146 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -0700147 public static final String AVAILABLE_PHONE_ACCOUNTS = "selectPhoneAccountAccounts";
148
mike dooley4af561f2016-12-20 08:55:17 -0800149 /**
Hall Liu34d9e242018-11-21 17:05:58 -0800150 * Key for extra used to pass along a list of {@link PhoneAccountSuggestion}s to the in-call
151 * UI when a call enters the {@link #STATE_SELECT_PHONE_ACCOUNT} state. The list included here
152 * will have the same length and be in the same order as the list passed with
153 * {@link #AVAILABLE_PHONE_ACCOUNTS}.
154 */
155 public static final String EXTRA_SUGGESTED_PHONE_ACCOUNTS =
156 "android.telecom.extra.SUGGESTED_PHONE_ACCOUNTS";
157
158 /**
mike dooley91217422017-03-09 12:58:42 -0800159 * Extra key used to indicate the time (in milliseconds since midnight, January 1, 1970 UTC)
160 * when the last outgoing emergency call was made. This is used to identify potential emergency
161 * callbacks.
mike dooley4af561f2016-12-20 08:55:17 -0800162 */
163 public static final String EXTRA_LAST_EMERGENCY_CALLBACK_TIME_MILLIS =
164 "android.telecom.extra.LAST_EMERGENCY_CALLBACK_TIME_MILLIS";
165
Usman Abdullahb0dc29a2019-03-06 15:54:56 -0800166
167 /**
168 * Extra key used to indicate whether a {@link CallScreeningService} has requested to silence
169 * the ringtone for a call. If the {@link InCallService} declares
170 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in its manifest, it should not
171 * play a ringtone for an incoming call with this extra key set.
172 */
173 public static final String EXTRA_SILENT_RINGING_REQUESTED =
174 "android.telecom.extra.SILENT_RINGING_REQUESTED";
175
Tyler Gunn8bf76572017-04-06 15:30:08 -0700176 /**
177 * Call event sent from a {@link Call} via {@link #sendCallEvent(String, Bundle)} to inform
178 * Telecom that the user has requested that the current {@link Call} should be handed over
179 * to another {@link ConnectionService}.
180 * <p>
181 * The caller must specify the {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE} to indicate to
182 * Telecom which {@link PhoneAccountHandle} the {@link Call} should be handed over to.
183 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700184 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
185 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700186 */
187 public static final String EVENT_REQUEST_HANDOVER =
188 "android.telecom.event.REQUEST_HANDOVER";
189
190 /**
191 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
192 * {@link PhoneAccountHandle} to which a call should be handed over to.
193 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700194 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
195 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700196 */
197 public static final String EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE =
198 "android.telecom.extra.HANDOVER_PHONE_ACCOUNT_HANDLE";
199
200 /**
201 * Integer extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
202 * video state of the call when it is handed over to the new {@link PhoneAccount}.
203 * <p>
204 * Valid values: {@link VideoProfile#STATE_AUDIO_ONLY},
205 * {@link VideoProfile#STATE_BIDIRECTIONAL}, {@link VideoProfile#STATE_RX_ENABLED}, and
206 * {@link VideoProfile#STATE_TX_ENABLED}.
207 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700208 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
209 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700210 */
211 public static final String EXTRA_HANDOVER_VIDEO_STATE =
212 "android.telecom.extra.HANDOVER_VIDEO_STATE";
213
214 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700215 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Used by the
216 * {@link InCallService} initiating a handover to provide a {@link Bundle} with extra
217 * information to the handover {@link ConnectionService} specified by
218 * {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE}.
219 * <p>
220 * This {@link Bundle} is not interpreted by Telecom, but passed as-is to the
221 * {@link ConnectionService} via the request extras when
222 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
223 * is called to initate the handover.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700224 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700225 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
226 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700227 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700228 public static final String EXTRA_HANDOVER_EXTRAS = "android.telecom.extra.HANDOVER_EXTRAS";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700229
230 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700231 * Call event sent from Telecom to the handover {@link ConnectionService} via
232 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
233 * to the {@link ConnectionService} has completed successfully.
234 * <p>
235 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700236 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700237 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
238 * APIs instead.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700239 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700240 public static final String EVENT_HANDOVER_COMPLETE =
241 "android.telecom.event.HANDOVER_COMPLETE";
Tyler Gunn34a2b312017-06-23 08:32:00 -0700242
243 /**
244 * Call event sent from Telecom to the handover destination {@link ConnectionService} via
245 * {@link Connection#onCallEvent(String, Bundle)} to inform the handover destination that the
246 * source connection has disconnected. The {@link Bundle} parameter for the call event will be
247 * {@code null}.
248 * <p>
249 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
250 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700251 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
252 * APIs instead.
Tyler Gunn34a2b312017-06-23 08:32:00 -0700253 */
254 public static final String EVENT_HANDOVER_SOURCE_DISCONNECTED =
255 "android.telecom.event.HANDOVER_SOURCE_DISCONNECTED";
256
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700257 /**
258 * Call event sent from Telecom to the handover {@link ConnectionService} via
259 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
260 * to the {@link ConnectionService} has failed.
261 * <p>
262 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
263 * @hide
Tyler Gunn1a505fa2018-09-14 13:36:38 -0700264 * @deprecated Use {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} and its associated
265 * APIs instead.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700266 */
267 public static final String EVENT_HANDOVER_FAILED =
268 "android.telecom.event.HANDOVER_FAILED";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700269
Tyler Gunnfacfdee2020-01-23 13:10:37 -0800270
271 /**
272 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
273 * call because they have declined to answer it. This typically means that they are unable
274 * to answer the call at this time and would prefer it be sent to voicemail.
275 */
276 public static final int REJECT_REASON_DECLINED = 1;
277
278 /**
279 * Reject reason used with {@link #reject(int)} to indicate that the user is rejecting this
280 * call because it is an unwanted call. This allows the user to indicate that they are
281 * rejecting a call because it is likely a nuisance call.
282 */
283 public static final int REJECT_REASON_UNWANTED = 2;
284
285 /**
286 * @hide
287 */
288 @IntDef(prefix = { "REJECT_REASON_" },
289 value = {REJECT_REASON_DECLINED, REJECT_REASON_UNWANTED})
290 @Retention(RetentionPolicy.SOURCE)
291 public @interface RejectReason {};
292
Ihab Awade63fadb2014-07-09 21:52:04 -0700293 public static class Details {
Tyler Gunn94f8f112018-12-17 09:56:11 -0800294 /** @hide */
295 @Retention(RetentionPolicy.SOURCE)
296 @IntDef(
297 prefix = { "DIRECTION_" },
298 value = {DIRECTION_UNKNOWN, DIRECTION_INCOMING, DIRECTION_OUTGOING})
299 public @interface CallDirection {}
300
301 /**
302 * Indicates that the call is neither and incoming nor an outgoing call. This can be the
303 * case for calls reported directly by a {@link ConnectionService} in special cases such as
304 * call handovers.
305 */
306 public static final int DIRECTION_UNKNOWN = -1;
307
308 /**
309 * Indicates that the call is an incoming call.
310 */
311 public static final int DIRECTION_INCOMING = 0;
312
313 /**
314 * Indicates that the call is an outgoing call.
315 */
316 public static final int DIRECTION_OUTGOING = 1;
317
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800318 /** Call can currently be put on hold or unheld. */
319 public static final int CAPABILITY_HOLD = 0x00000001;
320
321 /** Call supports the hold feature. */
322 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
323
324 /**
325 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
326 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
327 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
328 * capability allows a merge button to be shown while the conference call is in the foreground
329 * of the in-call UI.
330 * <p>
331 * This is only intended for use by a {@link Conference}.
332 */
333 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
334
335 /**
336 * Calls within a conference can be swapped between foreground and background.
337 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
338 * <p>
339 * This is only intended for use by a {@link Conference}.
340 */
341 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
342
343 /**
344 * @hide
345 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700346 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800347
348 /** Call supports responding via text option. */
349 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
350
351 /** Call can be muted. */
352 public static final int CAPABILITY_MUTE = 0x00000040;
353
354 /**
355 * Call supports conference call management. This capability only applies to {@link Conference}
356 * calls which can have {@link Connection}s as children.
357 */
358 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
359
360 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700361 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800362 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700363 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800364
365 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700366 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800367 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700368 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800369
370 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700371 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800372 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700373 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700374 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800375
376 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700377 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800378 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700379 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
380
381 /**
382 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700383 */
384 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
385
386 /**
387 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700388 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700389 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700390 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800391
392 /**
393 * Call is able to be separated from its parent {@code Conference}, if any.
394 */
395 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
396
397 /**
398 * Call is able to be individually disconnected when in a {@code Conference}.
399 */
400 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
401
402 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500403 * Speed up audio setup for MT call.
404 * @hide
405 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700406 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
407
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700408 /**
409 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700410 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800411 * @deprecated Use {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
412 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL} to indicate for a call
413 * whether or not video calling is supported.
Rekha Kumar07366812015-03-24 16:42:31 -0700414 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800415 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Rekha Kumar07366812015-03-24 16:42:31 -0700416 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
417
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700418 /**
419 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700420 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700421 */
422 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
423
Bryce Lee81901682015-08-28 16:38:02 -0700424 /**
425 * Call sends responses through connection.
426 * @hide
427 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800428 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
429
430 /**
431 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
432 * <p>
433 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
434 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
435 * downgraded from a video call back to a VideoState of
436 * {@link VideoProfile#STATE_AUDIO_ONLY}.
437 * <p>
438 * Intuitively, a call which can be downgraded to audio should also have local and remote
439 * video
440 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
441 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
442 */
443 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700444
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700445 /**
446 * When set for an external call, indicates that this {@code Call} can be pulled from a
447 * remote device to the current device.
448 * <p>
449 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
450 * <p>
451 * An {@link InCallService} will only see calls with this capability if it has the
452 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
453 * in its manifest.
454 * <p>
455 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700456 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700457 */
458 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
459
Pooja Jaind34698d2017-12-28 14:15:31 +0530460 /** Call supports the deflect feature. */
461 public static final int CAPABILITY_SUPPORT_DEFLECT = 0x01000000;
462
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800463 /**
464 * Call supports adding participants to the call via
Grace Jia8587ee52020-07-10 15:42:32 -0700465 * {@link #addConferenceParticipants(List)}. Once participants are added, the call becomes
466 * an adhoc conference call ({@link #PROPERTY_IS_ADHOC_CONFERENCE}).
Tyler Gunn0c62ef02020-02-11 14:39:43 -0800467 */
Ravi Paluri404babb2020-01-23 19:02:44 +0530468 public static final int CAPABILITY_ADD_PARTICIPANT = 0x02000000;
Ravi Palurif4b38e72020-02-05 12:35:41 +0530469
470 /**
471 * When set for a call, indicates that this {@code Call} can be transferred to another
472 * number.
Tyler Gunn460360d2020-07-29 10:21:45 -0700473 * Call supports the confirmed and unconfirmed call transfer feature.
Ravi Palurif4b38e72020-02-05 12:35:41 +0530474 *
475 * @hide
476 */
477 public static final int CAPABILITY_TRANSFER = 0x04000000;
478
479 /**
480 * When set for a call, indicates that this {@code Call} can be transferred to another
481 * ongoing call.
482 * Call supports the consultative call transfer feature.
483 *
484 * @hide
485 */
486 public static final int CAPABILITY_TRANSFER_CONSULTATIVE = 0x08000000;
487
Tyler Gunnd11a3152015-03-18 13:09:14 -0700488 //******************************************************************************************
Ravi Palurif4b38e72020-02-05 12:35:41 +0530489 // Next CAPABILITY value: 0x10000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700490 //******************************************************************************************
491
492 /**
493 * Whether the call is currently a conference.
494 */
495 public static final int PROPERTY_CONFERENCE = 0x00000001;
496
497 /**
498 * Whether the call is a generic conference, where we do not know the precise state of
499 * participants in the conference (eg. on CDMA).
500 */
501 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
502
503 /**
504 * Whether the call is made while the device is in emergency callback mode.
505 */
506 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
507
508 /**
509 * Connection is using WIFI.
510 */
511 public static final int PROPERTY_WIFI = 0x00000008;
512
513 /**
Tyler Gunn6b6ae552018-10-11 10:42:10 -0700514 * When set, the UI should indicate to the user that a call is using high definition
515 * audio.
516 * <p>
517 * The underlying {@link ConnectionService} is responsible for reporting this
518 * property. It is important to note that this property is not intended to report the
519 * actual audio codec being used for a Call, but whether the call should be indicated
520 * to the user as high definition.
521 * <p>
522 * The Android Telephony stack reports this property for calls based on a number
523 * of factors, including which audio codec is used and whether a call is using an HD
524 * codec end-to-end. Some mobile operators choose to suppress display of an HD indication,
525 * and in these cases this property will not be set for a call even if the underlying audio
526 * codec is in fact "high definition".
Andrew Lee2378ea72015-04-29 14:38:11 -0700527 */
528 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
529
Tony Maka68dcce2015-12-17 09:31:18 +0000530 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100531 * Whether the call is associated with the work profile.
532 */
533 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
534
535 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700536 * When set, indicates that this {@code Call} does not actually exist locally for the
537 * {@link ConnectionService}.
538 * <p>
539 * Consider, for example, a scenario where a user has two phones with the same phone number.
540 * When a user places a call on one device, the telephony stack can represent that call on
541 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700542 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700543 * <p>
544 * An {@link InCallService} will only see calls with this property if it has the
545 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
546 * in its manifest.
547 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700548 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700549 */
550 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
551
Brad Ebinger15847072016-05-18 11:08:36 -0700552 /**
553 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
554 */
555 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
556
Tyler Gunn24e18332017-02-10 09:42:49 -0800557 /**
558 * Indicates that the call is from a self-managed {@link ConnectionService}.
559 * <p>
560 * See also {@link Connection#PROPERTY_SELF_MANAGED}
561 */
562 public static final int PROPERTY_SELF_MANAGED = 0x00000100;
563
Eric Erfanianec881872017-12-06 16:27:53 -0800564 /**
565 * Indicates the call used Assisted Dialing.
Tyler Gunn5567d742019-10-31 13:04:37 -0700566 *
567 * @see TelecomManager#EXTRA_USE_ASSISTED_DIALING
Eric Erfanianec881872017-12-06 16:27:53 -0800568 */
Tyler Gunnc9503d62020-01-27 10:30:51 -0800569 public static final int PROPERTY_ASSISTED_DIALING = 0x00000200;
Eric Erfanianec881872017-12-06 16:27:53 -0800570
Hall Liue9041242018-02-09 16:40:03 -0800571 /**
572 * Indicates that the call is an RTT call. Use {@link #getRttCall()} to get the
573 * {@link RttCall} object that is used to send and receive text.
574 */
575 public static final int PROPERTY_RTT = 0x00000400;
576
Tyler Gunn5bd90852018-09-21 09:37:07 -0700577 /**
578 * Indicates that the call has been identified as the network as an emergency call. This
579 * property may be set for both incoming and outgoing calls which the network identifies as
580 * emergency calls.
581 */
582 public static final int PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL = 0x00000800;
583
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700584 /**
585 * Indicates that the call is using VoIP audio mode.
586 * <p>
587 * When this property is set, the {@link android.media.AudioManager} audio mode for this
588 * call will be {@link android.media.AudioManager#MODE_IN_COMMUNICATION}. When this
589 * property is not set, the audio mode for this call will be
590 * {@link android.media.AudioManager#MODE_IN_CALL}.
591 * <p>
592 * This property reflects changes made using {@link Connection#setAudioModeIsVoip(boolean)}.
593 * <p>
594 * You can use this property to determine whether an un-answered incoming call or a held
595 * call will use VoIP audio mode (if the call does not currently have focus, the system
596 * audio mode may not reflect the mode the call will use).
597 */
598 public static final int PROPERTY_VOIP_AUDIO_MODE = 0x00001000;
599
Ravi Paluri80aa2142019-12-02 11:57:37 +0530600 /**
601 * Indicates that the call is an adhoc conference call. This property can be set for both
Grace Jia8587ee52020-07-10 15:42:32 -0700602 * incoming and outgoing calls. An adhoc conference call is formed using
603 * {@link #addConferenceParticipants(List)},
604 * {@link TelecomManager#addNewIncomingConference(PhoneAccountHandle, Bundle)}, or
605 * {@link TelecomManager#startConference(List, Bundle)}, rather than by merging existing
606 * call using {@link #conference(Call)}.
Ravi Paluri80aa2142019-12-02 11:57:37 +0530607 */
608 public static final int PROPERTY_IS_ADHOC_CONFERENCE = 0x00002000;
609
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800610 /**
611 * Connection is using Cross SIM Calling.
612 */
613 public static final int PROPERTY_CROSS_SIM = 0x00004000;
614
Andrew Lee2378ea72015-04-29 14:38:11 -0700615 //******************************************************************************************
Ravi Paluri80aa2142019-12-02 11:57:37 +0530616 // Next PROPERTY value: 0x00004000
Tyler Gunnd11a3152015-03-18 13:09:14 -0700617 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800618
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800619 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700620 private final Uri mHandle;
621 private final int mHandlePresentation;
622 private final String mCallerDisplayName;
623 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700624 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700625 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700626 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800627 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700628 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700629 private final long mConnectTimeMillis;
630 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700631 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700632 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700633 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700634 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700635 private final long mCreationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -0800636 private final String mContactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -0800637 private final @CallDirection int mCallDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -0700638 private final @Connection.VerificationStatus int mCallerNumberVerificationStatus;
Ihab Awade63fadb2014-07-09 21:52:04 -0700639
640 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800641 * Whether the supplied capabilities supports the specified capability.
642 *
643 * @param capabilities A bit field of capabilities.
644 * @param capability The capability to check capabilities for.
645 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800646 */
647 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800648 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800649 }
650
651 /**
652 * Whether the capabilities of this {@code Details} supports the specified capability.
653 *
654 * @param capability The capability to check capabilities for.
655 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800656 */
657 public boolean can(int capability) {
658 return can(mCallCapabilities, capability);
659 }
660
661 /**
662 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
663 *
664 * @param capabilities A capability bit field.
665 * @return A human readable string representation.
666 */
667 public static String capabilitiesToString(int capabilities) {
668 StringBuilder builder = new StringBuilder();
669 builder.append("[Capabilities:");
670 if (can(capabilities, CAPABILITY_HOLD)) {
671 builder.append(" CAPABILITY_HOLD");
672 }
673 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
674 builder.append(" CAPABILITY_SUPPORT_HOLD");
675 }
676 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
677 builder.append(" CAPABILITY_MERGE_CONFERENCE");
678 }
679 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
680 builder.append(" CAPABILITY_SWAP_CONFERENCE");
681 }
682 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
683 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
684 }
685 if (can(capabilities, CAPABILITY_MUTE)) {
686 builder.append(" CAPABILITY_MUTE");
687 }
688 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
689 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
690 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700691 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
692 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
693 }
694 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
695 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
696 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700697 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
698 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800699 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700700 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
701 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
702 }
703 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
704 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
705 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800706 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
707 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
708 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700709 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
710 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800711 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500712 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700713 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500714 }
Rekha Kumar07366812015-03-24 16:42:31 -0700715 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
716 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
717 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700718 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
719 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
720 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700721 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
722 builder.append(" CAPABILITY_CAN_PULL_CALL");
723 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530724 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
725 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
726 }
Ravi Paluri404babb2020-01-23 19:02:44 +0530727 if (can(capabilities, CAPABILITY_ADD_PARTICIPANT)) {
728 builder.append(" CAPABILITY_ADD_PARTICIPANT");
729 }
Ravi Palurif4b38e72020-02-05 12:35:41 +0530730 if (can(capabilities, CAPABILITY_TRANSFER)) {
731 builder.append(" CAPABILITY_TRANSFER");
732 }
733 if (can(capabilities, CAPABILITY_TRANSFER_CONSULTATIVE)) {
734 builder.append(" CAPABILITY_TRANSFER_CONSULTATIVE");
735 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800736 builder.append("]");
737 return builder.toString();
738 }
739
740 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700741 * Whether the supplied properties includes the specified property.
742 *
743 * @param properties A bit field of properties.
744 * @param property The property to check properties for.
745 * @return Whether the specified property is supported.
746 */
747 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800748 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700749 }
750
751 /**
752 * Whether the properties of this {@code Details} includes the specified property.
753 *
754 * @param property The property to check properties for.
755 * @return Whether the specified property is supported.
756 */
757 public boolean hasProperty(int property) {
758 return hasProperty(mCallProperties, property);
759 }
760
761 /**
762 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
763 *
764 * @param properties A property bit field.
765 * @return A human readable string representation.
766 */
767 public static String propertiesToString(int properties) {
768 StringBuilder builder = new StringBuilder();
769 builder.append("[Properties:");
770 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
771 builder.append(" PROPERTY_CONFERENCE");
772 }
773 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
774 builder.append(" PROPERTY_GENERIC_CONFERENCE");
775 }
776 if (hasProperty(properties, PROPERTY_WIFI)) {
777 builder.append(" PROPERTY_WIFI");
778 }
779 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
780 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
781 }
782 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700783 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700784 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700785 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
786 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
787 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700788 if (hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
Brad Ebinger15847072016-05-18 11:08:36 -0700789 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
790 }
Tyler Gunnc9503d62020-01-27 10:30:51 -0800791 if (hasProperty(properties, PROPERTY_ASSISTED_DIALING)) {
Eric Erfanianec881872017-12-06 16:27:53 -0800792 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
793 }
Tyler Gunn5bd90852018-09-21 09:37:07 -0700794 if (hasProperty(properties, PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL)) {
795 builder.append(" PROPERTY_NETWORK_IDENTIFIED_EMERGENCY_CALL");
796 }
Tyler Gunn80a5e1e2018-06-22 15:52:27 -0700797 if (hasProperty(properties, PROPERTY_RTT)) {
798 builder.append(" PROPERTY_RTT");
799 }
800 if (hasProperty(properties, PROPERTY_VOIP_AUDIO_MODE)) {
801 builder.append(" PROPERTY_VOIP_AUDIO_MODE");
802 }
Ravi Paluri80aa2142019-12-02 11:57:37 +0530803 if (hasProperty(properties, PROPERTY_IS_ADHOC_CONFERENCE)) {
804 builder.append(" PROPERTY_IS_ADHOC_CONFERENCE");
805 }
Sooraj Sasindran64f05b12020-11-18 12:07:10 -0800806 if (hasProperty(properties, PROPERTY_CROSS_SIM)) {
807 builder.append(" PROPERTY_CROSS_SIM");
808 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700809 builder.append("]");
810 return builder.toString();
811 }
812
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800813 /** {@hide} */
Hall Liu31de23d2019-10-11 15:38:29 -0700814 @TestApi
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800815 public String getTelecomCallId() {
816 return mTelecomCallId;
817 }
818
Andrew Lee2378ea72015-04-29 14:38:11 -0700819 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700820 * @return The handle (e.g., phone number) to which the {@code Call} is currently
821 * connected.
822 */
823 public Uri getHandle() {
824 return mHandle;
825 }
826
827 /**
828 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700829 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700830 */
831 public int getHandlePresentation() {
832 return mHandlePresentation;
833 }
834
835 /**
Tyler Gunnd081f042018-12-04 12:56:45 -0800836 * The display name for the caller.
837 * <p>
838 * This is the name as reported by the {@link ConnectionService} associated with this call.
Tyler Gunnd081f042018-12-04 12:56:45 -0800839 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700840 * @return The display name for the caller.
841 */
842 public String getCallerDisplayName() {
843 return mCallerDisplayName;
844 }
845
846 /**
847 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700848 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700849 */
850 public int getCallerDisplayNamePresentation() {
851 return mCallerDisplayNamePresentation;
852 }
853
854 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700855 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
856 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700857 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700858 public PhoneAccountHandle getAccountHandle() {
859 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -0700860 }
861
862 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800863 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
864 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -0700865 */
Ihab Awad5d0410f2014-07-30 10:07:40 -0700866 public int getCallCapabilities() {
867 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -0700868 }
869
870 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700871 * @return A bitmask of the properties of the {@code Call}, as defined by the various
872 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -0700873 */
874 public int getCallProperties() {
875 return mCallProperties;
876 }
877
878 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800879 * @return a bitmask of the audio routes available for the call.
880 *
881 * @hide
882 */
883 public int getSupportedAudioRoutes() {
884 return mSupportedAudioRoutes;
885 }
886
887 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700888 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -0700889 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700890 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700891 public DisconnectCause getDisconnectCause() {
892 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700893 }
894
895 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700896 * Returns the time the {@link Call} connected (i.e. became active). This information is
897 * updated periodically, but user interfaces should not rely on this to display the "call
898 * time clock". For the time when the call was first added to Telecom, see
899 * {@link #getCreationTimeMillis()}.
900 *
901 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -0700902 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -0700903 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -0700904 return mConnectTimeMillis;
905 }
906
907 /**
908 * @return Information about any calling gateway the {@code Call} may be using.
909 */
910 public GatewayInfo getGatewayInfo() {
911 return mGatewayInfo;
912 }
913
Andrew Lee7a341382014-07-15 17:05:08 -0700914 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -0700915 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -0700916 */
917 public int getVideoState() {
918 return mVideoState;
919 }
920
Ihab Awad5d0410f2014-07-30 10:07:40 -0700921 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700922 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -0700923 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -0700924 */
925 public StatusHints getStatusHints() {
926 return mStatusHints;
927 }
928
Nancy Chen10798dc2014-08-08 14:00:25 -0700929 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -0700930 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700931 */
932 public Bundle getExtras() {
933 return mExtras;
934 }
935
Santos Cordon6b7f9552015-05-27 17:21:45 -0700936 /**
937 * @return The extras used with the original intent to place this call.
938 */
939 public Bundle getIntentExtras() {
940 return mIntentExtras;
941 }
942
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700943 /**
944 * Returns the time when the call was first created and added to Telecom. This is the same
945 * time that is logged as the start time in the Call Log (see
946 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
947 * (became active), see {@link #getConnectTimeMillis()}.
948 *
949 * @return The creation time of the call, in millis since the epoch.
950 */
951 public long getCreationTimeMillis() {
952 return mCreationTimeMillis;
953 }
954
Tyler Gunnd081f042018-12-04 12:56:45 -0800955 /**
Hall Liuef98bf82020-01-09 15:22:44 -0800956 * Returns the name of the caller on the remote end, as derived from a
957 * {@link android.provider.ContactsContract} lookup of the call's handle.
958 * @return The name of the caller, or {@code null} if the lookup is not yet complete, if
959 * there's no contacts entry for the caller, or if the {@link InCallService} does
960 * not hold the {@link android.Manifest.permission#READ_CONTACTS} permission.
961 */
962 public @Nullable String getContactDisplayName() {
963 return mContactDisplayName;
964 }
965
966 /**
Tyler Gunn94f8f112018-12-17 09:56:11 -0800967 * Indicates whether the call is an incoming or outgoing call.
968 * @return The call's direction.
969 */
970 public @CallDirection int getCallDirection() {
971 return mCallDirection;
972 }
973
Tyler Gunnd57d76c2019-09-24 14:53:23 -0700974 /**
975 * Gets the verification status for the phone number of an incoming call as identified in
976 * ATIS-1000082.
Tyler Gunn9c642492020-10-08 13:37:03 -0700977 * <p>
978 * For incoming calls, the number verification status indicates whether the device was
979 * able to verify the authenticity of the calling number using the STIR process outlined
980 * in ATIS-1000082. {@link Connection#VERIFICATION_STATUS_NOT_VERIFIED} indicates that
981 * the network was not able to use STIR to verify the caller's number (i.e. nothing is
982 * known regarding the authenticity of the number.
983 * {@link Connection#VERIFICATION_STATUS_PASSED} indicates that the network was able to
984 * use STIR to verify the caller's number. This indicates that the network has a high
985 * degree of confidence that the incoming call actually originated from the indicated
986 * number. {@link Connection#VERIFICATION_STATUS_FAILED} indicates that the network's
987 * STIR verification did not pass. This indicates that the incoming call may not
988 * actually be from the indicated number. This could occur if, for example, the caller
989 * is using an impersonated phone number.
990 * <p>
991 * A {@link CallScreeningService} can use this information to help determine if an
992 * incoming call is potentially an unwanted call. A verification status of
993 * {@link Connection#VERIFICATION_STATUS_FAILED} indicates that an incoming call may not
994 * actually be from the number indicated on the call (i.e. impersonated number) and that it
995 * should potentially be blocked. Likewise,
996 * {@link Connection#VERIFICATION_STATUS_PASSED} can be used as a positive signal to
997 * help clarify that the incoming call is originating from the indicated number and it
998 * is less likely to be an undesirable call.
999 * <p>
1000 * An {@link InCallService} can use this information to provide a visual indicator to the
1001 * user regarding the verification status of a call and to help identify calls from
1002 * potentially impersonated numbers.
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001003 * @return the verification status.
1004 */
1005 public @Connection.VerificationStatus int getCallerNumberVerificationStatus() {
1006 return mCallerNumberVerificationStatus;
1007 }
1008
Ihab Awade63fadb2014-07-09 21:52:04 -07001009 @Override
1010 public boolean equals(Object o) {
1011 if (o instanceof Details) {
1012 Details d = (Details) o;
1013 return
1014 Objects.equals(mHandle, d.mHandle) &&
1015 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
1016 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
1017 Objects.equals(mCallerDisplayNamePresentation,
1018 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -07001019 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -07001020 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -07001021 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001022 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -07001023 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -07001024 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -07001025 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -07001026 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07001027 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001028 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
Tyler Gunnd081f042018-12-04 12:56:45 -08001029 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis) &&
Hall Liuef98bf82020-01-09 15:22:44 -08001030 Objects.equals(mContactDisplayName, d.mContactDisplayName) &&
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001031 Objects.equals(mCallDirection, d.mCallDirection) &&
1032 Objects.equals(mCallerNumberVerificationStatus,
1033 d.mCallerNumberVerificationStatus);
Ihab Awade63fadb2014-07-09 21:52:04 -07001034 }
1035 return false;
1036 }
1037
1038 @Override
1039 public int hashCode() {
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001040 return Objects.hash(mHandle,
1041 mHandlePresentation,
1042 mCallerDisplayName,
1043 mCallerDisplayNamePresentation,
1044 mAccountHandle,
1045 mCallCapabilities,
1046 mCallProperties,
1047 mDisconnectCause,
1048 mConnectTimeMillis,
1049 mGatewayInfo,
1050 mVideoState,
1051 mStatusHints,
1052 mExtras,
1053 mIntentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001054 mCreationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001055 mContactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001056 mCallDirection,
1057 mCallerNumberVerificationStatus);
Ihab Awade63fadb2014-07-09 21:52:04 -07001058 }
1059
1060 /** {@hide} */
1061 public Details(
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001062 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -07001063 Uri handle,
1064 int handlePresentation,
1065 String callerDisplayName,
1066 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -07001067 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -07001068 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -07001069 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001070 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -07001071 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -07001072 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -07001073 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -07001074 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -07001075 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001076 Bundle intentExtras,
Tyler Gunnd081f042018-12-04 12:56:45 -08001077 long creationTimeMillis,
Hall Liuef98bf82020-01-09 15:22:44 -08001078 String contactDisplayName,
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001079 int callDirection,
1080 int callerNumberVerificationStatus) {
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001081 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001082 mHandle = handle;
1083 mHandlePresentation = handlePresentation;
1084 mCallerDisplayName = callerDisplayName;
1085 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -07001086 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -07001087 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -07001088 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -07001089 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -07001090 mConnectTimeMillis = connectTimeMillis;
1091 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -07001092 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -07001093 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -07001094 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -07001095 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001096 mCreationTimeMillis = creationTimeMillis;
Hall Liuef98bf82020-01-09 15:22:44 -08001097 mContactDisplayName = contactDisplayName;
Tyler Gunn94f8f112018-12-17 09:56:11 -08001098 mCallDirection = callDirection;
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001099 mCallerNumberVerificationStatus = callerNumberVerificationStatus;
Ihab Awade63fadb2014-07-09 21:52:04 -07001100 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001101
1102 /** {@hide} */
1103 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
1104 return new Details(
1105 parcelableCall.getId(),
1106 parcelableCall.getHandle(),
1107 parcelableCall.getHandlePresentation(),
1108 parcelableCall.getCallerDisplayName(),
1109 parcelableCall.getCallerDisplayNamePresentation(),
1110 parcelableCall.getAccountHandle(),
1111 parcelableCall.getCapabilities(),
1112 parcelableCall.getProperties(),
1113 parcelableCall.getDisconnectCause(),
1114 parcelableCall.getConnectTimeMillis(),
1115 parcelableCall.getGatewayInfo(),
1116 parcelableCall.getVideoState(),
1117 parcelableCall.getStatusHints(),
1118 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -07001119 parcelableCall.getIntentExtras(),
Tyler Gunnd081f042018-12-04 12:56:45 -08001120 parcelableCall.getCreationTimeMillis(),
Hall Liuef98bf82020-01-09 15:22:44 -08001121 parcelableCall.getContactDisplayName(),
Tyler Gunnd57d76c2019-09-24 14:53:23 -07001122 parcelableCall.getCallDirection(),
1123 parcelableCall.getCallerNumberVerificationStatus());
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001124 }
Santos Cordon3c20d632016-02-25 16:12:35 -08001125
1126 @Override
1127 public String toString() {
1128 StringBuilder sb = new StringBuilder();
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001129 sb.append("[id: ");
1130 sb.append(mTelecomCallId);
1131 sb.append(", pa: ");
Santos Cordon3c20d632016-02-25 16:12:35 -08001132 sb.append(mAccountHandle);
1133 sb.append(", hdl: ");
Tyler Gunn3cd820f2018-11-30 14:21:18 -08001134 sb.append(Log.piiHandle(mHandle));
1135 sb.append(", hdlPres: ");
1136 sb.append(mHandlePresentation);
1137 sb.append(", videoState: ");
1138 sb.append(VideoProfile.videoStateToString(mVideoState));
Santos Cordon3c20d632016-02-25 16:12:35 -08001139 sb.append(", caps: ");
1140 sb.append(capabilitiesToString(mCallCapabilities));
1141 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -07001142 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -08001143 sb.append("]");
1144 return sb.toString();
1145 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001146 }
1147
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001148 /**
1149 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
1150 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
1151 * implementation.
1152 * <p>
1153 * You can handle these callbacks by extending the {@link Callback} class and overriding the
1154 * callbacks that your {@link InCallService} is interested in. The callback methods include the
1155 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
1156 * {@link Callback} implementation, if desired.
1157 * <p>
1158 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
1159 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
1160 * (typically in {@link InCallService#onCallRemoved(Call)}).
1161 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
1162 * reach your implementation of {@link Callback}, so it is important to register your callback
1163 * as soon as your {@link InCallService} is notified of a new call via
1164 * {@link InCallService#onCallAdded(Call)}.
1165 */
Andrew Leeda80c872015-04-15 14:09:50 -07001166 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -07001167 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001168 * @hide
1169 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001170 @IntDef(prefix = { "HANDOVER_" },
1171 value = {HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_NOT_SUPPORTED,
Tyler Gunn5c60d712018-03-16 09:53:44 -07001172 HANDOVER_FAILURE_USER_REJECTED, HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL,
Tyler Gunn9d127732018-03-02 15:45:51 -08001173 HANDOVER_FAILURE_UNKNOWN})
Sanket Padawea8eddd42017-11-03 11:07:35 -07001174 @Retention(RetentionPolicy.SOURCE)
1175 public @interface HandoverFailureErrors {}
1176
1177 /**
1178 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
Tyler Gunn9d127732018-03-02 15:45:51 -08001179 * to handover the call to rejects the handover request.
1180 * <p>
1181 * Will be returned when {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} is called
1182 * and the destination {@link PhoneAccountHandle}'s {@link ConnectionService} returns a
1183 * {@code null} {@link Connection} from
1184 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
1185 * ConnectionRequest)}.
1186 * <p>
1187 * For more information on call handovers, see
1188 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001189 */
1190 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
1191
1192 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001193 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1194 * is initiated but the source or destination app does not support handover.
1195 * <p>
1196 * Will be returned when a handover is requested via
1197 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)} and the destination
1198 * {@link PhoneAccountHandle} does not declare
1199 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}. May also be returned when a handover is
1200 * requested at the {@link PhoneAccountHandle} for the current call (i.e. the source call's
1201 * {@link Details#getAccountHandle()}) does not declare
1202 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}.
1203 * <p>
1204 * For more information on call handovers, see
1205 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001206 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001207 public static final int HANDOVER_FAILURE_NOT_SUPPORTED = 2;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001208
1209 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08001210 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the remote
1211 * user rejects the handover request.
1212 * <p>
1213 * For more information on call handovers, see
1214 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001215 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001216 public static final int HANDOVER_FAILURE_USER_REJECTED = 3;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001217
Sanket Padawe85291f62017-12-01 13:59:27 -08001218 /**
1219 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
1220 * is ongoing emergency call.
Tyler Gunn9d127732018-03-02 15:45:51 -08001221 * <p>
1222 * This error code is returned when {@link #handoverTo(PhoneAccountHandle, int, Bundle)} is
1223 * called on an emergency call, or if any other call is an emergency call.
1224 * <p>
1225 * Handovers are not permitted while there are ongoing emergency calls.
1226 * <p>
1227 * For more information on call handovers, see
1228 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
Sanket Padawe85291f62017-12-01 13:59:27 -08001229 */
Tyler Gunn5c60d712018-03-16 09:53:44 -07001230 public static final int HANDOVER_FAILURE_ONGOING_EMERGENCY_CALL = 4;
Sanket Padawe85291f62017-12-01 13:59:27 -08001231
Tyler Gunn9d127732018-03-02 15:45:51 -08001232 /**
1233 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when a handover
1234 * fails for an unknown reason.
1235 * <p>
1236 * For more information on call handovers, see
1237 * {@link #handoverTo(PhoneAccountHandle, int, Bundle)}.
1238 */
1239 public static final int HANDOVER_FAILURE_UNKNOWN = 5;
Sanket Padawea8eddd42017-11-03 11:07:35 -07001240
1241 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001242 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
1243 *
Ihab Awade63fadb2014-07-09 21:52:04 -07001244 * @param call The {@code Call} invoking this method.
1245 * @param state The new state of the {@code Call}.
1246 */
1247 public void onStateChanged(Call call, int state) {}
1248
1249 /**
1250 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
1251 *
1252 * @param call The {@code Call} invoking this method.
1253 * @param parent The new parent of the {@code Call}.
1254 */
1255 public void onParentChanged(Call call, Call parent) {}
1256
1257 /**
1258 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
1259 *
1260 * @param call The {@code Call} invoking this method.
1261 * @param children The new children of the {@code Call}.
1262 */
1263 public void onChildrenChanged(Call call, List<Call> children) {}
1264
1265 /**
1266 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
1267 *
1268 * @param call The {@code Call} invoking this method.
1269 * @param details A {@code Details} object describing the {@code Call}.
1270 */
1271 public void onDetailsChanged(Call call, Details details) {}
1272
1273 /**
1274 * Invoked when the text messages that can be used as responses to the incoming
1275 * {@code Call} are loaded from the relevant database.
1276 * See {@link #getCannedTextResponses()}.
1277 *
1278 * @param call The {@code Call} invoking this method.
1279 * @param cannedTextResponses The text messages useable as responses.
1280 */
1281 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
1282
1283 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001284 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
1285 * character. This causes the post-dial signals to stop pending user confirmation. An
1286 * implementation should present this choice to the user and invoke
1287 * {@link #postDialContinue(boolean)} when the user makes the choice.
1288 *
1289 * @param call The {@code Call} invoking this method.
1290 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
1291 */
1292 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
1293
1294 /**
Andrew Lee50aca232014-07-22 16:41:54 -07001295 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -07001296 *
1297 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -07001298 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001299 */
Andrew Lee50aca232014-07-22 16:41:54 -07001300 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -07001301
1302 /**
1303 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
1304 * up their UI for the {@code Call} in response to state transitions. Specifically,
1305 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
1306 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
1307 * clients should wait for this method to be invoked.
1308 *
1309 * @param call The {@code Call} being destroyed.
1310 */
1311 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001312
1313 /**
1314 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
1315 * conferenced.
1316 *
1317 * @param call The {@code Call} being updated.
1318 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
1319 * conferenced.
1320 */
1321 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001322
1323 /**
Tyler Gunn5567d742019-10-31 13:04:37 -07001324 * Invoked when a {@link Call} receives an event from its associated {@link Connection} or
1325 * {@link Conference}.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001326 * <p>
1327 * Where possible, the Call should make an attempt to handle {@link Connection} events which
1328 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1329 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1330 * possible that a {@link ConnectionService} has defined its own Connection events which a
1331 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001332 * <p>
Tyler Gunn5567d742019-10-31 13:04:37 -07001333 * See {@link Connection#sendConnectionEvent(String, Bundle)},
1334 * {@link Conference#sendConferenceEvent(String, Bundle)}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001335 *
1336 * @param call The {@code Call} receiving the event.
1337 * @param event The event.
1338 * @param extras Extras associated with the connection event.
1339 */
1340 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001341
1342 /**
1343 * Invoked when the RTT mode changes for this call.
1344 * @param call The call whose RTT mode has changed.
1345 * @param mode the new RTT mode, one of
1346 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1347 * or {@link RttCall#RTT_MODE_VCO}
1348 */
1349 public void onRttModeChanged(Call call, int mode) {}
1350
1351 /**
1352 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1353 * @param call The call whose RTT status has changed.
1354 * @param enabled whether RTT is now enabled or disabled
1355 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1356 * on, null otherwise.
1357 */
1358 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1359
1360 /**
1361 * Invoked when the remote end of the connection has requested that an RTT communication
1362 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1363 * with the same ID that this method is invoked with.
1364 * @param call The call which the RTT request was placed on
1365 * @param id The ID of the request.
1366 */
1367 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001368
1369 /**
1370 * Invoked when the RTT session failed to initiate for some reason, including rejection
1371 * by the remote party.
1372 * @param call The call which the RTT initiation failure occurred on.
1373 * @param reason One of the status codes defined in
1374 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1375 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
1376 */
1377 public void onRttInitiationFailure(Call call, int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001378
1379 /**
1380 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1381 * has completed successfully.
Tyler Gunn9d127732018-03-02 15:45:51 -08001382 * <p>
1383 * For a full discussion of the handover process and the APIs involved, see
1384 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1385 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001386 * @param call The call which had initiated handover.
1387 */
1388 public void onHandoverComplete(Call call) {}
1389
1390 /**
1391 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1392 * has failed.
Tyler Gunn9d127732018-03-02 15:45:51 -08001393 * <p>
1394 * For a full discussion of the handover process and the APIs involved, see
1395 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
1396 *
Sanket Padawea8eddd42017-11-03 11:07:35 -07001397 * @param call The call which had initiated handover.
Tyler Gunn9d127732018-03-02 15:45:51 -08001398 * @param failureReason Error reason for failure.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001399 */
1400 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001401 }
1402
1403 /**
1404 * A class that holds the state that describes the state of the RTT channel to the remote
1405 * party, if it is active.
1406 */
1407 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001408 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001409 @Retention(RetentionPolicy.SOURCE)
1410 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1411 public @interface RttAudioMode {}
1412
1413 /**
1414 * For metrics use. Default value in the proto.
1415 * @hide
1416 */
1417 public static final int RTT_MODE_INVALID = 0;
1418
1419 /**
1420 * Indicates that there should be a bidirectional audio stream between the two parties
1421 * on the call.
1422 */
1423 public static final int RTT_MODE_FULL = 1;
1424
1425 /**
1426 * Indicates that the local user should be able to hear the audio stream from the remote
1427 * user, but not vice versa. Equivalent to muting the microphone.
1428 */
1429 public static final int RTT_MODE_HCO = 2;
1430
1431 /**
1432 * Indicates that the remote user should be able to hear the audio stream from the local
1433 * user, but not vice versa. Equivalent to setting the volume to zero.
1434 */
1435 public static final int RTT_MODE_VCO = 3;
1436
1437 private static final int READ_BUFFER_SIZE = 1000;
1438
1439 private InputStreamReader mReceiveStream;
1440 private OutputStreamWriter mTransmitStream;
1441 private int mRttMode;
1442 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001443 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001444 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1445
1446 /**
1447 * @hide
1448 */
Hall Liu57006aa2017-02-06 10:49:48 -08001449 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1450 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1451 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001452 mReceiveStream = receiveStream;
1453 mTransmitStream = transmitStream;
1454 mRttMode = mode;
1455 mInCallAdapter = inCallAdapter;
1456 }
1457
1458 /**
1459 * Returns the current RTT audio mode.
1460 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1461 * {@link #RTT_MODE_HCO}.
1462 */
1463 public int getRttAudioMode() {
1464 return mRttMode;
1465 }
1466
1467 /**
1468 * Sets the RTT audio mode. The requested mode change will be communicated through
1469 * {@link Callback#onRttModeChanged(Call, int)}.
1470 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1471 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1472 */
1473 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001474 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001475 }
1476
1477 /**
1478 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
Hall Liudc46c852020-10-29 16:15:33 -07001479 * RTT transmits text in real-time, this method should be called once for each user action.
1480 * For example, when the user enters text as discrete characters using the keyboard, this
1481 * method should be called once for each character. However, if the user enters text by
1482 * pasting or autocomplete, the entire contents of the pasted or autocompleted text should
1483 * be sent in one call to this method.
Hall Liu95d55872017-01-25 17:12:49 -08001484 *
1485 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1486 * lead to interleaved text.
1487 * @param input The message to send to the remote user.
1488 */
1489 public void write(String input) throws IOException {
1490 mTransmitStream.write(input);
1491 mTransmitStream.flush();
1492 }
1493
1494 /**
1495 * Reads a string from the remote user, blocking if there is no data available. Returns
1496 * {@code null} if the RTT conversation has been terminated and there is no further data
1497 * to read.
1498 *
1499 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1500 * lead to interleaved text.
1501 * @return A string containing text sent by the remote user, or {@code null} if the
1502 * conversation has been terminated or if there was an error while reading.
1503 */
Hall Liub1c8a772017-07-17 17:04:41 -07001504 public String read() {
1505 try {
1506 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1507 if (numRead < 0) {
1508 return null;
1509 }
1510 return new String(mReadBuffer, 0, numRead);
1511 } catch (IOException e) {
1512 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001513 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001514 }
Hall Liuffa4a812017-03-02 16:11:00 -08001515 }
1516
1517 /**
1518 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1519 * be read.
1520 * @return A string containing text entered by the user, or {@code null} if the user has
1521 * not entered any new text yet.
1522 */
1523 public String readImmediately() throws IOException {
1524 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001525 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1526 if (numRead < 0) {
1527 return null;
1528 }
1529 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001530 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001531 return null;
1532 }
1533 }
Hall Liue9041242018-02-09 16:40:03 -08001534
1535 /**
1536 * Closes the underlying file descriptors
1537 * @hide
1538 */
1539 public void close() {
1540 try {
1541 mReceiveStream.close();
1542 } catch (IOException e) {
1543 // ignore
1544 }
1545 try {
1546 mTransmitStream.close();
1547 } catch (IOException e) {
1548 // ignore
1549 }
1550 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001551 }
1552
Andrew Leeda80c872015-04-15 14:09:50 -07001553 /**
1554 * @deprecated Use {@code Call.Callback} instead.
1555 * @hide
1556 */
1557 @Deprecated
1558 @SystemApi
1559 public static abstract class Listener extends Callback { }
1560
Ihab Awade63fadb2014-07-09 21:52:04 -07001561 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001562 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001563 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001564 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001565 private final List<Call> mChildren = new ArrayList<>();
1566 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001567 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001568 private final List<Call> mConferenceableCalls = new ArrayList<>();
1569 private final List<Call> mUnmodifiableConferenceableCalls =
1570 Collections.unmodifiableList(mConferenceableCalls);
1571
Santos Cordon823fd3c2014-08-07 18:35:18 -07001572 private boolean mChildrenCached;
1573 private String mParentId = null;
Hall Liuef98bf82020-01-09 15:22:44 -08001574 private String mActiveGenericConferenceChild = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001575 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001576 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001577 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001578 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001579 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001580 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001581 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001582 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001583 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001584
1585 /**
1586 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1587 *
1588 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1589 * remaining or this {@code Call} is not in a post-dial state.
1590 */
1591 public String getRemainingPostDialSequence() {
1592 return mRemainingPostDialSequence;
1593 }
1594
1595 /**
1596 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001597 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001598 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001599 public void answer(@VideoProfile.VideoState int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001600 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001601 }
1602
1603 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301604 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1605 *
1606 * @param address The address to which the call will be deflected.
1607 */
1608 public void deflect(Uri address) {
1609 mInCallAdapter.deflectCall(mTelecomCallId, address);
1610 }
1611
1612 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001613 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1614 *
1615 * @param rejectWithMessage Whether to reject with a text message.
1616 * @param textMessage An optional text message with which to respond.
1617 */
1618 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001619 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001620 }
1621
1622 /**
Tyler Gunnfacfdee2020-01-23 13:10:37 -08001623 * Instructs the {@link ConnectionService} providing this {@link #STATE_RINGING} call that the
1624 * user has chosen to reject the call and has indicated a reason why the call is being rejected.
1625 *
1626 * @param rejectReason the reason the call is being rejected.
1627 */
1628 public void reject(@RejectReason int rejectReason) {
1629 mInCallAdapter.rejectCall(mTelecomCallId, rejectReason);
1630 }
1631
1632 /**
Ravi Palurif4b38e72020-02-05 12:35:41 +05301633 * Instructs this {@code Call} to be transferred to another number.
1634 *
1635 * @param targetNumber The address to which the call will be transferred.
Tyler Gunn460360d2020-07-29 10:21:45 -07001636 * @param isConfirmationRequired if {@code true} it will initiate a confirmed transfer,
1637 * if {@code false}, it will initiate an unconfirmed transfer.
Ravi Palurif4b38e72020-02-05 12:35:41 +05301638 *
1639 * @hide
1640 */
1641 public void transfer(@NonNull Uri targetNumber, boolean isConfirmationRequired) {
1642 mInCallAdapter.transferCall(mTelecomCallId, targetNumber, isConfirmationRequired);
1643 }
1644
1645 /**
1646 * Instructs this {@code Call} to be transferred to another ongoing call.
1647 * This will initiate CONSULTATIVE transfer.
1648 * @param toCall The other ongoing {@code Call} to which this call will be transferred.
1649 *
1650 * @hide
1651 */
1652 public void transfer(@NonNull android.telecom.Call toCall) {
1653 mInCallAdapter.transferCall(mTelecomCallId, toCall.mTelecomCallId);
1654 }
1655
1656 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001657 * Instructs this {@code Call} to disconnect.
1658 */
1659 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001660 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001661 }
1662
1663 /**
1664 * Instructs this {@code Call} to go on hold.
1665 */
1666 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001667 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001668 }
1669
1670 /**
1671 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1672 */
1673 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001674 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001675 }
1676
1677 /**
Hall Liu6dfa2492019-10-01 17:20:39 -07001678 * Instructs Telecom to put the call into the background audio processing state.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001679 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001680 * This method can be called either when the call is in {@link #STATE_RINGING} or
1681 * {@link #STATE_ACTIVE}. After Telecom acknowledges the request by setting the call's state to
1682 * {@link #STATE_AUDIO_PROCESSING}, your app may setup the audio paths with the audio stack in
1683 * order to capture and play audio on the call stream.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001684 * <p>
Hall Liu6dfa2492019-10-01 17:20:39 -07001685 * This method can only be called by the default dialer app.
Tyler Gunn460b7d42020-05-15 10:19:32 -07001686 * <p>
1687 * Apps built with SDK version {@link android.os.Build.VERSION_CODES#R} or later which are using
1688 * the microphone as part of audio processing should specify the foreground service type using
1689 * the attribute {@link android.R.attr#foregroundServiceType} in the {@link InCallService}
1690 * service element of the app's manifest file.
1691 * The {@link ServiceInfo#FOREGROUND_SERVICE_TYPE_MICROPHONE} attribute should be specified.
1692 * @see <a href="https://developer.android.com/preview/privacy/foreground-service-types">
1693 * the Android Developer Site</a> for more information.
Hall Liu6dfa2492019-10-01 17:20:39 -07001694 * @hide
1695 */
1696 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001697 public void enterBackgroundAudioProcessing() {
1698 if (mState != STATE_ACTIVE && mState != STATE_RINGING) {
1699 throw new IllegalStateException("Call must be active or ringing");
1700 }
1701 mInCallAdapter.enterBackgroundAudioProcessing(mTelecomCallId);
1702 }
1703
1704 /**
1705 * Instructs Telecom to come out of the background audio processing state requested by
1706 * {@link #enterBackgroundAudioProcessing()} or from the call screening service.
1707 *
1708 * This method can only be called when the call is in {@link #STATE_AUDIO_PROCESSING}.
1709 *
1710 * @param shouldRing If true, Telecom will put the call into the
1711 * {@link #STATE_SIMULATED_RINGING} state and notify other apps that there is
1712 * a ringing call. Otherwise, the call will go into {@link #STATE_ACTIVE}
1713 * immediately.
1714 * @hide
1715 */
1716 @SystemApi
Hall Liu6dfa2492019-10-01 17:20:39 -07001717 public void exitBackgroundAudioProcessing(boolean shouldRing) {
1718 if (mState != STATE_AUDIO_PROCESSING) {
1719 throw new IllegalStateException("Call must in the audio processing state");
1720 }
1721 mInCallAdapter.exitBackgroundAudioProcessing(mTelecomCallId, shouldRing);
1722 }
1723
1724 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001725 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
1726 *
1727 * Any other currently playing DTMF tone in the specified call is immediately stopped.
1728 *
1729 * @param digit A character representing the DTMF digit for which to play the tone. This
1730 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1731 */
1732 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001733 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001734 }
1735
1736 /**
1737 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1738 * currently playing.
1739 *
1740 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1741 * currently playing, this method will do nothing.
1742 */
1743 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001744 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001745 }
1746
1747 /**
1748 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1749 *
1750 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1751 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001752 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001753 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001754 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1755 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001756 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001757 * {@code Call} will pause playing the tones and notify callbacks via
1758 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001759 * should display to the user an indication of this state and an affordance to continue
1760 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1761 * app should invoke the {@link #postDialContinue(boolean)} method.
1762 *
1763 * @param proceed Whether or not to continue with the post-dial sequence.
1764 */
1765 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001766 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001767 }
1768
1769 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001770 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001771 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001772 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001773 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1774 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001775
1776 }
1777
1778 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001779 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001780 *
1781 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001782 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001783 public void conference(Call callToConferenceWith) {
1784 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001785 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001786 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001787 }
1788
1789 /**
1790 * Instructs this {@code Call} to split from any conference call with which it may be
1791 * connected.
1792 */
1793 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001794 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001795 }
1796
1797 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001798 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001799 */
1800 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001801 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001802 }
1803
1804 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001805 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001806 */
1807 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001808 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001809 }
1810
1811 /**
Ravi Paluri404babb2020-01-23 19:02:44 +05301812 * Pulls participants to existing call by forming a conference call.
1813 * See {@link Details#CAPABILITY_ADD_PARTICIPANT}.
1814 *
1815 * @param participants participants to be pulled to existing call.
1816 */
1817 public void addConferenceParticipants(@NonNull List<Uri> participants) {
1818 mInCallAdapter.addConferenceParticipants(mTelecomCallId, participants);
1819 }
1820
1821 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001822 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1823 * device.
1824 * <p>
1825 * Calls to this method are ignored if the call does not have the
1826 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
1827 * <p>
1828 * An {@link InCallService} will only see calls which support this method if it has the
1829 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
1830 * in its manifest.
1831 */
1832 public void pullExternalCall() {
1833 // If this isn't an external call, ignore the request.
1834 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
1835 return;
1836 }
1837
1838 mInCallAdapter.pullExternalCall(mTelecomCallId);
1839 }
1840
1841 /**
1842 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
1843 * the {@link ConnectionService}.
1844 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001845 * Call events are used to communicate point in time information from an {@link InCallService}
1846 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
1847 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
1848 * {@link ConnectionService}.
1849 * <p>
1850 * A {@link ConnectionService} can communicate to the {@link InCallService} using
1851 * {@link Connection#sendConnectionEvent(String, Bundle)}.
1852 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001853 * Events are exposed to {@link ConnectionService} implementations via
1854 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
1855 * <p>
1856 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001857 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
1858 * ignore some events altogether.
1859 * <p>
1860 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
1861 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
1862 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
1863 * they define their own event types in this namespace. When defining a custom event type,
1864 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
1865 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
1866 * <p>
1867 * When defining events and the associated extras, it is important to keep their behavior
1868 * consistent when the associated {@link InCallService} is updated. Support for deprecated
1869 * events/extras should me maintained to ensure backwards compatibility with older
1870 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001871 *
1872 * @param event The connection event.
1873 * @param extras Bundle containing extra information associated with the event.
1874 */
1875 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08001876 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001877 }
1878
1879 /**
Hall Liu95d55872017-01-25 17:12:49 -08001880 * Sends an RTT upgrade request to the remote end of the connection. Success is not
1881 * guaranteed, and notification of success will be via the
1882 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
1883 */
1884 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08001885 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08001886 }
1887
1888 /**
1889 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
1890 * callback.
1891 * The ID used here should be the same as the ID that was received via the callback.
1892 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
1893 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
1894 */
1895 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08001896 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08001897 }
1898
1899 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001900 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
1901 * by {@code toHandle}. The videoState specified indicates the desired video state after the
1902 * handover.
1903 * <p>
Tyler Gunn9d127732018-03-02 15:45:51 -08001904 * A call handover is the process where an ongoing call is transferred from one app (i.e.
1905 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
1906 * mobile network call in a video calling app. The mobile network call via the Telephony stack
1907 * is referred to as the source of the handover, and the video calling app is referred to as the
1908 * destination.
1909 * <p>
1910 * When considering a handover scenario the device this method is called on is considered the
1911 * <em>initiating</em> device (since the user initiates the handover from this device), and the
1912 * other device is considered the <em>receiving</em> device.
1913 * <p>
1914 * When this method is called on the <em>initiating</em> device, the Telecom framework will bind
1915 * to the {@link ConnectionService} defined by the {@code toHandle} {@link PhoneAccountHandle}
1916 * and invoke
1917 * {@link ConnectionService#onCreateOutgoingHandoverConnection(PhoneAccountHandle,
1918 * ConnectionRequest)} to inform the destination app that a request has been made to handover a
1919 * call to it. The app returns an instance of {@link Connection} to represent the handover call
1920 * At this point the app should display UI to indicate to the user that a call
1921 * handover is in process.
1922 * <p>
1923 * The destination app is responsible for communicating the handover request from the
1924 * <em>initiating</em> device to the <em>receiving</em> device.
1925 * <p>
1926 * When the app on the <em>receiving</em> device receives the handover request, it calls
1927 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)} to continue the handover
1928 * process from the <em>initiating</em> device to the <em>receiving</em> device. At this point
1929 * the destination app on the <em>receiving</em> device should show UI to allow the user to
1930 * choose whether they want to continue their call in the destination app.
1931 * <p>
1932 * When the destination app on the <em>receiving</em> device calls
1933 * {@link TelecomManager#acceptHandover(Uri, int, PhoneAccountHandle)}, Telecom will bind to its
1934 * {@link ConnectionService} and call
1935 * {@link ConnectionService#onCreateIncomingHandoverConnection(PhoneAccountHandle,
1936 * ConnectionRequest)} to inform it of the handover request. The app returns an instance of
1937 * {@link Connection} to represent the handover call.
1938 * <p>
1939 * If the user of the <em>receiving</em> device accepts the handover, the app calls
1940 * {@link Connection#setActive()} to complete the handover process; Telecom will disconnect the
1941 * original call. If the user rejects the handover, the app calls
1942 * {@link Connection#setDisconnected(DisconnectCause)} and specifies a {@link DisconnectCause}
1943 * of {@link DisconnectCause#CANCELED} to indicate that the handover has been cancelled.
1944 * <p>
1945 * Telecom will only allow handovers from {@link PhoneAccount}s which declare
1946 * {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_FROM}. Similarly, the {@link PhoneAccount}
1947 * specified by {@code toHandle} must declare {@link PhoneAccount#EXTRA_SUPPORTS_HANDOVER_TO}.
1948 * <p>
1949 * Errors in the handover process are reported to the {@link InCallService} via
1950 * {@link Callback#onHandoverFailed(Call, int)}. Errors in the handover process are reported to
1951 * the involved {@link ConnectionService}s via
1952 * {@link ConnectionService#onHandoverFailed(ConnectionRequest, int)}.
Sanket Padawea8eddd42017-11-03 11:07:35 -07001953 *
1954 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
1955 * this call to.
Tyler Gunn9d127732018-03-02 15:45:51 -08001956 * @param videoState Indicates the video state desired after the handover (see the
1957 * {@code STATE_*} constants defined in {@link VideoProfile}).
Sanket Padawea8eddd42017-11-03 11:07:35 -07001958 * @param extras Bundle containing extra information to be passed to the
1959 * {@link ConnectionService}
1960 */
Tyler Gunn9d127732018-03-02 15:45:51 -08001961 public void handoverTo(PhoneAccountHandle toHandle, @VideoProfile.VideoState int videoState,
1962 Bundle extras) {
Sanket Padawea8eddd42017-11-03 11:07:35 -07001963 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
1964 }
1965
1966 /**
Hall Liu95d55872017-01-25 17:12:49 -08001967 * Terminate the RTT session on this call. The resulting state change will be notified via
1968 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
1969 */
1970 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08001971 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08001972 }
1973
1974 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07001975 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
1976 * added.
1977 * <p>
1978 * No assumptions should be made as to how an In-Call UI or service will handle these
1979 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
1980 *
1981 * @param extras The extras to add.
1982 */
1983 public final void putExtras(Bundle extras) {
1984 if (extras == null) {
1985 return;
1986 }
1987
1988 if (mExtras == null) {
1989 mExtras = new Bundle();
1990 }
1991 mExtras.putAll(extras);
1992 mInCallAdapter.putExtras(mTelecomCallId, extras);
1993 }
1994
1995 /**
1996 * Adds a boolean extra to this {@link Call}.
1997 *
1998 * @param key The extra key.
1999 * @param value The value.
2000 * @hide
2001 */
2002 public final void putExtra(String key, boolean value) {
2003 if (mExtras == null) {
2004 mExtras = new Bundle();
2005 }
2006 mExtras.putBoolean(key, value);
2007 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2008 }
2009
2010 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002011 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002012 *
2013 * @param key The extra key.
2014 * @param value The value.
2015 * @hide
2016 */
2017 public final void putExtra(String key, int value) {
2018 if (mExtras == null) {
2019 mExtras = new Bundle();
2020 }
2021 mExtras.putInt(key, value);
2022 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2023 }
2024
2025 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002026 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002027 *
2028 * @param key The extra key.
2029 * @param value The value.
2030 * @hide
2031 */
2032 public final void putExtra(String key, String value) {
2033 if (mExtras == null) {
2034 mExtras = new Bundle();
2035 }
2036 mExtras.putString(key, value);
2037 mInCallAdapter.putExtra(mTelecomCallId, key, value);
2038 }
2039
2040 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002041 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07002042 *
2043 * @param keys The keys of the extras to remove.
2044 */
2045 public final void removeExtras(List<String> keys) {
2046 if (mExtras != null) {
2047 for (String key : keys) {
2048 mExtras.remove(key);
2049 }
2050 if (mExtras.size() == 0) {
2051 mExtras = null;
2052 }
2053 }
2054 mInCallAdapter.removeExtras(mTelecomCallId, keys);
2055 }
2056
2057 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07002058 * Removes extras from this {@link Call}.
2059 *
2060 * @param keys The keys of the extras to remove.
2061 */
2062 public final void removeExtras(String ... keys) {
2063 removeExtras(Arrays.asList(keys));
2064 }
2065
2066 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002067 * Obtains the parent of this {@code Call} in a conference, if any.
2068 *
2069 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
2070 * child of any conference {@code Call}s.
2071 */
2072 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002073 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002074 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002075 }
2076 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07002077 }
2078
2079 /**
2080 * Obtains the children of this conference {@code Call}, if any.
2081 *
2082 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
2083 * {@code List} otherwise.
2084 */
2085 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002086 if (!mChildrenCached) {
2087 mChildrenCached = true;
2088 mChildren.clear();
2089
2090 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002091 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07002092 if (call == null) {
2093 // At least one child was still not found, so do not save true for "cached"
2094 mChildrenCached = false;
2095 } else {
2096 mChildren.add(call);
2097 }
2098 }
2099 }
2100
Ihab Awade63fadb2014-07-09 21:52:04 -07002101 return mUnmodifiableChildren;
2102 }
2103
2104 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002105 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
2106 *
2107 * @return The list of conferenceable {@code Call}s.
2108 */
2109 public List<Call> getConferenceableCalls() {
2110 return mUnmodifiableConferenceableCalls;
2111 }
2112
2113 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002114 * Obtains the state of this {@code Call}.
2115 *
2116 * @return A state value, chosen from the {@code STATE_*} constants.
2117 */
2118 public int getState() {
2119 return mState;
2120 }
2121
2122 /**
Hall Liuef98bf82020-01-09 15:22:44 -08002123 * Returns the child {@link Call} in a generic conference that is currently active.
Hall Liu135e53aa2020-02-27 18:34:11 -08002124 *
2125 * A "generic conference" is the mechanism used to support two simultaneous calls on a device
2126 * in CDMA networks. It is effectively equivalent to having one call active and one call on hold
2127 * in GSM or IMS calls. This method returns the currently active call.
2128 *
2129 * In a generic conference, the network exposes the conference to us as a single call, and we
2130 * switch between talking to the two participants using a CDMA flash command. Since the network
2131 * exposes no additional information about the call, the only way we know which caller we're
2132 * currently talking to is by keeping track of the flash commands that we've sent to the
2133 * network.
2134 *
Hall Liuef98bf82020-01-09 15:22:44 -08002135 * For calls that are not generic conferences, or when the generic conference has more than
2136 * 2 children, returns {@code null}.
2137 * @see Details#PROPERTY_GENERIC_CONFERENCE
2138 * @return The active child call.
2139 */
2140 public @Nullable Call getGenericConferenceActiveChildCall() {
2141 if (mActiveGenericConferenceChild != null) {
2142 return mPhone.internalGetCallByTelecomId(mActiveGenericConferenceChild);
2143 }
2144 return null;
2145 }
2146
2147 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002148 * Obtains a list of canned, pre-configured message responses to present to the user as
Tyler Gunn434fc2c2020-10-06 14:23:54 -07002149 * ways of rejecting an incoming {@code Call} using via a text message.
2150 * <p>
2151 * <em>Note:</em> Since canned responses may be loaded from the file system, they are not
2152 * guaranteed to be present when this {@link Call} is first added to the {@link InCallService}
2153 * via {@link InCallService#onCallAdded(Call)}. The callback
2154 * {@link Call.Callback#onCannedTextResponsesLoaded(Call, List)} will be called when/if canned
2155 * responses for the call become available.
Ihab Awade63fadb2014-07-09 21:52:04 -07002156 *
2157 * @see #reject(boolean, String)
2158 *
2159 * @return A list of canned text message responses.
2160 */
2161 public List<String> getCannedTextResponses() {
2162 return mCannedTextResponses;
2163 }
2164
2165 /**
2166 * Obtains an object that can be used to display video from this {@code Call}.
2167 *
Andrew Lee50aca232014-07-22 16:41:54 -07002168 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07002169 */
Andrew Lee50aca232014-07-22 16:41:54 -07002170 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002171 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07002172 }
2173
2174 /**
2175 * Obtains an object containing call details.
2176 *
2177 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
2178 * result may be {@code null}.
2179 */
2180 public Details getDetails() {
2181 return mDetails;
2182 }
2183
2184 /**
Hall Liu95d55872017-01-25 17:12:49 -08002185 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
2186 * receive RTT text data, as well as to change the RTT mode.
2187 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
2188 */
2189 public @Nullable RttCall getRttCall() {
2190 return mRttCall;
2191 }
2192
2193 /**
2194 * Returns whether this call has an active RTT connection.
2195 * @return true if there is a connection, false otherwise.
2196 */
2197 public boolean isRttActive() {
Hall Liue9041242018-02-09 16:40:03 -08002198 return mRttCall != null && mDetails.hasProperty(Details.PROPERTY_RTT);
Hall Liu95d55872017-01-25 17:12:49 -08002199 }
2200
2201 /**
Andrew Leeda80c872015-04-15 14:09:50 -07002202 * Registers a callback to this {@code Call}.
2203 *
2204 * @param callback A {@code Callback}.
2205 */
2206 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07002207 registerCallback(callback, new Handler());
2208 }
2209
2210 /**
2211 * Registers a callback to this {@code Call}.
2212 *
2213 * @param callback A {@code Callback}.
2214 * @param handler A handler which command and status changes will be delivered to.
2215 */
2216 public void registerCallback(Callback callback, Handler handler) {
2217 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07002218 // Don't allow new callback registration if the call is already being destroyed.
2219 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002220 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
2221 }
Andrew Leeda80c872015-04-15 14:09:50 -07002222 }
2223
2224 /**
2225 * Unregisters a callback from this {@code Call}.
2226 *
2227 * @param callback A {@code Callback}.
2228 */
2229 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07002230 // Don't allow callback deregistration if the call is already being destroyed.
2231 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07002232 for (CallbackRecord<Callback> record : mCallbackRecords) {
2233 if (record.getCallback() == callback) {
2234 mCallbackRecords.remove(record);
2235 break;
2236 }
2237 }
Andrew Leeda80c872015-04-15 14:09:50 -07002238 }
2239 }
2240
Santos Cordon3c20d632016-02-25 16:12:35 -08002241 @Override
2242 public String toString() {
2243 return new StringBuilder().
2244 append("Call [id: ").
2245 append(mTelecomCallId).
2246 append(", state: ").
2247 append(stateToString(mState)).
2248 append(", details: ").
2249 append(mDetails).
2250 append("]").toString();
2251 }
2252
2253 /**
2254 * @param state An integer value of a {@code STATE_*} constant.
2255 * @return A string representation of the value.
2256 */
2257 private static String stateToString(int state) {
2258 switch (state) {
2259 case STATE_NEW:
2260 return "NEW";
2261 case STATE_RINGING:
2262 return "RINGING";
2263 case STATE_DIALING:
2264 return "DIALING";
2265 case STATE_ACTIVE:
2266 return "ACTIVE";
2267 case STATE_HOLDING:
2268 return "HOLDING";
2269 case STATE_DISCONNECTED:
2270 return "DISCONNECTED";
2271 case STATE_CONNECTING:
2272 return "CONNECTING";
2273 case STATE_DISCONNECTING:
2274 return "DISCONNECTING";
2275 case STATE_SELECT_PHONE_ACCOUNT:
2276 return "SELECT_PHONE_ACCOUNT";
Hall Liu4e35b642019-10-14 17:50:45 -07002277 case STATE_SIMULATED_RINGING:
2278 return "SIMULATED_RINGING";
2279 case STATE_AUDIO_PROCESSING:
2280 return "AUDIO_PROCESSING";
Santos Cordon3c20d632016-02-25 16:12:35 -08002281 default:
2282 Log.w(Call.class, "Unknown state %d", state);
2283 return "UNKNOWN";
2284 }
2285 }
2286
Andrew Leeda80c872015-04-15 14:09:50 -07002287 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07002288 * Adds a listener to this {@code Call}.
2289 *
2290 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002291 * @deprecated Use {@link #registerCallback} instead.
2292 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002293 */
Andrew Leeda80c872015-04-15 14:09:50 -07002294 @Deprecated
2295 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002296 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002297 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002298 }
2299
2300 /**
2301 * Removes a listener from this {@code Call}.
2302 *
2303 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07002304 * @deprecated Use {@link #unregisterCallback} instead.
2305 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07002306 */
Andrew Leeda80c872015-04-15 14:09:50 -07002307 @Deprecated
2308 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07002309 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07002310 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07002311 }
2312
2313 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08002314 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
2315 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07002316 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002317 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002318 mInCallAdapter = inCallAdapter;
2319 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002320 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002321 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07002322 }
2323
2324 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08002325 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08002326 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002327 mPhone = phone;
2328 mTelecomCallId = telecomCallId;
2329 mInCallAdapter = inCallAdapter;
2330 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08002331 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08002332 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07002333 }
2334
2335 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002336 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002337 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002338 }
2339
2340 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002341 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08002342
Ihab Awade63fadb2014-07-09 21:52:04 -07002343 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08002344 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07002345 boolean detailsChanged = !Objects.equals(mDetails, details);
2346 if (detailsChanged) {
2347 mDetails = details;
2348 }
2349
2350 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07002351 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
2352 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
2353 mCannedTextResponses =
2354 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07002355 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07002356 }
2357
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002358 IVideoProvider previousVideoProvider = mVideoCallImpl == null ? null :
2359 mVideoCallImpl.getVideoProvider();
2360 IVideoProvider newVideoProvider = parcelableCall.getVideoProvider();
2361
2362 // parcelableCall.isVideoCallProviderChanged is only true when we have a video provider
2363 // specified; so we should check if the actual IVideoProvider changes as well.
2364 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged()
2365 && !Objects.equals(previousVideoProvider, newVideoProvider);
Andrew Lee50aca232014-07-22 16:41:54 -07002366 if (videoCallChanged) {
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002367 if (mVideoCallImpl != null) {
2368 mVideoCallImpl.destroy();
2369 }
2370 mVideoCallImpl = parcelableCall.isVideoCallProviderChanged() ?
2371 parcelableCall.getVideoCallImpl(mCallingPackage, mTargetSdkVersion) : null;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002372 }
Tyler Gunnd1fdf3a2019-11-05 15:47:58 -08002373
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002374 if (mVideoCallImpl != null) {
2375 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07002376 }
2377
Santos Cordone3c507b2015-04-23 14:44:19 -07002378 int state = parcelableCall.getState();
Hall Liu31de23d2019-10-11 15:38:29 -07002379 if (mTargetSdkVersion < Phone.SDK_VERSION_R && state == Call.STATE_SIMULATED_RINGING) {
2380 state = Call.STATE_RINGING;
2381 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002382 boolean stateChanged = mState != state;
2383 if (stateChanged) {
2384 mState = state;
2385 }
2386
Santos Cordon823fd3c2014-08-07 18:35:18 -07002387 String parentId = parcelableCall.getParentCallId();
2388 boolean parentChanged = !Objects.equals(mParentId, parentId);
2389 if (parentChanged) {
2390 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07002391 }
2392
Santos Cordon823fd3c2014-08-07 18:35:18 -07002393 List<String> childCallIds = parcelableCall.getChildCallIds();
2394 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
2395 if (childrenChanged) {
2396 mChildrenIds.clear();
2397 mChildrenIds.addAll(parcelableCall.getChildCallIds());
2398 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07002399 }
2400
Hall Liuef98bf82020-01-09 15:22:44 -08002401 String activeChildCallId = parcelableCall.getActiveChildCallId();
2402 boolean activeChildChanged = !Objects.equals(activeChildCallId,
2403 mActiveGenericConferenceChild);
2404 if (activeChildChanged) {
2405 mActiveGenericConferenceChild = activeChildCallId;
2406 }
2407
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002408 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
2409 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
2410 for (String otherId : conferenceableCallIds) {
2411 if (callIdMap.containsKey(otherId)) {
2412 conferenceableCalls.add(callIdMap.get(otherId));
2413 }
2414 }
2415
2416 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
2417 mConferenceableCalls.clear();
2418 mConferenceableCalls.addAll(conferenceableCalls);
2419 fireConferenceableCallsChanged();
2420 }
2421
Hall Liu95d55872017-01-25 17:12:49 -08002422 boolean isRttChanged = false;
2423 boolean rttModeChanged = false;
Hall Liue9041242018-02-09 16:40:03 -08002424 if (parcelableCall.getIsRttCallChanged()
2425 && mDetails.hasProperty(Details.PROPERTY_RTT)) {
Hall Liu95d55872017-01-25 17:12:49 -08002426 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
2427 InputStreamReader receiveStream = new InputStreamReader(
2428 new ParcelFileDescriptor.AutoCloseInputStream(
2429 parcelableRttCall.getReceiveStream()),
2430 StandardCharsets.UTF_8);
2431 OutputStreamWriter transmitStream = new OutputStreamWriter(
2432 new ParcelFileDescriptor.AutoCloseOutputStream(
2433 parcelableRttCall.getTransmitStream()),
2434 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08002435 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08002436 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
2437 if (mRttCall == null) {
2438 isRttChanged = true;
2439 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
2440 rttModeChanged = true;
2441 }
2442 mRttCall = newRttCall;
2443 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
2444 && parcelableCall.getIsRttCallChanged()) {
2445 isRttChanged = true;
2446 mRttCall = null;
2447 }
2448
Ihab Awade63fadb2014-07-09 21:52:04 -07002449 // Now we fire updates, ensuring that any client who listens to any of these notifications
2450 // gets the most up-to-date state.
2451
2452 if (stateChanged) {
2453 fireStateChanged(mState);
2454 }
2455 if (detailsChanged) {
2456 fireDetailsChanged(mDetails);
2457 }
2458 if (cannedTextResponsesChanged) {
2459 fireCannedTextResponsesLoaded(mCannedTextResponses);
2460 }
Andrew Lee50aca232014-07-22 16:41:54 -07002461 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08002462 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07002463 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07002464 if (parentChanged) {
2465 fireParentChanged(getParent());
2466 }
Hall Liuef98bf82020-01-09 15:22:44 -08002467 if (childrenChanged || activeChildChanged) {
Santos Cordon823fd3c2014-08-07 18:35:18 -07002468 fireChildrenChanged(getChildren());
2469 }
Hall Liu95d55872017-01-25 17:12:49 -08002470 if (isRttChanged) {
2471 fireOnIsRttChanged(mRttCall != null, mRttCall);
2472 }
2473 if (rttModeChanged) {
2474 fireOnRttModeChanged(mRttCall.getRttAudioMode());
2475 }
Ihab Awade63fadb2014-07-09 21:52:04 -07002476
2477 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
2478 // remove ourselves from the Phone. Note that we do this after completing all state updates
2479 // so a client can cleanly transition all their UI to the state appropriate for a
2480 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
2481 if (mState == STATE_DISCONNECTED) {
2482 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07002483 }
2484 }
2485
2486 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07002487 final void internalSetPostDialWait(String remaining) {
2488 mRemainingPostDialSequence = remaining;
2489 firePostDialWait(mRemainingPostDialSequence);
2490 }
2491
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07002492 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07002493 final void internalSetDisconnected() {
2494 if (mState != Call.STATE_DISCONNECTED) {
2495 mState = Call.STATE_DISCONNECTED;
2496 fireStateChanged(mState);
2497 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07002498 }
2499 }
2500
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002501 /** {@hide} */
2502 final void internalOnConnectionEvent(String event, Bundle extras) {
2503 fireOnConnectionEvent(event, extras);
2504 }
2505
Hall Liu95d55872017-01-25 17:12:49 -08002506 /** {@hide} */
2507 final void internalOnRttUpgradeRequest(final int requestId) {
2508 for (CallbackRecord<Callback> record : mCallbackRecords) {
2509 final Call call = this;
2510 final Callback callback = record.getCallback();
2511 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
2512 }
2513 }
2514
Hall Liu57006aa2017-02-06 10:49:48 -08002515 /** @hide */
2516 final void internalOnRttInitiationFailure(int reason) {
2517 for (CallbackRecord<Callback> record : mCallbackRecords) {
2518 final Call call = this;
2519 final Callback callback = record.getCallback();
2520 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
2521 }
2522 }
2523
Sanket Padawe85291f62017-12-01 13:59:27 -08002524 /** {@hide} */
2525 final void internalOnHandoverFailed(int error) {
2526 for (CallbackRecord<Callback> record : mCallbackRecords) {
2527 final Call call = this;
2528 final Callback callback = record.getCallback();
2529 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
2530 }
2531 }
2532
Tyler Gunn858bfaf2018-01-22 15:17:54 -08002533 /** {@hide} */
2534 final void internalOnHandoverComplete() {
2535 for (CallbackRecord<Callback> record : mCallbackRecords) {
2536 final Call call = this;
2537 final Callback callback = record.getCallback();
2538 record.getHandler().post(() -> callback.onHandoverComplete(call));
2539 }
2540 }
2541
Andrew Lee011728f2015-04-23 15:47:06 -07002542 private void fireStateChanged(final int newState) {
2543 for (CallbackRecord<Callback> record : mCallbackRecords) {
2544 final Call call = this;
2545 final Callback callback = record.getCallback();
2546 record.getHandler().post(new Runnable() {
2547 @Override
2548 public void run() {
2549 callback.onStateChanged(call, newState);
2550 }
2551 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002552 }
2553 }
2554
Andrew Lee011728f2015-04-23 15:47:06 -07002555 private void fireParentChanged(final Call newParent) {
2556 for (CallbackRecord<Callback> record : mCallbackRecords) {
2557 final Call call = this;
2558 final Callback callback = record.getCallback();
2559 record.getHandler().post(new Runnable() {
2560 @Override
2561 public void run() {
2562 callback.onParentChanged(call, newParent);
2563 }
2564 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002565 }
2566 }
2567
Andrew Lee011728f2015-04-23 15:47:06 -07002568 private void fireChildrenChanged(final List<Call> children) {
2569 for (CallbackRecord<Callback> record : mCallbackRecords) {
2570 final Call call = this;
2571 final Callback callback = record.getCallback();
2572 record.getHandler().post(new Runnable() {
2573 @Override
2574 public void run() {
2575 callback.onChildrenChanged(call, children);
2576 }
2577 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002578 }
2579 }
2580
Andrew Lee011728f2015-04-23 15:47:06 -07002581 private void fireDetailsChanged(final Details details) {
2582 for (CallbackRecord<Callback> record : mCallbackRecords) {
2583 final Call call = this;
2584 final Callback callback = record.getCallback();
2585 record.getHandler().post(new Runnable() {
2586 @Override
2587 public void run() {
2588 callback.onDetailsChanged(call, details);
2589 }
2590 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002591 }
2592 }
2593
Andrew Lee011728f2015-04-23 15:47:06 -07002594 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2595 for (CallbackRecord<Callback> record : mCallbackRecords) {
2596 final Call call = this;
2597 final Callback callback = record.getCallback();
2598 record.getHandler().post(new Runnable() {
2599 @Override
2600 public void run() {
2601 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2602 }
2603 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002604 }
2605 }
2606
Andrew Lee011728f2015-04-23 15:47:06 -07002607 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2608 for (CallbackRecord<Callback> record : mCallbackRecords) {
2609 final Call call = this;
2610 final Callback callback = record.getCallback();
2611 record.getHandler().post(new Runnable() {
2612 @Override
2613 public void run() {
2614 callback.onVideoCallChanged(call, videoCall);
2615 }
2616 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002617 }
2618 }
2619
Andrew Lee011728f2015-04-23 15:47:06 -07002620 private void firePostDialWait(final String remainingPostDialSequence) {
2621 for (CallbackRecord<Callback> record : mCallbackRecords) {
2622 final Call call = this;
2623 final Callback callback = record.getCallback();
2624 record.getHandler().post(new Runnable() {
2625 @Override
2626 public void run() {
2627 callback.onPostDialWait(call, remainingPostDialSequence);
2628 }
2629 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002630 }
2631 }
2632
2633 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002634 /**
2635 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2636 * onCallRemoved callback, we remove this call from the Phone's record
2637 * only once all of the registered onCallDestroyed callbacks are executed.
2638 * All the callbacks get removed from our records as a part of this operation
2639 * since onCallDestroyed is the final callback.
2640 */
2641 final Call call = this;
2642 if (mCallbackRecords.isEmpty()) {
2643 // No callbacks registered, remove the call from Phone's record.
2644 mPhone.internalRemoveCall(call);
2645 }
2646 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002647 final Callback callback = record.getCallback();
2648 record.getHandler().post(new Runnable() {
2649 @Override
2650 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002651 boolean isFinalRemoval = false;
2652 RuntimeException toThrow = null;
2653 try {
2654 callback.onCallDestroyed(call);
2655 } catch (RuntimeException e) {
2656 toThrow = e;
2657 }
2658 synchronized(Call.this) {
2659 mCallbackRecords.remove(record);
2660 if (mCallbackRecords.isEmpty()) {
2661 isFinalRemoval = true;
2662 }
2663 }
2664 if (isFinalRemoval) {
2665 mPhone.internalRemoveCall(call);
2666 }
2667 if (toThrow != null) {
2668 throw toThrow;
2669 }
Andrew Lee011728f2015-04-23 15:47:06 -07002670 }
2671 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002672 }
2673 }
2674
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002675 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002676 for (CallbackRecord<Callback> record : mCallbackRecords) {
2677 final Call call = this;
2678 final Callback callback = record.getCallback();
2679 record.getHandler().post(new Runnable() {
2680 @Override
2681 public void run() {
2682 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2683 }
2684 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002685 }
2686 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002687
2688 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002689 * Notifies listeners of an incoming connection event.
2690 * <p>
2691 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2692 *
2693 * @param event
2694 * @param extras
2695 */
2696 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2697 for (CallbackRecord<Callback> record : mCallbackRecords) {
2698 final Call call = this;
2699 final Callback callback = record.getCallback();
2700 record.getHandler().post(new Runnable() {
2701 @Override
2702 public void run() {
2703 callback.onConnectionEvent(call, event, extras);
2704 }
2705 });
2706 }
2707 }
2708
2709 /**
Hall Liu95d55872017-01-25 17:12:49 -08002710 * Notifies listeners of an RTT on/off change
2711 *
2712 * @param enabled True if RTT is now enabled, false otherwise
2713 */
2714 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2715 for (CallbackRecord<Callback> record : mCallbackRecords) {
2716 final Call call = this;
2717 final Callback callback = record.getCallback();
2718 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2719 }
2720 }
2721
2722 /**
2723 * Notifies listeners of a RTT mode change
2724 *
2725 * @param mode The new RTT mode
2726 */
2727 private void fireOnRttModeChanged(final int mode) {
2728 for (CallbackRecord<Callback> record : mCallbackRecords) {
2729 final Call call = this;
2730 final Callback callback = record.getCallback();
2731 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2732 }
2733 }
2734
2735 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002736 * Determines if two bundles are equal.
2737 *
2738 * @param bundle The original bundle.
2739 * @param newBundle The bundle to compare with.
2740 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2741 */
2742 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2743 if (bundle == null || newBundle == null) {
2744 return bundle == newBundle;
2745 }
2746
2747 if (bundle.size() != newBundle.size()) {
2748 return false;
2749 }
2750
2751 for(String key : bundle.keySet()) {
2752 if (key != null) {
2753 final Object value = bundle.get(key);
2754 final Object newValue = newBundle.get(key);
2755 if (!Objects.equals(value, newValue)) {
2756 return false;
2757 }
2758 }
2759 }
2760 return true;
2761 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002762}