blob: 0c92c2000f9299dde7de95dfd0bf081bccf72e81 [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;
20import android.annotation.Nullable;
Andrew Leeda80c872015-04-15 14:09:50 -070021import android.annotation.SystemApi;
Ihab Awade63fadb2014-07-09 21:52:04 -070022import android.net.Uri;
Nancy Chen10798dc2014-08-08 14:00:25 -070023import android.os.Bundle;
Andrew Lee011728f2015-04-23 15:47:06 -070024import android.os.Handler;
Hall Liu95d55872017-01-25 17:12:49 -080025import android.os.ParcelFileDescriptor;
Ihab Awade63fadb2014-07-09 21:52:04 -070026
Hall Liu95d55872017-01-25 17:12:49 -080027import java.io.IOException;
28import java.io.InputStreamReader;
29import java.io.OutputStreamWriter;
Andrew Lee50aca232014-07-22 16:41:54 -070030import java.lang.String;
Hall Liu95d55872017-01-25 17:12:49 -080031import java.lang.annotation.Retention;
32import java.lang.annotation.RetentionPolicy;
33import java.nio.charset.StandardCharsets;
Ihab Awade63fadb2014-07-09 21:52:04 -070034import java.util.ArrayList;
Tyler Gunn071be6f2016-05-10 14:52:33 -070035import java.util.Arrays;
Ihab Awade63fadb2014-07-09 21:52:04 -070036import java.util.Collections;
37import java.util.List;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -070038import java.util.Map;
Ihab Awade63fadb2014-07-09 21:52:04 -070039import java.util.Objects;
Jay Shrauner229e3822014-08-15 09:23:07 -070040import java.util.concurrent.CopyOnWriteArrayList;
Ihab Awade63fadb2014-07-09 21:52:04 -070041
42/**
43 * Represents an ongoing phone call that the in-call app should present to the user.
44 */
45public final class Call {
46 /**
47 * The state of a {@code Call} when newly created.
48 */
49 public static final int STATE_NEW = 0;
50
51 /**
52 * The state of an outgoing {@code Call} when dialing the remote number, but not yet connected.
53 */
54 public static final int STATE_DIALING = 1;
55
56 /**
57 * The state of an incoming {@code Call} when ringing locally, but not yet connected.
58 */
59 public static final int STATE_RINGING = 2;
60
61 /**
62 * The state of a {@code Call} when in a holding state.
63 */
64 public static final int STATE_HOLDING = 3;
65
66 /**
67 * The state of a {@code Call} when actively supporting conversation.
68 */
69 public static final int STATE_ACTIVE = 4;
70
71 /**
72 * The state of a {@code Call} when no further voice or other communication is being
73 * transmitted, the remote side has been or will inevitably be informed that the {@code Call}
74 * is no longer active, and the local data transport has or inevitably will release resources
75 * associated with this {@code Call}.
76 */
77 public static final int STATE_DISCONNECTED = 7;
78
Nancy Chen5da0fd52014-07-08 14:16:17 -070079 /**
Santos Cordone3c507b2015-04-23 14:44:19 -070080 * The state of an outgoing {@code Call} when waiting on user to select a
81 * {@link PhoneAccount} through which to place the call.
Nancy Chen5da0fd52014-07-08 14:16:17 -070082 */
Santos Cordone3c507b2015-04-23 14:44:19 -070083 public static final int STATE_SELECT_PHONE_ACCOUNT = 8;
84
85 /**
86 * @hide
87 * @deprecated use STATE_SELECT_PHONE_ACCOUNT.
88 */
89 @Deprecated
90 @SystemApi
91 public static final int STATE_PRE_DIAL_WAIT = STATE_SELECT_PHONE_ACCOUNT;
Nancy Chen5da0fd52014-07-08 14:16:17 -070092
Nancy Chene20930f2014-08-07 16:17:21 -070093 /**
Nancy Chene9b7a8e2014-08-08 14:26:27 -070094 * The initial state of an outgoing {@code Call}.
95 * Common transitions are to {@link #STATE_DIALING} state for a successful call or
96 * {@link #STATE_DISCONNECTED} if it failed.
Nancy Chene20930f2014-08-07 16:17:21 -070097 */
98 public static final int STATE_CONNECTING = 9;
99
Nancy Chen513c8922014-09-17 14:47:20 -0700100 /**
Tyler Gunn4afc6af2014-10-07 10:14:55 -0700101 * The state of a {@code Call} when the user has initiated a disconnection of the call, but the
102 * call has not yet been disconnected by the underlying {@code ConnectionService}. The next
103 * state of the call is (potentially) {@link #STATE_DISCONNECTED}.
104 */
105 public static final int STATE_DISCONNECTING = 10;
106
107 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700108 * The state of an external call which is in the process of being pulled from a remote device to
109 * the local device.
110 * <p>
111 * A call can only be in this state if the {@link Details#PROPERTY_IS_EXTERNAL_CALL} property
112 * and {@link Details#CAPABILITY_CAN_PULL_CALL} capability are set on the call.
113 * <p>
114 * An {@link InCallService} will only see this state if it has the
115 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true} in its
116 * manifest.
117 */
118 public static final int STATE_PULLING_CALL = 11;
119
120 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700121 * The key to retrieve the optional {@code PhoneAccount}s Telecom can bundle with its Call
122 * extras. Used to pass the phone accounts to display on the front end to the user in order to
123 * select phone accounts to (for example) place a call.
Nancy Chen513c8922014-09-17 14:47:20 -0700124 */
125 public static final String AVAILABLE_PHONE_ACCOUNTS = "selectPhoneAccountAccounts";
126
mike dooley4af561f2016-12-20 08:55:17 -0800127 /**
mike dooley91217422017-03-09 12:58:42 -0800128 * Extra key used to indicate the time (in milliseconds since midnight, January 1, 1970 UTC)
129 * when the last outgoing emergency call was made. This is used to identify potential emergency
130 * callbacks.
mike dooley4af561f2016-12-20 08:55:17 -0800131 */
132 public static final String EXTRA_LAST_EMERGENCY_CALLBACK_TIME_MILLIS =
133 "android.telecom.extra.LAST_EMERGENCY_CALLBACK_TIME_MILLIS";
134
Tyler Gunn8bf76572017-04-06 15:30:08 -0700135 /**
136 * Call event sent from a {@link Call} via {@link #sendCallEvent(String, Bundle)} to inform
137 * Telecom that the user has requested that the current {@link Call} should be handed over
138 * to another {@link ConnectionService}.
139 * <p>
140 * The caller must specify the {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE} to indicate to
141 * Telecom which {@link PhoneAccountHandle} the {@link Call} should be handed over to.
142 * @hide
143 */
144 public static final String EVENT_REQUEST_HANDOVER =
145 "android.telecom.event.REQUEST_HANDOVER";
146
147 /**
148 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
149 * {@link PhoneAccountHandle} to which a call should be handed over to.
150 * @hide
151 */
152 public static final String EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE =
153 "android.telecom.extra.HANDOVER_PHONE_ACCOUNT_HANDLE";
154
155 /**
156 * Integer extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Specifies the
157 * video state of the call when it is handed over to the new {@link PhoneAccount}.
158 * <p>
159 * Valid values: {@link VideoProfile#STATE_AUDIO_ONLY},
160 * {@link VideoProfile#STATE_BIDIRECTIONAL}, {@link VideoProfile#STATE_RX_ENABLED}, and
161 * {@link VideoProfile#STATE_TX_ENABLED}.
162 * @hide
163 */
164 public static final String EXTRA_HANDOVER_VIDEO_STATE =
165 "android.telecom.extra.HANDOVER_VIDEO_STATE";
166
167 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700168 * Extra key used with the {@link #EVENT_REQUEST_HANDOVER} call event. Used by the
169 * {@link InCallService} initiating a handover to provide a {@link Bundle} with extra
170 * information to the handover {@link ConnectionService} specified by
171 * {@link #EXTRA_HANDOVER_PHONE_ACCOUNT_HANDLE}.
172 * <p>
173 * This {@link Bundle} is not interpreted by Telecom, but passed as-is to the
174 * {@link ConnectionService} via the request extras when
175 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
176 * is called to initate the handover.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700177 * @hide
178 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700179 public static final String EXTRA_HANDOVER_EXTRAS = "android.telecom.extra.HANDOVER_EXTRAS";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700180
181 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700182 * Call event sent from Telecom to the handover {@link ConnectionService} via
183 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
184 * to the {@link ConnectionService} has completed successfully.
185 * <p>
186 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700187 * @hide
188 */
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700189 public static final String EVENT_HANDOVER_COMPLETE =
190 "android.telecom.event.HANDOVER_COMPLETE";
Tyler Gunn34a2b312017-06-23 08:32:00 -0700191
192 /**
193 * Call event sent from Telecom to the handover destination {@link ConnectionService} via
194 * {@link Connection#onCallEvent(String, Bundle)} to inform the handover destination that the
195 * source connection has disconnected. The {@link Bundle} parameter for the call event will be
196 * {@code null}.
197 * <p>
198 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
199 * @hide
200 */
201 public static final String EVENT_HANDOVER_SOURCE_DISCONNECTED =
202 "android.telecom.event.HANDOVER_SOURCE_DISCONNECTED";
203
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700204 /**
205 * Call event sent from Telecom to the handover {@link ConnectionService} via
206 * {@link Connection#onCallEvent(String, Bundle)} to inform a {@link Connection} that a handover
207 * to the {@link ConnectionService} has failed.
208 * <p>
209 * A handover is initiated with the {@link #EVENT_REQUEST_HANDOVER} call event.
210 * @hide
211 */
212 public static final String EVENT_HANDOVER_FAILED =
213 "android.telecom.event.HANDOVER_FAILED";
Tyler Gunn8bf76572017-04-06 15:30:08 -0700214
Ihab Awade63fadb2014-07-09 21:52:04 -0700215 public static class Details {
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800216
217 /** Call can currently be put on hold or unheld. */
218 public static final int CAPABILITY_HOLD = 0x00000001;
219
220 /** Call supports the hold feature. */
221 public static final int CAPABILITY_SUPPORT_HOLD = 0x00000002;
222
223 /**
224 * Calls within a conference can be merged. A {@link ConnectionService} has the option to
225 * add a {@link Conference} call before the child {@link Connection}s are merged. This is how
226 * CDMA-based {@link Connection}s are implemented. For these unmerged {@link Conference}s, this
227 * capability allows a merge button to be shown while the conference call is in the foreground
228 * of the in-call UI.
229 * <p>
230 * This is only intended for use by a {@link Conference}.
231 */
232 public static final int CAPABILITY_MERGE_CONFERENCE = 0x00000004;
233
234 /**
235 * Calls within a conference can be swapped between foreground and background.
236 * See {@link #CAPABILITY_MERGE_CONFERENCE} for additional information.
237 * <p>
238 * This is only intended for use by a {@link Conference}.
239 */
240 public static final int CAPABILITY_SWAP_CONFERENCE = 0x00000008;
241
242 /**
243 * @hide
244 */
Andrew Lee2378ea72015-04-29 14:38:11 -0700245 public static final int CAPABILITY_UNUSED_1 = 0x00000010;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800246
247 /** Call supports responding via text option. */
248 public static final int CAPABILITY_RESPOND_VIA_TEXT = 0x00000020;
249
250 /** Call can be muted. */
251 public static final int CAPABILITY_MUTE = 0x00000040;
252
253 /**
254 * Call supports conference call management. This capability only applies to {@link Conference}
255 * calls which can have {@link Connection}s as children.
256 */
257 public static final int CAPABILITY_MANAGE_CONFERENCE = 0x00000080;
258
259 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700260 * Local device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800261 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700262 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_RX = 0x00000100;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800263
264 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700265 * Local device supports transmitting video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800266 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700267 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_TX = 0x00000200;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800268
269 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700270 * Local device supports bidirectional video calling.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800271 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700272 public static final int CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700273 CAPABILITY_SUPPORTS_VT_LOCAL_RX | CAPABILITY_SUPPORTS_VT_LOCAL_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800274
275 /**
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700276 * Remote device supports receiving video.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800277 */
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700278 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_RX = 0x00000400;
279
280 /**
281 * Remote device supports transmitting video.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700282 */
283 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_TX = 0x00000800;
284
285 /**
286 * Remote device supports bidirectional video calling.
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700287 */
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700288 public static final int CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL =
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700289 CAPABILITY_SUPPORTS_VT_REMOTE_RX | CAPABILITY_SUPPORTS_VT_REMOTE_TX;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800290
291 /**
292 * Call is able to be separated from its parent {@code Conference}, if any.
293 */
294 public static final int CAPABILITY_SEPARATE_FROM_CONFERENCE = 0x00001000;
295
296 /**
297 * Call is able to be individually disconnected when in a {@code Conference}.
298 */
299 public static final int CAPABILITY_DISCONNECT_FROM_CONFERENCE = 0x00002000;
300
301 /**
Dong Zhou89f41eb2015-03-15 11:59:49 -0500302 * Speed up audio setup for MT call.
303 * @hide
304 */
Tyler Gunn96d6c402015-03-18 12:39:23 -0700305 public static final int CAPABILITY_SPEED_UP_MT_AUDIO = 0x00040000;
306
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700307 /**
308 * Call can be upgraded to a video call.
Rekha Kumar07366812015-03-24 16:42:31 -0700309 * @hide
310 */
311 public static final int CAPABILITY_CAN_UPGRADE_TO_VIDEO = 0x00080000;
312
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700313 /**
314 * For video calls, indicates whether the outgoing video for the call can be paused using
Yorke Lee32f24732015-05-12 16:18:03 -0700315 * the {@link android.telecom.VideoProfile#STATE_PAUSED} VideoState.
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700316 */
317 public static final int CAPABILITY_CAN_PAUSE_VIDEO = 0x00100000;
318
Bryce Lee81901682015-08-28 16:38:02 -0700319 /**
320 * Call sends responses through connection.
321 * @hide
322 */
Tyler Gunnf97a0092016-01-19 15:59:34 -0800323 public static final int CAPABILITY_CAN_SEND_RESPONSE_VIA_CONNECTION = 0x00200000;
324
325 /**
326 * When set, prevents a video {@code Call} from being downgraded to an audio-only call.
327 * <p>
328 * Should be set when the VideoState has the {@link VideoProfile#STATE_TX_ENABLED} or
329 * {@link VideoProfile#STATE_RX_ENABLED} bits set to indicate that the connection cannot be
330 * downgraded from a video call back to a VideoState of
331 * {@link VideoProfile#STATE_AUDIO_ONLY}.
332 * <p>
333 * Intuitively, a call which can be downgraded to audio should also have local and remote
334 * video
335 * capabilities (see {@link #CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL} and
336 * {@link #CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL}).
337 */
338 public static final int CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO = 0x00400000;
Bryce Lee81901682015-08-28 16:38:02 -0700339
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700340 /**
341 * When set for an external call, indicates that this {@code Call} can be pulled from a
342 * remote device to the current device.
343 * <p>
344 * Should only be set on a {@code Call} where {@link #PROPERTY_IS_EXTERNAL_CALL} is set.
345 * <p>
346 * An {@link InCallService} will only see calls with this capability if it has the
347 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
348 * in its manifest.
349 * <p>
350 * See {@link Connection#CAPABILITY_CAN_PULL_CALL} and
Tyler Gunn720c6642016-03-22 09:02:47 -0700351 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700352 */
353 public static final int CAPABILITY_CAN_PULL_CALL = 0x00800000;
354
Pooja Jaind34698d2017-12-28 14:15:31 +0530355 /** Call supports the deflect feature. */
356 public static final int CAPABILITY_SUPPORT_DEFLECT = 0x01000000;
357
Tyler Gunnd11a3152015-03-18 13:09:14 -0700358 //******************************************************************************************
Pooja Jaind34698d2017-12-28 14:15:31 +0530359 // Next CAPABILITY value: 0x02000000
Andrew Lee2378ea72015-04-29 14:38:11 -0700360 //******************************************************************************************
361
362 /**
363 * Whether the call is currently a conference.
364 */
365 public static final int PROPERTY_CONFERENCE = 0x00000001;
366
367 /**
368 * Whether the call is a generic conference, where we do not know the precise state of
369 * participants in the conference (eg. on CDMA).
370 */
371 public static final int PROPERTY_GENERIC_CONFERENCE = 0x00000002;
372
373 /**
374 * Whether the call is made while the device is in emergency callback mode.
375 */
376 public static final int PROPERTY_EMERGENCY_CALLBACK_MODE = 0x00000004;
377
378 /**
379 * Connection is using WIFI.
380 */
381 public static final int PROPERTY_WIFI = 0x00000008;
382
383 /**
384 * Call is using high definition audio.
385 */
386 public static final int PROPERTY_HIGH_DEF_AUDIO = 0x00000010;
387
Tony Maka68dcce2015-12-17 09:31:18 +0000388 /**
Tony Mak53b5df42016-05-19 13:40:38 +0100389 * Whether the call is associated with the work profile.
390 */
391 public static final int PROPERTY_ENTERPRISE_CALL = 0x00000020;
392
393 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700394 * When set, indicates that this {@code Call} does not actually exist locally for the
395 * {@link ConnectionService}.
396 * <p>
397 * Consider, for example, a scenario where a user has two phones with the same phone number.
398 * When a user places a call on one device, the telephony stack can represent that call on
399 * the other device by adding it to the {@link ConnectionService} with the
Tyler Gunn720c6642016-03-22 09:02:47 -0700400 * {@link Connection#PROPERTY_IS_EXTERNAL_CALL} property set.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700401 * <p>
402 * An {@link InCallService} will only see calls with this property if it has the
403 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
404 * in its manifest.
405 * <p>
Tyler Gunn720c6642016-03-22 09:02:47 -0700406 * See {@link Connection#PROPERTY_IS_EXTERNAL_CALL}.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700407 */
408 public static final int PROPERTY_IS_EXTERNAL_CALL = 0x00000040;
409
Brad Ebinger15847072016-05-18 11:08:36 -0700410 /**
411 * Indicates that the call has CDMA Enhanced Voice Privacy enabled.
412 */
413 public static final int PROPERTY_HAS_CDMA_VOICE_PRIVACY = 0x00000080;
414
Tyler Gunn24e18332017-02-10 09:42:49 -0800415 /**
416 * Indicates that the call is from a self-managed {@link ConnectionService}.
417 * <p>
418 * See also {@link Connection#PROPERTY_SELF_MANAGED}
419 */
420 public static final int PROPERTY_SELF_MANAGED = 0x00000100;
421
Eric Erfanianec881872017-12-06 16:27:53 -0800422 /**
423 * Indicates the call used Assisted Dialing.
424 * See also {@link Connection#PROPERTY_ASSISTED_DIALING_USED}
Eric Erfanianec881872017-12-06 16:27:53 -0800425 */
426 public static final int PROPERTY_ASSISTED_DIALING_USED = 0x00000200;
427
Hall Liua549fed2018-02-09 16:40:03 -0800428 /**
429 * Indicates that the call is an RTT call. Use {@link #getRttCall()} to get the
430 * {@link RttCall} object that is used to send and receive text.
431 */
432 public static final int PROPERTY_RTT = 0x00000400;
433
Andrew Lee2378ea72015-04-29 14:38:11 -0700434 //******************************************************************************************
Hall Liua549fed2018-02-09 16:40:03 -0800435 // Next PROPERTY value: 0x00000800
Tyler Gunnd11a3152015-03-18 13:09:14 -0700436 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800437
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800438 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700439 private final Uri mHandle;
440 private final int mHandlePresentation;
441 private final String mCallerDisplayName;
442 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700443 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700444 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700445 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800446 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700447 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700448 private final long mConnectTimeMillis;
449 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700450 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700451 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700452 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700453 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700454 private final long mCreationTimeMillis;
Ihab Awade63fadb2014-07-09 21:52:04 -0700455
456 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800457 * Whether the supplied capabilities supports the specified capability.
458 *
459 * @param capabilities A bit field of capabilities.
460 * @param capability The capability to check capabilities for.
461 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800462 */
463 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800464 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800465 }
466
467 /**
468 * Whether the capabilities of this {@code Details} supports the specified capability.
469 *
470 * @param capability The capability to check capabilities for.
471 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800472 */
473 public boolean can(int capability) {
474 return can(mCallCapabilities, capability);
475 }
476
477 /**
478 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
479 *
480 * @param capabilities A capability bit field.
481 * @return A human readable string representation.
482 */
483 public static String capabilitiesToString(int capabilities) {
484 StringBuilder builder = new StringBuilder();
485 builder.append("[Capabilities:");
486 if (can(capabilities, CAPABILITY_HOLD)) {
487 builder.append(" CAPABILITY_HOLD");
488 }
489 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
490 builder.append(" CAPABILITY_SUPPORT_HOLD");
491 }
492 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
493 builder.append(" CAPABILITY_MERGE_CONFERENCE");
494 }
495 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
496 builder.append(" CAPABILITY_SWAP_CONFERENCE");
497 }
498 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
499 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
500 }
501 if (can(capabilities, CAPABILITY_MUTE)) {
502 builder.append(" CAPABILITY_MUTE");
503 }
504 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
505 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
506 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700507 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
508 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
509 }
510 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
511 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
512 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700513 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
514 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800515 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700516 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
517 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
518 }
519 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
520 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
521 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800522 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
523 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
524 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700525 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
526 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800527 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500528 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700529 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500530 }
Rekha Kumar07366812015-03-24 16:42:31 -0700531 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
532 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
533 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700534 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
535 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
536 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700537 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
538 builder.append(" CAPABILITY_CAN_PULL_CALL");
539 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530540 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
541 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
542 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800543 builder.append("]");
544 return builder.toString();
545 }
546
547 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700548 * Whether the supplied properties includes the specified property.
549 *
550 * @param properties A bit field of properties.
551 * @param property The property to check properties for.
552 * @return Whether the specified property is supported.
553 */
554 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800555 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700556 }
557
558 /**
559 * Whether the properties of this {@code Details} includes the specified property.
560 *
561 * @param property The property to check properties for.
562 * @return Whether the specified property is supported.
563 */
564 public boolean hasProperty(int property) {
565 return hasProperty(mCallProperties, property);
566 }
567
568 /**
569 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
570 *
571 * @param properties A property bit field.
572 * @return A human readable string representation.
573 */
574 public static String propertiesToString(int properties) {
575 StringBuilder builder = new StringBuilder();
576 builder.append("[Properties:");
577 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
578 builder.append(" PROPERTY_CONFERENCE");
579 }
580 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
581 builder.append(" PROPERTY_GENERIC_CONFERENCE");
582 }
583 if (hasProperty(properties, PROPERTY_WIFI)) {
584 builder.append(" PROPERTY_WIFI");
585 }
586 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
587 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
588 }
589 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700590 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700591 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700592 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
593 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
594 }
Brad Ebinger15847072016-05-18 11:08:36 -0700595 if(hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
596 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
597 }
Eric Erfanianec881872017-12-06 16:27:53 -0800598 if(hasProperty(properties, PROPERTY_ASSISTED_DIALING_USED)) {
599 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
600 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700601 builder.append("]");
602 return builder.toString();
603 }
604
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800605 /** {@hide} */
606 public String getTelecomCallId() {
607 return mTelecomCallId;
608 }
609
Andrew Lee2378ea72015-04-29 14:38:11 -0700610 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700611 * @return The handle (e.g., phone number) to which the {@code Call} is currently
612 * connected.
613 */
614 public Uri getHandle() {
615 return mHandle;
616 }
617
618 /**
619 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700620 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700621 */
622 public int getHandlePresentation() {
623 return mHandlePresentation;
624 }
625
626 /**
627 * @return The display name for the caller.
628 */
629 public String getCallerDisplayName() {
630 return mCallerDisplayName;
631 }
632
633 /**
634 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700635 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700636 */
637 public int getCallerDisplayNamePresentation() {
638 return mCallerDisplayNamePresentation;
639 }
640
641 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700642 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
643 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700644 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700645 public PhoneAccountHandle getAccountHandle() {
646 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -0700647 }
648
649 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800650 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
651 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -0700652 */
Ihab Awad5d0410f2014-07-30 10:07:40 -0700653 public int getCallCapabilities() {
654 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -0700655 }
656
657 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700658 * @return A bitmask of the properties of the {@code Call}, as defined by the various
659 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -0700660 */
661 public int getCallProperties() {
662 return mCallProperties;
663 }
664
665 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800666 * @return a bitmask of the audio routes available for the call.
667 *
668 * @hide
669 */
670 public int getSupportedAudioRoutes() {
671 return mSupportedAudioRoutes;
672 }
673
674 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700675 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -0700676 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700677 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700678 public DisconnectCause getDisconnectCause() {
679 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700680 }
681
682 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700683 * Returns the time the {@link Call} connected (i.e. became active). This information is
684 * updated periodically, but user interfaces should not rely on this to display the "call
685 * time clock". For the time when the call was first added to Telecom, see
686 * {@link #getCreationTimeMillis()}.
687 *
688 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -0700689 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -0700690 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -0700691 return mConnectTimeMillis;
692 }
693
694 /**
695 * @return Information about any calling gateway the {@code Call} may be using.
696 */
697 public GatewayInfo getGatewayInfo() {
698 return mGatewayInfo;
699 }
700
Andrew Lee7a341382014-07-15 17:05:08 -0700701 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -0700702 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -0700703 */
704 public int getVideoState() {
705 return mVideoState;
706 }
707
Ihab Awad5d0410f2014-07-30 10:07:40 -0700708 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700709 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -0700710 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -0700711 */
712 public StatusHints getStatusHints() {
713 return mStatusHints;
714 }
715
Nancy Chen10798dc2014-08-08 14:00:25 -0700716 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -0700717 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700718 */
719 public Bundle getExtras() {
720 return mExtras;
721 }
722
Santos Cordon6b7f9552015-05-27 17:21:45 -0700723 /**
724 * @return The extras used with the original intent to place this call.
725 */
726 public Bundle getIntentExtras() {
727 return mIntentExtras;
728 }
729
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700730 /**
731 * Returns the time when the call was first created and added to Telecom. This is the same
732 * time that is logged as the start time in the Call Log (see
733 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
734 * (became active), see {@link #getConnectTimeMillis()}.
735 *
736 * @return The creation time of the call, in millis since the epoch.
737 */
738 public long getCreationTimeMillis() {
739 return mCreationTimeMillis;
740 }
741
Ihab Awade63fadb2014-07-09 21:52:04 -0700742 @Override
743 public boolean equals(Object o) {
744 if (o instanceof Details) {
745 Details d = (Details) o;
746 return
747 Objects.equals(mHandle, d.mHandle) &&
748 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
749 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
750 Objects.equals(mCallerDisplayNamePresentation,
751 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -0700752 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -0700753 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -0700754 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700755 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -0700756 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -0700757 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -0700758 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -0700759 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -0700760 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700761 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
762 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis);
Ihab Awade63fadb2014-07-09 21:52:04 -0700763 }
764 return false;
765 }
766
767 @Override
768 public int hashCode() {
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700769 return Objects.hash(mHandle,
770 mHandlePresentation,
771 mCallerDisplayName,
772 mCallerDisplayNamePresentation,
773 mAccountHandle,
774 mCallCapabilities,
775 mCallProperties,
776 mDisconnectCause,
777 mConnectTimeMillis,
778 mGatewayInfo,
779 mVideoState,
780 mStatusHints,
781 mExtras,
782 mIntentExtras,
783 mCreationTimeMillis);
Ihab Awade63fadb2014-07-09 21:52:04 -0700784 }
785
786 /** {@hide} */
787 public Details(
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800788 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -0700789 Uri handle,
790 int handlePresentation,
791 String callerDisplayName,
792 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -0700793 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -0700794 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -0700795 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700796 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -0700797 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -0700798 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -0700799 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -0700800 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -0700801 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700802 Bundle intentExtras,
803 long creationTimeMillis) {
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800804 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700805 mHandle = handle;
806 mHandlePresentation = handlePresentation;
807 mCallerDisplayName = callerDisplayName;
808 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700809 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700810 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700811 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700812 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700813 mConnectTimeMillis = connectTimeMillis;
814 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700815 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700816 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700817 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700818 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700819 mCreationTimeMillis = creationTimeMillis;
Ihab Awade63fadb2014-07-09 21:52:04 -0700820 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800821
822 /** {@hide} */
823 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
824 return new Details(
825 parcelableCall.getId(),
826 parcelableCall.getHandle(),
827 parcelableCall.getHandlePresentation(),
828 parcelableCall.getCallerDisplayName(),
829 parcelableCall.getCallerDisplayNamePresentation(),
830 parcelableCall.getAccountHandle(),
831 parcelableCall.getCapabilities(),
832 parcelableCall.getProperties(),
833 parcelableCall.getDisconnectCause(),
834 parcelableCall.getConnectTimeMillis(),
835 parcelableCall.getGatewayInfo(),
836 parcelableCall.getVideoState(),
837 parcelableCall.getStatusHints(),
838 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700839 parcelableCall.getIntentExtras(),
840 parcelableCall.getCreationTimeMillis());
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800841 }
Santos Cordon3c20d632016-02-25 16:12:35 -0800842
843 @Override
844 public String toString() {
845 StringBuilder sb = new StringBuilder();
846 sb.append("[pa: ");
847 sb.append(mAccountHandle);
848 sb.append(", hdl: ");
849 sb.append(Log.pii(mHandle));
850 sb.append(", caps: ");
851 sb.append(capabilitiesToString(mCallCapabilities));
852 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -0700853 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -0800854 sb.append("]");
855 return sb.toString();
856 }
Ihab Awade63fadb2014-07-09 21:52:04 -0700857 }
858
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -0700859 /**
860 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
861 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
862 * implementation.
863 * <p>
864 * You can handle these callbacks by extending the {@link Callback} class and overriding the
865 * callbacks that your {@link InCallService} is interested in. The callback methods include the
866 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
867 * {@link Callback} implementation, if desired.
868 * <p>
869 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
870 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
871 * (typically in {@link InCallService#onCallRemoved(Call)}).
872 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
873 * reach your implementation of {@link Callback}, so it is important to register your callback
874 * as soon as your {@link InCallService} is notified of a new call via
875 * {@link InCallService#onCallAdded(Call)}.
876 */
Andrew Leeda80c872015-04-15 14:09:50 -0700877 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -0700878 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -0700879 * @hide
880 */
881 @IntDef({HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_DEST_NOT_SUPPORTED,
Sanket Padawe85291f62017-12-01 13:59:27 -0800882 HANDOVER_FAILURE_DEST_INVALID_PERM, HANDOVER_FAILURE_DEST_USER_REJECTED,
883 HANDOVER_FAILURE_ONGOING_EMERG_CALL})
Sanket Padawea8eddd42017-11-03 11:07:35 -0700884 @Retention(RetentionPolicy.SOURCE)
885 public @interface HandoverFailureErrors {}
886
887 /**
888 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
889 * to handover the call rejects handover.
890 */
891 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
892
893 /**
894 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there is
895 * an error associated with unsupported handover.
896 */
897 public static final int HANDOVER_FAILURE_DEST_NOT_SUPPORTED = 2;
898
899 /**
900 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
901 * are some permission errors associated with APIs doing handover.
902 */
903 public static final int HANDOVER_FAILURE_DEST_INVALID_PERM = 3;
904
905 /**
906 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when user
907 * rejects handover.
908 */
909 public static final int HANDOVER_FAILURE_DEST_USER_REJECTED = 4;
910
Sanket Padawe85291f62017-12-01 13:59:27 -0800911 /**
912 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
913 * is ongoing emergency call.
914 */
915 public static final int HANDOVER_FAILURE_ONGOING_EMERG_CALL = 5;
916
Sanket Padawea8eddd42017-11-03 11:07:35 -0700917
918 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700919 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
920 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700921 * @param call The {@code Call} invoking this method.
922 * @param state The new state of the {@code Call}.
923 */
924 public void onStateChanged(Call call, int state) {}
925
926 /**
927 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
928 *
929 * @param call The {@code Call} invoking this method.
930 * @param parent The new parent of the {@code Call}.
931 */
932 public void onParentChanged(Call call, Call parent) {}
933
934 /**
935 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
936 *
937 * @param call The {@code Call} invoking this method.
938 * @param children The new children of the {@code Call}.
939 */
940 public void onChildrenChanged(Call call, List<Call> children) {}
941
942 /**
943 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
944 *
945 * @param call The {@code Call} invoking this method.
946 * @param details A {@code Details} object describing the {@code Call}.
947 */
948 public void onDetailsChanged(Call call, Details details) {}
949
950 /**
951 * Invoked when the text messages that can be used as responses to the incoming
952 * {@code Call} are loaded from the relevant database.
953 * See {@link #getCannedTextResponses()}.
954 *
955 * @param call The {@code Call} invoking this method.
956 * @param cannedTextResponses The text messages useable as responses.
957 */
958 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
959
960 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700961 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
962 * character. This causes the post-dial signals to stop pending user confirmation. An
963 * implementation should present this choice to the user and invoke
964 * {@link #postDialContinue(boolean)} when the user makes the choice.
965 *
966 * @param call The {@code Call} invoking this method.
967 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
968 */
969 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
970
971 /**
Andrew Lee50aca232014-07-22 16:41:54 -0700972 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700973 *
974 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -0700975 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700976 */
Andrew Lee50aca232014-07-22 16:41:54 -0700977 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -0700978
979 /**
980 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
981 * up their UI for the {@code Call} in response to state transitions. Specifically,
982 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
983 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
984 * clients should wait for this method to be invoked.
985 *
986 * @param call The {@code Call} being destroyed.
987 */
988 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700989
990 /**
991 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
992 * conferenced.
993 *
994 * @param call The {@code Call} being updated.
995 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
996 * conferenced.
997 */
998 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700999
1000 /**
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001001 * Invoked when a {@link Call} receives an event from its associated {@link Connection}.
1002 * <p>
1003 * Where possible, the Call should make an attempt to handle {@link Connection} events which
1004 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1005 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1006 * possible that a {@link ConnectionService} has defined its own Connection events which a
1007 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001008 * <p>
1009 * See {@link Connection#sendConnectionEvent(String, Bundle)}.
1010 *
1011 * @param call The {@code Call} receiving the event.
1012 * @param event The event.
1013 * @param extras Extras associated with the connection event.
1014 */
1015 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001016
1017 /**
1018 * Invoked when the RTT mode changes for this call.
1019 * @param call The call whose RTT mode has changed.
1020 * @param mode the new RTT mode, one of
1021 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1022 * or {@link RttCall#RTT_MODE_VCO}
1023 */
1024 public void onRttModeChanged(Call call, int mode) {}
1025
1026 /**
1027 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1028 * @param call The call whose RTT status has changed.
1029 * @param enabled whether RTT is now enabled or disabled
1030 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1031 * on, null otherwise.
1032 */
1033 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1034
1035 /**
1036 * Invoked when the remote end of the connection has requested that an RTT communication
1037 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1038 * with the same ID that this method is invoked with.
1039 * @param call The call which the RTT request was placed on
1040 * @param id The ID of the request.
1041 */
1042 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001043
1044 /**
1045 * Invoked when the RTT session failed to initiate for some reason, including rejection
1046 * by the remote party.
1047 * @param call The call which the RTT initiation failure occurred on.
1048 * @param reason One of the status codes defined in
1049 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1050 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
1051 */
1052 public void onRttInitiationFailure(Call call, int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001053
1054 /**
1055 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1056 * has completed successfully.
1057 * @param call The call which had initiated handover.
1058 */
1059 public void onHandoverComplete(Call call) {}
1060
1061 /**
1062 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1063 * has failed.
1064 * @param call The call which had initiated handover.
1065 * @param failureReason Error reason for failure
1066 */
1067 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001068 }
1069
1070 /**
1071 * A class that holds the state that describes the state of the RTT channel to the remote
1072 * party, if it is active.
1073 */
1074 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001075 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001076 @Retention(RetentionPolicy.SOURCE)
1077 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1078 public @interface RttAudioMode {}
1079
1080 /**
1081 * For metrics use. Default value in the proto.
1082 * @hide
1083 */
1084 public static final int RTT_MODE_INVALID = 0;
1085
1086 /**
1087 * Indicates that there should be a bidirectional audio stream between the two parties
1088 * on the call.
1089 */
1090 public static final int RTT_MODE_FULL = 1;
1091
1092 /**
1093 * Indicates that the local user should be able to hear the audio stream from the remote
1094 * user, but not vice versa. Equivalent to muting the microphone.
1095 */
1096 public static final int RTT_MODE_HCO = 2;
1097
1098 /**
1099 * Indicates that the remote user should be able to hear the audio stream from the local
1100 * user, but not vice versa. Equivalent to setting the volume to zero.
1101 */
1102 public static final int RTT_MODE_VCO = 3;
1103
1104 private static final int READ_BUFFER_SIZE = 1000;
1105
1106 private InputStreamReader mReceiveStream;
1107 private OutputStreamWriter mTransmitStream;
1108 private int mRttMode;
1109 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001110 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001111 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1112
1113 /**
1114 * @hide
1115 */
Hall Liu57006aa2017-02-06 10:49:48 -08001116 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1117 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1118 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001119 mReceiveStream = receiveStream;
1120 mTransmitStream = transmitStream;
1121 mRttMode = mode;
1122 mInCallAdapter = inCallAdapter;
1123 }
1124
1125 /**
1126 * Returns the current RTT audio mode.
1127 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1128 * {@link #RTT_MODE_HCO}.
1129 */
1130 public int getRttAudioMode() {
1131 return mRttMode;
1132 }
1133
1134 /**
1135 * Sets the RTT audio mode. The requested mode change will be communicated through
1136 * {@link Callback#onRttModeChanged(Call, int)}.
1137 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1138 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1139 */
1140 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001141 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001142 }
1143
1144 /**
1145 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
1146 * RTT transmits text in real-time, this method should be called once for each character
1147 * the user enters into the device.
1148 *
1149 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1150 * lead to interleaved text.
1151 * @param input The message to send to the remote user.
1152 */
1153 public void write(String input) throws IOException {
1154 mTransmitStream.write(input);
1155 mTransmitStream.flush();
1156 }
1157
1158 /**
1159 * Reads a string from the remote user, blocking if there is no data available. Returns
1160 * {@code null} if the RTT conversation has been terminated and there is no further data
1161 * to read.
1162 *
1163 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1164 * lead to interleaved text.
1165 * @return A string containing text sent by the remote user, or {@code null} if the
1166 * conversation has been terminated or if there was an error while reading.
1167 */
Hall Liub1c8a772017-07-17 17:04:41 -07001168 public String read() {
1169 try {
1170 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1171 if (numRead < 0) {
1172 return null;
1173 }
1174 return new String(mReadBuffer, 0, numRead);
1175 } catch (IOException e) {
1176 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001177 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001178 }
Hall Liuffa4a812017-03-02 16:11:00 -08001179 }
1180
1181 /**
1182 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1183 * be read.
1184 * @return A string containing text entered by the user, or {@code null} if the user has
1185 * not entered any new text yet.
1186 */
1187 public String readImmediately() throws IOException {
1188 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001189 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1190 if (numRead < 0) {
1191 return null;
1192 }
1193 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001194 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001195 return null;
1196 }
1197 }
Hall Liua549fed2018-02-09 16:40:03 -08001198
1199 /**
1200 * Closes the underlying file descriptors
1201 * @hide
1202 */
1203 public void close() {
1204 try {
1205 mReceiveStream.close();
1206 } catch (IOException e) {
1207 // ignore
1208 }
1209 try {
1210 mTransmitStream.close();
1211 } catch (IOException e) {
1212 // ignore
1213 }
1214 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001215 }
1216
Andrew Leeda80c872015-04-15 14:09:50 -07001217 /**
1218 * @deprecated Use {@code Call.Callback} instead.
1219 * @hide
1220 */
1221 @Deprecated
1222 @SystemApi
1223 public static abstract class Listener extends Callback { }
1224
Ihab Awade63fadb2014-07-09 21:52:04 -07001225 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001226 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001227 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001228 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001229 private final List<Call> mChildren = new ArrayList<>();
1230 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001231 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001232 private final List<Call> mConferenceableCalls = new ArrayList<>();
1233 private final List<Call> mUnmodifiableConferenceableCalls =
1234 Collections.unmodifiableList(mConferenceableCalls);
1235
Santos Cordon823fd3c2014-08-07 18:35:18 -07001236 private boolean mChildrenCached;
1237 private String mParentId = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001238 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001239 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001240 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001241 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001242 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001243 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001244 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001245 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001246 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001247
1248 /**
1249 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1250 *
1251 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1252 * remaining or this {@code Call} is not in a post-dial state.
1253 */
1254 public String getRemainingPostDialSequence() {
1255 return mRemainingPostDialSequence;
1256 }
1257
1258 /**
1259 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001260 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001261 */
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001262 public void answer(int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001263 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001264 }
1265
1266 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301267 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1268 *
1269 * @param address The address to which the call will be deflected.
1270 */
1271 public void deflect(Uri address) {
1272 mInCallAdapter.deflectCall(mTelecomCallId, address);
1273 }
1274
1275 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001276 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1277 *
1278 * @param rejectWithMessage Whether to reject with a text message.
1279 * @param textMessage An optional text message with which to respond.
1280 */
1281 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001282 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001283 }
1284
1285 /**
1286 * Instructs this {@code Call} to disconnect.
1287 */
1288 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001289 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001290 }
1291
1292 /**
1293 * Instructs this {@code Call} to go on hold.
1294 */
1295 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001296 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001297 }
1298
1299 /**
1300 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1301 */
1302 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001303 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001304 }
1305
1306 /**
1307 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
1308 *
1309 * Any other currently playing DTMF tone in the specified call is immediately stopped.
1310 *
1311 * @param digit A character representing the DTMF digit for which to play the tone. This
1312 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1313 */
1314 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001315 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001316 }
1317
1318 /**
1319 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1320 * currently playing.
1321 *
1322 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1323 * currently playing, this method will do nothing.
1324 */
1325 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001326 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001327 }
1328
1329 /**
1330 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1331 *
1332 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1333 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001334 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001335 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001336 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1337 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001338 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001339 * {@code Call} will pause playing the tones and notify callbacks via
1340 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001341 * should display to the user an indication of this state and an affordance to continue
1342 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1343 * app should invoke the {@link #postDialContinue(boolean)} method.
1344 *
1345 * @param proceed Whether or not to continue with the post-dial sequence.
1346 */
1347 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001348 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001349 }
1350
1351 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001352 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001353 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001354 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001355 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1356 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001357
1358 }
1359
1360 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001361 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001362 *
1363 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001364 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001365 public void conference(Call callToConferenceWith) {
1366 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001367 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001368 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001369 }
1370
1371 /**
1372 * Instructs this {@code Call} to split from any conference call with which it may be
1373 * connected.
1374 */
1375 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001376 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001377 }
1378
1379 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001380 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001381 */
1382 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001383 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001384 }
1385
1386 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001387 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001388 */
1389 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001390 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001391 }
1392
1393 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001394 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1395 * device.
1396 * <p>
1397 * Calls to this method are ignored if the call does not have the
1398 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
1399 * <p>
1400 * An {@link InCallService} will only see calls which support this method if it has the
1401 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
1402 * in its manifest.
1403 */
1404 public void pullExternalCall() {
1405 // If this isn't an external call, ignore the request.
1406 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
1407 return;
1408 }
1409
1410 mInCallAdapter.pullExternalCall(mTelecomCallId);
1411 }
1412
1413 /**
1414 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
1415 * the {@link ConnectionService}.
1416 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001417 * Call events are used to communicate point in time information from an {@link InCallService}
1418 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
1419 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
1420 * {@link ConnectionService}.
1421 * <p>
1422 * A {@link ConnectionService} can communicate to the {@link InCallService} using
1423 * {@link Connection#sendConnectionEvent(String, Bundle)}.
1424 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001425 * Events are exposed to {@link ConnectionService} implementations via
1426 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
1427 * <p>
1428 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001429 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
1430 * ignore some events altogether.
1431 * <p>
1432 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
1433 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
1434 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
1435 * they define their own event types in this namespace. When defining a custom event type,
1436 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
1437 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
1438 * <p>
1439 * When defining events and the associated extras, it is important to keep their behavior
1440 * consistent when the associated {@link InCallService} is updated. Support for deprecated
1441 * events/extras should me maintained to ensure backwards compatibility with older
1442 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001443 *
1444 * @param event The connection event.
1445 * @param extras Bundle containing extra information associated with the event.
1446 */
1447 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08001448 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001449 }
1450
1451 /**
Hall Liu95d55872017-01-25 17:12:49 -08001452 * Sends an RTT upgrade request to the remote end of the connection. Success is not
1453 * guaranteed, and notification of success will be via the
1454 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
1455 */
1456 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08001457 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08001458 }
1459
1460 /**
1461 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
1462 * callback.
1463 * The ID used here should be the same as the ID that was received via the callback.
1464 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
1465 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
1466 */
1467 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08001468 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08001469 }
1470
1471 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001472 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
1473 * by {@code toHandle}. The videoState specified indicates the desired video state after the
1474 * handover.
1475 * <p>
1476 * A handover request is initiated by the user from one app to indicate a desire
1477 * to handover a call to another.
1478 *
1479 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
1480 * this call to.
1481 * @param videoState Indicates the video state desired after the handover.
1482 * @param extras Bundle containing extra information to be passed to the
1483 * {@link ConnectionService}
1484 */
1485 public void handoverTo(PhoneAccountHandle toHandle, int videoState, Bundle extras) {
1486 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
1487 }
1488
1489 /**
Hall Liu95d55872017-01-25 17:12:49 -08001490 * Terminate the RTT session on this call. The resulting state change will be notified via
1491 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
1492 */
1493 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08001494 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08001495 }
1496
1497 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07001498 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
1499 * added.
1500 * <p>
1501 * No assumptions should be made as to how an In-Call UI or service will handle these
1502 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
1503 *
1504 * @param extras The extras to add.
1505 */
1506 public final void putExtras(Bundle extras) {
1507 if (extras == null) {
1508 return;
1509 }
1510
1511 if (mExtras == null) {
1512 mExtras = new Bundle();
1513 }
1514 mExtras.putAll(extras);
1515 mInCallAdapter.putExtras(mTelecomCallId, extras);
1516 }
1517
1518 /**
1519 * Adds a boolean extra to this {@link Call}.
1520 *
1521 * @param key The extra key.
1522 * @param value The value.
1523 * @hide
1524 */
1525 public final void putExtra(String key, boolean value) {
1526 if (mExtras == null) {
1527 mExtras = new Bundle();
1528 }
1529 mExtras.putBoolean(key, value);
1530 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1531 }
1532
1533 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001534 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001535 *
1536 * @param key The extra key.
1537 * @param value The value.
1538 * @hide
1539 */
1540 public final void putExtra(String key, int value) {
1541 if (mExtras == null) {
1542 mExtras = new Bundle();
1543 }
1544 mExtras.putInt(key, value);
1545 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1546 }
1547
1548 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001549 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001550 *
1551 * @param key The extra key.
1552 * @param value The value.
1553 * @hide
1554 */
1555 public final void putExtra(String key, String value) {
1556 if (mExtras == null) {
1557 mExtras = new Bundle();
1558 }
1559 mExtras.putString(key, value);
1560 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1561 }
1562
1563 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001564 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001565 *
1566 * @param keys The keys of the extras to remove.
1567 */
1568 public final void removeExtras(List<String> keys) {
1569 if (mExtras != null) {
1570 for (String key : keys) {
1571 mExtras.remove(key);
1572 }
1573 if (mExtras.size() == 0) {
1574 mExtras = null;
1575 }
1576 }
1577 mInCallAdapter.removeExtras(mTelecomCallId, keys);
1578 }
1579
1580 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001581 * Removes extras from this {@link Call}.
1582 *
1583 * @param keys The keys of the extras to remove.
1584 */
1585 public final void removeExtras(String ... keys) {
1586 removeExtras(Arrays.asList(keys));
1587 }
1588
1589 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001590 * Obtains the parent of this {@code Call} in a conference, if any.
1591 *
1592 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
1593 * child of any conference {@code Call}s.
1594 */
1595 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001596 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001597 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001598 }
1599 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07001600 }
1601
1602 /**
1603 * Obtains the children of this conference {@code Call}, if any.
1604 *
1605 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
1606 * {@code List} otherwise.
1607 */
1608 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001609 if (!mChildrenCached) {
1610 mChildrenCached = true;
1611 mChildren.clear();
1612
1613 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001614 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001615 if (call == null) {
1616 // At least one child was still not found, so do not save true for "cached"
1617 mChildrenCached = false;
1618 } else {
1619 mChildren.add(call);
1620 }
1621 }
1622 }
1623
Ihab Awade63fadb2014-07-09 21:52:04 -07001624 return mUnmodifiableChildren;
1625 }
1626
1627 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001628 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
1629 *
1630 * @return The list of conferenceable {@code Call}s.
1631 */
1632 public List<Call> getConferenceableCalls() {
1633 return mUnmodifiableConferenceableCalls;
1634 }
1635
1636 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001637 * Obtains the state of this {@code Call}.
1638 *
1639 * @return A state value, chosen from the {@code STATE_*} constants.
1640 */
1641 public int getState() {
1642 return mState;
1643 }
1644
1645 /**
1646 * Obtains a list of canned, pre-configured message responses to present to the user as
1647 * ways of rejecting this {@code Call} using via a text message.
1648 *
1649 * @see #reject(boolean, String)
1650 *
1651 * @return A list of canned text message responses.
1652 */
1653 public List<String> getCannedTextResponses() {
1654 return mCannedTextResponses;
1655 }
1656
1657 /**
1658 * Obtains an object that can be used to display video from this {@code Call}.
1659 *
Andrew Lee50aca232014-07-22 16:41:54 -07001660 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001661 */
Andrew Lee50aca232014-07-22 16:41:54 -07001662 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001663 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07001664 }
1665
1666 /**
1667 * Obtains an object containing call details.
1668 *
1669 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
1670 * result may be {@code null}.
1671 */
1672 public Details getDetails() {
1673 return mDetails;
1674 }
1675
1676 /**
Hall Liu95d55872017-01-25 17:12:49 -08001677 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
1678 * receive RTT text data, as well as to change the RTT mode.
1679 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
1680 */
1681 public @Nullable RttCall getRttCall() {
1682 return mRttCall;
1683 }
1684
1685 /**
1686 * Returns whether this call has an active RTT connection.
1687 * @return true if there is a connection, false otherwise.
1688 */
1689 public boolean isRttActive() {
Hall Liua549fed2018-02-09 16:40:03 -08001690 return mRttCall != null && mDetails.hasProperty(Details.PROPERTY_RTT);
Hall Liu95d55872017-01-25 17:12:49 -08001691 }
1692
1693 /**
Andrew Leeda80c872015-04-15 14:09:50 -07001694 * Registers a callback to this {@code Call}.
1695 *
1696 * @param callback A {@code Callback}.
1697 */
1698 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07001699 registerCallback(callback, new Handler());
1700 }
1701
1702 /**
1703 * Registers a callback to this {@code Call}.
1704 *
1705 * @param callback A {@code Callback}.
1706 * @param handler A handler which command and status changes will be delivered to.
1707 */
1708 public void registerCallback(Callback callback, Handler handler) {
1709 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07001710 // Don't allow new callback registration if the call is already being destroyed.
1711 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001712 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
1713 }
Andrew Leeda80c872015-04-15 14:09:50 -07001714 }
1715
1716 /**
1717 * Unregisters a callback from this {@code Call}.
1718 *
1719 * @param callback A {@code Callback}.
1720 */
1721 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07001722 // Don't allow callback deregistration if the call is already being destroyed.
1723 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001724 for (CallbackRecord<Callback> record : mCallbackRecords) {
1725 if (record.getCallback() == callback) {
1726 mCallbackRecords.remove(record);
1727 break;
1728 }
1729 }
Andrew Leeda80c872015-04-15 14:09:50 -07001730 }
1731 }
1732
Santos Cordon3c20d632016-02-25 16:12:35 -08001733 @Override
1734 public String toString() {
1735 return new StringBuilder().
1736 append("Call [id: ").
1737 append(mTelecomCallId).
1738 append(", state: ").
1739 append(stateToString(mState)).
1740 append(", details: ").
1741 append(mDetails).
1742 append("]").toString();
1743 }
1744
1745 /**
1746 * @param state An integer value of a {@code STATE_*} constant.
1747 * @return A string representation of the value.
1748 */
1749 private static String stateToString(int state) {
1750 switch (state) {
1751 case STATE_NEW:
1752 return "NEW";
1753 case STATE_RINGING:
1754 return "RINGING";
1755 case STATE_DIALING:
1756 return "DIALING";
1757 case STATE_ACTIVE:
1758 return "ACTIVE";
1759 case STATE_HOLDING:
1760 return "HOLDING";
1761 case STATE_DISCONNECTED:
1762 return "DISCONNECTED";
1763 case STATE_CONNECTING:
1764 return "CONNECTING";
1765 case STATE_DISCONNECTING:
1766 return "DISCONNECTING";
1767 case STATE_SELECT_PHONE_ACCOUNT:
1768 return "SELECT_PHONE_ACCOUNT";
1769 default:
1770 Log.w(Call.class, "Unknown state %d", state);
1771 return "UNKNOWN";
1772 }
1773 }
1774
Andrew Leeda80c872015-04-15 14:09:50 -07001775 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001776 * Adds a listener to this {@code Call}.
1777 *
1778 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001779 * @deprecated Use {@link #registerCallback} instead.
1780 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001781 */
Andrew Leeda80c872015-04-15 14:09:50 -07001782 @Deprecated
1783 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001784 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001785 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001786 }
1787
1788 /**
1789 * Removes a listener from this {@code Call}.
1790 *
1791 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001792 * @deprecated Use {@link #unregisterCallback} instead.
1793 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001794 */
Andrew Leeda80c872015-04-15 14:09:50 -07001795 @Deprecated
1796 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001797 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001798 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001799 }
1800
1801 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08001802 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
1803 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07001804 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001805 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001806 mInCallAdapter = inCallAdapter;
1807 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001808 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001809 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001810 }
1811
1812 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08001813 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08001814 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07001815 mPhone = phone;
1816 mTelecomCallId = telecomCallId;
1817 mInCallAdapter = inCallAdapter;
1818 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001819 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001820 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07001821 }
1822
1823 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001824 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001825 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001826 }
1827
1828 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001829 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08001830
Ihab Awade63fadb2014-07-09 21:52:04 -07001831 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001832 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07001833 boolean detailsChanged = !Objects.equals(mDetails, details);
1834 if (detailsChanged) {
1835 mDetails = details;
1836 }
1837
1838 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07001839 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
1840 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
1841 mCannedTextResponses =
1842 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07001843 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07001844 }
1845
Tyler Gunn159f35c2017-03-02 09:28:37 -08001846 VideoCallImpl newVideoCallImpl = parcelableCall.getVideoCallImpl(mCallingPackage,
1847 mTargetSdkVersion);
Tyler Gunn75958422015-04-15 14:23:42 -07001848 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged() &&
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001849 !Objects.equals(mVideoCallImpl, newVideoCallImpl);
Andrew Lee50aca232014-07-22 16:41:54 -07001850 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001851 mVideoCallImpl = newVideoCallImpl;
1852 }
1853 if (mVideoCallImpl != null) {
1854 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07001855 }
1856
Santos Cordone3c507b2015-04-23 14:44:19 -07001857 int state = parcelableCall.getState();
Ihab Awade63fadb2014-07-09 21:52:04 -07001858 boolean stateChanged = mState != state;
1859 if (stateChanged) {
1860 mState = state;
1861 }
1862
Santos Cordon823fd3c2014-08-07 18:35:18 -07001863 String parentId = parcelableCall.getParentCallId();
1864 boolean parentChanged = !Objects.equals(mParentId, parentId);
1865 if (parentChanged) {
1866 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001867 }
1868
Santos Cordon823fd3c2014-08-07 18:35:18 -07001869 List<String> childCallIds = parcelableCall.getChildCallIds();
1870 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
1871 if (childrenChanged) {
1872 mChildrenIds.clear();
1873 mChildrenIds.addAll(parcelableCall.getChildCallIds());
1874 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07001875 }
1876
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001877 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
1878 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
1879 for (String otherId : conferenceableCallIds) {
1880 if (callIdMap.containsKey(otherId)) {
1881 conferenceableCalls.add(callIdMap.get(otherId));
1882 }
1883 }
1884
1885 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
1886 mConferenceableCalls.clear();
1887 mConferenceableCalls.addAll(conferenceableCalls);
1888 fireConferenceableCallsChanged();
1889 }
1890
Hall Liu95d55872017-01-25 17:12:49 -08001891 boolean isRttChanged = false;
1892 boolean rttModeChanged = false;
Hall Liua549fed2018-02-09 16:40:03 -08001893 if (parcelableCall.getIsRttCallChanged()
1894 && mDetails.hasProperty(Details.PROPERTY_RTT)) {
Hall Liu95d55872017-01-25 17:12:49 -08001895 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
1896 InputStreamReader receiveStream = new InputStreamReader(
1897 new ParcelFileDescriptor.AutoCloseInputStream(
1898 parcelableRttCall.getReceiveStream()),
1899 StandardCharsets.UTF_8);
1900 OutputStreamWriter transmitStream = new OutputStreamWriter(
1901 new ParcelFileDescriptor.AutoCloseOutputStream(
1902 parcelableRttCall.getTransmitStream()),
1903 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08001904 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08001905 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
1906 if (mRttCall == null) {
1907 isRttChanged = true;
1908 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
1909 rttModeChanged = true;
1910 }
1911 mRttCall = newRttCall;
1912 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
1913 && parcelableCall.getIsRttCallChanged()) {
1914 isRttChanged = true;
1915 mRttCall = null;
1916 }
1917
Ihab Awade63fadb2014-07-09 21:52:04 -07001918 // Now we fire updates, ensuring that any client who listens to any of these notifications
1919 // gets the most up-to-date state.
1920
1921 if (stateChanged) {
1922 fireStateChanged(mState);
1923 }
1924 if (detailsChanged) {
1925 fireDetailsChanged(mDetails);
1926 }
1927 if (cannedTextResponsesChanged) {
1928 fireCannedTextResponsesLoaded(mCannedTextResponses);
1929 }
Andrew Lee50aca232014-07-22 16:41:54 -07001930 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001931 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07001932 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07001933 if (parentChanged) {
1934 fireParentChanged(getParent());
1935 }
1936 if (childrenChanged) {
1937 fireChildrenChanged(getChildren());
1938 }
Hall Liu95d55872017-01-25 17:12:49 -08001939 if (isRttChanged) {
1940 fireOnIsRttChanged(mRttCall != null, mRttCall);
1941 }
1942 if (rttModeChanged) {
1943 fireOnRttModeChanged(mRttCall.getRttAudioMode());
1944 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001945
1946 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
1947 // remove ourselves from the Phone. Note that we do this after completing all state updates
1948 // so a client can cleanly transition all their UI to the state appropriate for a
1949 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
1950 if (mState == STATE_DISCONNECTED) {
1951 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07001952 }
1953 }
1954
1955 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001956 final void internalSetPostDialWait(String remaining) {
1957 mRemainingPostDialSequence = remaining;
1958 firePostDialWait(mRemainingPostDialSequence);
1959 }
1960
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07001961 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07001962 final void internalSetDisconnected() {
1963 if (mState != Call.STATE_DISCONNECTED) {
1964 mState = Call.STATE_DISCONNECTED;
1965 fireStateChanged(mState);
1966 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07001967 }
1968 }
1969
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001970 /** {@hide} */
1971 final void internalOnConnectionEvent(String event, Bundle extras) {
1972 fireOnConnectionEvent(event, extras);
1973 }
1974
Hall Liu95d55872017-01-25 17:12:49 -08001975 /** {@hide} */
1976 final void internalOnRttUpgradeRequest(final int requestId) {
1977 for (CallbackRecord<Callback> record : mCallbackRecords) {
1978 final Call call = this;
1979 final Callback callback = record.getCallback();
1980 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
1981 }
1982 }
1983
Hall Liu57006aa2017-02-06 10:49:48 -08001984 /** @hide */
1985 final void internalOnRttInitiationFailure(int reason) {
1986 for (CallbackRecord<Callback> record : mCallbackRecords) {
1987 final Call call = this;
1988 final Callback callback = record.getCallback();
1989 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
1990 }
1991 }
1992
Sanket Padawe85291f62017-12-01 13:59:27 -08001993 /** {@hide} */
1994 final void internalOnHandoverFailed(int error) {
1995 for (CallbackRecord<Callback> record : mCallbackRecords) {
1996 final Call call = this;
1997 final Callback callback = record.getCallback();
1998 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
1999 }
2000 }
2001
Tyler Gunn79bc1ec2018-01-22 15:17:54 -08002002 /** {@hide} */
2003 final void internalOnHandoverComplete() {
2004 for (CallbackRecord<Callback> record : mCallbackRecords) {
2005 final Call call = this;
2006 final Callback callback = record.getCallback();
2007 record.getHandler().post(() -> callback.onHandoverComplete(call));
2008 }
2009 }
2010
Andrew Lee011728f2015-04-23 15:47:06 -07002011 private void fireStateChanged(final int newState) {
2012 for (CallbackRecord<Callback> record : mCallbackRecords) {
2013 final Call call = this;
2014 final Callback callback = record.getCallback();
2015 record.getHandler().post(new Runnable() {
2016 @Override
2017 public void run() {
2018 callback.onStateChanged(call, newState);
2019 }
2020 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002021 }
2022 }
2023
Andrew Lee011728f2015-04-23 15:47:06 -07002024 private void fireParentChanged(final Call newParent) {
2025 for (CallbackRecord<Callback> record : mCallbackRecords) {
2026 final Call call = this;
2027 final Callback callback = record.getCallback();
2028 record.getHandler().post(new Runnable() {
2029 @Override
2030 public void run() {
2031 callback.onParentChanged(call, newParent);
2032 }
2033 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002034 }
2035 }
2036
Andrew Lee011728f2015-04-23 15:47:06 -07002037 private void fireChildrenChanged(final List<Call> children) {
2038 for (CallbackRecord<Callback> record : mCallbackRecords) {
2039 final Call call = this;
2040 final Callback callback = record.getCallback();
2041 record.getHandler().post(new Runnable() {
2042 @Override
2043 public void run() {
2044 callback.onChildrenChanged(call, children);
2045 }
2046 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002047 }
2048 }
2049
Andrew Lee011728f2015-04-23 15:47:06 -07002050 private void fireDetailsChanged(final Details details) {
2051 for (CallbackRecord<Callback> record : mCallbackRecords) {
2052 final Call call = this;
2053 final Callback callback = record.getCallback();
2054 record.getHandler().post(new Runnable() {
2055 @Override
2056 public void run() {
2057 callback.onDetailsChanged(call, details);
2058 }
2059 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002060 }
2061 }
2062
Andrew Lee011728f2015-04-23 15:47:06 -07002063 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2064 for (CallbackRecord<Callback> record : mCallbackRecords) {
2065 final Call call = this;
2066 final Callback callback = record.getCallback();
2067 record.getHandler().post(new Runnable() {
2068 @Override
2069 public void run() {
2070 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2071 }
2072 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002073 }
2074 }
2075
Andrew Lee011728f2015-04-23 15:47:06 -07002076 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2077 for (CallbackRecord<Callback> record : mCallbackRecords) {
2078 final Call call = this;
2079 final Callback callback = record.getCallback();
2080 record.getHandler().post(new Runnable() {
2081 @Override
2082 public void run() {
2083 callback.onVideoCallChanged(call, videoCall);
2084 }
2085 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002086 }
2087 }
2088
Andrew Lee011728f2015-04-23 15:47:06 -07002089 private void firePostDialWait(final String remainingPostDialSequence) {
2090 for (CallbackRecord<Callback> record : mCallbackRecords) {
2091 final Call call = this;
2092 final Callback callback = record.getCallback();
2093 record.getHandler().post(new Runnable() {
2094 @Override
2095 public void run() {
2096 callback.onPostDialWait(call, remainingPostDialSequence);
2097 }
2098 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002099 }
2100 }
2101
2102 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002103 /**
2104 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2105 * onCallRemoved callback, we remove this call from the Phone's record
2106 * only once all of the registered onCallDestroyed callbacks are executed.
2107 * All the callbacks get removed from our records as a part of this operation
2108 * since onCallDestroyed is the final callback.
2109 */
2110 final Call call = this;
2111 if (mCallbackRecords.isEmpty()) {
2112 // No callbacks registered, remove the call from Phone's record.
2113 mPhone.internalRemoveCall(call);
2114 }
2115 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002116 final Callback callback = record.getCallback();
2117 record.getHandler().post(new Runnable() {
2118 @Override
2119 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002120 boolean isFinalRemoval = false;
2121 RuntimeException toThrow = null;
2122 try {
2123 callback.onCallDestroyed(call);
2124 } catch (RuntimeException e) {
2125 toThrow = e;
2126 }
2127 synchronized(Call.this) {
2128 mCallbackRecords.remove(record);
2129 if (mCallbackRecords.isEmpty()) {
2130 isFinalRemoval = true;
2131 }
2132 }
2133 if (isFinalRemoval) {
2134 mPhone.internalRemoveCall(call);
2135 }
2136 if (toThrow != null) {
2137 throw toThrow;
2138 }
Andrew Lee011728f2015-04-23 15:47:06 -07002139 }
2140 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002141 }
2142 }
2143
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002144 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002145 for (CallbackRecord<Callback> record : mCallbackRecords) {
2146 final Call call = this;
2147 final Callback callback = record.getCallback();
2148 record.getHandler().post(new Runnable() {
2149 @Override
2150 public void run() {
2151 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2152 }
2153 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002154 }
2155 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002156
2157 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002158 * Notifies listeners of an incoming connection event.
2159 * <p>
2160 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2161 *
2162 * @param event
2163 * @param extras
2164 */
2165 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2166 for (CallbackRecord<Callback> record : mCallbackRecords) {
2167 final Call call = this;
2168 final Callback callback = record.getCallback();
2169 record.getHandler().post(new Runnable() {
2170 @Override
2171 public void run() {
2172 callback.onConnectionEvent(call, event, extras);
2173 }
2174 });
2175 }
2176 }
2177
2178 /**
Hall Liu95d55872017-01-25 17:12:49 -08002179 * Notifies listeners of an RTT on/off change
2180 *
2181 * @param enabled True if RTT is now enabled, false otherwise
2182 */
2183 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2184 for (CallbackRecord<Callback> record : mCallbackRecords) {
2185 final Call call = this;
2186 final Callback callback = record.getCallback();
2187 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2188 }
2189 }
2190
2191 /**
2192 * Notifies listeners of a RTT mode change
2193 *
2194 * @param mode The new RTT mode
2195 */
2196 private void fireOnRttModeChanged(final int mode) {
2197 for (CallbackRecord<Callback> record : mCallbackRecords) {
2198 final Call call = this;
2199 final Callback callback = record.getCallback();
2200 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2201 }
2202 }
2203
2204 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002205 * Determines if two bundles are equal.
2206 *
2207 * @param bundle The original bundle.
2208 * @param newBundle The bundle to compare with.
2209 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2210 */
2211 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2212 if (bundle == null || newBundle == null) {
2213 return bundle == newBundle;
2214 }
2215
2216 if (bundle.size() != newBundle.size()) {
2217 return false;
2218 }
2219
2220 for(String key : bundle.keySet()) {
2221 if (key != null) {
2222 final Object value = bundle.get(key);
2223 final Object newValue = newBundle.get(key);
2224 if (!Objects.equals(value, newValue)) {
2225 return false;
2226 }
2227 }
2228 }
2229 return true;
2230 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002231}