blob: 1f32c978fad17cbcc29e1edd3328e065d2dc298e [file] [log] [blame]
Yorke Leeb4ce1432014-06-09 13:53:23 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
Santos Cordon9eb45932014-06-27 12:28:43 -07004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5 * in compliance with the License. You may obtain a copy of the License at
Yorke Leeb4ce1432014-06-09 13:53:23 -07006 *
Santos Cordon9eb45932014-06-27 12:28:43 -07007 * http://www.apache.org/licenses/LICENSE-2.0
Yorke Leeb4ce1432014-06-09 13:53:23 -07008 *
Santos Cordon9eb45932014-06-27 12:28:43 -07009 * Unless required by applicable law or agreed to in writing, software distributed under the License
10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11 * or implied. See the License for the specific language governing permissions and limitations under
12 * the License.
Yorke Leeb4ce1432014-06-09 13:53:23 -070013 */
14
Tyler Gunnef9f6f92014-09-12 22:16:17 -070015package android.telecom;
Yorke Leeb4ce1432014-06-09 13:53:23 -070016
Tyler Gunn00d737b2019-10-31 13:04:37 -070017import static android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE;
Nan Wuc51fd762022-08-01 21:08:23 +000018import static android.content.Intent.LOCAL_FLAG_FROM_SYSTEM;
Tyler Gunn00d737b2019-10-31 13:04:37 -070019
Hall Liu0464b9b2016-01-12 15:32:58 -080020import android.Manifest;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070021import android.annotation.CallbackExecutor;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080022import android.annotation.IntDef;
Fan Zhang5431ef52019-10-14 13:43:46 -070023import android.annotation.NonNull;
Slava Shklyaeve65e4012019-03-04 16:02:34 +000024import android.annotation.Nullable;
Hui Wangc47df7f2021-12-14 20:37:47 +000025import android.annotation.RequiresFeature;
Yorke Leec61d13662015-09-21 17:25:25 -070026import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060027import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060028import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070029import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060030import android.annotation.SystemService;
Brad Ebingera8366ae2021-03-23 21:01:51 +000031import android.compat.annotation.ChangeId;
32import android.compat.annotation.EnabledSince;
Artur Satayev2ebb31c2020-01-08 12:24:36 +000033import android.compat.annotation.UnsupportedAppUsage;
Santos Cordon6c7a3882014-06-25 15:30:08 -070034import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070035import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070036import android.content.Intent;
Hui Wangc47df7f2021-12-14 20:37:47 +000037import android.content.pm.PackageManager;
Nancy Chenb2299c12014-10-29 18:22:11 -070038import android.net.Uri;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -080039import android.os.Build;
Santos Cordon96efb482014-07-19 14:57:05 -070040import android.os.Bundle;
Kevin Jeon767cda32020-11-17 01:40:16 +000041import android.os.IBinder;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070042import android.os.OutcomeReceiver;
Shuo Qian4d065262020-10-20 11:04:28 -070043import android.os.Process;
Santos Cordon6c7a3882014-06-25 15:30:08 -070044import android.os.RemoteException;
45import android.os.ServiceManager;
Tyler Gunn7e45b722018-12-04 12:56:45 -080046import android.os.UserHandle;
Chen Xuc9d4ee12019-09-26 16:11:59 -070047import android.telephony.Annotation.CallState;
Brad Ebingere7833312019-05-07 10:55:55 -070048import android.telephony.SubscriptionManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070049import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070050import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070051import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070052
Kevin Jeon767cda32020-11-17 01:40:16 +000053import com.android.internal.annotations.GuardedBy;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070054import com.android.internal.telecom.ClientTransactionalServiceRepository;
55import com.android.internal.telecom.ClientTransactionalServiceWrapper;
Tyler Gunnef9f6f92014-09-12 22:16:17 -070056import com.android.internal.telecom.ITelecomService;
Yorke Leeb4ce1432014-06-09 13:53:23 -070057
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
Jay Shrauner7746a942014-08-26 12:15:15 -070060import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070061import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070062import java.util.List;
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -080063import java.util.Objects;
Tyler Gunn7e45b722018-12-04 12:56:45 -080064import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070065
Yorke Leeb4ce1432014-06-09 13:53:23 -070066/**
Santos Cordond9e614f2014-10-28 13:10:36 -070067 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080068 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070069 * <p>
70 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
71 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
72 * <p>
73 * Note that access to some telecom information is permission-protected. Your app cannot access the
74 * protected information or gain access to protected functionality unless it has the appropriate
75 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
76 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070077 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060078@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060079@SystemService(Context.TELECOM_SERVICE)
Hui Wangc47df7f2021-12-14 20:37:47 +000080@RequiresFeature(PackageManager.FEATURE_TELECOM)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070081public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070082
Evan Charlton10197192014-07-19 15:00:29 -070083 /**
Santos Cordon96efb482014-07-19 14:57:05 -070084 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070085 * UI by notifying the Telecom system that an incoming call exists for a specific call service
86 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
87 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070088 * ultimately use to control and get information about the call.
89 * <p>
90 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070091 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070092 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080093 *
94 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070095 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070096 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070097
98 /**
Yorke Leec3cf9822014-10-02 09:38:39 -070099 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
100 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -0800101 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -0700102 * @hide
103 */
104 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
105
106 /**
Santos Cordon895d4b82015-06-25 16:41:48 -0700107 * An {@link android.content.Intent} action sent by the telecom framework to start a
108 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
109 * and each app that registers a {@link PhoneAccount} should provide one if desired.
110 * <p>
111 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
112 * app's settings menu. For each entry, the settings app will add a click action. When
113 * triggered, the click-action will start this intent along with the extra
114 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
115 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
116 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700117 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700118 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
119 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700120
121 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800122 * The {@link android.content.Intent} action used to show the call accessibility settings page.
123 */
124 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
125 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
126
127 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700128 * The {@link android.content.Intent} action used to show the call settings page.
129 */
130 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700131 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700132
133 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800134 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
135 */
136 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
137 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
138
139 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700140 * The {@link android.content.Intent} action used to show the settings page used to configure
141 * {@link PhoneAccount} preferences.
142 */
143 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700144 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700145
146 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700147 * {@link android.content.Intent} action used indicate that a new phone account was just
148 * registered.
149 * <p>
150 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
151 * to indicate which {@link PhoneAccount} was registered.
152 * <p>
153 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800154 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800155 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
156 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
157
158 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700159 * {@link android.content.Intent} action used indicate that a phone account was just
160 * unregistered.
161 * <p>
162 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
163 * to indicate which {@link PhoneAccount} was unregistered.
164 * <p>
165 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700166 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700167 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
168 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
169
170 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700171 * Activity action: Shows a dialog asking the user whether or not they want to replace the
172 * current default Dialer with the one specified in
173 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
174 *
175 * Usage example:
176 * <pre>
177 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
178 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
179 * getActivity().getPackageName());
180 * startActivity(intent);
181 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800182 * <p>
183 * This is no longer supported since Q, please use
184 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
185 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700186 */
187 public static final String ACTION_CHANGE_DEFAULT_DIALER =
188 "android.telecom.action.CHANGE_DEFAULT_DIALER";
189
190 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700191 * Broadcast intent action indicating that the current default dialer has changed.
192 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
193 * name of the package that the default dialer was changed to.
194 *
195 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
196 */
197 public static final String ACTION_DEFAULT_DIALER_CHANGED =
198 "android.telecom.action.DEFAULT_DIALER_CHANGED";
199
200 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700201 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
202 */
203 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
204 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
205
206 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800207 * Broadcast intent action indicating that the current default call screening app has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700208 * <p>
209 * Note: This intent is NEVER actually broadcast and will be deprecated in the future.
210 * <p>
211 * An app that want to know if it holds the
212 * {@link android.app.role.RoleManager#ROLE_CALL_SCREENING} role can use
213 * {@link android.app.role.RoleManager#isRoleHeld(String)} to confirm if it holds the role or
214 * not.
tonyzhuff60f5e2018-10-01 19:14:59 +0800215 */
216 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
217 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
218
219 /**
220 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
221 * indicate the ComponentName of the call screening app which has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700222 * <p>
223 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800224 */
225 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
226 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
227
228 /**
229 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
230 * indicate whether an app is the default call screening app.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700231 * <p>
232 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800233 */
234 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
235 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
236
237 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700238 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
239 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700240 */
241 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700242 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700243
244 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700245 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
246 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700247 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700248 * {@link VideoProfile#STATE_AUDIO_ONLY},
249 * {@link VideoProfile#STATE_BIDIRECTIONAL},
250 * {@link VideoProfile#STATE_RX_ENABLED},
251 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700252 */
253 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700254 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700255
256 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700257 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
258 * integer that determines the requested video state for an incoming call.
259 * Valid options:
260 * {@link VideoProfile#STATE_AUDIO_ONLY},
261 * {@link VideoProfile#STATE_BIDIRECTIONAL},
262 * {@link VideoProfile#STATE_RX_ENABLED},
263 * {@link VideoProfile#STATE_TX_ENABLED}.
264 */
265 public static final String EXTRA_INCOMING_VIDEO_STATE =
266 "android.telecom.extra.INCOMING_VIDEO_STATE";
267
268 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700269 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
270 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
271 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700272 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700273 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700274 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700275 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700276 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700277
278 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700279 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
280 * subject which will be associated with an outgoing call. Should only be specified if the
Shuo Qian3ed38832020-11-30 21:54:36 -0800281 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
282 * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700283 */
284 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
285
Shuo Qian3ed38832020-11-30 21:54:36 -0800286 // Values for EXTRA_PRIORITY
287 /**
288 * Indicates the call composer call priority is normal.
289 *
290 * Reference: RCC.20 Section 2.4.4.2
291 */
292 public static final int PRIORITY_NORMAL = 0;
293
294 /**
295 * Indicates the call composer call priority is urgent.
296 *
297 * Reference: RCC.20 Section 2.4.4.2
298 */
299 public static final int PRIORITY_URGENT = 1;
300
301 /**
302 * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
303 * {@link #PRIORITY_URGENT}.
304 *
305 * Reference: RCC.20 Section 2.4.4.2
306 */
307 public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
308
309 /**
310 * Extra for the call composer call location, an {@link android.location.Location} parcelable
311 * class to represent the geolocation as a latitude and longitude pair.
312 *
313 * Reference: RCC.20 Section 2.4.3.2
314 */
315 public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
316
317 /**
318 * A boolean extra set on incoming calls to indicate that the call has a picture specified.
319 * Given that image download could take a (short) time, the EXTRA is set immediately upon
320 * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
321 * if one is expected. The EXTRA may be unset if the image download ends up failing for some
322 * reason.
323 */
324 public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
325
326 /**
Hall Liu48c3c142021-03-11 16:14:22 -0800327 * A {@link Uri} representing the picture that was downloaded when a call is received or
328 * uploaded when a call is placed.
Hall Liu8fee7ea2021-01-21 16:37:51 -0800329 *
Shuo Qian3ed38832020-11-30 21:54:36 -0800330 * This is a content URI within the call log provider which can be used to open a file
331 * descriptor. This could be set a short time after a call is added to the Dialer app if the
Hall Liu8fee7ea2021-01-21 16:37:51 -0800332 * download/upload is delayed for some reason. The Dialer app will receive a callback via
Shuo Qian3ed38832020-11-30 21:54:36 -0800333 * {@link Call.Callback#onDetailsChanged} when this value has changed.
334 *
335 * Reference: RCC.20 Section 2.4.3.2
336 */
Hall Liu8fee7ea2021-01-21 16:37:51 -0800337 public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
Shuo Qian3ed38832020-11-30 21:54:36 -0800338
Shuo Qian3ed38832020-11-30 21:54:36 -0800339 /**
340 * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
Hall Liua749abc2021-01-21 10:05:43 -0800341 * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
342 * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
Shuo Qian3ed38832020-11-30 21:54:36 -0800343 */
344 public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
345
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700346 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700347 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
348 * has initiated a new incoming call.
349 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700350 public static final String EXTRA_INCOMING_CALL_ADDRESS =
351 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700352
353 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700354 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
355 * metadata about the call. This {@link Bundle} will be returned to the
356 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700357 */
358 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700359 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700360
361 /**
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800362 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} used to indicate
363 * that a call has an in-band ringtone associated with it. This is used when the device is
364 * acting as an HFP headset and the Bluetooth stack has received an in-band ringtone from the
365 * the HFP host which must be played instead of any local ringtone the device would otherwise
366 * have generated.
367 *
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800368 * @hide
369 */
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800370 @SystemApi
371 public static final String EXTRA_CALL_HAS_IN_BAND_RINGTONE =
372 "android.telecom.extra.CALL_HAS_IN_BAND_RINGTONE";
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800373
374 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700375 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
376 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
377 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700378 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700379 */
380 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700381 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700382
383 /**
sqian6d9e7452019-02-08 21:42:15 -0800384 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
385 * whether the user's dial intent is emergency; this is required to specify when the dialed
386 * number is ambiguous, identified as both emergency number and any other non-emergency number;
387 * e.g. in some situation, 611 could be both an emergency number in a country and a
388 * non-emergency number of a carrier's customer service hotline.
389 *
390 * @hide
391 */
392 @SystemApi
393 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
394 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
395
396 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800397 * A mandatory extra containing a {@link Uri} to be passed in when calling
398 * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
399 * the remote handle of the new call.
Yorke Leec3cf9822014-10-02 09:38:39 -0700400 * @hide
401 */
Hall Liu2ef04112020-09-14 18:34:10 -0700402 @SystemApi
Yorke Leec3cf9822014-10-02 09:38:39 -0700403 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
404 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
405
406 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700407 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
408 * call was created. This value is in milliseconds since boot.
Hall Liudbb17f12020-03-10 18:28:58 -0700409 * @hide
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700410 */
411 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
412 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
413
414 /**
qing90c40cf2023-02-22 22:46:00 +0000415 * Optional extra for incoming containing a long which specifies the time the
416 * call was answered by user. This value is in milliseconds.
417 * @hide
418 */
419 public static final String EXTRA_CALL_ANSWERED_TIME_MILLIS =
420 "android.telecom.extra.CALL_ANSWERED_TIME_MILLIS";
421
422
423 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800424 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
425 * time the call was created.
426 * @hide
427 */
428 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
429 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
430
431 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700432 * Optional extra for incoming and outgoing calls containing a long which specifies the time
433 * telecom began routing the call. This value is in milliseconds since boot.
434 * @hide
435 */
436 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
437 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
438
439 /**
440 * Optional extra for incoming and outgoing calls containing a long which specifies the time
441 * telecom finished routing the call. This value is in milliseconds since boot.
442 * @hide
443 */
444 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
445 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
446
447 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700448 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
449 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700450 */
451 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700452 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700453
454 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700455 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
456 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700457 */
458 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700459 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700460
461 /**
radhika0dd90652020-11-04 11:12:51 -0800462 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
463 * lower layers
464 * @hide
465 */
466 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
467 "Call dropped by lower layers";
468
469 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700470 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
471 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800472 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700473 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800474 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700475 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700476 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700477
478 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800479 * Optional extra for communicating the call technology used by a {@link ConnectionService}
480 * to Telecom. Valid values are:
481 * <ul>
482 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
483 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
484 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
485 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
486 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
487 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800488 * @hide
489 */
Hall Liu2ef04112020-09-14 18:34:10 -0700490 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800491 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
492 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
493
494 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800495 * Optional extra for communicating the call network technology used by a
496 * {@link android.telecom.Connection} to Telecom and InCallUI.
497 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700498 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800499 */
500 public static final String EXTRA_CALL_NETWORK_TYPE =
501 "android.telecom.extra.CALL_NETWORK_TYPE";
502
503 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700504 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
505 * package name of the app specifying an alternative gateway for the call.
506 * The value is a string.
507 *
508 * (The following comment corresponds to the all GATEWAY_* extras)
509 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
510 * alternative address to dial which is different from the one specified and displayed to
511 * the user. This alternative address is referred to as the gateway address.
512 */
513 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700514 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700515
516 /**
517 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
518 * original address to dial for the call. This is used when an alternative gateway address is
519 * provided to recall the original address.
520 * The value is a {@link android.net.Uri}.
521 *
522 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
523 */
524 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700525 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700526
527 /**
Evan Charlton10197192014-07-19 15:00:29 -0700528 * The number which the party on the other side of the line will see (and use to return the
529 * call).
530 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700531 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
532 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
533 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700534 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700535 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700536
537 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800538 * The number of milliseconds that Telecom should wait after disconnecting a call via the
539 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
540 * to make a new one.
541 * @hide
542 */
543 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
544 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
545
546 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700547 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700548 * existing call from the user's device to a different {@link PhoneAccount}.
549 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700550 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
551 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
552 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
553 * the receiving side of a handover.
554 * <p>
555 * Used when Telecom calls
556 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
557 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
558 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
559 * occurs on the initiating side of a handover.
560 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700561 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700562 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800563 * @deprecated Use the public handover APIs. See
564 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700565 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800566 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700567 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
568
569 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800570 * When {@code true} indicates that a request to create a new connection is for the purpose of
571 * a handover. Note: This is used with the
572 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
573 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
574 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
575 * @hide
576 */
577 public static final String EXTRA_IS_HANDOVER_CONNECTION =
578 "android.telecom.extra.IS_HANDOVER_CONNECTION";
579
580 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700581 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
582 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
583 * the handover is from.
584 * @hide
585 */
586 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
587 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
588
589 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700590 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
591 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
592 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
593 * {@link Connection} will be.
594 * @hide
595 */
596 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
597
598 /**
Hall Liu95d55872017-01-25 17:12:49 -0800599 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
600 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
601 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
602 */
603 public static final String EXTRA_START_CALL_WITH_RTT =
604 "android.telecom.extra.START_CALL_WITH_RTT";
605
606 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800607 * Start an activity indicating that the completion of an outgoing call or an incoming call
608 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
609 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
610 *
611 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
612 * call which completed.
613 *
614 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
615 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
616 *
617 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
618 * {@link #EXTRA_CALL_DURATION} for more information.
619 */
620 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
621
622 /**
623 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
624 * uri handle(phone number) of the completed call.
625 */
626 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
627
628 /**
629 * A integer value provided for completed calls to indicate the reason for the call
630 * disconnection.
631 * <p>
632 * Allowed values:
633 * <ul>
634 * <li>{@link DisconnectCause#UNKNOWN}</li>
635 * <li>{@link DisconnectCause#LOCAL}</li>
636 * <li>{@link DisconnectCause#REMOTE}</li>
637 * <li>{@link DisconnectCause#REJECTED}</li>
638 * <li>{@link DisconnectCause#MISSED}</li>
639 * </ul>
640 * </p>
641 */
642 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
643
644 /**
645 * A integer value provided for completed calls to indicate the duration of the call.
646 * <p>
647 * Allowed values:
648 * <ul>
649 * <li>{@link #DURATION_VERY_SHORT}</li>
650 * <li>{@link #DURATION_SHORT}</li>
651 * <li>{@link #DURATION_MEDIUM}</li>
652 * <li>{@link #DURATION_LONG}</li>
653 * </ul>
654 * </p>
655 */
656 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
657
658 /**
659 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
660 * call was < 3 seconds.
661 */
662 public static final int DURATION_VERY_SHORT = 0;
663
664 /**
665 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
666 * call was >= 3 seconds and < 60 seconds.
667 */
668 public static final int DURATION_SHORT = 1;
669
670 /**
671 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
672 * call was >= 60 seconds and < 120 seconds.
673 */
674 public static final int DURATION_MEDIUM = 2;
675
676 /**
677 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
678 * call was >= 120 seconds.
679 */
680 public static final int DURATION_LONG = 3;
681
682 /**
683 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
684 * milliseconds.
685 * @hide
686 */
687 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
688
689 /**
690 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
691 * milliseconds.
692 * @hide
693 */
694 public static final long SHORT_CALL_TIME_MS = 60000;
695
696 /**
697 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
698 * milliseconds.
699 * @hide
700 */
701 public static final long MEDIUM_CALL_TIME_MS = 120000;
702
703 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700704 * A boolean meta-data value indicating whether an {@link InCallService} implements an
705 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
706 * would also like to replace the in-call interface should set this meta-data to {@code true} in
707 * the manifest registration of their {@link InCallService}.
708 */
709 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
710
711 /**
Santos Cordon88881552015-12-10 17:29:54 -0800712 * A boolean meta-data value indicating whether an {@link InCallService} implements an
713 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000714 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800715 */
716 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
717 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
718
719 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800720 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
721 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
722 * override the system provided ringing should set this meta-data to {@code true} in the
723 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700724 * <p>
725 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
726 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800727 */
728 public static final String METADATA_IN_CALL_SERVICE_RINGING =
729 "android.telecom.IN_CALL_SERVICE_RINGING";
730
731 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700732 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
733 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
734 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
735 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
736 * informed of external calls should set this meta-data to {@code true} in the manifest
737 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
738 * be informed of external calls.
739 */
740 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
741 "android.telecom.INCLUDE_EXTERNAL_CALLS";
742
743 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800744 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
745 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
746 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
747 * to implement its own call user interface. An {@link InCallService} implementation which
748 * would like to be informed of external calls should set this meta-data to {@code true} in the
749 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
750 * will NOT be informed about self-managed calls.
751 * <p>
752 * An {@link InCallService} which receives self-managed calls is free to view and control the
753 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700754 * exposing these calls to an automotive device via its companion app.
755 * <p>
Tyler Gunn24e18332017-02-10 09:42:49 -0800756 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
757 */
758 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
759 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
760
761 /**
Evan Charlton10197192014-07-19 15:00:29 -0700762 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
763 * pause for a predefined period.
764 */
765 public static final char DTMF_CHARACTER_PAUSE = ',';
766
767 /**
768 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
769 * wait for user confirmation before proceeding.
770 */
771 public static final char DTMF_CHARACTER_WAIT = ';';
772
773 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800774 * @hide
775 */
776 @IntDef(prefix = { "TTY_MODE_" },
777 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
778 @Retention(RetentionPolicy.SOURCE)
779 public @interface TtyMode {}
780
781 /**
Evan Charlton10197192014-07-19 15:00:29 -0700782 * TTY (teletypewriter) mode is off.
783 *
784 * @hide
785 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800786 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700787 public static final int TTY_MODE_OFF = 0;
788
789 /**
790 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
791 * will communicate with the remote party by sending and receiving text messages.
792 *
793 * @hide
794 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800795 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700796 public static final int TTY_MODE_FULL = 1;
797
798 /**
799 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
800 * speaker is on. The user will communicate with the remote party by sending text messages and
801 * hearing an audible reply.
802 *
803 * @hide
804 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800805 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700806 public static final int TTY_MODE_HCO = 2;
807
808 /**
809 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
810 * microphone is still on. User will communicate with the remote party by speaking and receiving
811 * text message replies.
812 *
813 * @hide
814 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800815 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700816 public static final int TTY_MODE_VCO = 3;
817
818 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700819 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700820 *
Hall Liu2ef04112020-09-14 18:34:10 -0700821 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
822 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700823 * @hide
824 */
Hall Liu2ef04112020-09-14 18:34:10 -0700825 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700826 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700827 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700828
829 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700830 * Integer extra key that indicates the current TTY mode.
831 *
832 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
833 *
834 * Valid modes are:
835 * <ul>
836 * <li>{@link #TTY_MODE_OFF}</li>
837 * <li>{@link #TTY_MODE_FULL}</li>
838 * <li>{@link #TTY_MODE_HCO}</li>
839 * <li>{@link #TTY_MODE_VCO}</li>
840 * </ul>
841 *
842 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
843 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
844 * plugged into the device.
845 * @hide
846 */
Hall Liu2ef04112020-09-14 18:34:10 -0700847 @SystemApi
848 public static final String EXTRA_CURRENT_TTY_MODE =
849 "android.telecom.extra.CURRENT_TTY_MODE";
850
851 /**
852 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
853 *
854 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
855 * preferred TTY mode.
856 * @hide
857 */
Hall Liu2ef04112020-09-14 18:34:10 -0700858 @SystemApi
859 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
860 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
861
862 /**
863 * Integer extra key that indicates the preferred TTY mode.
864 *
865 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
866 *
Evan Charlton10197192014-07-19 15:00:29 -0700867 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800868 * <ul>
869 * <li>{@link #TTY_MODE_OFF}</li>
870 * <li>{@link #TTY_MODE_FULL}</li>
871 * <li>{@link #TTY_MODE_HCO}</li>
872 * <li>{@link #TTY_MODE_VCO}</li>
873 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700874 * @hide
875 */
Hall Liu2ef04112020-09-14 18:34:10 -0700876 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700877 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800878 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700879
Nancy Chen9d568c02014-09-08 14:17:59 -0700880 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700881 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800882 * notification. If no custom component exists then this is sent to the default dialer which
883 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700884 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700885 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
886 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
887
888 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800889 * The number of calls associated with the notification. If the number is zero then the missed
890 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700891 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700892 public static final String EXTRA_NOTIFICATION_COUNT =
893 "android.telecom.extra.NOTIFICATION_COUNT";
894
895 /**
896 * The number associated with the missed calls. This number is only relevant
897 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700898 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700899 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
900 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
901
902 /**
Tyler Gunna2879412023-02-28 23:41:53 +0000903 * Included in the extras of the {@link #ACTION_SHOW_MISSED_CALLS_NOTIFICATION}, provides a
904 * pending intent which can be used to clear the missed calls notification and mark unread
905 * missed call log entries as read.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700906 * @hide
Tyler Gunna2879412023-02-28 23:41:53 +0000907 * @deprecated Use {@link #cancelMissedCallsNotification()} instead.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700908 */
Tyler Gunna2879412023-02-28 23:41:53 +0000909 @Deprecated
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700910 @SystemApi
911 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
912 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
913
914 /**
915 * The intent to call back a missed call.
916 * @hide
917 */
918 @SystemApi
919 public static final String EXTRA_CALL_BACK_INTENT =
920 "android.telecom.extra.CALL_BACK_INTENT";
921
922 /**
Charles He858f1322017-11-27 17:11:04 -0800923 * The dialer activity responsible for placing emergency calls from, for example, a locked
924 * keyguard.
925 * @hide
926 */
927 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
928 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
929
930 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800931 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
932 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700933 * <p>
934 * The call initiator can use this extra to indicate that a call used assisted dialing to help
935 * place the call. This is most commonly used by a Dialer app which provides the ability to
936 * automatically add dialing prefixes when placing international calls.
937 * <p>
938 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800939 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
940 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700941 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
942 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
943 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800944 */
945 public static final String EXTRA_USE_ASSISTED_DIALING =
946 "android.telecom.extra.USE_ASSISTED_DIALING";
947
948 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800949 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
950 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800951 * Valid sources are:
952 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
953 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
954 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800955 *
Hall Liu2ef04112020-09-14 18:34:10 -0700956 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800957 * @hide
958 */
Hall Liu2ef04112020-09-14 18:34:10 -0700959 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800960 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
961
962 /**
Ayush Sharma527b5072023-01-06 10:14:43 +0000963 * Intent action to trigger "switch to managed profile" dialog for call in SystemUI
964 *
965 * @hide
966 */
967 public static final String ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG =
968 "android.telecom.action.SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG";
969
970 /**
971 * Extra specifying the managed profile user id.
972 * This is used with {@link TelecomManager#ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG}
973 *
974 * @hide
975 */
976 public static final String EXTRA_MANAGED_PROFILE_USER_ID =
977 "android.telecom.extra.MANAGED_PROFILE_USER_ID";
978
979 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800980 * Indicating the call is initiated via emergency dialer's shortcut button.
981 *
982 * @hide
983 */
Hall Liu2ef04112020-09-14 18:34:10 -0700984 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800985 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
986
987 /**
988 * Indicating the call is initiated via emergency dialer's dialpad.
989 *
990 * @hide
991 */
Hall Liu2ef04112020-09-14 18:34:10 -0700992 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800993 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
994
995 /**
996 * Indicating the call source is not specified.
997 *
998 * @hide
999 */
Hall Liu2ef04112020-09-14 18:34:10 -07001000 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -08001001 public static final int CALL_SOURCE_UNSPECIFIED = 0;
1002
1003 /**
Nancy Chen9d568c02014-09-08 14:17:59 -07001004 * The following 4 constants define how properties such as phone numbers and names are
1005 * displayed to the user.
1006 */
1007
Santos Cordoned769ae2015-05-13 18:47:38 -07001008 /**
1009 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -08001010 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001011 public static final int PRESENTATION_ALLOWED = 1;
1012
Santos Cordoned769ae2015-05-13 18:47:38 -07001013 /**
1014 * Indicates that the address or number of a call is blocked by the other party.
1015 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001016 public static final int PRESENTATION_RESTRICTED = 2;
1017
Santos Cordoned769ae2015-05-13 18:47:38 -07001018 /**
1019 * Indicates that the address or number of a call is not specified or known by the carrier.
1020 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001021 public static final int PRESENTATION_UNKNOWN = 3;
1022
Santos Cordoned769ae2015-05-13 18:47:38 -07001023 /**
1024 * Indicates that the address or number of a call belongs to a pay phone.
1025 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001026 public static final int PRESENTATION_PAYPHONE = 4;
1027
Grace Jiacc16b042021-08-09 09:06:11 -07001028 /**
1029 * Indicates that the address or number of a call is unavailable.
1030 */
1031 public static final int PRESENTATION_UNAVAILABLE = 5;
1032
Hall Liu4a9fde12020-01-16 17:38:46 -08001033
1034 /*
1035 * Values for the adb property "persist.radio.videocall.audio.output"
1036 */
1037 /** @hide */
1038 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1039 /** @hide */
1040 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1041 /** @hide */
1042 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1043
Tyler Gunn00d737b2019-10-31 13:04:37 -07001044 /** @hide */
1045 @Retention(RetentionPolicy.SOURCE)
1046 @IntDef(
1047 prefix = { "PRESENTATION_" },
1048 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001049 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001050 public @interface Presentation {}
1051
Brad Ebingera8366ae2021-03-23 21:01:51 +00001052
1053 /**
1054 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1055 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1056 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001057 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001058 */
1059 @ChangeId
1060 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1061 // this magic number is a bug ID
1062 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1063
Grace Jiab13eb2c2021-04-21 14:13:26 -07001064 /**
1065 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1066 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1067 * @hide
1068 */
1069 @ChangeId
1070 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1071 // bug ID
1072 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1073
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001074 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001075
Kevin Jeon767cda32020-11-17 01:40:16 +00001076
1077 /** Cached service handles, cleared by resetServiceCache() at death */
1078 private static final Object CACHE_LOCK = new Object();
1079
1080 @GuardedBy("CACHE_LOCK")
1081 private static ITelecomService sTelecomService;
1082 @GuardedBy("CACHE_LOCK")
1083 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1084
Yorke Leeb4ce1432014-06-09 13:53:23 -07001085 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001086
Hall Liue1bc2ec2015-10-09 15:58:37 -07001087 private final ITelecomService mTelecomServiceOverride;
1088
Thomas Stuart9bfb2432022-09-27 15:02:07 -07001089 /** @hide **/
1090 private final ClientTransactionalServiceRepository mTransactionalServiceRepository =
1091 new ClientTransactionalServiceRepository();
1092 /** @hide **/
1093 public static final int TELECOM_TRANSACTION_SUCCESS = 0;
1094 /** @hide **/
1095 public static final String TRANSACTION_CALL_ID_KEY = "TelecomCallId";
1096
Santos Cordon6c7a3882014-06-25 15:30:08 -07001097 /**
1098 * @hide
1099 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001100 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001101 public static TelecomManager from(Context context) {
1102 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001103 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001104
1105 /**
1106 * @hide
1107 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001108 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001109 this(context, null);
1110 }
1111
1112 /**
1113 * @hide
1114 */
1115 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001116 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001117 if (appContext != null && Objects.equals(context.getAttributionTag(),
1118 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001119 mContext = appContext;
1120 } else {
1121 mContext = context;
1122 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001123 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001124 }
1125
1126 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001127 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1128 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1129 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1130 * account returned depends on the following priorities:
1131 * <ul>
1132 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1133 * be returned.
1134 * </li>
1135 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1136 * will be returned.
1137 * </li>
1138 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001139 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001140 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1141 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001142 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001143 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001144 */
Yorke Leec61d13662015-09-21 17:25:25 -07001145 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001146 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001147 ITelecomService service = getTelecomService();
1148 if (service != null) {
1149 try {
1150 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001151 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001152 } catch (RemoteException e) {
1153 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001154 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001155 }
1156 return null;
1157 }
1158
1159 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001160 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1161 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001162 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001163 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001164 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1165 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001166 * <p>
1167 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001168 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001169 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1170 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001171 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001172 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001173 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001174 ITelecomService service = getTelecomService();
1175 if (service != null) {
1176 try {
1177 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001178 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001179 } catch (RemoteException e) {
1180 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001181 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001182 }
1183 return null;
1184 }
1185
1186 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001187 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1188 *
1189 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001190 * outgoing voice calls, or {@code null} if no default is specified (the
1191 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001192 * @hide
1193 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001194 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1195 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001196 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001197 ITelecomService service = getTelecomService();
1198 if (service != null) {
1199 try {
1200 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1201 } catch (RemoteException e) {
1202 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001203 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001204 }
1205 }
1206
1207 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001208 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001209 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1210 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001211 *
Brad Ebingere7833312019-05-07 10:55:55 -07001212 * @return The phone account handle of the current sim call manager for the default voice
1213 * subscription.
1214 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001215 */
1216 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001217 ITelecomService service = getTelecomService();
1218 if (service != null) {
1219 try {
1220 return service.getSimCallManager(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001221 SubscriptionManager.getDefaultSubscriptionId(), mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001222 } catch (RemoteException e) {
1223 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001224 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001225 }
1226 return null;
1227 }
1228
1229 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001230 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1231 * prepared for this method to return {@code null}, indicating that there currently exists no
1232 * SIM call manager {@link PhoneAccount} for the subscription specified.
1233 *
1234 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1235 * queried for.
1236 * @return The phone account handle of the current sim call manager.
1237 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001238 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001239 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001240 ITelecomService service = getTelecomService();
1241 if (service != null) {
1242 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001243 return service.getSimCallManager(subscriptionId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001244 } catch (RemoteException e) {
1245 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001246 }
Brad Ebingere7833312019-05-07 10:55:55 -07001247 }
1248 return null;
1249 }
1250
1251 /**
1252 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1253 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1254 * must be prepared for this method to return {@code null}, indicating that there currently
1255 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001256 *
1257 * @return The phone account handle of the current sim call manager.
1258 *
1259 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001260 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001261 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001262 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001263 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001264 ITelecomService service = getTelecomService();
1265 if (service != null) {
1266 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001267 return service.getSimCallManagerForUser(userId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001268 } catch (RemoteException e) {
1269 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001270 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001271 }
1272 return null;
1273 }
1274
1275 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001276 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001277 * {@code null}, indicating that there currently exists no Connection Manager
1278 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001279 *
1280 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001281 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001282 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001283 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001284 public PhoneAccountHandle getConnectionManager() {
1285 return getSimCallManager();
1286 }
1287
1288 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001289 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1290 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001291 * <P>
1292 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1293 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1294 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1295 * such as {@code sip:example@sipexample.com}).
1296 *
1297 * @param uriScheme The URI scheme.
1298 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001299 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001300 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001301 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001302 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001303 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001304 android.Manifest.permission.READ_PHONE_STATE
1305 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001306 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001307 ITelecomService service = getTelecomService();
1308 if (service != null) {
1309 try {
1310 return service.getPhoneAccountsSupportingScheme(uriScheme,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001311 mContext.getOpPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001312 } catch (RemoteException e) {
1313 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001314 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001315 }
1316 return new ArrayList<>();
1317 }
1318
Nancy Chen513c8922014-09-17 14:47:20 -07001319
1320 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001321 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1322 * calls. The returned list includes only those accounts which have been explicitly enabled
1323 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001324 *
1325 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1326 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001327 */
Yorke Leec61d13662015-09-21 17:25:25 -07001328 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001329 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001330 return getCallCapablePhoneAccounts(false);
1331 }
1332
1333 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001334 * Returns a list of {@link PhoneAccountHandle}s for all self-managed
1335 * {@link ConnectionService}s owned by the calling {@link UserHandle}.
Tyler Gunn89317072017-04-07 14:57:37 -07001336 * <p>
1337 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1338 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1339 * <p>
1340 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuart510f49a2022-01-28 23:06:57 +00001341 * is the default dialer app.
Tyler Gunn89317072017-04-07 14:57:37 -07001342 * <p>
Thomas Stuart510f49a2022-01-28 23:06:57 +00001343 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1344 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
Tyler Gunn89317072017-04-07 14:57:37 -07001345 *
1346 * @return A list of {@code PhoneAccountHandle} objects.
1347 */
Thomas Stuart510f49a2022-01-28 23:06:57 +00001348 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1349 public @NonNull List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001350 ITelecomService service = getTelecomService();
1351 if (service != null) {
1352 try {
1353 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001354 mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001355 } catch (RemoteException e) {
1356 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001357 }
Tyler Gunn89317072017-04-07 14:57:37 -07001358 }
1359 return new ArrayList<>();
1360 }
1361
1362 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001363 * Returns a list of {@link PhoneAccountHandle}s owned by the calling self-managed
1364 * {@link ConnectionService}.
1365 * <p>
1366 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1367 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1368 * <p>
1369 * Requires permission {@link android.Manifest.permission#MANAGE_OWN_CALLS}
1370 * <p>
1371 * A {@link SecurityException} will be thrown if a caller lacks the
1372 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission.
1373 *
1374 * @return A list of {@code PhoneAccountHandle} objects.
1375 */
1376 @RequiresPermission(Manifest.permission.MANAGE_OWN_CALLS)
1377 public @NonNull List<PhoneAccountHandle> getOwnSelfManagedPhoneAccounts() {
1378 ITelecomService service = getTelecomService();
1379 if (service != null) {
1380 try {
1381 return service.getOwnSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001382 mContext.getAttributionTag()).getList();
Thomas Stuart510f49a2022-01-28 23:06:57 +00001383 } catch (RemoteException e) {
1384 throw e.rethrowFromSystemServer();
1385 }
1386 }
1387 throw new IllegalStateException("Telecom is not available");
1388 }
1389
1390 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001391 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1392 * by the user.
1393 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001394 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001395 * when {@code false}, only enabled phone accounts will be
1396 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001397 * @return A list of {@code PhoneAccountHandle} objects.
1398 * @hide
1399 */
Hall Liub2306242019-11-15 17:13:05 -08001400 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001401 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1402 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1403 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001404 ITelecomService service = getTelecomService();
1405 if (service != null) {
1406 try {
1407 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001408 mContext.getOpPackageName(), mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001409 } catch (RemoteException e) {
1410 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1411 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001412 }
Nancy Chen513c8922014-09-17 14:47:20 -07001413 }
1414 return new ArrayList<>();
1415 }
1416
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001417 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001418 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1419 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001420 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1421 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001422 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001423 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001424 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001425 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001426 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001427 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001428 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001429 ITelecomService service = getTelecomService();
1430 if (service != null) {
1431 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001432 return service.getPhoneAccountsForPackage(mContext.getPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001433 } catch (RemoteException e) {
1434 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001435 }
Nancy Chen513c8922014-09-17 14:47:20 -07001436 }
1437 return null;
1438 }
1439
1440 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001441 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1442 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001443 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001444 * Requires Permission:
1445 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1446 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001447 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001448 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001449 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001450 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001451 ITelecomService service = getTelecomService();
1452 if (service != null) {
1453 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001454 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001455 } catch (RemoteException e) {
1456 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001457 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001458 }
1459 return null;
1460 }
1461
1462 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001463 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001464 *
Nancy Chen210ef032014-09-15 17:58:42 -07001465 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001466 * @hide
1467 */
1468 @SystemApi
1469 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001470 ITelecomService service = getTelecomService();
1471 if (service != null) {
1472 try {
1473 return service.getAllPhoneAccountsCount();
1474 } catch (RemoteException e) {
1475 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001476 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001477 }
1478 return 0;
1479 }
1480
1481 /**
1482 * Returns a list of all {@link PhoneAccount}s.
1483 *
1484 * @return All {@link PhoneAccount}s.
1485 * @hide
1486 */
1487 @SystemApi
1488 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001489 ITelecomService service = getTelecomService();
1490 if (service != null) {
1491 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001492 return service.getAllPhoneAccounts().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001493 } catch (RemoteException e) {
1494 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001495 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001496 }
1497 return Collections.EMPTY_LIST;
1498 }
1499
1500 /**
1501 * Returns a list of all {@link PhoneAccountHandle}s.
1502 *
1503 * @return All {@link PhoneAccountHandle}s.
1504 * @hide
1505 */
1506 @SystemApi
1507 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001508 ITelecomService service = getTelecomService();
1509 if (service != null) {
1510 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001511 return service.getAllPhoneAccountHandles().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001512 } catch (RemoteException e) {
1513 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001514 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001515 }
1516 return Collections.EMPTY_LIST;
1517 }
1518
1519 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001520 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1521 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1522 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001523 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1524 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1525 * the phone app settings before the account is usable.
1526 * <p>
Thomas Stuarte0416212022-01-31 20:31:42 +00001527 * Note: Each package is limited to 10 {@link PhoneAccount} registrations.
1528 * <p>
Santos Cordond9e614f2014-10-28 13:10:36 -07001529 * A {@link SecurityException} will be thrown if an app tries to register a
1530 * {@link PhoneAccountHandle} where the package name specified within
1531 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Thomas Stuarte0416212022-01-31 20:31:42 +00001532 * <p>
1533 * A {@link IllegalArgumentException} will be thrown if an app tries to register a
1534 * {@link PhoneAccount} when the upper bound limit, 10, has already been reached.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001535 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001536 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001537 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001538 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001539 ITelecomService service = getTelecomService();
1540 if (service != null) {
1541 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001542 service.registerPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001543 } catch (RemoteException e) {
1544 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001545 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001546 }
1547 }
1548
1549 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001550 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001551 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001552 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001553 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001554 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001555 ITelecomService service = getTelecomService();
1556 if (service != null) {
1557 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001558 service.unregisterPhoneAccount(accountHandle, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001559 } catch (RemoteException e) {
1560 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001561 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001562 }
1563 }
1564
1565 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001566 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001567 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001568 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001569 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001570 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001571 public void clearPhoneAccounts() {
1572 clearAccounts();
1573 }
1574 /**
1575 * Remove all Accounts that belong to the calling package from the system.
1576 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1577 * @hide
1578 */
1579 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001580 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001581 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001582 ITelecomService service = getTelecomService();
1583 if (service != null) {
1584 try {
1585 service.clearAccounts(mContext.getPackageName());
1586 } catch (RemoteException e) {
1587 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001588 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001589 }
1590 }
1591
1592 /**
Anthony Lee67279262014-10-27 11:28:40 -07001593 * Remove all Accounts that belong to the specified package from the system.
1594 * @hide
1595 */
1596 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001597 ITelecomService service = getTelecomService();
1598 if (service != null) {
1599 try {
1600 if (!TextUtils.isEmpty(packageName)) {
1601 service.clearAccounts(packageName);
1602 }
1603 } catch (RemoteException e) {
1604 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001605 }
Anthony Lee67279262014-10-27 11:28:40 -07001606 }
1607 }
1608
Yorke Lee1011f482015-04-23 15:58:27 -07001609
Anthony Lee67279262014-10-27 11:28:40 -07001610 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001611 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1612 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001613 * @hide
1614 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001615 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001616 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001617 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001618 ITelecomService service = getTelecomService();
1619 if (service != null) {
1620 try {
1621 return service.getDefaultPhoneApp();
1622 } catch (RemoteException e) {
1623 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001624 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001625 }
1626 return null;
1627 }
1628
Santos Cordon9eb45932014-06-27 12:28:43 -07001629 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001630 * Used to determine the currently selected default dialer package.
1631 *
1632 * @return package name for the default dialer package or null if no package has been
1633 * selected as the default dialer.
1634 */
1635 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001636 ITelecomService service = getTelecomService();
1637 if (service != null) {
1638 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001639 return service.getDefaultDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001640 } catch (RemoteException e) {
1641 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001642 }
Yorke Lee1011f482015-04-23 15:58:27 -07001643 }
1644 return null;
1645 }
1646
1647 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001648 * Used to determine the currently selected default dialer package for a specific user.
1649 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001650 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001651 * @return package name for the default dialer package or null if no package has been
1652 * selected as the default dialer.
1653 * @hide
1654 */
1655 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001656 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001657 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001658 ITelecomService service = getTelecomService();
1659 if (service != null) {
1660 try {
1661 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001662 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001663 } catch (RemoteException e) {
1664 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001665 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001666 }
1667 return null;
1668 }
1669
1670 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001671 * Used to set the default dialer package.
1672 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001673 * @param packageName to set the default dialer to, or {@code null} if the system provided
1674 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001675 *
1676 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1677 * the specified package does not correspond to an installed dialer, or is already
1678 * the default dialer.
1679 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001680 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001681 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001682 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1683 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001684 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001685 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001686 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001687 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001688 @RequiresPermission(allOf = {
1689 android.Manifest.permission.MODIFY_PHONE_STATE,
1690 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001691 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001692 ITelecomService service = getTelecomService();
1693 if (service != null) {
1694 try {
1695 return service.setDefaultDialer(packageName);
1696 } catch (RemoteException e) {
1697 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001698 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001699 }
1700 return false;
1701 }
1702
1703 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001704 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001705 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001706 * @return package name for the system dialer package or {@code null} if no system dialer is
1707 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001708 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001709 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001710 ITelecomService service = getTelecomService();
1711 if (service != null) {
1712 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001713 return service.getSystemDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001714 } catch (RemoteException e) {
1715 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001716 }
Yorke Lee1011f482015-04-23 15:58:27 -07001717 }
1718 return null;
1719 }
1720
1721 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001722 * Return whether a given phone number is the configured voicemail number for a
1723 * particular phone account.
1724 *
1725 * @param accountHandle The handle for the account to check the voicemail number against
1726 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001727 */
Yorke Leec61d13662015-09-21 17:25:25 -07001728 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001729 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001730 ITelecomService service = getTelecomService();
1731 if (service != null) {
1732 try {
1733 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001734 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001735 } catch (RemoteException e) {
1736 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001737 }
Nancy Chen443e5012014-10-15 15:48:21 -07001738 }
1739 return false;
1740 }
1741
1742 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001743 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001744 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001745 * @param accountHandle The handle for the phone account.
1746 * @return The voicemail number for the phone account, and {@code null} if one has not been
1747 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001748 */
Yorke Leec61d13662015-09-21 17:25:25 -07001749 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001750 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001751 ITelecomService service = getTelecomService();
1752 if (service != null) {
1753 try {
1754 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001755 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001756 } catch (RemoteException e) {
1757 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001758 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001759 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001760 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001761 }
1762
1763 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001764 * Return the line 1 phone number for given phone account.
1765 *
Michael Groover08490f12020-03-24 14:08:14 -07001766 * <p>Requires Permission:
1767 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1768 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1769 * or that the caller is the default SMS app for any API level.
1770 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1771 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001772 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001773 * @param accountHandle The handle for the account retrieve a number for.
1774 * @return A string representation of the line 1 phone number.
Meng Wang8665b512021-11-18 15:13:43 -08001775 * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1776 * Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1777 * from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
Nancy Chen5cf27842015-01-24 23:30:27 -08001778 */
Meng Wang8665b512021-11-18 15:13:43 -08001779 @Deprecated
Michael Groover08490f12020-03-24 14:08:14 -07001780 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1781 @RequiresPermission(anyOf = {
1782 android.Manifest.permission.READ_PHONE_STATE,
1783 android.Manifest.permission.READ_SMS,
1784 android.Manifest.permission.READ_PHONE_NUMBERS
1785 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001786 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001787 ITelecomService service = getTelecomService();
1788 if (service != null) {
1789 try {
1790 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001791 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001792 } catch (RemoteException e) {
1793 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001794 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001795 }
1796 return null;
1797 }
1798
1799 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001800 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001801 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001802 *
1803 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1804 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001805 */
Yorke Leec61d13662015-09-21 17:25:25 -07001806 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001807 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001808 ITelecomService service = getTelecomService();
1809 if (service != null) {
1810 try {
1811 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001812 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001813 } catch (RemoteException e) {
1814 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001815 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001816 }
1817 return false;
1818 }
1819
1820 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001821 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1822 * permission. The permission can be obtained by associating with a physical wearable device
1823 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1824 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001825 *
1826 * @return {@code true} if the caller has {@link InCallService} access for
1827 * companion app; {@code false} otherwise.
1828 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001829 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001830 ITelecomService service = getTelecomService();
1831 if (service != null) {
1832 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001833 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001834 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001835 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001836 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001837 if (!isSystemProcess()) {
1838 e.rethrowAsRuntimeException();
1839 }
Shuo Qian4d065262020-10-20 11:04:28 -07001840 }
1841 }
1842 return false;
1843 }
1844
1845 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001846 * Returns whether there is an ongoing call originating from a managed
1847 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1848 * states.
1849 * <p>
1850 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1851 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001852 *
1853 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1854 * {@code false} otherwise.
1855 */
1856 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1857 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001858 ITelecomService service = getTelecomService();
1859 if (service != null) {
1860 try {
1861 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001862 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001863 } catch (RemoteException e) {
1864 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001865 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001866 }
1867 return false;
1868 }
1869
1870 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001871 * Returns one of the following constants that represents the current state of Telecom:
1872 *
1873 * {@link TelephonyManager#CALL_STATE_RINGING}
1874 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1875 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001876 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001877 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001878 * <p>
1879 * Requires Permission:
1880 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1881 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001882 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001883 * @hide
1884 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001885 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1886 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001887 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001888 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001889 ITelecomService service = getTelecomService();
1890 if (service != null) {
1891 try {
Thomas Stuartde1f1f22022-11-16 22:17:42 +00001892 return service.getCallStateUsingPackage(mContext.getOpPackageName(),
Brad Ebingera8366ae2021-03-23 21:01:51 +00001893 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001894 } catch (RemoteException e) {
1895 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001896 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001897 }
1898 return TelephonyManager.CALL_STATE_IDLE;
1899 }
1900
1901 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001902 * Returns whether there currently exists is a ringing incoming-call.
1903 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001904 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001905 * @hide
1906 */
1907 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001908 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001909 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001910 android.Manifest.permission.READ_PHONE_STATE
1911 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001912 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001913 ITelecomService service = getTelecomService();
1914 if (service != null) {
1915 try {
1916 return service.isRinging(mContext.getOpPackageName());
1917 } catch (RemoteException e) {
1918 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001919 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001920 }
1921 return false;
1922 }
1923
1924 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001925 * Ends the foreground call on the device.
1926 * <p>
1927 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1928 * foreground call is ended.
1929 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001930 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1931 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001932 *
1933 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1934 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001935 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1936 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1937 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001938 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001939 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001940 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001941 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001942 ITelecomService service = getTelecomService();
1943 if (service != null) {
1944 try {
1945 return service.endCall(mContext.getPackageName());
1946 } catch (RemoteException e) {
1947 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001948 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001949 }
1950 return false;
1951 }
1952
1953 /**
1954 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001955 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001956 * If the incoming call is a video call, the call will be answered with the same video state as
1957 * the incoming call requests. This means, for example, that an incoming call requesting
1958 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001959 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001960 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1961 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001962 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001963 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1964 // this method (clockwork & gearhead).
1965 @RequiresPermission(anyOf =
1966 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001967 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001968 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001969 ITelecomService service = getTelecomService();
1970 if (service != null) {
1971 try {
1972 service.acceptRingingCall(mContext.getPackageName());
1973 } catch (RemoteException e) {
1974 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001975 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001976 }
1977 }
1978
1979 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001980 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1981 * with the specified video state.
1982 *
1983 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001984 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1985 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001986 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001987 @RequiresPermission(anyOf =
1988 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001989 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07001990 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001991 ITelecomService service = getTelecomService();
1992 if (service != null) {
1993 try {
1994 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001995 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001996 } catch (RemoteException e) {
1997 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001998 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07001999 }
2000 }
2001
2002 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07002003 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07002004 * <p>
2005 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
2006 * already started playing. It is intended to handle use-cases such as silencing a ringing call
2007 * when the user presses the volume button during ringing.
2008 * <p>
2009 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
2010 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
2011 * <p>
2012 * A dialer app which wants to have more control over ringtone playing should declare
2013 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
2014 * {@link InCallService} implementation to indicate that the app wants to be responsible for
2015 * playing the ringtone for all incoming calls.
2016 * <p>
2017 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
2018 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07002019 */
Yorke Leec61d13662015-09-21 17:25:25 -07002020 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07002021 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002022 ITelecomService service = getTelecomService();
2023 if (service != null) {
2024 try {
2025 service.silenceRinger(mContext.getOpPackageName());
2026 } catch (RemoteException e) {
2027 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002028 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002029 }
2030 }
2031
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002032 /**
2033 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002034 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002035 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07002036 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002037 android.Manifest.permission.READ_PHONE_STATE
2038 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002039 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002040 ITelecomService service = getTelecomService();
2041 if (service != null) {
2042 try {
2043 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002044 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002045 } catch (RemoteException e) {
2046 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002047 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002048 }
2049 return false;
2050 }
2051
2052 /**
2053 * Returns the current TTY mode of the device. For TTY to be on the user must enable it in
Santos Cordon96efb482014-07-19 14:57:05 -07002054 * settings and have a wired headset plugged in.
2055 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002056 * - {@link TelecomManager#TTY_MODE_OFF}
2057 * - {@link TelecomManager#TTY_MODE_FULL}
2058 * - {@link TelecomManager#TTY_MODE_HCO}
2059 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002060 * @hide
2061 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002062 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07002063 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002064 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002065 ITelecomService service = getTelecomService();
2066 if (service != null) {
2067 try {
2068 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002069 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002070 } catch (RemoteException e) {
2071 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002072 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002073 }
Evan Charlton10197192014-07-19 15:00:29 -07002074 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002075 }
2076
Santos Cordon96efb482014-07-19 14:57:05 -07002077 /**
2078 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08002079 * has an incoming call. For managed {@link ConnectionService}s, the specified
2080 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2081 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2082 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2083 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2084 * <p>
Tyler Gunnd8778662023-02-10 17:13:11 +00002085 * Specify the address associated with the incoming call using
2086 * {@link #EXTRA_INCOMING_CALL_ADDRESS}. If an incoming call is from an anonymous source, omit
2087 * this extra and ensure you specify a valid number presentation via
2088 * {@link Connection#setAddress(Uri, int)} on the {@link Connection} instance you return in
2089 * your
2090 * {@link ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)}
2091 * implementation.
2092 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002093 * The incoming call you are adding is assumed to have a video state of
2094 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2095 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2096 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002097 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2098 * associated with the {@link PhoneAccountHandle} and request additional information about the
2099 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002100 * call UI.
2101 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002102 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2103 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2104 * the associated {@link PhoneAccount} is not currently enabled by the user.
2105 * <p>
2106 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2107 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2108 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002109 * <p>
2110 * <p>
2111 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2112 * the call is added to Telecom in order for the notification to be non-dismissible.
Santos Cordon96efb482014-07-19 14:57:05 -07002113 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2114 * {@link #registerPhoneAccount}.
2115 * @param extras A bundle that will be passed through to
2116 * {@link ConnectionService#onCreateIncomingConnection}.
2117 */
2118 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002119 ITelecomService service = getTelecomService();
2120 if (service != null) {
2121 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002122 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2123 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2124 Build.VERSION_CODES.O_MR1) {
2125 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2126 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002127 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002128 }
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002129 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras,
2130 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002131 } catch (RemoteException e) {
2132 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002133 }
Santos Cordon96efb482014-07-19 14:57:05 -07002134 }
2135 }
2136
Nancy Chen0eb1e402014-08-21 22:52:29 -07002137 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302138 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002139 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2140 * call initiated on another device which the user is being invited to join in. For managed
2141 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2142 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2143 * corresponding {@link PhoneAccount}. This can be checked using
2144 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2145 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302146 * <p>
2147 * The incoming conference you are adding is assumed to have a video state of
2148 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2149 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2150 * <p>
2151 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2152 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002153 * call (See
2154 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2155 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302156 * <p>
2157 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2158 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2159 * the associated {@link PhoneAccount} is not currently enabled by the user.
2160 *
2161 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2162 * {@link #registerPhoneAccount}.
2163 * @param extras A bundle that will be passed through to
2164 * {@link ConnectionService#onCreateIncomingConference}.
2165 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302166 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2167 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002168 ITelecomService service = getTelecomService();
2169 if (service != null) {
2170 try {
2171 service.addNewIncomingConference(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002172 phoneAccount, extras == null ? new Bundle() : extras,
2173 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002174 } catch (RemoteException e) {
2175 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302176 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302177 }
2178 }
2179
2180 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002181 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2182 * service. This is invoked when Telephony detects a new unknown connection that was neither
2183 * a new incoming call, nor an user-initiated outgoing call.
2184 *
2185 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2186 * {@link #registerPhoneAccount}.
2187 * @param extras A bundle that will be passed through to
2188 * {@link ConnectionService#onCreateIncomingConnection}.
2189 * @hide
2190 */
2191 @SystemApi
2192 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002193 ITelecomService service = getTelecomService();
2194 if (service != null) {
2195 try {
2196 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002197 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002198 } catch (RemoteException e) {
2199 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002200 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002201 }
2202 }
2203
2204 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002205 * Processes the specified dial string as an MMI code.
2206 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2207 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002208 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002209 * <p>
2210 * Requires that the method-caller be set as the system dialer app.
2211 * </p>
2212 *
2213 * @param dialString The digits to dial.
2214 * @return True if the digits were processed as an MMI code, false otherwise.
2215 */
Yorke Leec61d13662015-09-21 17:25:25 -07002216 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002217 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002218 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002219 if (service != null) {
2220 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002221 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002222 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002223 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002224 }
2225 }
2226 return false;
2227 }
2228
2229 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002230 * Processes the specified dial string as an MMI code.
2231 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2232 * Some of these sequences launch special behavior through handled by Telephony.
2233 * <p>
2234 * Requires that the method-caller be set as the system dialer app.
2235 * </p>
2236 *
2237 * @param accountHandle The handle for the account the MMI code should apply to.
2238 * @param dialString The digits to dial.
2239 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002240 */
Yorke Leec61d13662015-09-21 17:25:25 -07002241 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002242 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002243 ITelecomService service = getTelecomService();
2244 if (service != null) {
2245 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002246 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2247 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002248 } catch (RemoteException e) {
2249 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2250 }
2251 }
2252 return false;
2253 }
2254
2255 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002256 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2257 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002258 * @param accountHandle The handle for the account to derive an adn query URI for or
2259 * {@code null} to return a URI which will use the default account.
2260 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2261 * for the the content retrieve.
2262 */
Yorke Leec61d13662015-09-21 17:25:25 -07002263 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002264 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2265 ITelecomService service = getTelecomService();
2266 if (service != null && accountHandle != null) {
2267 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002268 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002269 } catch (RemoteException e) {
2270 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2271 }
2272 }
2273 return Uri.parse("content://icc/adn");
2274 }
2275
2276 /**
Tyler Gunna2879412023-02-28 23:41:53 +00002277 * Removes the missed-call notification if one is present and marks missed calls in the call
2278 * log as read.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002279 * <p>
Tyler Gunna2879412023-02-28 23:41:53 +00002280 * Requires that the method-caller be set as the default dialer app.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002281 * </p>
2282 */
Yorke Leec61d13662015-09-21 17:25:25 -07002283 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002284 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002285 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002286 if (service != null) {
2287 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002288 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002289 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002290 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002291 }
2292 }
2293 }
2294
2295 /**
2296 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2297 * currently no ongoing call, then this method does nothing.
2298 * <p>
2299 * Requires that the method-caller be set as the system dialer app or have the
2300 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2301 * </p>
2302 *
2303 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2304 */
Yorke Leec61d13662015-09-21 17:25:25 -07002305 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002306 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002307 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002308 if (service != null) {
2309 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002310 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002311 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002312 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002313 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002314 }
2315 }
2316 }
2317
Yorke Lee3e56ba12015-04-23 12:32:36 -07002318 /**
2319 * Places a new outgoing call to the provided address using the system telecom service with
2320 * the specified extras.
2321 *
2322 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2323 * except that the outgoing call will always be sent via the system telecom service. If
2324 * method-caller is either the user selected default dialer app or preloaded system dialer
2325 * app, then emergency calls will also be allowed.
2326 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002327 * Placing a call via a managed {@link ConnectionService} requires permission:
2328 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002329 *
2330 * Usage example:
2331 * <pre>
2332 * Uri uri = Uri.fromParts("tel", "12345", null);
2333 * Bundle extras = new Bundle();
2334 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2335 * telecomManager.placeCall(uri, extras);
2336 * </pre>
2337 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002338 * The following keys are supported in the supplied extras.
2339 * <ul>
2340 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2341 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2342 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2343 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2344 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002345 * <p>
2346 * An app which implements the self-managed {@link ConnectionService} API uses
2347 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2348 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2349 * associated {@link android.telecom.PhoneAccountHandle}.
2350 *
2351 * Self-managed {@link ConnectionService}s require permission
2352 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002353 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002354 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2355 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2356 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2357 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2358 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2359 * </p>
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002360 * <p>
2361 * <p>
2362 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2363 * the call is placed in order for the notification to be non-dismissible.
Yorke Lee3e56ba12015-04-23 12:32:36 -07002364 * @param address The address to make the call to.
2365 * @param extras Bundle of extras to use with the call.
2366 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002367 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2368 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002369 public void placeCall(Uri address, Bundle extras) {
2370 ITelecomService service = getTelecomService();
2371 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002372 if (address == null) {
2373 Log.w(TAG, "Cannot place call to empty address.");
2374 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002375 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002376 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002377 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002378 } catch (RemoteException e) {
2379 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2380 }
2381 }
2382 }
2383
Ravi Paluri80aa2142019-12-02 11:57:37 +05302384
2385 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002386 * Place a new adhoc conference call with the provided participants using the system telecom
2387 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302388 *
2389 * An adhoc conference call is established by providing a list of addresses to
2390 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2391 * {@link ConnectionService} is responsible for connecting all indicated participants
2392 * to a conference simultaneously.
2393 * This is in contrast to conferences formed by merging calls together (e.g. using
2394 * {@link android.telecom.Call#mergeConference()}).
2395 *
2396 * The following keys are supported in the supplied extras.
2397 * <ul>
2398 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2399 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2400 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2401 * </ul>
2402 *
2403 * @param participants List of participants to start conference with
2404 * @param extras Bundle of extras to use with the call
2405 */
2406 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2407 public void startConference(@NonNull List<Uri> participants,
2408 @NonNull Bundle extras) {
2409 ITelecomService service = getTelecomService();
2410 if (service != null) {
2411 try {
2412 service.startConference(participants, extras,
2413 mContext.getOpPackageName());
2414 } catch (RemoteException e) {
2415 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2416 }
2417 }
2418 }
2419
Santos Cordon91371dc02015-05-08 13:52:09 -07002420 /**
2421 * Enables and disables specified phone account.
2422 *
2423 * @param handle Handle to the phone account.
2424 * @param isEnabled Enable state of the phone account.
2425 * @hide
2426 */
2427 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002428 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002429 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2430 ITelecomService service = getTelecomService();
2431 if (service != null) {
2432 try {
2433 service.enablePhoneAccount(handle, isEnabled);
2434 } catch (RemoteException e) {
2435 Log.e(TAG, "Error enablePhoneAbbount", e);
2436 }
2437 }
2438 }
2439
Hall Liu0464b9b2016-01-12 15:32:58 -08002440 /**
2441 * Dumps telecom analytics for uploading.
2442 *
2443 * @return
2444 * @hide
2445 */
2446 @SystemApi
2447 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002448 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002449 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002450 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002451 if (service != null) {
2452 try {
2453 result = service.dumpCallAnalytics();
2454 } catch (RemoteException e) {
2455 Log.e(TAG, "Error dumping call analytics", e);
2456 }
2457 }
2458 return result;
2459 }
2460
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002461 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002462 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2463 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002464 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002465 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2466 * {@code true} for the current user.
2467 */
2468 public Intent createManageBlockedNumbersIntent() {
2469 ITelecomService service = getTelecomService();
2470 Intent result = null;
2471 if (service != null) {
2472 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002473 result = service.createManageBlockedNumbersIntent(mContext.getPackageName());
Nan Wuc51fd762022-08-01 21:08:23 +00002474 if (result != null) {
2475 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2476 mContext.getAttributionSource());
2477 }
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002478 } catch (RemoteException e) {
2479 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2480 }
2481 }
2482 return result;
2483 }
2484
Fan Zhang5431ef52019-10-14 13:43:46 -07002485
2486 /**
2487 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2488 * launch the activity for emergency dialer.
2489 *
2490 * @param number Optional number to call in emergency dialer
2491 * @hide
2492 */
2493 @SystemApi
2494 @NonNull
2495 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2496 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002497 if (service != null) {
2498 try {
Nan Wuc51fd762022-08-01 21:08:23 +00002499 Intent result = service.createLaunchEmergencyDialerIntent(number);
2500 if (result != null) {
2501 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2502 mContext.getAttributionSource());
2503 }
2504 return result;
Fan Zhang5431ef52019-10-14 13:43:46 -07002505 } catch (RemoteException e) {
2506 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2507 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002508 } else {
2509 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002510 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002511
2512 // Telecom service knows the package name of the expected emergency dialer package; if it
2513 // is not available, then fallback to not targeting a specific package.
2514 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2515 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2516 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2517 }
2518 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002519 }
2520
Tyler Gunnf5035432017-01-09 09:43:12 -08002521 /**
2522 * Determines whether Telecom would permit an incoming call to be added via the
2523 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2524 * {@link PhoneAccountHandle}.
2525 * <p>
2526 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2527 * in the following situations:
2528 * <ul>
2529 * <li>{@link PhoneAccount} does not have property
2530 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2531 * {@link ConnectionService}), and the active or held call limit has
2532 * been reached.</li>
2533 * <li>There is an ongoing emergency call.</li>
2534 * </ul>
2535 *
2536 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2537 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2538 * otherwise.
2539 */
2540 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002541 if (phoneAccountHandle == null) {
2542 return false;
2543 }
2544
Tyler Gunnf5035432017-01-09 09:43:12 -08002545 ITelecomService service = getTelecomService();
2546 if (service != null) {
2547 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002548 return service.isIncomingCallPermitted(phoneAccountHandle,
2549 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002550 } catch (RemoteException e) {
2551 Log.e(TAG, "Error isIncomingCallPermitted", e);
2552 }
2553 }
2554 return false;
2555 }
2556
2557 /**
2558 * Determines whether Telecom would permit an outgoing call to be placed via the
2559 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2560 * <p>
2561 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2562 * in the following situations:
2563 * <ul>
2564 * <li>{@link PhoneAccount} does not have property
2565 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2566 * {@link ConnectionService}), and the active, held or ringing call limit has
2567 * been reached.</li>
2568 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2569 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2570 * another {@link ConnectionService}.</li>
2571 * <li>There is an ongoing emergency call.</li>
2572 * </ul>
2573 *
2574 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2575 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2576 * otherwise.
2577 */
2578 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2579 ITelecomService service = getTelecomService();
2580 if (service != null) {
2581 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002582 return service.isOutgoingCallPermitted(phoneAccountHandle,
2583 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002584 } catch (RemoteException e) {
2585 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2586 }
2587 }
2588 return false;
2589 }
2590
Sanket Padawea8eddd42017-11-03 11:07:35 -07002591 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002592 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2593 * {@link PhoneAccountHandle} it defines.
2594 * <p>
2595 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2596 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2597 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2598 * is referred to as the source of the handover, and the video calling app is referred to as the
2599 * destination.
2600 * <p>
2601 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2602 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2603 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2604 * device.
2605 * <p>
2606 * For a full discussion of the handover process and the APIs involved, see
2607 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2608 * <p>
2609 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2610 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002611 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2612 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2613 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2614 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2615 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2616 * <p>
2617 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2618 * associated with the {@link PhoneAccountHandle} destAcct and call
2619 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2620 * <p>
2621 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2622 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2623 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2624 * user.
2625 * <p>
2626 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2627 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2628 *
2629 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2630 * {@link ConnectionService}.
2631 * @param videoState Video state after the handover.
2632 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2633 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002634 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2635 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002636 ITelecomService service = getTelecomService();
2637 if (service != null) {
2638 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002639 service.acceptHandover(srcAddr, videoState, destAcct, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002640 } catch (RemoteException e) {
2641 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002642 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002643 }
2644 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002645
Tyler Gunn5bd90852018-09-21 09:37:07 -07002646 /**
2647 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2648 * call, as identified by the dialed number, or because a call was identified by the network
2649 * as an emergency call.
2650 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2651 * @hide
2652 */
2653 @SystemApi
2654 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2655 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002656 ITelecomService service = getTelecomService();
2657 if (service != null) {
2658 try {
2659 return service.isInEmergencyCall();
2660 } catch (RemoteException e) {
2661 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2662 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002663 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002664 }
2665 return false;
2666 }
2667
Tyler Gunnc37445c2018-09-28 16:16:20 -07002668 /**
Tyler Gunn27bf4342022-03-25 14:17:52 -07002669 * Determines whether there are any ongoing {@link PhoneAccount#CAPABILITY_SELF_MANAGED}
2670 * calls for a given {@code packageName} and {@code userHandle}.
2671 *
2672 * @param packageName the package name of the app to check calls for.
2673 * @param userHandle the user handle on which to check for calls.
2674 * @return {@code true} if there are ongoing calls, {@code false} otherwise.
2675 * @hide
2676 */
2677 @RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
2678 public boolean isInSelfManagedCall(@NonNull String packageName,
2679 @NonNull UserHandle userHandle) {
2680 ITelecomService service = getTelecomService();
2681 if (service != null) {
2682 try {
2683 return service.isInSelfManagedCall(packageName, userHandle,
2684 mContext.getOpPackageName());
2685 } catch (RemoteException e) {
2686 Log.e(TAG, "RemoteException isInSelfManagedCall: " + e);
2687 e.rethrowFromSystemServer();
2688 return false;
2689 }
2690 } else {
2691 throw new IllegalStateException("Telecom service is not present");
2692 }
2693 }
2694
2695 /**
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002696 * Add a call to the Android system service Telecom. This allows the system to start tracking an
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002697 * incoming or outgoing call with the specified {@link CallAttributes}. Once a call is added,
2698 * a {@link android.app.Notification.CallStyle} notification should be posted and when the
2699 * call is ready to be disconnected, use {@link CallControl#disconnect(DisconnectCause,
2700 * Executor, OutcomeReceiver)} which is provided by the
2701 * {@code pendingControl#onResult(CallControl)}.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002702 * <p>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002703 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002704 * <p>
2705 * <b>Call Lifecycle</b>: Your app is given foreground execution priority as long as you have a
2706 * valid call and are posting a {@link android.app.Notification.CallStyle} notification.
2707 * When your application is given foreground execution priority, your app is treated as a
2708 * foreground service. Foreground execution priority will prevent the
2709 * {@link android.app.ActivityManager} from killing your application when it is placed the
2710 * background. Foreground execution priority is removed from your app when all of your app's
2711 * calls terminate or your app no longer posts a valid notification.
2712 * <p>
2713 * <p>
2714 * <p>
2715 * <b>Note</b>: Only packages that register with
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002716 * {@link PhoneAccount#CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS}
2717 * can utilize this API. {@link PhoneAccount}s that set the capabilities
2718 * {@link PhoneAccount#CAPABILITY_SIM_SUBSCRIPTION},
2719 * {@link PhoneAccount#CAPABILITY_CALL_PROVIDER},
2720 * {@link PhoneAccount#CAPABILITY_CONNECTION_MANAGER}
2721 * are not supported and will cause an exception to be thrown.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002722 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002723 * <p>
2724 * <p>
2725 * <b>Usage example:</b>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002726 * <pre>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002727 * // Its up to your app on how you want to wrap the objects. One such implementation can be:
2728 * class MyVoipCall {
2729 * ...
2730 * public CallControlCallEventCallback handshakes = new CallControlCallback() {
2731 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002732 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002733 *
2734 * public CallEventCallback events = new CallEventCallback() {
2735 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002736 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002737 *
2738 * public MyVoipCall(String id){
2739 * ...
2740 * }
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002741 * }
2742 *
Thomas Stuart6e418b32023-02-06 08:22:08 -08002743 * MyVoipCall myFirstOutgoingCall = new MyVoipCall("1");
2744 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002745 * telecomManager.addCall(callAttributes,
2746 * Runnable::run,
2747 * new OutcomeReceiver() {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002748 * public void onResult(CallControl callControl) {
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002749 * // The call has been added successfully. For demonstration
2750 * // purposes, the call is disconnected immediately ...
2751 * callControl.disconnect(
2752 * new DisconnectCause(DisconnectCause.LOCAL) )
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002753 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002754 * },
2755 * myFirstOutgoingCall.handshakes,
2756 * myFirstOutgoingCall.events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002757 * </pre>
2758 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002759 * @param callAttributes attributes of the new call (incoming or outgoing, address, etc.)
2760 * @param executor execution context to run {@link CallControlCallback} updates on
2761 * @param pendingControl Receives the result of addCall transaction. Upon success, a
2762 * CallControl object is provided which can be used to do things like
2763 * disconnect the call that was added.
2764 * @param handshakes callback that receives <b>actionable</b> updates that originate from
2765 * Telecom.
2766 * @param events callback that receives <b>non</b>-actionable updates that originate
2767 * from Telecom.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002768 */
2769 @RequiresPermission(android.Manifest.permission.MANAGE_OWN_CALLS)
2770 @SuppressLint("SamShouldBeLast")
2771 public void addCall(@NonNull CallAttributes callAttributes,
2772 @NonNull @CallbackExecutor Executor executor,
2773 @NonNull OutcomeReceiver<CallControl, CallException> pendingControl,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002774 @NonNull CallControlCallback handshakes,
2775 @NonNull CallEventCallback events) {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002776 Objects.requireNonNull(callAttributes);
2777 Objects.requireNonNull(executor);
2778 Objects.requireNonNull(pendingControl);
Thomas Stuart6e418b32023-02-06 08:22:08 -08002779 Objects.requireNonNull(handshakes);
2780 Objects.requireNonNull(events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002781
2782 ITelecomService service = getTelecomService();
2783 if (service != null) {
2784 try {
2785 // create or add the new call to a service wrapper w/ the same phoneAccountHandle
2786 ClientTransactionalServiceWrapper transactionalServiceWrapper =
2787 mTransactionalServiceRepository.addNewCallForTransactionalServiceWrapper(
2788 callAttributes.getPhoneAccountHandle());
2789
2790 // couple all the args passed by the client
2791 String newCallId = transactionalServiceWrapper.trackCall(callAttributes, executor,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002792 pendingControl, handshakes, events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002793
2794 // send args to server to process new call
2795 service.addCall(callAttributes, transactionalServiceWrapper.getCallEventCallback(),
2796 newCallId, mContext.getOpPackageName());
2797 } catch (RemoteException e) {
2798 Log.e(TAG, "RemoteException addCall: " + e);
2799 e.rethrowFromSystemServer();
2800 }
2801 } else {
2802 throw new IllegalStateException("Telecom service is not present");
2803 }
2804 }
2805
2806 /**
Tyler Gunnc37445c2018-09-28 16:16:20 -07002807 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2808 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002809 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002810 * @hide
2811 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002812 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002813 ITelecomService service = getTelecomService();
2814 if (service != null) {
2815 try {
2816 service.handleCallIntent(intent, callingPackageProxy);
2817 } catch (RemoteException e) {
2818 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002819 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002820 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002821 }
2822
Shuo Qian4d065262020-10-20 11:04:28 -07002823 private boolean isSystemProcess() {
2824 return Process.myUid() == Process.SYSTEM_UID;
2825 }
2826
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002827 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002828 if (mTelecomServiceOverride != null) {
2829 return mTelecomServiceOverride;
2830 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002831 if (sTelecomService == null) {
2832 ITelecomService temp = ITelecomService.Stub.asInterface(
2833 ServiceManager.getService(Context.TELECOM_SERVICE));
2834 synchronized (CACHE_LOCK) {
2835 if (sTelecomService == null && temp != null) {
2836 try {
2837 sTelecomService = temp;
2838 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2839 } catch (Exception e) {
2840 sTelecomService = null;
2841 }
2842 }
2843 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002844 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002845 return sTelecomService;
2846 }
2847
2848 private static class DeathRecipient implements IBinder.DeathRecipient {
2849 @Override
2850 public void binderDied() {
2851 resetServiceCache();
2852 }
2853 }
2854
2855 private static void resetServiceCache() {
2856 synchronized (CACHE_LOCK) {
2857 if (sTelecomService != null) {
2858 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2859 sTelecomService = null;
2860 }
2861 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002862 }
Evan Charlton235c1592014-09-05 15:41:23 +00002863}