blob: 2341f03d2ec54fad2cd398718ca5be09b2daa7c7 [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}
425 * @hide
426 */
427 public static final int PROPERTY_ASSISTED_DIALING_USED = 0x00000200;
428
Andrew Lee2378ea72015-04-29 14:38:11 -0700429 //******************************************************************************************
Eric Erfanianec881872017-12-06 16:27:53 -0800430 // Next PROPERTY value: 0x00000400
Tyler Gunnd11a3152015-03-18 13:09:14 -0700431 //******************************************************************************************
Tyler Gunn068085b2015-02-06 13:56:52 -0800432
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800433 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700434 private final Uri mHandle;
435 private final int mHandlePresentation;
436 private final String mCallerDisplayName;
437 private final int mCallerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700438 private final PhoneAccountHandle mAccountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700439 private final int mCallCapabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700440 private final int mCallProperties;
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800441 private final int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700442 private final DisconnectCause mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700443 private final long mConnectTimeMillis;
444 private final GatewayInfo mGatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700445 private final int mVideoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700446 private final StatusHints mStatusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700447 private final Bundle mExtras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700448 private final Bundle mIntentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700449 private final long mCreationTimeMillis;
Ihab Awade63fadb2014-07-09 21:52:04 -0700450
451 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800452 * Whether the supplied capabilities supports the specified capability.
453 *
454 * @param capabilities A bit field of capabilities.
455 * @param capability The capability to check capabilities for.
456 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800457 */
458 public static boolean can(int capabilities, int capability) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800459 return (capabilities & capability) == capability;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800460 }
461
462 /**
463 * Whether the capabilities of this {@code Details} supports the specified capability.
464 *
465 * @param capability The capability to check capabilities for.
466 * @return Whether the specified capability is supported.
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800467 */
468 public boolean can(int capability) {
469 return can(mCallCapabilities, capability);
470 }
471
472 /**
473 * Render a set of capability bits ({@code CAPABILITY_*}) as a human readable string.
474 *
475 * @param capabilities A capability bit field.
476 * @return A human readable string representation.
477 */
478 public static String capabilitiesToString(int capabilities) {
479 StringBuilder builder = new StringBuilder();
480 builder.append("[Capabilities:");
481 if (can(capabilities, CAPABILITY_HOLD)) {
482 builder.append(" CAPABILITY_HOLD");
483 }
484 if (can(capabilities, CAPABILITY_SUPPORT_HOLD)) {
485 builder.append(" CAPABILITY_SUPPORT_HOLD");
486 }
487 if (can(capabilities, CAPABILITY_MERGE_CONFERENCE)) {
488 builder.append(" CAPABILITY_MERGE_CONFERENCE");
489 }
490 if (can(capabilities, CAPABILITY_SWAP_CONFERENCE)) {
491 builder.append(" CAPABILITY_SWAP_CONFERENCE");
492 }
493 if (can(capabilities, CAPABILITY_RESPOND_VIA_TEXT)) {
494 builder.append(" CAPABILITY_RESPOND_VIA_TEXT");
495 }
496 if (can(capabilities, CAPABILITY_MUTE)) {
497 builder.append(" CAPABILITY_MUTE");
498 }
499 if (can(capabilities, CAPABILITY_MANAGE_CONFERENCE)) {
500 builder.append(" CAPABILITY_MANAGE_CONFERENCE");
501 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700502 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_RX)) {
503 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_RX");
504 }
505 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_TX)) {
506 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_TX");
507 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700508 if (can(capabilities, CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL)) {
509 builder.append(" CAPABILITY_SUPPORTS_VT_LOCAL_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800510 }
Andrew Lee5e9e8bb2015-03-10 13:58:24 -0700511 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_RX)) {
512 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_RX");
513 }
514 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_TX)) {
515 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_TX");
516 }
Tyler Gunnf97a0092016-01-19 15:59:34 -0800517 if (can(capabilities, CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO)) {
518 builder.append(" CAPABILITY_CANNOT_DOWNGRADE_VIDEO_TO_AUDIO");
519 }
Andrew Lee9a8f9ce2015-04-10 18:09:46 -0700520 if (can(capabilities, CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL)) {
521 builder.append(" CAPABILITY_SUPPORTS_VT_REMOTE_BIDIRECTIONAL");
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800522 }
Dong Zhou89f41eb2015-03-15 11:59:49 -0500523 if (can(capabilities, CAPABILITY_SPEED_UP_MT_AUDIO)) {
Tyler Gunnd11a3152015-03-18 13:09:14 -0700524 builder.append(" CAPABILITY_SPEED_UP_MT_AUDIO");
Dong Zhou89f41eb2015-03-15 11:59:49 -0500525 }
Rekha Kumar07366812015-03-24 16:42:31 -0700526 if (can(capabilities, CAPABILITY_CAN_UPGRADE_TO_VIDEO)) {
527 builder.append(" CAPABILITY_CAN_UPGRADE_TO_VIDEO");
528 }
Tyler Gunnb5e0cfb2015-04-07 16:10:51 -0700529 if (can(capabilities, CAPABILITY_CAN_PAUSE_VIDEO)) {
530 builder.append(" CAPABILITY_CAN_PAUSE_VIDEO");
531 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700532 if (can(capabilities, CAPABILITY_CAN_PULL_CALL)) {
533 builder.append(" CAPABILITY_CAN_PULL_CALL");
534 }
Pooja Jaind34698d2017-12-28 14:15:31 +0530535 if (can(capabilities, CAPABILITY_SUPPORT_DEFLECT)) {
536 builder.append(" CAPABILITY_SUPPORT_DEFLECT");
537 }
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800538 builder.append("]");
539 return builder.toString();
540 }
541
542 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700543 * Whether the supplied properties includes the specified property.
544 *
545 * @param properties A bit field of properties.
546 * @param property The property to check properties for.
547 * @return Whether the specified property is supported.
548 */
549 public static boolean hasProperty(int properties, int property) {
Tyler Gunn014c7112015-12-18 14:33:57 -0800550 return (properties & property) == property;
Andrew Lee2378ea72015-04-29 14:38:11 -0700551 }
552
553 /**
554 * Whether the properties of this {@code Details} includes the specified property.
555 *
556 * @param property The property to check properties for.
557 * @return Whether the specified property is supported.
558 */
559 public boolean hasProperty(int property) {
560 return hasProperty(mCallProperties, property);
561 }
562
563 /**
564 * Render a set of property bits ({@code PROPERTY_*}) as a human readable string.
565 *
566 * @param properties A property bit field.
567 * @return A human readable string representation.
568 */
569 public static String propertiesToString(int properties) {
570 StringBuilder builder = new StringBuilder();
571 builder.append("[Properties:");
572 if (hasProperty(properties, PROPERTY_CONFERENCE)) {
573 builder.append(" PROPERTY_CONFERENCE");
574 }
575 if (hasProperty(properties, PROPERTY_GENERIC_CONFERENCE)) {
576 builder.append(" PROPERTY_GENERIC_CONFERENCE");
577 }
578 if (hasProperty(properties, PROPERTY_WIFI)) {
579 builder.append(" PROPERTY_WIFI");
580 }
581 if (hasProperty(properties, PROPERTY_HIGH_DEF_AUDIO)) {
582 builder.append(" PROPERTY_HIGH_DEF_AUDIO");
583 }
584 if (hasProperty(properties, PROPERTY_EMERGENCY_CALLBACK_MODE)) {
Yorke Leebe2a4a22015-06-12 10:10:55 -0700585 builder.append(" PROPERTY_EMERGENCY_CALLBACK_MODE");
Andrew Lee2378ea72015-04-29 14:38:11 -0700586 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700587 if (hasProperty(properties, PROPERTY_IS_EXTERNAL_CALL)) {
588 builder.append(" PROPERTY_IS_EXTERNAL_CALL");
589 }
Brad Ebinger15847072016-05-18 11:08:36 -0700590 if(hasProperty(properties, PROPERTY_HAS_CDMA_VOICE_PRIVACY)) {
591 builder.append(" PROPERTY_HAS_CDMA_VOICE_PRIVACY");
592 }
Eric Erfanianec881872017-12-06 16:27:53 -0800593 if(hasProperty(properties, PROPERTY_ASSISTED_DIALING_USED)) {
594 builder.append(" PROPERTY_ASSISTED_DIALING_USED");
595 }
Andrew Lee2378ea72015-04-29 14:38:11 -0700596 builder.append("]");
597 return builder.toString();
598 }
599
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800600 /** {@hide} */
601 public String getTelecomCallId() {
602 return mTelecomCallId;
603 }
604
Andrew Lee2378ea72015-04-29 14:38:11 -0700605 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700606 * @return The handle (e.g., phone number) to which the {@code Call} is currently
607 * connected.
608 */
609 public Uri getHandle() {
610 return mHandle;
611 }
612
613 /**
614 * @return The presentation requirements for the handle. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700615 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700616 */
617 public int getHandlePresentation() {
618 return mHandlePresentation;
619 }
620
621 /**
622 * @return The display name for the caller.
623 */
624 public String getCallerDisplayName() {
625 return mCallerDisplayName;
626 }
627
628 /**
629 * @return The presentation requirements for the caller display name. See
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700630 * {@link TelecomManager} for valid values.
Ihab Awade63fadb2014-07-09 21:52:04 -0700631 */
632 public int getCallerDisplayNamePresentation() {
633 return mCallerDisplayNamePresentation;
634 }
635
636 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700637 * @return The {@code PhoneAccountHandle} whereby the {@code Call} is currently being
638 * routed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700639 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700640 public PhoneAccountHandle getAccountHandle() {
641 return mAccountHandle;
Ihab Awade63fadb2014-07-09 21:52:04 -0700642 }
643
644 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800645 * @return A bitmask of the capabilities of the {@code Call}, as defined by the various
646 * {@code CAPABILITY_*} constants in this class.
Ihab Awade63fadb2014-07-09 21:52:04 -0700647 */
Ihab Awad5d0410f2014-07-30 10:07:40 -0700648 public int getCallCapabilities() {
649 return mCallCapabilities;
Ihab Awade63fadb2014-07-09 21:52:04 -0700650 }
651
652 /**
Andrew Lee2378ea72015-04-29 14:38:11 -0700653 * @return A bitmask of the properties of the {@code Call}, as defined by the various
654 * {@code PROPERTY_*} constants in this class.
Andrew Lee223ad142014-08-27 16:33:08 -0700655 */
656 public int getCallProperties() {
657 return mCallProperties;
658 }
659
660 /**
Christine Hallstrom4e22d6d2016-11-30 16:06:42 -0800661 * @return a bitmask of the audio routes available for the call.
662 *
663 * @hide
664 */
665 public int getSupportedAudioRoutes() {
666 return mSupportedAudioRoutes;
667 }
668
669 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700670 * @return For a {@link #STATE_DISCONNECTED} {@code Call}, the disconnect cause expressed
Nancy Chenf4cf77c2014-09-19 10:53:21 -0700671 * by {@link android.telecom.DisconnectCause}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700672 */
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700673 public DisconnectCause getDisconnectCause() {
674 return mDisconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700675 }
676
677 /**
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700678 * Returns the time the {@link Call} connected (i.e. became active). This information is
679 * updated periodically, but user interfaces should not rely on this to display the "call
680 * time clock". For the time when the call was first added to Telecom, see
681 * {@link #getCreationTimeMillis()}.
682 *
683 * @return The time the {@link Call} connected in milliseconds since the epoch.
Ihab Awade63fadb2014-07-09 21:52:04 -0700684 */
Jay Shrauner164a0ac2015-04-14 18:16:10 -0700685 public final long getConnectTimeMillis() {
Ihab Awade63fadb2014-07-09 21:52:04 -0700686 return mConnectTimeMillis;
687 }
688
689 /**
690 * @return Information about any calling gateway the {@code Call} may be using.
691 */
692 public GatewayInfo getGatewayInfo() {
693 return mGatewayInfo;
694 }
695
Andrew Lee7a341382014-07-15 17:05:08 -0700696 /**
Ihab Awad5d0410f2014-07-30 10:07:40 -0700697 * @return The video state of the {@code Call}.
Andrew Lee7a341382014-07-15 17:05:08 -0700698 */
699 public int getVideoState() {
700 return mVideoState;
701 }
702
Ihab Awad5d0410f2014-07-30 10:07:40 -0700703 /**
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700704 * @return The current {@link android.telecom.StatusHints}, or {@code null} if none
Ihab Awad5d0410f2014-07-30 10:07:40 -0700705 * have been set.
Evan Charlton5b49ade2014-07-15 17:03:20 -0700706 */
707 public StatusHints getStatusHints() {
708 return mStatusHints;
709 }
710
Nancy Chen10798dc2014-08-08 14:00:25 -0700711 /**
Santos Cordon6b7f9552015-05-27 17:21:45 -0700712 * @return The extras associated with this call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700713 */
714 public Bundle getExtras() {
715 return mExtras;
716 }
717
Santos Cordon6b7f9552015-05-27 17:21:45 -0700718 /**
719 * @return The extras used with the original intent to place this call.
720 */
721 public Bundle getIntentExtras() {
722 return mIntentExtras;
723 }
724
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700725 /**
726 * Returns the time when the call was first created and added to Telecom. This is the same
727 * time that is logged as the start time in the Call Log (see
728 * {@link android.provider.CallLog.Calls#DATE}). To determine when the call was connected
729 * (became active), see {@link #getConnectTimeMillis()}.
730 *
731 * @return The creation time of the call, in millis since the epoch.
732 */
733 public long getCreationTimeMillis() {
734 return mCreationTimeMillis;
735 }
736
Ihab Awade63fadb2014-07-09 21:52:04 -0700737 @Override
738 public boolean equals(Object o) {
739 if (o instanceof Details) {
740 Details d = (Details) o;
741 return
742 Objects.equals(mHandle, d.mHandle) &&
743 Objects.equals(mHandlePresentation, d.mHandlePresentation) &&
744 Objects.equals(mCallerDisplayName, d.mCallerDisplayName) &&
745 Objects.equals(mCallerDisplayNamePresentation,
746 d.mCallerDisplayNamePresentation) &&
Evan Charlton8c8a0622014-07-20 12:31:00 -0700747 Objects.equals(mAccountHandle, d.mAccountHandle) &&
Ihab Awad5d0410f2014-07-30 10:07:40 -0700748 Objects.equals(mCallCapabilities, d.mCallCapabilities) &&
Andrew Lee223ad142014-08-27 16:33:08 -0700749 Objects.equals(mCallProperties, d.mCallProperties) &&
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700750 Objects.equals(mDisconnectCause, d.mDisconnectCause) &&
Ihab Awade63fadb2014-07-09 21:52:04 -0700751 Objects.equals(mConnectTimeMillis, d.mConnectTimeMillis) &&
Andrew Lee85f5d422014-07-11 17:22:03 -0700752 Objects.equals(mGatewayInfo, d.mGatewayInfo) &&
Evan Charlton5b49ade2014-07-15 17:03:20 -0700753 Objects.equals(mVideoState, d.mVideoState) &&
Nancy Chen10798dc2014-08-08 14:00:25 -0700754 Objects.equals(mStatusHints, d.mStatusHints) &&
Tyler Gunn1e9bfc62015-08-19 11:18:58 -0700755 areBundlesEqual(mExtras, d.mExtras) &&
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700756 areBundlesEqual(mIntentExtras, d.mIntentExtras) &&
757 Objects.equals(mCreationTimeMillis, d.mCreationTimeMillis);
Ihab Awade63fadb2014-07-09 21:52:04 -0700758 }
759 return false;
760 }
761
762 @Override
763 public int hashCode() {
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700764 return Objects.hash(mHandle,
765 mHandlePresentation,
766 mCallerDisplayName,
767 mCallerDisplayNamePresentation,
768 mAccountHandle,
769 mCallCapabilities,
770 mCallProperties,
771 mDisconnectCause,
772 mConnectTimeMillis,
773 mGatewayInfo,
774 mVideoState,
775 mStatusHints,
776 mExtras,
777 mIntentExtras,
778 mCreationTimeMillis);
Ihab Awade63fadb2014-07-09 21:52:04 -0700779 }
780
781 /** {@hide} */
782 public Details(
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800783 String telecomCallId,
Ihab Awade63fadb2014-07-09 21:52:04 -0700784 Uri handle,
785 int handlePresentation,
786 String callerDisplayName,
787 int callerDisplayNamePresentation,
Evan Charlton8c8a0622014-07-20 12:31:00 -0700788 PhoneAccountHandle accountHandle,
Ihab Awade63fadb2014-07-09 21:52:04 -0700789 int capabilities,
Andrew Lee223ad142014-08-27 16:33:08 -0700790 int properties,
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700791 DisconnectCause disconnectCause,
Ihab Awade63fadb2014-07-09 21:52:04 -0700792 long connectTimeMillis,
Andrew Lee85f5d422014-07-11 17:22:03 -0700793 GatewayInfo gatewayInfo,
Evan Charlton5b49ade2014-07-15 17:03:20 -0700794 int videoState,
Nancy Chen10798dc2014-08-08 14:00:25 -0700795 StatusHints statusHints,
Santos Cordon6b7f9552015-05-27 17:21:45 -0700796 Bundle extras,
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700797 Bundle intentExtras,
798 long creationTimeMillis) {
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800799 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -0700800 mHandle = handle;
801 mHandlePresentation = handlePresentation;
802 mCallerDisplayName = callerDisplayName;
803 mCallerDisplayNamePresentation = callerDisplayNamePresentation;
Evan Charlton8c8a0622014-07-20 12:31:00 -0700804 mAccountHandle = accountHandle;
Ihab Awad5d0410f2014-07-30 10:07:40 -0700805 mCallCapabilities = capabilities;
Andrew Lee223ad142014-08-27 16:33:08 -0700806 mCallProperties = properties;
Andrew Lee7f3d41f2014-09-11 17:33:16 -0700807 mDisconnectCause = disconnectCause;
Ihab Awade63fadb2014-07-09 21:52:04 -0700808 mConnectTimeMillis = connectTimeMillis;
809 mGatewayInfo = gatewayInfo;
Andrew Lee85f5d422014-07-11 17:22:03 -0700810 mVideoState = videoState;
Evan Charlton5b49ade2014-07-15 17:03:20 -0700811 mStatusHints = statusHints;
Nancy Chen10798dc2014-08-08 14:00:25 -0700812 mExtras = extras;
Santos Cordon6b7f9552015-05-27 17:21:45 -0700813 mIntentExtras = intentExtras;
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700814 mCreationTimeMillis = creationTimeMillis;
Ihab Awade63fadb2014-07-09 21:52:04 -0700815 }
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800816
817 /** {@hide} */
818 public static Details createFromParcelableCall(ParcelableCall parcelableCall) {
819 return new Details(
820 parcelableCall.getId(),
821 parcelableCall.getHandle(),
822 parcelableCall.getHandlePresentation(),
823 parcelableCall.getCallerDisplayName(),
824 parcelableCall.getCallerDisplayNamePresentation(),
825 parcelableCall.getAccountHandle(),
826 parcelableCall.getCapabilities(),
827 parcelableCall.getProperties(),
828 parcelableCall.getDisconnectCause(),
829 parcelableCall.getConnectTimeMillis(),
830 parcelableCall.getGatewayInfo(),
831 parcelableCall.getVideoState(),
832 parcelableCall.getStatusHints(),
833 parcelableCall.getExtras(),
Tyler Gunnc0bf6de2017-03-17 11:27:09 -0700834 parcelableCall.getIntentExtras(),
835 parcelableCall.getCreationTimeMillis());
Sailesh Nepal1bef3392016-01-24 18:21:53 -0800836 }
Santos Cordon3c20d632016-02-25 16:12:35 -0800837
838 @Override
839 public String toString() {
840 StringBuilder sb = new StringBuilder();
841 sb.append("[pa: ");
842 sb.append(mAccountHandle);
843 sb.append(", hdl: ");
844 sb.append(Log.pii(mHandle));
845 sb.append(", caps: ");
846 sb.append(capabilitiesToString(mCallCapabilities));
847 sb.append(", props: ");
Tyler Gunn720c6642016-03-22 09:02:47 -0700848 sb.append(propertiesToString(mCallProperties));
Santos Cordon3c20d632016-02-25 16:12:35 -0800849 sb.append("]");
850 return sb.toString();
851 }
Ihab Awade63fadb2014-07-09 21:52:04 -0700852 }
853
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -0700854 /**
855 * Defines callbacks which inform the {@link InCallService} of changes to a {@link Call}.
856 * These callbacks can originate from the Telecom framework, or a {@link ConnectionService}
857 * implementation.
858 * <p>
859 * You can handle these callbacks by extending the {@link Callback} class and overriding the
860 * callbacks that your {@link InCallService} is interested in. The callback methods include the
861 * {@link Call} for which the callback applies, allowing reuse of a single instance of your
862 * {@link Callback} implementation, if desired.
863 * <p>
864 * Use {@link Call#registerCallback(Callback)} to register your callback(s). Ensure
865 * {@link Call#unregisterCallback(Callback)} is called when you no longer require callbacks
866 * (typically in {@link InCallService#onCallRemoved(Call)}).
867 * Note: Callbacks which occur before you call {@link Call#registerCallback(Callback)} will not
868 * reach your implementation of {@link Callback}, so it is important to register your callback
869 * as soon as your {@link InCallService} is notified of a new call via
870 * {@link InCallService#onCallAdded(Call)}.
871 */
Andrew Leeda80c872015-04-15 14:09:50 -0700872 public static abstract class Callback {
Ihab Awade63fadb2014-07-09 21:52:04 -0700873 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -0700874 * @hide
875 */
876 @IntDef({HANDOVER_FAILURE_DEST_APP_REJECTED, HANDOVER_FAILURE_DEST_NOT_SUPPORTED,
Sanket Padawe85291f62017-12-01 13:59:27 -0800877 HANDOVER_FAILURE_DEST_INVALID_PERM, HANDOVER_FAILURE_DEST_USER_REJECTED,
878 HANDOVER_FAILURE_ONGOING_EMERG_CALL})
Sanket Padawea8eddd42017-11-03 11:07:35 -0700879 @Retention(RetentionPolicy.SOURCE)
880 public @interface HandoverFailureErrors {}
881
882 /**
883 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when the app
884 * to handover the call rejects handover.
885 */
886 public static final int HANDOVER_FAILURE_DEST_APP_REJECTED = 1;
887
888 /**
889 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there is
890 * an error associated with unsupported handover.
891 */
892 public static final int HANDOVER_FAILURE_DEST_NOT_SUPPORTED = 2;
893
894 /**
895 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
896 * are some permission errors associated with APIs doing handover.
897 */
898 public static final int HANDOVER_FAILURE_DEST_INVALID_PERM = 3;
899
900 /**
901 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when user
902 * rejects handover.
903 */
904 public static final int HANDOVER_FAILURE_DEST_USER_REJECTED = 4;
905
Sanket Padawe85291f62017-12-01 13:59:27 -0800906 /**
907 * Handover failure reason returned via {@link #onHandoverFailed(Call, int)} when there
908 * is ongoing emergency call.
909 */
910 public static final int HANDOVER_FAILURE_ONGOING_EMERG_CALL = 5;
911
Sanket Padawea8eddd42017-11-03 11:07:35 -0700912
913 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700914 * Invoked when the state of this {@code Call} has changed. See {@link #getState()}.
915 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700916 * @param call The {@code Call} invoking this method.
917 * @param state The new state of the {@code Call}.
918 */
919 public void onStateChanged(Call call, int state) {}
920
921 /**
922 * Invoked when the parent of this {@code Call} has changed. See {@link #getParent()}.
923 *
924 * @param call The {@code Call} invoking this method.
925 * @param parent The new parent of the {@code Call}.
926 */
927 public void onParentChanged(Call call, Call parent) {}
928
929 /**
930 * Invoked when the children of this {@code Call} have changed. See {@link #getChildren()}.
931 *
932 * @param call The {@code Call} invoking this method.
933 * @param children The new children of the {@code Call}.
934 */
935 public void onChildrenChanged(Call call, List<Call> children) {}
936
937 /**
938 * Invoked when the details of this {@code Call} have changed. See {@link #getDetails()}.
939 *
940 * @param call The {@code Call} invoking this method.
941 * @param details A {@code Details} object describing the {@code Call}.
942 */
943 public void onDetailsChanged(Call call, Details details) {}
944
945 /**
946 * Invoked when the text messages that can be used as responses to the incoming
947 * {@code Call} are loaded from the relevant database.
948 * See {@link #getCannedTextResponses()}.
949 *
950 * @param call The {@code Call} invoking this method.
951 * @param cannedTextResponses The text messages useable as responses.
952 */
953 public void onCannedTextResponsesLoaded(Call call, List<String> cannedTextResponses) {}
954
955 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700956 * Invoked when the post-dial sequence in the outgoing {@code Call} has reached a pause
957 * character. This causes the post-dial signals to stop pending user confirmation. An
958 * implementation should present this choice to the user and invoke
959 * {@link #postDialContinue(boolean)} when the user makes the choice.
960 *
961 * @param call The {@code Call} invoking this method.
962 * @param remainingPostDialSequence The post-dial characters that remain to be sent.
963 */
964 public void onPostDialWait(Call call, String remainingPostDialSequence) {}
965
966 /**
Andrew Lee50aca232014-07-22 16:41:54 -0700967 * Invoked when the {@code Call.VideoCall} of the {@code Call} has changed.
Ihab Awade63fadb2014-07-09 21:52:04 -0700968 *
969 * @param call The {@code Call} invoking this method.
Andrew Lee50aca232014-07-22 16:41:54 -0700970 * @param videoCall The {@code Call.VideoCall} associated with the {@code Call}.
Ihab Awade63fadb2014-07-09 21:52:04 -0700971 */
Andrew Lee50aca232014-07-22 16:41:54 -0700972 public void onVideoCallChanged(Call call, InCallService.VideoCall videoCall) {}
Ihab Awade63fadb2014-07-09 21:52:04 -0700973
974 /**
975 * Invoked when the {@code Call} is destroyed. Clients should refrain from cleaning
976 * up their UI for the {@code Call} in response to state transitions. Specifically,
977 * clients should not assume that a {@link #onStateChanged(Call, int)} with a state of
978 * {@link #STATE_DISCONNECTED} is the final notification the {@code Call} will send. Rather,
979 * clients should wait for this method to be invoked.
980 *
981 * @param call The {@code Call} being destroyed.
982 */
983 public void onCallDestroyed(Call call) {}
Santos Cordon7c7bc7f2014-07-28 18:15:48 -0700984
985 /**
986 * Invoked upon changes to the set of {@code Call}s with which this {@code Call} can be
987 * conferenced.
988 *
989 * @param call The {@code Call} being updated.
990 * @param conferenceableCalls The {@code Call}s with which this {@code Call} can be
991 * conferenced.
992 */
993 public void onConferenceableCallsChanged(Call call, List<Call> conferenceableCalls) {}
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700994
995 /**
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -0700996 * Invoked when a {@link Call} receives an event from its associated {@link Connection}.
997 * <p>
998 * Where possible, the Call should make an attempt to handle {@link Connection} events which
999 * are part of the {@code android.telecom.*} namespace. The Call should ignore any events
1000 * it does not wish to handle. Unexpected events should be handled gracefully, as it is
1001 * possible that a {@link ConnectionService} has defined its own Connection events which a
1002 * Call is not aware of.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001003 * <p>
1004 * See {@link Connection#sendConnectionEvent(String, Bundle)}.
1005 *
1006 * @param call The {@code Call} receiving the event.
1007 * @param event The event.
1008 * @param extras Extras associated with the connection event.
1009 */
1010 public void onConnectionEvent(Call call, String event, Bundle extras) {}
Hall Liu95d55872017-01-25 17:12:49 -08001011
1012 /**
1013 * Invoked when the RTT mode changes for this call.
1014 * @param call The call whose RTT mode has changed.
1015 * @param mode the new RTT mode, one of
1016 * {@link RttCall#RTT_MODE_FULL}, {@link RttCall#RTT_MODE_HCO},
1017 * or {@link RttCall#RTT_MODE_VCO}
1018 */
1019 public void onRttModeChanged(Call call, int mode) {}
1020
1021 /**
1022 * Invoked when the call's RTT status changes, either from off to on or from on to off.
1023 * @param call The call whose RTT status has changed.
1024 * @param enabled whether RTT is now enabled or disabled
1025 * @param rttCall the {@link RttCall} object to use for reading and writing if RTT is now
1026 * on, null otherwise.
1027 */
1028 public void onRttStatusChanged(Call call, boolean enabled, RttCall rttCall) {}
1029
1030 /**
1031 * Invoked when the remote end of the connection has requested that an RTT communication
1032 * channel be opened. A response to this should be sent via {@link #respondToRttRequest}
1033 * with the same ID that this method is invoked with.
1034 * @param call The call which the RTT request was placed on
1035 * @param id The ID of the request.
1036 */
1037 public void onRttRequest(Call call, int id) {}
Hall Liu57006aa2017-02-06 10:49:48 -08001038
1039 /**
1040 * Invoked when the RTT session failed to initiate for some reason, including rejection
1041 * by the remote party.
1042 * @param call The call which the RTT initiation failure occurred on.
1043 * @param reason One of the status codes defined in
1044 * {@link android.telecom.Connection.RttModifyStatus}, with the exception of
1045 * {@link android.telecom.Connection.RttModifyStatus#SESSION_MODIFY_REQUEST_SUCCESS}.
1046 */
1047 public void onRttInitiationFailure(Call call, int reason) {}
Sanket Padawea8eddd42017-11-03 11:07:35 -07001048
1049 /**
1050 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1051 * has completed successfully.
1052 * @param call The call which had initiated handover.
1053 */
1054 public void onHandoverComplete(Call call) {}
1055
1056 /**
1057 * Invoked when Call handover from one {@link PhoneAccount} to other {@link PhoneAccount}
1058 * has failed.
1059 * @param call The call which had initiated handover.
1060 * @param failureReason Error reason for failure
1061 */
1062 public void onHandoverFailed(Call call, @HandoverFailureErrors int failureReason) {}
Hall Liu95d55872017-01-25 17:12:49 -08001063 }
1064
1065 /**
1066 * A class that holds the state that describes the state of the RTT channel to the remote
1067 * party, if it is active.
1068 */
1069 public static final class RttCall {
Hall Liu07094df2017-02-28 15:17:44 -08001070 /** @hide */
Hall Liu95d55872017-01-25 17:12:49 -08001071 @Retention(RetentionPolicy.SOURCE)
1072 @IntDef({RTT_MODE_INVALID, RTT_MODE_FULL, RTT_MODE_HCO, RTT_MODE_VCO})
1073 public @interface RttAudioMode {}
1074
1075 /**
1076 * For metrics use. Default value in the proto.
1077 * @hide
1078 */
1079 public static final int RTT_MODE_INVALID = 0;
1080
1081 /**
1082 * Indicates that there should be a bidirectional audio stream between the two parties
1083 * on the call.
1084 */
1085 public static final int RTT_MODE_FULL = 1;
1086
1087 /**
1088 * Indicates that the local user should be able to hear the audio stream from the remote
1089 * user, but not vice versa. Equivalent to muting the microphone.
1090 */
1091 public static final int RTT_MODE_HCO = 2;
1092
1093 /**
1094 * Indicates that the remote user should be able to hear the audio stream from the local
1095 * user, but not vice versa. Equivalent to setting the volume to zero.
1096 */
1097 public static final int RTT_MODE_VCO = 3;
1098
1099 private static final int READ_BUFFER_SIZE = 1000;
1100
1101 private InputStreamReader mReceiveStream;
1102 private OutputStreamWriter mTransmitStream;
1103 private int mRttMode;
1104 private final InCallAdapter mInCallAdapter;
Hall Liu57006aa2017-02-06 10:49:48 -08001105 private final String mTelecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001106 private char[] mReadBuffer = new char[READ_BUFFER_SIZE];
1107
1108 /**
1109 * @hide
1110 */
Hall Liu57006aa2017-02-06 10:49:48 -08001111 public RttCall(String telecomCallId, InputStreamReader receiveStream,
1112 OutputStreamWriter transmitStream, int mode, InCallAdapter inCallAdapter) {
1113 mTelecomCallId = telecomCallId;
Hall Liu95d55872017-01-25 17:12:49 -08001114 mReceiveStream = receiveStream;
1115 mTransmitStream = transmitStream;
1116 mRttMode = mode;
1117 mInCallAdapter = inCallAdapter;
1118 }
1119
1120 /**
1121 * Returns the current RTT audio mode.
1122 * @return Current RTT audio mode. One of {@link #RTT_MODE_FULL}, {@link #RTT_MODE_VCO}, or
1123 * {@link #RTT_MODE_HCO}.
1124 */
1125 public int getRttAudioMode() {
1126 return mRttMode;
1127 }
1128
1129 /**
1130 * Sets the RTT audio mode. The requested mode change will be communicated through
1131 * {@link Callback#onRttModeChanged(Call, int)}.
1132 * @param mode The desired RTT audio mode, one of {@link #RTT_MODE_FULL},
1133 * {@link #RTT_MODE_VCO}, or {@link #RTT_MODE_HCO}.
1134 */
1135 public void setRttMode(@RttAudioMode int mode) {
Hall Liu57006aa2017-02-06 10:49:48 -08001136 mInCallAdapter.setRttMode(mTelecomCallId, mode);
Hall Liu95d55872017-01-25 17:12:49 -08001137 }
1138
1139 /**
1140 * Writes the string {@param input} into the outgoing text stream for this RTT call. Since
1141 * RTT transmits text in real-time, this method should be called once for each character
1142 * the user enters into the device.
1143 *
1144 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1145 * lead to interleaved text.
1146 * @param input The message to send to the remote user.
1147 */
1148 public void write(String input) throws IOException {
1149 mTransmitStream.write(input);
1150 mTransmitStream.flush();
1151 }
1152
1153 /**
1154 * Reads a string from the remote user, blocking if there is no data available. Returns
1155 * {@code null} if the RTT conversation has been terminated and there is no further data
1156 * to read.
1157 *
1158 * This method is not thread-safe -- calling it from multiple threads simultaneously may
1159 * lead to interleaved text.
1160 * @return A string containing text sent by the remote user, or {@code null} if the
1161 * conversation has been terminated or if there was an error while reading.
1162 */
Hall Liub1c8a772017-07-17 17:04:41 -07001163 public String read() {
1164 try {
1165 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1166 if (numRead < 0) {
1167 return null;
1168 }
1169 return new String(mReadBuffer, 0, numRead);
1170 } catch (IOException e) {
1171 Log.w(this, "Exception encountered when reading from InputStreamReader: %s", e);
Jeff Sharkey90396362017-06-12 16:26:53 -06001172 return null;
Hall Liuffa4a812017-03-02 16:11:00 -08001173 }
Hall Liuffa4a812017-03-02 16:11:00 -08001174 }
1175
1176 /**
1177 * Non-blocking version of {@link #read()}. Returns {@code null} if there is nothing to
1178 * be read.
1179 * @return A string containing text entered by the user, or {@code null} if the user has
1180 * not entered any new text yet.
1181 */
1182 public String readImmediately() throws IOException {
1183 if (mReceiveStream.ready()) {
Hall Liub1c8a772017-07-17 17:04:41 -07001184 int numRead = mReceiveStream.read(mReadBuffer, 0, READ_BUFFER_SIZE);
1185 if (numRead < 0) {
1186 return null;
1187 }
1188 return new String(mReadBuffer, 0, numRead);
Hall Liuffa4a812017-03-02 16:11:00 -08001189 } else {
Hall Liu95d55872017-01-25 17:12:49 -08001190 return null;
1191 }
1192 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001193 }
1194
Andrew Leeda80c872015-04-15 14:09:50 -07001195 /**
1196 * @deprecated Use {@code Call.Callback} instead.
1197 * @hide
1198 */
1199 @Deprecated
1200 @SystemApi
1201 public static abstract class Listener extends Callback { }
1202
Ihab Awade63fadb2014-07-09 21:52:04 -07001203 private final Phone mPhone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001204 private final String mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001205 private final InCallAdapter mInCallAdapter;
Santos Cordon823fd3c2014-08-07 18:35:18 -07001206 private final List<String> mChildrenIds = new ArrayList<>();
Ihab Awade63fadb2014-07-09 21:52:04 -07001207 private final List<Call> mChildren = new ArrayList<>();
1208 private final List<Call> mUnmodifiableChildren = Collections.unmodifiableList(mChildren);
Andrew Lee011728f2015-04-23 15:47:06 -07001209 private final List<CallbackRecord<Callback>> mCallbackRecords = new CopyOnWriteArrayList<>();
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001210 private final List<Call> mConferenceableCalls = new ArrayList<>();
1211 private final List<Call> mUnmodifiableConferenceableCalls =
1212 Collections.unmodifiableList(mConferenceableCalls);
1213
Santos Cordon823fd3c2014-08-07 18:35:18 -07001214 private boolean mChildrenCached;
1215 private String mParentId = null;
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001216 private int mState;
Ihab Awade63fadb2014-07-09 21:52:04 -07001217 private List<String> mCannedTextResponses = null;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001218 private String mCallingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001219 private int mTargetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001220 private String mRemainingPostDialSequence;
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001221 private VideoCallImpl mVideoCallImpl;
Hall Liu95d55872017-01-25 17:12:49 -08001222 private RttCall mRttCall;
Ihab Awade63fadb2014-07-09 21:52:04 -07001223 private Details mDetails;
Tyler Gunndee56a82016-03-23 16:06:34 -07001224 private Bundle mExtras;
Ihab Awade63fadb2014-07-09 21:52:04 -07001225
1226 /**
1227 * Obtains the post-dial sequence remaining to be emitted by this {@code Call}, if any.
1228 *
1229 * @return The remaining post-dial sequence, or {@code null} if there is no post-dial sequence
1230 * remaining or this {@code Call} is not in a post-dial state.
1231 */
1232 public String getRemainingPostDialSequence() {
1233 return mRemainingPostDialSequence;
1234 }
1235
1236 /**
1237 * Instructs this {@link #STATE_RINGING} {@code Call} to answer.
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001238 * @param videoState The video state in which to answer the call.
Ihab Awade63fadb2014-07-09 21:52:04 -07001239 */
Andrew Lee8da4c3c2014-07-16 10:11:42 -07001240 public void answer(int videoState) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001241 mInCallAdapter.answerCall(mTelecomCallId, videoState);
Ihab Awade63fadb2014-07-09 21:52:04 -07001242 }
1243
1244 /**
Pooja Jaind34698d2017-12-28 14:15:31 +05301245 * Instructs this {@link #STATE_RINGING} {@code Call} to deflect.
1246 *
1247 * @param address The address to which the call will be deflected.
1248 */
1249 public void deflect(Uri address) {
1250 mInCallAdapter.deflectCall(mTelecomCallId, address);
1251 }
1252
1253 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001254 * Instructs this {@link #STATE_RINGING} {@code Call} to reject.
1255 *
1256 * @param rejectWithMessage Whether to reject with a text message.
1257 * @param textMessage An optional text message with which to respond.
1258 */
1259 public void reject(boolean rejectWithMessage, String textMessage) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001260 mInCallAdapter.rejectCall(mTelecomCallId, rejectWithMessage, textMessage);
Ihab Awade63fadb2014-07-09 21:52:04 -07001261 }
1262
1263 /**
1264 * Instructs this {@code Call} to disconnect.
1265 */
1266 public void disconnect() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001267 mInCallAdapter.disconnectCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001268 }
1269
1270 /**
1271 * Instructs this {@code Call} to go on hold.
1272 */
1273 public void hold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001274 mInCallAdapter.holdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001275 }
1276
1277 /**
1278 * Instructs this {@link #STATE_HOLDING} call to release from hold.
1279 */
1280 public void unhold() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001281 mInCallAdapter.unholdCall(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001282 }
1283
1284 /**
1285 * Instructs this {@code Call} to play a dual-tone multi-frequency signaling (DTMF) tone.
1286 *
1287 * Any other currently playing DTMF tone in the specified call is immediately stopped.
1288 *
1289 * @param digit A character representing the DTMF digit for which to play the tone. This
1290 * value must be one of {@code '0'} through {@code '9'}, {@code '*'} or {@code '#'}.
1291 */
1292 public void playDtmfTone(char digit) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001293 mInCallAdapter.playDtmfTone(mTelecomCallId, digit);
Ihab Awade63fadb2014-07-09 21:52:04 -07001294 }
1295
1296 /**
1297 * Instructs this {@code Call} to stop any dual-tone multi-frequency signaling (DTMF) tone
1298 * currently playing.
1299 *
1300 * DTMF tones are played by calling {@link #playDtmfTone(char)}. If no DTMF tone is
1301 * currently playing, this method will do nothing.
1302 */
1303 public void stopDtmfTone() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001304 mInCallAdapter.stopDtmfTone(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001305 }
1306
1307 /**
1308 * Instructs this {@code Call} to continue playing a post-dial DTMF string.
1309 *
1310 * A post-dial DTMF string is a string of digits entered after a phone number, when dialed,
1311 * that are immediately sent as DTMF tones to the recipient as soon as the connection is made.
Ihab Awade63fadb2014-07-09 21:52:04 -07001312 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001313 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_PAUSE} symbol, this
Ihab Awade63fadb2014-07-09 21:52:04 -07001314 * {@code Call} will temporarily pause playing the tones for a pre-defined period of time.
1315 *
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001316 * If the DTMF string contains a {@link TelecomManager#DTMF_CHARACTER_WAIT} symbol, this
Andrew Leeda80c872015-04-15 14:09:50 -07001317 * {@code Call} will pause playing the tones and notify callbacks via
1318 * {@link Callback#onPostDialWait(Call, String)}. At this point, the in-call app
Ihab Awade63fadb2014-07-09 21:52:04 -07001319 * should display to the user an indication of this state and an affordance to continue
1320 * the postdial sequence. When the user decides to continue the postdial sequence, the in-call
1321 * app should invoke the {@link #postDialContinue(boolean)} method.
1322 *
1323 * @param proceed Whether or not to continue with the post-dial sequence.
1324 */
1325 public void postDialContinue(boolean proceed) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001326 mInCallAdapter.postDialContinue(mTelecomCallId, proceed);
Ihab Awade63fadb2014-07-09 21:52:04 -07001327 }
1328
1329 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001330 * Notifies this {@code Call} that an account has been selected and to proceed with placing
Nancy Chen36c62f32014-10-21 18:36:39 -07001331 * an outgoing call. Optionally sets this account as the default account.
Nancy Chen5da0fd52014-07-08 14:16:17 -07001332 */
Nancy Chen36c62f32014-10-21 18:36:39 -07001333 public void phoneAccountSelected(PhoneAccountHandle accountHandle, boolean setDefault) {
1334 mInCallAdapter.phoneAccountSelected(mTelecomCallId, accountHandle, setDefault);
Nancy Chen5da0fd52014-07-08 14:16:17 -07001335
1336 }
1337
1338 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001339 * Instructs this {@code Call} to enter a conference.
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001340 *
1341 * @param callToConferenceWith The other call with which to conference.
Ihab Awade63fadb2014-07-09 21:52:04 -07001342 */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001343 public void conference(Call callToConferenceWith) {
1344 if (callToConferenceWith != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001345 mInCallAdapter.conference(mTelecomCallId, callToConferenceWith.mTelecomCallId);
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001346 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001347 }
1348
1349 /**
1350 * Instructs this {@code Call} to split from any conference call with which it may be
1351 * connected.
1352 */
1353 public void splitFromConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001354 mInCallAdapter.splitFromConference(mTelecomCallId);
Ihab Awade63fadb2014-07-09 21:52:04 -07001355 }
1356
1357 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001358 * Merges the calls within this conference. See {@link Details#CAPABILITY_MERGE_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001359 */
1360 public void mergeConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001361 mInCallAdapter.mergeConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001362 }
1363
1364 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -08001365 * Swaps the calls within this conference. See {@link Details#CAPABILITY_SWAP_CONFERENCE}.
Santos Cordona4868042014-09-04 17:39:22 -07001366 */
1367 public void swapConference() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001368 mInCallAdapter.swapConference(mTelecomCallId);
Santos Cordona4868042014-09-04 17:39:22 -07001369 }
1370
1371 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001372 * Initiates a request to the {@link ConnectionService} to pull an external call to the local
1373 * device.
1374 * <p>
1375 * Calls to this method are ignored if the call does not have the
1376 * {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property set.
1377 * <p>
1378 * An {@link InCallService} will only see calls which support this method if it has the
1379 * {@link TelecomManager#METADATA_INCLUDE_EXTERNAL_CALLS} metadata set to {@code true}
1380 * in its manifest.
1381 */
1382 public void pullExternalCall() {
1383 // If this isn't an external call, ignore the request.
1384 if (!mDetails.hasProperty(Details.PROPERTY_IS_EXTERNAL_CALL)) {
1385 return;
1386 }
1387
1388 mInCallAdapter.pullExternalCall(mTelecomCallId);
1389 }
1390
1391 /**
1392 * Sends a {@code Call} event from this {@code Call} to the associated {@link Connection} in
1393 * the {@link ConnectionService}.
1394 * <p>
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001395 * Call events are used to communicate point in time information from an {@link InCallService}
1396 * to a {@link ConnectionService}. A {@link ConnectionService} implementation could define
1397 * events which enable the {@link InCallService}, for example, toggle a unique feature of the
1398 * {@link ConnectionService}.
1399 * <p>
1400 * A {@link ConnectionService} can communicate to the {@link InCallService} using
1401 * {@link Connection#sendConnectionEvent(String, Bundle)}.
1402 * <p>
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001403 * Events are exposed to {@link ConnectionService} implementations via
1404 * {@link android.telecom.Connection#onCallEvent(String, Bundle)}.
1405 * <p>
1406 * No assumptions should be made as to how a {@link ConnectionService} will handle these events.
Tyler Gunn9c0eb0b2016-06-29 11:23:25 -07001407 * The {@link InCallService} must assume that the {@link ConnectionService} could chose to
1408 * ignore some events altogether.
1409 * <p>
1410 * Events should be fully qualified (e.g., {@code com.example.event.MY_EVENT}) to avoid
1411 * conflicts between {@link InCallService} implementations. Further, {@link InCallService}
1412 * implementations shall not re-purpose events in the {@code android.*} namespace, nor shall
1413 * they define their own event types in this namespace. When defining a custom event type,
1414 * ensure the contents of the extras {@link Bundle} is clearly defined. Extra keys for this
1415 * bundle should be named similar to the event type (e.g. {@code com.example.extra.MY_EXTRA}).
1416 * <p>
1417 * When defining events and the associated extras, it is important to keep their behavior
1418 * consistent when the associated {@link InCallService} is updated. Support for deprecated
1419 * events/extras should me maintained to ensure backwards compatibility with older
1420 * {@link ConnectionService} implementations which were built to support the older behavior.
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001421 *
1422 * @param event The connection event.
1423 * @param extras Bundle containing extra information associated with the event.
1424 */
1425 public void sendCallEvent(String event, Bundle extras) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08001426 mInCallAdapter.sendCallEvent(mTelecomCallId, event, mTargetSdkVersion, extras);
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001427 }
1428
1429 /**
Hall Liu95d55872017-01-25 17:12:49 -08001430 * Sends an RTT upgrade request to the remote end of the connection. Success is not
1431 * guaranteed, and notification of success will be via the
1432 * {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
1433 */
1434 public void sendRttRequest() {
Hall Liu57006aa2017-02-06 10:49:48 -08001435 mInCallAdapter.sendRttRequest(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08001436 }
1437
1438 /**
1439 * Responds to an RTT request received via the {@link Callback#onRttRequest(Call, int)} )}
1440 * callback.
1441 * The ID used here should be the same as the ID that was received via the callback.
1442 * @param id The request ID received via {@link Callback#onRttRequest(Call, int)}
1443 * @param accept {@code true} if the RTT request should be accepted, {@code false} otherwise.
1444 */
1445 public void respondToRttRequest(int id, boolean accept) {
Hall Liu57006aa2017-02-06 10:49:48 -08001446 mInCallAdapter.respondToRttRequest(mTelecomCallId, id, accept);
Hall Liu95d55872017-01-25 17:12:49 -08001447 }
1448
1449 /**
Sanket Padawea8eddd42017-11-03 11:07:35 -07001450 * Initiates a handover of this {@link Call} to the {@link ConnectionService} identified
1451 * by {@code toHandle}. The videoState specified indicates the desired video state after the
1452 * handover.
1453 * <p>
1454 * A handover request is initiated by the user from one app to indicate a desire
1455 * to handover a call to another.
1456 *
1457 * @param toHandle {@link PhoneAccountHandle} of the {@link ConnectionService} to handover
1458 * this call to.
1459 * @param videoState Indicates the video state desired after the handover.
1460 * @param extras Bundle containing extra information to be passed to the
1461 * {@link ConnectionService}
1462 */
1463 public void handoverTo(PhoneAccountHandle toHandle, int videoState, Bundle extras) {
1464 mInCallAdapter.handoverTo(mTelecomCallId, toHandle, videoState, extras);
1465 }
1466
1467 /**
Hall Liu95d55872017-01-25 17:12:49 -08001468 * Terminate the RTT session on this call. The resulting state change will be notified via
1469 * the {@link Callback#onRttStatusChanged(Call, boolean, RttCall)} callback.
1470 */
1471 public void stopRtt() {
Hall Liu57006aa2017-02-06 10:49:48 -08001472 mInCallAdapter.stopRtt(mTelecomCallId);
Hall Liu95d55872017-01-25 17:12:49 -08001473 }
1474
1475 /**
Tyler Gunndee56a82016-03-23 16:06:34 -07001476 * Adds some extras to this {@link Call}. Existing keys are replaced and new ones are
1477 * added.
1478 * <p>
1479 * No assumptions should be made as to how an In-Call UI or service will handle these
1480 * extras. Keys should be fully qualified (e.g., com.example.MY_EXTRA) to avoid conflicts.
1481 *
1482 * @param extras The extras to add.
1483 */
1484 public final void putExtras(Bundle extras) {
1485 if (extras == null) {
1486 return;
1487 }
1488
1489 if (mExtras == null) {
1490 mExtras = new Bundle();
1491 }
1492 mExtras.putAll(extras);
1493 mInCallAdapter.putExtras(mTelecomCallId, extras);
1494 }
1495
1496 /**
1497 * Adds a boolean extra to this {@link Call}.
1498 *
1499 * @param key The extra key.
1500 * @param value The value.
1501 * @hide
1502 */
1503 public final void putExtra(String key, boolean value) {
1504 if (mExtras == null) {
1505 mExtras = new Bundle();
1506 }
1507 mExtras.putBoolean(key, value);
1508 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1509 }
1510
1511 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001512 * Adds an integer extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001513 *
1514 * @param key The extra key.
1515 * @param value The value.
1516 * @hide
1517 */
1518 public final void putExtra(String key, int value) {
1519 if (mExtras == null) {
1520 mExtras = new Bundle();
1521 }
1522 mExtras.putInt(key, value);
1523 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1524 }
1525
1526 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001527 * Adds a string extra to this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001528 *
1529 * @param key The extra key.
1530 * @param value The value.
1531 * @hide
1532 */
1533 public final void putExtra(String key, String value) {
1534 if (mExtras == null) {
1535 mExtras = new Bundle();
1536 }
1537 mExtras.putString(key, value);
1538 mInCallAdapter.putExtra(mTelecomCallId, key, value);
1539 }
1540
1541 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001542 * Removes extras from this {@link Call}.
Tyler Gunndee56a82016-03-23 16:06:34 -07001543 *
1544 * @param keys The keys of the extras to remove.
1545 */
1546 public final void removeExtras(List<String> keys) {
1547 if (mExtras != null) {
1548 for (String key : keys) {
1549 mExtras.remove(key);
1550 }
1551 if (mExtras.size() == 0) {
1552 mExtras = null;
1553 }
1554 }
1555 mInCallAdapter.removeExtras(mTelecomCallId, keys);
1556 }
1557
1558 /**
Tyler Gunn071be6f2016-05-10 14:52:33 -07001559 * Removes extras from this {@link Call}.
1560 *
1561 * @param keys The keys of the extras to remove.
1562 */
1563 public final void removeExtras(String ... keys) {
1564 removeExtras(Arrays.asList(keys));
1565 }
1566
1567 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001568 * Obtains the parent of this {@code Call} in a conference, if any.
1569 *
1570 * @return The parent {@code Call}, or {@code null} if this {@code Call} is not a
1571 * child of any conference {@code Call}s.
1572 */
1573 public Call getParent() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001574 if (mParentId != null) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001575 return mPhone.internalGetCallByTelecomId(mParentId);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001576 }
1577 return null;
Ihab Awade63fadb2014-07-09 21:52:04 -07001578 }
1579
1580 /**
1581 * Obtains the children of this conference {@code Call}, if any.
1582 *
1583 * @return The children of this {@code Call} if this {@code Call} is a conference, or an empty
1584 * {@code List} otherwise.
1585 */
1586 public List<Call> getChildren() {
Santos Cordon823fd3c2014-08-07 18:35:18 -07001587 if (!mChildrenCached) {
1588 mChildrenCached = true;
1589 mChildren.clear();
1590
1591 for(String id : mChildrenIds) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001592 Call call = mPhone.internalGetCallByTelecomId(id);
Santos Cordon823fd3c2014-08-07 18:35:18 -07001593 if (call == null) {
1594 // At least one child was still not found, so do not save true for "cached"
1595 mChildrenCached = false;
1596 } else {
1597 mChildren.add(call);
1598 }
1599 }
1600 }
1601
Ihab Awade63fadb2014-07-09 21:52:04 -07001602 return mUnmodifiableChildren;
1603 }
1604
1605 /**
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001606 * Returns the list of {@code Call}s with which this {@code Call} is allowed to conference.
1607 *
1608 * @return The list of conferenceable {@code Call}s.
1609 */
1610 public List<Call> getConferenceableCalls() {
1611 return mUnmodifiableConferenceableCalls;
1612 }
1613
1614 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001615 * Obtains the state of this {@code Call}.
1616 *
1617 * @return A state value, chosen from the {@code STATE_*} constants.
1618 */
1619 public int getState() {
1620 return mState;
1621 }
1622
1623 /**
1624 * Obtains a list of canned, pre-configured message responses to present to the user as
1625 * ways of rejecting this {@code Call} using via a text message.
1626 *
1627 * @see #reject(boolean, String)
1628 *
1629 * @return A list of canned text message responses.
1630 */
1631 public List<String> getCannedTextResponses() {
1632 return mCannedTextResponses;
1633 }
1634
1635 /**
1636 * Obtains an object that can be used to display video from this {@code Call}.
1637 *
Andrew Lee50aca232014-07-22 16:41:54 -07001638 * @return An {@code Call.VideoCall}.
Ihab Awade63fadb2014-07-09 21:52:04 -07001639 */
Andrew Lee50aca232014-07-22 16:41:54 -07001640 public InCallService.VideoCall getVideoCall() {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001641 return mVideoCallImpl;
Ihab Awade63fadb2014-07-09 21:52:04 -07001642 }
1643
1644 /**
1645 * Obtains an object containing call details.
1646 *
1647 * @return A {@link Details} object. Depending on the state of the {@code Call}, the
1648 * result may be {@code null}.
1649 */
1650 public Details getDetails() {
1651 return mDetails;
1652 }
1653
1654 /**
Hall Liu95d55872017-01-25 17:12:49 -08001655 * Returns this call's RttCall object. The {@link RttCall} instance is used to send and
1656 * receive RTT text data, as well as to change the RTT mode.
1657 * @return A {@link Call.RttCall}. {@code null} if there is no active RTT connection.
1658 */
1659 public @Nullable RttCall getRttCall() {
1660 return mRttCall;
1661 }
1662
1663 /**
1664 * Returns whether this call has an active RTT connection.
1665 * @return true if there is a connection, false otherwise.
1666 */
1667 public boolean isRttActive() {
1668 return mRttCall != null;
1669 }
1670
1671 /**
Andrew Leeda80c872015-04-15 14:09:50 -07001672 * Registers a callback to this {@code Call}.
1673 *
1674 * @param callback A {@code Callback}.
1675 */
1676 public void registerCallback(Callback callback) {
Andrew Lee011728f2015-04-23 15:47:06 -07001677 registerCallback(callback, new Handler());
1678 }
1679
1680 /**
1681 * Registers a callback to this {@code Call}.
1682 *
1683 * @param callback A {@code Callback}.
1684 * @param handler A handler which command and status changes will be delivered to.
1685 */
1686 public void registerCallback(Callback callback, Handler handler) {
1687 unregisterCallback(callback);
Roshan Pius1ca62072015-07-07 17:34:51 -07001688 // Don't allow new callback registration if the call is already being destroyed.
1689 if (callback != null && handler != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001690 mCallbackRecords.add(new CallbackRecord<Callback>(callback, handler));
1691 }
Andrew Leeda80c872015-04-15 14:09:50 -07001692 }
1693
1694 /**
1695 * Unregisters a callback from this {@code Call}.
1696 *
1697 * @param callback A {@code Callback}.
1698 */
1699 public void unregisterCallback(Callback callback) {
Roshan Pius1ca62072015-07-07 17:34:51 -07001700 // Don't allow callback deregistration if the call is already being destroyed.
1701 if (callback != null && mState != STATE_DISCONNECTED) {
Andrew Lee011728f2015-04-23 15:47:06 -07001702 for (CallbackRecord<Callback> record : mCallbackRecords) {
1703 if (record.getCallback() == callback) {
1704 mCallbackRecords.remove(record);
1705 break;
1706 }
1707 }
Andrew Leeda80c872015-04-15 14:09:50 -07001708 }
1709 }
1710
Santos Cordon3c20d632016-02-25 16:12:35 -08001711 @Override
1712 public String toString() {
1713 return new StringBuilder().
1714 append("Call [id: ").
1715 append(mTelecomCallId).
1716 append(", state: ").
1717 append(stateToString(mState)).
1718 append(", details: ").
1719 append(mDetails).
1720 append("]").toString();
1721 }
1722
1723 /**
1724 * @param state An integer value of a {@code STATE_*} constant.
1725 * @return A string representation of the value.
1726 */
1727 private static String stateToString(int state) {
1728 switch (state) {
1729 case STATE_NEW:
1730 return "NEW";
1731 case STATE_RINGING:
1732 return "RINGING";
1733 case STATE_DIALING:
1734 return "DIALING";
1735 case STATE_ACTIVE:
1736 return "ACTIVE";
1737 case STATE_HOLDING:
1738 return "HOLDING";
1739 case STATE_DISCONNECTED:
1740 return "DISCONNECTED";
1741 case STATE_CONNECTING:
1742 return "CONNECTING";
1743 case STATE_DISCONNECTING:
1744 return "DISCONNECTING";
1745 case STATE_SELECT_PHONE_ACCOUNT:
1746 return "SELECT_PHONE_ACCOUNT";
1747 default:
1748 Log.w(Call.class, "Unknown state %d", state);
1749 return "UNKNOWN";
1750 }
1751 }
1752
Andrew Leeda80c872015-04-15 14:09:50 -07001753 /**
Ihab Awade63fadb2014-07-09 21:52:04 -07001754 * Adds a listener to this {@code Call}.
1755 *
1756 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001757 * @deprecated Use {@link #registerCallback} instead.
1758 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001759 */
Andrew Leeda80c872015-04-15 14:09:50 -07001760 @Deprecated
1761 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001762 public void addListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001763 registerCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001764 }
1765
1766 /**
1767 * Removes a listener from this {@code Call}.
1768 *
1769 * @param listener A {@code Listener}.
Andrew Leeda80c872015-04-15 14:09:50 -07001770 * @deprecated Use {@link #unregisterCallback} instead.
1771 * @hide
Ihab Awade63fadb2014-07-09 21:52:04 -07001772 */
Andrew Leeda80c872015-04-15 14:09:50 -07001773 @Deprecated
1774 @SystemApi
Ihab Awade63fadb2014-07-09 21:52:04 -07001775 public void removeListener(Listener listener) {
Andrew Leeda80c872015-04-15 14:09:50 -07001776 unregisterCallback(listener);
Ihab Awade63fadb2014-07-09 21:52:04 -07001777 }
1778
1779 /** {@hide} */
Tyler Gunn159f35c2017-03-02 09:28:37 -08001780 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, String callingPackage,
1781 int targetSdkVersion) {
Ihab Awade63fadb2014-07-09 21:52:04 -07001782 mPhone = phone;
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001783 mTelecomCallId = telecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001784 mInCallAdapter = inCallAdapter;
1785 mState = STATE_NEW;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001786 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001787 mTargetSdkVersion = targetSdkVersion;
Ihab Awade63fadb2014-07-09 21:52:04 -07001788 }
1789
1790 /** {@hide} */
Tyler Gunnb88b3112016-11-09 10:19:23 -08001791 Call(Phone phone, String telecomCallId, InCallAdapter inCallAdapter, int state,
Tyler Gunn159f35c2017-03-02 09:28:37 -08001792 String callingPackage, int targetSdkVersion) {
Shriram Ganeshddf570e2015-05-31 09:18:48 -07001793 mPhone = phone;
1794 mTelecomCallId = telecomCallId;
1795 mInCallAdapter = inCallAdapter;
1796 mState = state;
Tyler Gunnb88b3112016-11-09 10:19:23 -08001797 mCallingPackage = callingPackage;
Tyler Gunn159f35c2017-03-02 09:28:37 -08001798 mTargetSdkVersion = targetSdkVersion;
Shriram Ganeshddf570e2015-05-31 09:18:48 -07001799 }
1800
1801 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001802 final String internalGetCallId() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001803 return mTelecomCallId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001804 }
1805
1806 /** {@hide} */
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001807 final void internalUpdate(ParcelableCall parcelableCall, Map<String, Call> callIdMap) {
Tyler Gunnb88b3112016-11-09 10:19:23 -08001808
Ihab Awade63fadb2014-07-09 21:52:04 -07001809 // First, we update the internal state as far as possible before firing any updates.
Sailesh Nepal1bef3392016-01-24 18:21:53 -08001810 Details details = Details.createFromParcelableCall(parcelableCall);
Ihab Awade63fadb2014-07-09 21:52:04 -07001811 boolean detailsChanged = !Objects.equals(mDetails, details);
1812 if (detailsChanged) {
1813 mDetails = details;
1814 }
1815
1816 boolean cannedTextResponsesChanged = false;
Santos Cordon88b771d2014-07-19 13:10:40 -07001817 if (mCannedTextResponses == null && parcelableCall.getCannedSmsResponses() != null
1818 && !parcelableCall.getCannedSmsResponses().isEmpty()) {
1819 mCannedTextResponses =
1820 Collections.unmodifiableList(parcelableCall.getCannedSmsResponses());
Yorke Leee886f632015-08-04 13:43:31 -07001821 cannedTextResponsesChanged = true;
Ihab Awade63fadb2014-07-09 21:52:04 -07001822 }
1823
Tyler Gunn159f35c2017-03-02 09:28:37 -08001824 VideoCallImpl newVideoCallImpl = parcelableCall.getVideoCallImpl(mCallingPackage,
1825 mTargetSdkVersion);
Tyler Gunn75958422015-04-15 14:23:42 -07001826 boolean videoCallChanged = parcelableCall.isVideoCallProviderChanged() &&
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001827 !Objects.equals(mVideoCallImpl, newVideoCallImpl);
Andrew Lee50aca232014-07-22 16:41:54 -07001828 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001829 mVideoCallImpl = newVideoCallImpl;
1830 }
1831 if (mVideoCallImpl != null) {
1832 mVideoCallImpl.setVideoState(getDetails().getVideoState());
Ihab Awade63fadb2014-07-09 21:52:04 -07001833 }
1834
Santos Cordone3c507b2015-04-23 14:44:19 -07001835 int state = parcelableCall.getState();
Ihab Awade63fadb2014-07-09 21:52:04 -07001836 boolean stateChanged = mState != state;
1837 if (stateChanged) {
1838 mState = state;
1839 }
1840
Santos Cordon823fd3c2014-08-07 18:35:18 -07001841 String parentId = parcelableCall.getParentCallId();
1842 boolean parentChanged = !Objects.equals(mParentId, parentId);
1843 if (parentChanged) {
1844 mParentId = parentId;
Ihab Awade63fadb2014-07-09 21:52:04 -07001845 }
1846
Santos Cordon823fd3c2014-08-07 18:35:18 -07001847 List<String> childCallIds = parcelableCall.getChildCallIds();
1848 boolean childrenChanged = !Objects.equals(childCallIds, mChildrenIds);
1849 if (childrenChanged) {
1850 mChildrenIds.clear();
1851 mChildrenIds.addAll(parcelableCall.getChildCallIds());
1852 mChildrenCached = false;
Ihab Awade63fadb2014-07-09 21:52:04 -07001853 }
1854
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07001855 List<String> conferenceableCallIds = parcelableCall.getConferenceableCallIds();
1856 List<Call> conferenceableCalls = new ArrayList<Call>(conferenceableCallIds.size());
1857 for (String otherId : conferenceableCallIds) {
1858 if (callIdMap.containsKey(otherId)) {
1859 conferenceableCalls.add(callIdMap.get(otherId));
1860 }
1861 }
1862
1863 if (!Objects.equals(mConferenceableCalls, conferenceableCalls)) {
1864 mConferenceableCalls.clear();
1865 mConferenceableCalls.addAll(conferenceableCalls);
1866 fireConferenceableCallsChanged();
1867 }
1868
Hall Liu95d55872017-01-25 17:12:49 -08001869 boolean isRttChanged = false;
1870 boolean rttModeChanged = false;
1871 if (parcelableCall.getParcelableRttCall() != null && parcelableCall.getIsRttCallChanged()) {
1872 ParcelableRttCall parcelableRttCall = parcelableCall.getParcelableRttCall();
1873 InputStreamReader receiveStream = new InputStreamReader(
1874 new ParcelFileDescriptor.AutoCloseInputStream(
1875 parcelableRttCall.getReceiveStream()),
1876 StandardCharsets.UTF_8);
1877 OutputStreamWriter transmitStream = new OutputStreamWriter(
1878 new ParcelFileDescriptor.AutoCloseOutputStream(
1879 parcelableRttCall.getTransmitStream()),
1880 StandardCharsets.UTF_8);
Hall Liu57006aa2017-02-06 10:49:48 -08001881 RttCall newRttCall = new Call.RttCall(mTelecomCallId,
Hall Liu95d55872017-01-25 17:12:49 -08001882 receiveStream, transmitStream, parcelableRttCall.getRttMode(), mInCallAdapter);
1883 if (mRttCall == null) {
1884 isRttChanged = true;
1885 } else if (mRttCall.getRttAudioMode() != newRttCall.getRttAudioMode()) {
1886 rttModeChanged = true;
1887 }
1888 mRttCall = newRttCall;
1889 } else if (mRttCall != null && parcelableCall.getParcelableRttCall() == null
1890 && parcelableCall.getIsRttCallChanged()) {
1891 isRttChanged = true;
1892 mRttCall = null;
1893 }
1894
Ihab Awade63fadb2014-07-09 21:52:04 -07001895 // Now we fire updates, ensuring that any client who listens to any of these notifications
1896 // gets the most up-to-date state.
1897
1898 if (stateChanged) {
1899 fireStateChanged(mState);
1900 }
1901 if (detailsChanged) {
1902 fireDetailsChanged(mDetails);
1903 }
1904 if (cannedTextResponsesChanged) {
1905 fireCannedTextResponsesLoaded(mCannedTextResponses);
1906 }
Andrew Lee50aca232014-07-22 16:41:54 -07001907 if (videoCallChanged) {
Tyler Gunn584ba6c2015-12-08 10:53:41 -08001908 fireVideoCallChanged(mVideoCallImpl);
Ihab Awade63fadb2014-07-09 21:52:04 -07001909 }
Santos Cordon823fd3c2014-08-07 18:35:18 -07001910 if (parentChanged) {
1911 fireParentChanged(getParent());
1912 }
1913 if (childrenChanged) {
1914 fireChildrenChanged(getChildren());
1915 }
Hall Liu95d55872017-01-25 17:12:49 -08001916 if (isRttChanged) {
1917 fireOnIsRttChanged(mRttCall != null, mRttCall);
1918 }
1919 if (rttModeChanged) {
1920 fireOnRttModeChanged(mRttCall.getRttAudioMode());
1921 }
Ihab Awade63fadb2014-07-09 21:52:04 -07001922
1923 // If we have transitioned to DISCONNECTED, that means we need to notify clients and
1924 // remove ourselves from the Phone. Note that we do this after completing all state updates
1925 // so a client can cleanly transition all their UI to the state appropriate for a
1926 // DISCONNECTED Call while still relying on the existence of that Call in the Phone's list.
1927 if (mState == STATE_DISCONNECTED) {
1928 fireCallDestroyed();
Ihab Awade63fadb2014-07-09 21:52:04 -07001929 }
1930 }
1931
1932 /** {@hide} */
Ihab Awade63fadb2014-07-09 21:52:04 -07001933 final void internalSetPostDialWait(String remaining) {
1934 mRemainingPostDialSequence = remaining;
1935 firePostDialWait(mRemainingPostDialSequence);
1936 }
1937
Sailesh Nepal2ab88cc2014-07-18 14:49:18 -07001938 /** {@hide} */
Santos Cordonf30d7e92014-08-26 09:54:33 -07001939 final void internalSetDisconnected() {
1940 if (mState != Call.STATE_DISCONNECTED) {
1941 mState = Call.STATE_DISCONNECTED;
1942 fireStateChanged(mState);
1943 fireCallDestroyed();
Santos Cordonf30d7e92014-08-26 09:54:33 -07001944 }
1945 }
1946
Tyler Gunn876dbfb2016-03-14 15:18:07 -07001947 /** {@hide} */
1948 final void internalOnConnectionEvent(String event, Bundle extras) {
1949 fireOnConnectionEvent(event, extras);
1950 }
1951
Hall Liu95d55872017-01-25 17:12:49 -08001952 /** {@hide} */
1953 final void internalOnRttUpgradeRequest(final int requestId) {
1954 for (CallbackRecord<Callback> record : mCallbackRecords) {
1955 final Call call = this;
1956 final Callback callback = record.getCallback();
1957 record.getHandler().post(() -> callback.onRttRequest(call, requestId));
1958 }
1959 }
1960
Hall Liu57006aa2017-02-06 10:49:48 -08001961 /** @hide */
1962 final void internalOnRttInitiationFailure(int reason) {
1963 for (CallbackRecord<Callback> record : mCallbackRecords) {
1964 final Call call = this;
1965 final Callback callback = record.getCallback();
1966 record.getHandler().post(() -> callback.onRttInitiationFailure(call, reason));
1967 }
1968 }
1969
Sanket Padawe85291f62017-12-01 13:59:27 -08001970 /** {@hide} */
1971 final void internalOnHandoverFailed(int error) {
1972 for (CallbackRecord<Callback> record : mCallbackRecords) {
1973 final Call call = this;
1974 final Callback callback = record.getCallback();
1975 record.getHandler().post(() -> callback.onHandoverFailed(call, error));
1976 }
1977 }
1978
Tyler Gunn858bfaf2018-01-22 15:17:54 -08001979 /** {@hide} */
1980 final void internalOnHandoverComplete() {
1981 for (CallbackRecord<Callback> record : mCallbackRecords) {
1982 final Call call = this;
1983 final Callback callback = record.getCallback();
1984 record.getHandler().post(() -> callback.onHandoverComplete(call));
1985 }
1986 }
1987
Andrew Lee011728f2015-04-23 15:47:06 -07001988 private void fireStateChanged(final int newState) {
1989 for (CallbackRecord<Callback> record : mCallbackRecords) {
1990 final Call call = this;
1991 final Callback callback = record.getCallback();
1992 record.getHandler().post(new Runnable() {
1993 @Override
1994 public void run() {
1995 callback.onStateChanged(call, newState);
1996 }
1997 });
Ihab Awade63fadb2014-07-09 21:52:04 -07001998 }
1999 }
2000
Andrew Lee011728f2015-04-23 15:47:06 -07002001 private void fireParentChanged(final Call newParent) {
2002 for (CallbackRecord<Callback> record : mCallbackRecords) {
2003 final Call call = this;
2004 final Callback callback = record.getCallback();
2005 record.getHandler().post(new Runnable() {
2006 @Override
2007 public void run() {
2008 callback.onParentChanged(call, newParent);
2009 }
2010 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002011 }
2012 }
2013
Andrew Lee011728f2015-04-23 15:47:06 -07002014 private void fireChildrenChanged(final List<Call> children) {
2015 for (CallbackRecord<Callback> record : mCallbackRecords) {
2016 final Call call = this;
2017 final Callback callback = record.getCallback();
2018 record.getHandler().post(new Runnable() {
2019 @Override
2020 public void run() {
2021 callback.onChildrenChanged(call, children);
2022 }
2023 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002024 }
2025 }
2026
Andrew Lee011728f2015-04-23 15:47:06 -07002027 private void fireDetailsChanged(final Details details) {
2028 for (CallbackRecord<Callback> record : mCallbackRecords) {
2029 final Call call = this;
2030 final Callback callback = record.getCallback();
2031 record.getHandler().post(new Runnable() {
2032 @Override
2033 public void run() {
2034 callback.onDetailsChanged(call, details);
2035 }
2036 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002037 }
2038 }
2039
Andrew Lee011728f2015-04-23 15:47:06 -07002040 private void fireCannedTextResponsesLoaded(final List<String> cannedTextResponses) {
2041 for (CallbackRecord<Callback> record : mCallbackRecords) {
2042 final Call call = this;
2043 final Callback callback = record.getCallback();
2044 record.getHandler().post(new Runnable() {
2045 @Override
2046 public void run() {
2047 callback.onCannedTextResponsesLoaded(call, cannedTextResponses);
2048 }
2049 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002050 }
2051 }
2052
Andrew Lee011728f2015-04-23 15:47:06 -07002053 private void fireVideoCallChanged(final InCallService.VideoCall videoCall) {
2054 for (CallbackRecord<Callback> record : mCallbackRecords) {
2055 final Call call = this;
2056 final Callback callback = record.getCallback();
2057 record.getHandler().post(new Runnable() {
2058 @Override
2059 public void run() {
2060 callback.onVideoCallChanged(call, videoCall);
2061 }
2062 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002063 }
2064 }
2065
Andrew Lee011728f2015-04-23 15:47:06 -07002066 private void firePostDialWait(final String remainingPostDialSequence) {
2067 for (CallbackRecord<Callback> record : mCallbackRecords) {
2068 final Call call = this;
2069 final Callback callback = record.getCallback();
2070 record.getHandler().post(new Runnable() {
2071 @Override
2072 public void run() {
2073 callback.onPostDialWait(call, remainingPostDialSequence);
2074 }
2075 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002076 }
2077 }
2078
2079 private void fireCallDestroyed() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002080 /**
2081 * To preserve the ordering of the Call's onCallDestroyed callback and Phone's
2082 * onCallRemoved callback, we remove this call from the Phone's record
2083 * only once all of the registered onCallDestroyed callbacks are executed.
2084 * All the callbacks get removed from our records as a part of this operation
2085 * since onCallDestroyed is the final callback.
2086 */
2087 final Call call = this;
2088 if (mCallbackRecords.isEmpty()) {
2089 // No callbacks registered, remove the call from Phone's record.
2090 mPhone.internalRemoveCall(call);
2091 }
2092 for (final CallbackRecord<Callback> record : mCallbackRecords) {
Andrew Lee011728f2015-04-23 15:47:06 -07002093 final Callback callback = record.getCallback();
2094 record.getHandler().post(new Runnable() {
2095 @Override
2096 public void run() {
Roshan Pius1ca62072015-07-07 17:34:51 -07002097 boolean isFinalRemoval = false;
2098 RuntimeException toThrow = null;
2099 try {
2100 callback.onCallDestroyed(call);
2101 } catch (RuntimeException e) {
2102 toThrow = e;
2103 }
2104 synchronized(Call.this) {
2105 mCallbackRecords.remove(record);
2106 if (mCallbackRecords.isEmpty()) {
2107 isFinalRemoval = true;
2108 }
2109 }
2110 if (isFinalRemoval) {
2111 mPhone.internalRemoveCall(call);
2112 }
2113 if (toThrow != null) {
2114 throw toThrow;
2115 }
Andrew Lee011728f2015-04-23 15:47:06 -07002116 }
2117 });
Ihab Awade63fadb2014-07-09 21:52:04 -07002118 }
2119 }
2120
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002121 private void fireConferenceableCallsChanged() {
Andrew Lee011728f2015-04-23 15:47:06 -07002122 for (CallbackRecord<Callback> record : mCallbackRecords) {
2123 final Call call = this;
2124 final Callback callback = record.getCallback();
2125 record.getHandler().post(new Runnable() {
2126 @Override
2127 public void run() {
2128 callback.onConferenceableCallsChanged(call, mUnmodifiableConferenceableCalls);
2129 }
2130 });
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002131 }
2132 }
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002133
2134 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -07002135 * Notifies listeners of an incoming connection event.
2136 * <p>
2137 * Connection events are issued via {@link Connection#sendConnectionEvent(String, Bundle)}.
2138 *
2139 * @param event
2140 * @param extras
2141 */
2142 private void fireOnConnectionEvent(final String event, final Bundle extras) {
2143 for (CallbackRecord<Callback> record : mCallbackRecords) {
2144 final Call call = this;
2145 final Callback callback = record.getCallback();
2146 record.getHandler().post(new Runnable() {
2147 @Override
2148 public void run() {
2149 callback.onConnectionEvent(call, event, extras);
2150 }
2151 });
2152 }
2153 }
2154
2155 /**
Hall Liu95d55872017-01-25 17:12:49 -08002156 * Notifies listeners of an RTT on/off change
2157 *
2158 * @param enabled True if RTT is now enabled, false otherwise
2159 */
2160 private void fireOnIsRttChanged(final boolean enabled, final RttCall rttCall) {
2161 for (CallbackRecord<Callback> record : mCallbackRecords) {
2162 final Call call = this;
2163 final Callback callback = record.getCallback();
2164 record.getHandler().post(() -> callback.onRttStatusChanged(call, enabled, rttCall));
2165 }
2166 }
2167
2168 /**
2169 * Notifies listeners of a RTT mode change
2170 *
2171 * @param mode The new RTT mode
2172 */
2173 private void fireOnRttModeChanged(final int mode) {
2174 for (CallbackRecord<Callback> record : mCallbackRecords) {
2175 final Call call = this;
2176 final Callback callback = record.getCallback();
2177 record.getHandler().post(() -> callback.onRttModeChanged(call, mode));
2178 }
2179 }
2180
2181 /**
Tyler Gunn1e9bfc62015-08-19 11:18:58 -07002182 * Determines if two bundles are equal.
2183 *
2184 * @param bundle The original bundle.
2185 * @param newBundle The bundle to compare with.
2186 * @retrun {@code true} if the bundles are equal, {@code false} otherwise.
2187 */
2188 private static boolean areBundlesEqual(Bundle bundle, Bundle newBundle) {
2189 if (bundle == null || newBundle == null) {
2190 return bundle == newBundle;
2191 }
2192
2193 if (bundle.size() != newBundle.size()) {
2194 return false;
2195 }
2196
2197 for(String key : bundle.keySet()) {
2198 if (key != null) {
2199 final Object value = bundle.get(key);
2200 final Object newValue = newBundle.get(key);
2201 if (!Objects.equals(value, newValue)) {
2202 return false;
2203 }
2204 }
2205 }
2206 return true;
2207 }
Santos Cordon7c7bc7f2014-07-28 18:15:48 -07002208}