blob: a72f7806d3ea5299ed0e18a28a771a12f090752f [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 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800415 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
416 * time the call was created.
417 * @hide
418 */
419 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
420 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
421
422 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700423 * Optional extra for incoming and outgoing calls containing a long which specifies the time
424 * telecom began routing the call. This value is in milliseconds since boot.
425 * @hide
426 */
427 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
428 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
429
430 /**
431 * Optional extra for incoming and outgoing calls containing a long which specifies the time
432 * telecom finished routing the call. This value is in milliseconds since boot.
433 * @hide
434 */
435 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
436 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
437
438 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700439 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
440 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700441 */
442 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700443 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700444
445 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700446 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
447 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700448 */
449 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700450 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700451
452 /**
radhika0dd90652020-11-04 11:12:51 -0800453 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
454 * lower layers
455 * @hide
456 */
457 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
458 "Call dropped by lower layers";
459
460 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700461 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
462 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800463 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700464 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800465 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700466 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700467 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700468
469 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800470 * Optional extra for communicating the call technology used by a {@link ConnectionService}
471 * to Telecom. Valid values are:
472 * <ul>
473 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
474 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
475 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
476 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
477 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
478 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800479 * @hide
480 */
Hall Liu2ef04112020-09-14 18:34:10 -0700481 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800482 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
483 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
484
485 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800486 * Optional extra for communicating the call network technology used by a
487 * {@link android.telecom.Connection} to Telecom and InCallUI.
488 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700489 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800490 */
491 public static final String EXTRA_CALL_NETWORK_TYPE =
492 "android.telecom.extra.CALL_NETWORK_TYPE";
493
494 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700495 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
496 * package name of the app specifying an alternative gateway for the call.
497 * The value is a string.
498 *
499 * (The following comment corresponds to the all GATEWAY_* extras)
500 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
501 * alternative address to dial which is different from the one specified and displayed to
502 * the user. This alternative address is referred to as the gateway address.
503 */
504 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700505 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700506
507 /**
508 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
509 * original address to dial for the call. This is used when an alternative gateway address is
510 * provided to recall the original address.
511 * The value is a {@link android.net.Uri}.
512 *
513 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
514 */
515 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700516 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700517
518 /**
Evan Charlton10197192014-07-19 15:00:29 -0700519 * The number which the party on the other side of the line will see (and use to return the
520 * call).
521 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700522 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
523 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
524 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700525 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700526 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700527
528 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800529 * The number of milliseconds that Telecom should wait after disconnecting a call via the
530 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
531 * to make a new one.
532 * @hide
533 */
534 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
535 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
536
537 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700538 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700539 * existing call from the user's device to a different {@link PhoneAccount}.
540 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700541 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
542 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
543 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
544 * the receiving side of a handover.
545 * <p>
546 * Used when Telecom calls
547 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
548 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
549 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
550 * occurs on the initiating side of a handover.
551 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700552 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700553 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800554 * @deprecated Use the public handover APIs. See
555 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700556 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800557 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700558 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
559
560 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800561 * When {@code true} indicates that a request to create a new connection is for the purpose of
562 * a handover. Note: This is used with the
563 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
564 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
565 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
566 * @hide
567 */
568 public static final String EXTRA_IS_HANDOVER_CONNECTION =
569 "android.telecom.extra.IS_HANDOVER_CONNECTION";
570
571 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700572 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
573 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
574 * the handover is from.
575 * @hide
576 */
577 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
578 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
579
580 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700581 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
582 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
583 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
584 * {@link Connection} will be.
585 * @hide
586 */
587 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
588
589 /**
Hall Liu95d55872017-01-25 17:12:49 -0800590 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
591 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
592 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
593 */
594 public static final String EXTRA_START_CALL_WITH_RTT =
595 "android.telecom.extra.START_CALL_WITH_RTT";
596
597 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800598 * Start an activity indicating that the completion of an outgoing call or an incoming call
599 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
600 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
601 *
602 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
603 * call which completed.
604 *
605 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
606 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
607 *
608 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
609 * {@link #EXTRA_CALL_DURATION} for more information.
610 */
611 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
612
613 /**
614 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
615 * uri handle(phone number) of the completed call.
616 */
617 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
618
619 /**
620 * A integer value provided for completed calls to indicate the reason for the call
621 * disconnection.
622 * <p>
623 * Allowed values:
624 * <ul>
625 * <li>{@link DisconnectCause#UNKNOWN}</li>
626 * <li>{@link DisconnectCause#LOCAL}</li>
627 * <li>{@link DisconnectCause#REMOTE}</li>
628 * <li>{@link DisconnectCause#REJECTED}</li>
629 * <li>{@link DisconnectCause#MISSED}</li>
630 * </ul>
631 * </p>
632 */
633 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
634
635 /**
636 * A integer value provided for completed calls to indicate the duration of the call.
637 * <p>
638 * Allowed values:
639 * <ul>
640 * <li>{@link #DURATION_VERY_SHORT}</li>
641 * <li>{@link #DURATION_SHORT}</li>
642 * <li>{@link #DURATION_MEDIUM}</li>
643 * <li>{@link #DURATION_LONG}</li>
644 * </ul>
645 * </p>
646 */
647 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
648
649 /**
650 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
651 * call was < 3 seconds.
652 */
653 public static final int DURATION_VERY_SHORT = 0;
654
655 /**
656 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
657 * call was >= 3 seconds and < 60 seconds.
658 */
659 public static final int DURATION_SHORT = 1;
660
661 /**
662 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
663 * call was >= 60 seconds and < 120 seconds.
664 */
665 public static final int DURATION_MEDIUM = 2;
666
667 /**
668 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
669 * call was >= 120 seconds.
670 */
671 public static final int DURATION_LONG = 3;
672
673 /**
674 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
675 * milliseconds.
676 * @hide
677 */
678 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
679
680 /**
681 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
682 * milliseconds.
683 * @hide
684 */
685 public static final long SHORT_CALL_TIME_MS = 60000;
686
687 /**
688 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
689 * milliseconds.
690 * @hide
691 */
692 public static final long MEDIUM_CALL_TIME_MS = 120000;
693
694 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700695 * A boolean meta-data value indicating whether an {@link InCallService} implements an
696 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
697 * would also like to replace the in-call interface should set this meta-data to {@code true} in
698 * the manifest registration of their {@link InCallService}.
699 */
700 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
701
702 /**
Santos Cordon88881552015-12-10 17:29:54 -0800703 * A boolean meta-data value indicating whether an {@link InCallService} implements an
704 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000705 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800706 */
707 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
708 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
709
710 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800711 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
712 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
713 * override the system provided ringing should set this meta-data to {@code true} in the
714 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700715 * <p>
716 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
717 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800718 */
719 public static final String METADATA_IN_CALL_SERVICE_RINGING =
720 "android.telecom.IN_CALL_SERVICE_RINGING";
721
722 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700723 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
724 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
725 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
726 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
727 * informed of external calls should set this meta-data to {@code true} in the manifest
728 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
729 * be informed of external calls.
730 */
731 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
732 "android.telecom.INCLUDE_EXTERNAL_CALLS";
733
734 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800735 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
736 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
737 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
738 * to implement its own call user interface. An {@link InCallService} implementation which
739 * would like to be informed of external calls should set this meta-data to {@code true} in the
740 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
741 * will NOT be informed about self-managed calls.
742 * <p>
743 * An {@link InCallService} which receives self-managed calls is free to view and control the
744 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700745 * exposing these calls to an automotive device via its companion app.
746 * <p>
Tyler Gunn24e18332017-02-10 09:42:49 -0800747 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
748 */
749 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
750 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
751
752 /**
Evan Charlton10197192014-07-19 15:00:29 -0700753 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
754 * pause for a predefined period.
755 */
756 public static final char DTMF_CHARACTER_PAUSE = ',';
757
758 /**
759 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
760 * wait for user confirmation before proceeding.
761 */
762 public static final char DTMF_CHARACTER_WAIT = ';';
763
764 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800765 * @hide
766 */
767 @IntDef(prefix = { "TTY_MODE_" },
768 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
769 @Retention(RetentionPolicy.SOURCE)
770 public @interface TtyMode {}
771
772 /**
Evan Charlton10197192014-07-19 15:00:29 -0700773 * TTY (teletypewriter) mode is off.
774 *
775 * @hide
776 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800777 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700778 public static final int TTY_MODE_OFF = 0;
779
780 /**
781 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
782 * will communicate with the remote party by sending and receiving text messages.
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_FULL = 1;
788
789 /**
790 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
791 * speaker is on. The user will communicate with the remote party by sending text messages and
792 * hearing an audible reply.
793 *
794 * @hide
795 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800796 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700797 public static final int TTY_MODE_HCO = 2;
798
799 /**
800 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
801 * microphone is still on. User will communicate with the remote party by speaking and receiving
802 * text message replies.
803 *
804 * @hide
805 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800806 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700807 public static final int TTY_MODE_VCO = 3;
808
809 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700810 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700811 *
Hall Liu2ef04112020-09-14 18:34:10 -0700812 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
813 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700814 * @hide
815 */
Hall Liu2ef04112020-09-14 18:34:10 -0700816 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700817 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700818 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700819
820 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700821 * Integer extra key that indicates the current TTY mode.
822 *
823 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
824 *
825 * Valid modes are:
826 * <ul>
827 * <li>{@link #TTY_MODE_OFF}</li>
828 * <li>{@link #TTY_MODE_FULL}</li>
829 * <li>{@link #TTY_MODE_HCO}</li>
830 * <li>{@link #TTY_MODE_VCO}</li>
831 * </ul>
832 *
833 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
834 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
835 * plugged into the device.
836 * @hide
837 */
Hall Liu2ef04112020-09-14 18:34:10 -0700838 @SystemApi
839 public static final String EXTRA_CURRENT_TTY_MODE =
840 "android.telecom.extra.CURRENT_TTY_MODE";
841
842 /**
843 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
844 *
845 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
846 * preferred TTY mode.
847 * @hide
848 */
Hall Liu2ef04112020-09-14 18:34:10 -0700849 @SystemApi
850 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
851 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
852
853 /**
854 * Integer extra key that indicates the preferred TTY mode.
855 *
856 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
857 *
Evan Charlton10197192014-07-19 15:00:29 -0700858 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800859 * <ul>
860 * <li>{@link #TTY_MODE_OFF}</li>
861 * <li>{@link #TTY_MODE_FULL}</li>
862 * <li>{@link #TTY_MODE_HCO}</li>
863 * <li>{@link #TTY_MODE_VCO}</li>
864 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700865 * @hide
866 */
Hall Liu2ef04112020-09-14 18:34:10 -0700867 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700868 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800869 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700870
Nancy Chen9d568c02014-09-08 14:17:59 -0700871 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700872 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800873 * notification. If no custom component exists then this is sent to the default dialer which
874 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700875 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700876 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
877 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
878
879 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800880 * The number of calls associated with the notification. If the number is zero then the missed
881 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700882 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700883 public static final String EXTRA_NOTIFICATION_COUNT =
884 "android.telecom.extra.NOTIFICATION_COUNT";
885
886 /**
887 * The number associated with the missed calls. This number is only relevant
888 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700889 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700890 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
891 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
892
893 /**
Tyler Gunna2879412023-02-28 23:41:53 +0000894 * Included in the extras of the {@link #ACTION_SHOW_MISSED_CALLS_NOTIFICATION}, provides a
895 * pending intent which can be used to clear the missed calls notification and mark unread
896 * missed call log entries as read.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700897 * @hide
Tyler Gunna2879412023-02-28 23:41:53 +0000898 * @deprecated Use {@link #cancelMissedCallsNotification()} instead.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700899 */
Tyler Gunna2879412023-02-28 23:41:53 +0000900 @Deprecated
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700901 @SystemApi
902 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
903 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
904
905 /**
906 * The intent to call back a missed call.
907 * @hide
908 */
909 @SystemApi
910 public static final String EXTRA_CALL_BACK_INTENT =
911 "android.telecom.extra.CALL_BACK_INTENT";
912
913 /**
Charles He858f1322017-11-27 17:11:04 -0800914 * The dialer activity responsible for placing emergency calls from, for example, a locked
915 * keyguard.
916 * @hide
917 */
918 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
919 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
920
921 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800922 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
923 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700924 * <p>
925 * The call initiator can use this extra to indicate that a call used assisted dialing to help
926 * place the call. This is most commonly used by a Dialer app which provides the ability to
927 * automatically add dialing prefixes when placing international calls.
928 * <p>
929 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800930 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
931 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700932 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
933 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
934 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800935 */
936 public static final String EXTRA_USE_ASSISTED_DIALING =
937 "android.telecom.extra.USE_ASSISTED_DIALING";
938
939 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800940 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
941 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800942 * Valid sources are:
943 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
944 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
945 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800946 *
Hall Liu2ef04112020-09-14 18:34:10 -0700947 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800948 * @hide
949 */
Hall Liu2ef04112020-09-14 18:34:10 -0700950 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800951 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
952
953 /**
Ayush Sharma527b5072023-01-06 10:14:43 +0000954 * Intent action to trigger "switch to managed profile" dialog for call in SystemUI
955 *
956 * @hide
957 */
958 public static final String ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG =
959 "android.telecom.action.SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG";
960
961 /**
962 * Extra specifying the managed profile user id.
963 * This is used with {@link TelecomManager#ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG}
964 *
965 * @hide
966 */
967 public static final String EXTRA_MANAGED_PROFILE_USER_ID =
968 "android.telecom.extra.MANAGED_PROFILE_USER_ID";
969
970 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800971 * Indicating the call is initiated via emergency dialer's shortcut button.
972 *
973 * @hide
974 */
Hall Liu2ef04112020-09-14 18:34:10 -0700975 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800976 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
977
978 /**
979 * Indicating the call is initiated via emergency dialer's dialpad.
980 *
981 * @hide
982 */
Hall Liu2ef04112020-09-14 18:34:10 -0700983 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800984 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
985
986 /**
987 * Indicating the call source is not specified.
988 *
989 * @hide
990 */
Hall Liu2ef04112020-09-14 18:34:10 -0700991 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800992 public static final int CALL_SOURCE_UNSPECIFIED = 0;
993
994 /**
Nancy Chen9d568c02014-09-08 14:17:59 -0700995 * The following 4 constants define how properties such as phone numbers and names are
996 * displayed to the user.
997 */
998
Santos Cordoned769ae2015-05-13 18:47:38 -0700999 /**
1000 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -08001001 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001002 public static final int PRESENTATION_ALLOWED = 1;
1003
Santos Cordoned769ae2015-05-13 18:47:38 -07001004 /**
1005 * Indicates that the address or number of a call is blocked by the other party.
1006 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001007 public static final int PRESENTATION_RESTRICTED = 2;
1008
Santos Cordoned769ae2015-05-13 18:47:38 -07001009 /**
1010 * Indicates that the address or number of a call is not specified or known by the carrier.
1011 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001012 public static final int PRESENTATION_UNKNOWN = 3;
1013
Santos Cordoned769ae2015-05-13 18:47:38 -07001014 /**
1015 * Indicates that the address or number of a call belongs to a pay phone.
1016 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001017 public static final int PRESENTATION_PAYPHONE = 4;
1018
Grace Jiacc16b042021-08-09 09:06:11 -07001019 /**
1020 * Indicates that the address or number of a call is unavailable.
1021 */
1022 public static final int PRESENTATION_UNAVAILABLE = 5;
1023
Hall Liu4a9fde12020-01-16 17:38:46 -08001024
1025 /*
1026 * Values for the adb property "persist.radio.videocall.audio.output"
1027 */
1028 /** @hide */
1029 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1030 /** @hide */
1031 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1032 /** @hide */
1033 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1034
Tyler Gunn00d737b2019-10-31 13:04:37 -07001035 /** @hide */
1036 @Retention(RetentionPolicy.SOURCE)
1037 @IntDef(
1038 prefix = { "PRESENTATION_" },
1039 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001040 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001041 public @interface Presentation {}
1042
Brad Ebingera8366ae2021-03-23 21:01:51 +00001043
1044 /**
1045 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1046 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1047 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001048 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001049 */
1050 @ChangeId
1051 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1052 // this magic number is a bug ID
1053 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1054
Grace Jiab13eb2c2021-04-21 14:13:26 -07001055 /**
1056 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1057 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1058 * @hide
1059 */
1060 @ChangeId
1061 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1062 // bug ID
1063 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1064
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001065 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001066
Kevin Jeon767cda32020-11-17 01:40:16 +00001067
1068 /** Cached service handles, cleared by resetServiceCache() at death */
1069 private static final Object CACHE_LOCK = new Object();
1070
1071 @GuardedBy("CACHE_LOCK")
1072 private static ITelecomService sTelecomService;
1073 @GuardedBy("CACHE_LOCK")
1074 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1075
Yorke Leeb4ce1432014-06-09 13:53:23 -07001076 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001077
Hall Liue1bc2ec2015-10-09 15:58:37 -07001078 private final ITelecomService mTelecomServiceOverride;
1079
Thomas Stuart9bfb2432022-09-27 15:02:07 -07001080 /** @hide **/
1081 private final ClientTransactionalServiceRepository mTransactionalServiceRepository =
1082 new ClientTransactionalServiceRepository();
1083 /** @hide **/
1084 public static final int TELECOM_TRANSACTION_SUCCESS = 0;
1085 /** @hide **/
1086 public static final String TRANSACTION_CALL_ID_KEY = "TelecomCallId";
1087
Santos Cordon6c7a3882014-06-25 15:30:08 -07001088 /**
1089 * @hide
1090 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001091 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001092 public static TelecomManager from(Context context) {
1093 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001094 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001095
1096 /**
1097 * @hide
1098 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001099 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001100 this(context, null);
1101 }
1102
1103 /**
1104 * @hide
1105 */
1106 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001107 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001108 if (appContext != null && Objects.equals(context.getAttributionTag(),
1109 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001110 mContext = appContext;
1111 } else {
1112 mContext = context;
1113 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001114 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001115 }
1116
1117 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001118 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1119 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1120 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1121 * account returned depends on the following priorities:
1122 * <ul>
1123 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1124 * be returned.
1125 * </li>
1126 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1127 * will be returned.
1128 * </li>
1129 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001130 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001131 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1132 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001133 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001134 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001135 */
Yorke Leec61d13662015-09-21 17:25:25 -07001136 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001137 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001138 ITelecomService service = getTelecomService();
1139 if (service != null) {
1140 try {
1141 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001142 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001143 } catch (RemoteException e) {
1144 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001145 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001146 }
1147 return null;
1148 }
1149
1150 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001151 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1152 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001153 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001154 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001155 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1156 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001157 * <p>
1158 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001159 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001160 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1161 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001162 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001163 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001164 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001165 ITelecomService service = getTelecomService();
1166 if (service != null) {
1167 try {
1168 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001169 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001170 } catch (RemoteException e) {
1171 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001172 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001173 }
1174 return null;
1175 }
1176
1177 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001178 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1179 *
1180 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001181 * outgoing voice calls, or {@code null} if no default is specified (the
1182 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001183 * @hide
1184 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001185 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1186 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001187 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001188 ITelecomService service = getTelecomService();
1189 if (service != null) {
1190 try {
1191 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1192 } catch (RemoteException e) {
1193 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001194 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001195 }
1196 }
1197
1198 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001199 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001200 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1201 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001202 *
Brad Ebingere7833312019-05-07 10:55:55 -07001203 * @return The phone account handle of the current sim call manager for the default voice
1204 * subscription.
1205 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001206 */
1207 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001208 ITelecomService service = getTelecomService();
1209 if (service != null) {
1210 try {
1211 return service.getSimCallManager(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001212 SubscriptionManager.getDefaultSubscriptionId(), mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001213 } catch (RemoteException e) {
1214 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001215 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001216 }
1217 return null;
1218 }
1219
1220 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001221 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1222 * prepared for this method to return {@code null}, indicating that there currently exists no
1223 * SIM call manager {@link PhoneAccount} for the subscription specified.
1224 *
1225 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1226 * queried for.
1227 * @return The phone account handle of the current sim call manager.
1228 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001229 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001230 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001231 ITelecomService service = getTelecomService();
1232 if (service != null) {
1233 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001234 return service.getSimCallManager(subscriptionId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001235 } catch (RemoteException e) {
1236 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001237 }
Brad Ebingere7833312019-05-07 10:55:55 -07001238 }
1239 return null;
1240 }
1241
1242 /**
1243 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1244 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1245 * must be prepared for this method to return {@code null}, indicating that there currently
1246 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001247 *
1248 * @return The phone account handle of the current sim call manager.
1249 *
1250 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001251 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001252 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001253 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001254 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001255 ITelecomService service = getTelecomService();
1256 if (service != null) {
1257 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001258 return service.getSimCallManagerForUser(userId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001259 } catch (RemoteException e) {
1260 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001261 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001262 }
1263 return null;
1264 }
1265
1266 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001267 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001268 * {@code null}, indicating that there currently exists no Connection Manager
1269 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001270 *
1271 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001272 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001273 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001274 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001275 public PhoneAccountHandle getConnectionManager() {
1276 return getSimCallManager();
1277 }
1278
1279 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001280 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1281 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001282 * <P>
1283 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1284 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1285 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1286 * such as {@code sip:example@sipexample.com}).
1287 *
1288 * @param uriScheme The URI scheme.
1289 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001290 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001291 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001292 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001293 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001294 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001295 android.Manifest.permission.READ_PHONE_STATE
1296 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001297 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001298 ITelecomService service = getTelecomService();
1299 if (service != null) {
1300 try {
1301 return service.getPhoneAccountsSupportingScheme(uriScheme,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001302 mContext.getOpPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001303 } catch (RemoteException e) {
1304 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001305 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001306 }
1307 return new ArrayList<>();
1308 }
1309
Nancy Chen513c8922014-09-17 14:47:20 -07001310
1311 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001312 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1313 * calls. The returned list includes only those accounts which have been explicitly enabled
1314 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001315 *
1316 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1317 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001318 */
Yorke Leec61d13662015-09-21 17:25:25 -07001319 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001320 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001321 return getCallCapablePhoneAccounts(false);
1322 }
1323
1324 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001325 * Returns a list of {@link PhoneAccountHandle}s for all self-managed
1326 * {@link ConnectionService}s owned by the calling {@link UserHandle}.
Tyler Gunn89317072017-04-07 14:57:37 -07001327 * <p>
1328 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1329 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1330 * <p>
1331 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuart510f49a2022-01-28 23:06:57 +00001332 * is the default dialer app.
Tyler Gunn89317072017-04-07 14:57:37 -07001333 * <p>
Thomas Stuart510f49a2022-01-28 23:06:57 +00001334 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1335 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
Tyler Gunn89317072017-04-07 14:57:37 -07001336 *
1337 * @return A list of {@code PhoneAccountHandle} objects.
1338 */
Thomas Stuart510f49a2022-01-28 23:06:57 +00001339 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1340 public @NonNull List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001341 ITelecomService service = getTelecomService();
1342 if (service != null) {
1343 try {
1344 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001345 mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001346 } catch (RemoteException e) {
1347 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001348 }
Tyler Gunn89317072017-04-07 14:57:37 -07001349 }
1350 return new ArrayList<>();
1351 }
1352
1353 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001354 * Returns a list of {@link PhoneAccountHandle}s owned by the calling self-managed
1355 * {@link ConnectionService}.
1356 * <p>
1357 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1358 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1359 * <p>
1360 * Requires permission {@link android.Manifest.permission#MANAGE_OWN_CALLS}
1361 * <p>
1362 * A {@link SecurityException} will be thrown if a caller lacks the
1363 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission.
1364 *
1365 * @return A list of {@code PhoneAccountHandle} objects.
1366 */
1367 @RequiresPermission(Manifest.permission.MANAGE_OWN_CALLS)
1368 public @NonNull List<PhoneAccountHandle> getOwnSelfManagedPhoneAccounts() {
1369 ITelecomService service = getTelecomService();
1370 if (service != null) {
1371 try {
1372 return service.getOwnSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001373 mContext.getAttributionTag()).getList();
Thomas Stuart510f49a2022-01-28 23:06:57 +00001374 } catch (RemoteException e) {
1375 throw e.rethrowFromSystemServer();
1376 }
1377 }
1378 throw new IllegalStateException("Telecom is not available");
1379 }
1380
1381 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001382 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1383 * by the user.
1384 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001385 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001386 * when {@code false}, only enabled phone accounts will be
1387 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001388 * @return A list of {@code PhoneAccountHandle} objects.
1389 * @hide
1390 */
Hall Liub2306242019-11-15 17:13:05 -08001391 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001392 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1393 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1394 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001395 ITelecomService service = getTelecomService();
1396 if (service != null) {
1397 try {
1398 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001399 mContext.getOpPackageName(), mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001400 } catch (RemoteException e) {
1401 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1402 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001403 }
Nancy Chen513c8922014-09-17 14:47:20 -07001404 }
1405 return new ArrayList<>();
1406 }
1407
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001408 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001409 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1410 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001411 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1412 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001413 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001414 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001415 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001416 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001417 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001418 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001419 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001420 ITelecomService service = getTelecomService();
1421 if (service != null) {
1422 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001423 return service.getPhoneAccountsForPackage(mContext.getPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001424 } catch (RemoteException e) {
1425 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001426 }
Nancy Chen513c8922014-09-17 14:47:20 -07001427 }
1428 return null;
1429 }
1430
1431 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001432 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1433 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001434 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001435 * Requires Permission:
1436 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1437 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001438 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001439 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001440 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001441 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001442 ITelecomService service = getTelecomService();
1443 if (service != null) {
1444 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001445 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001446 } catch (RemoteException e) {
1447 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001448 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001449 }
1450 return null;
1451 }
1452
1453 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001454 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001455 *
Nancy Chen210ef032014-09-15 17:58:42 -07001456 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001457 * @hide
1458 */
1459 @SystemApi
1460 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001461 ITelecomService service = getTelecomService();
1462 if (service != null) {
1463 try {
1464 return service.getAllPhoneAccountsCount();
1465 } catch (RemoteException e) {
1466 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001467 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001468 }
1469 return 0;
1470 }
1471
1472 /**
1473 * Returns a list of all {@link PhoneAccount}s.
1474 *
1475 * @return All {@link PhoneAccount}s.
1476 * @hide
1477 */
1478 @SystemApi
1479 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001480 ITelecomService service = getTelecomService();
1481 if (service != null) {
1482 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001483 return service.getAllPhoneAccounts().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001484 } catch (RemoteException e) {
1485 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001486 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001487 }
1488 return Collections.EMPTY_LIST;
1489 }
1490
1491 /**
1492 * Returns a list of all {@link PhoneAccountHandle}s.
1493 *
1494 * @return All {@link PhoneAccountHandle}s.
1495 * @hide
1496 */
1497 @SystemApi
1498 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001499 ITelecomService service = getTelecomService();
1500 if (service != null) {
1501 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001502 return service.getAllPhoneAccountHandles().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001503 } catch (RemoteException e) {
1504 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001505 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001506 }
1507 return Collections.EMPTY_LIST;
1508 }
1509
1510 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001511 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1512 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1513 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001514 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1515 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1516 * the phone app settings before the account is usable.
1517 * <p>
Thomas Stuarte0416212022-01-31 20:31:42 +00001518 * Note: Each package is limited to 10 {@link PhoneAccount} registrations.
1519 * <p>
Santos Cordond9e614f2014-10-28 13:10:36 -07001520 * A {@link SecurityException} will be thrown if an app tries to register a
1521 * {@link PhoneAccountHandle} where the package name specified within
1522 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Thomas Stuarte0416212022-01-31 20:31:42 +00001523 * <p>
1524 * A {@link IllegalArgumentException} will be thrown if an app tries to register a
1525 * {@link PhoneAccount} when the upper bound limit, 10, has already been reached.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001526 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001527 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001528 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001529 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001530 ITelecomService service = getTelecomService();
1531 if (service != null) {
1532 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001533 service.registerPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001534 } catch (RemoteException e) {
1535 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001536 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001537 }
1538 }
1539
1540 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001541 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001542 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001543 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001544 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001545 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001546 ITelecomService service = getTelecomService();
1547 if (service != null) {
1548 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001549 service.unregisterPhoneAccount(accountHandle, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001550 } catch (RemoteException e) {
1551 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001552 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001553 }
1554 }
1555
1556 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001557 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001558 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001559 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001560 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001561 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001562 public void clearPhoneAccounts() {
1563 clearAccounts();
1564 }
1565 /**
1566 * Remove all Accounts that belong to the calling package from the system.
1567 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1568 * @hide
1569 */
1570 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001571 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001572 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001573 ITelecomService service = getTelecomService();
1574 if (service != null) {
1575 try {
1576 service.clearAccounts(mContext.getPackageName());
1577 } catch (RemoteException e) {
1578 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001579 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001580 }
1581 }
1582
1583 /**
Anthony Lee67279262014-10-27 11:28:40 -07001584 * Remove all Accounts that belong to the specified package from the system.
1585 * @hide
1586 */
1587 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001588 ITelecomService service = getTelecomService();
1589 if (service != null) {
1590 try {
1591 if (!TextUtils.isEmpty(packageName)) {
1592 service.clearAccounts(packageName);
1593 }
1594 } catch (RemoteException e) {
1595 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001596 }
Anthony Lee67279262014-10-27 11:28:40 -07001597 }
1598 }
1599
Yorke Lee1011f482015-04-23 15:58:27 -07001600
Anthony Lee67279262014-10-27 11:28:40 -07001601 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001602 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1603 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001604 * @hide
1605 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001606 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001607 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001608 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001609 ITelecomService service = getTelecomService();
1610 if (service != null) {
1611 try {
1612 return service.getDefaultPhoneApp();
1613 } catch (RemoteException e) {
1614 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001615 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001616 }
1617 return null;
1618 }
1619
Santos Cordon9eb45932014-06-27 12:28:43 -07001620 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001621 * Used to determine the currently selected default dialer package.
1622 *
1623 * @return package name for the default dialer package or null if no package has been
1624 * selected as the default dialer.
1625 */
1626 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001627 ITelecomService service = getTelecomService();
1628 if (service != null) {
1629 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001630 return service.getDefaultDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001631 } catch (RemoteException e) {
1632 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001633 }
Yorke Lee1011f482015-04-23 15:58:27 -07001634 }
1635 return null;
1636 }
1637
1638 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001639 * Used to determine the currently selected default dialer package for a specific user.
1640 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001641 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001642 * @return package name for the default dialer package or null if no package has been
1643 * selected as the default dialer.
1644 * @hide
1645 */
1646 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001647 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001648 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001649 ITelecomService service = getTelecomService();
1650 if (service != null) {
1651 try {
1652 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001653 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001654 } catch (RemoteException e) {
1655 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001656 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001657 }
1658 return null;
1659 }
1660
1661 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001662 * Used to set the default dialer package.
1663 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001664 * @param packageName to set the default dialer to, or {@code null} if the system provided
1665 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001666 *
1667 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1668 * the specified package does not correspond to an installed dialer, or is already
1669 * the default dialer.
1670 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001671 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001672 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001673 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1674 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001675 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001676 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001677 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001678 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001679 @RequiresPermission(allOf = {
1680 android.Manifest.permission.MODIFY_PHONE_STATE,
1681 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001682 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001683 ITelecomService service = getTelecomService();
1684 if (service != null) {
1685 try {
1686 return service.setDefaultDialer(packageName);
1687 } catch (RemoteException e) {
1688 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001689 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001690 }
1691 return false;
1692 }
1693
1694 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001695 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001696 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001697 * @return package name for the system dialer package or {@code null} if no system dialer is
1698 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001699 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001700 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001701 ITelecomService service = getTelecomService();
1702 if (service != null) {
1703 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001704 return service.getSystemDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001705 } catch (RemoteException e) {
1706 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001707 }
Yorke Lee1011f482015-04-23 15:58:27 -07001708 }
1709 return null;
1710 }
1711
1712 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001713 * Return whether a given phone number is the configured voicemail number for a
1714 * particular phone account.
1715 *
1716 * @param accountHandle The handle for the account to check the voicemail number against
1717 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001718 */
Yorke Leec61d13662015-09-21 17:25:25 -07001719 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001720 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001721 ITelecomService service = getTelecomService();
1722 if (service != null) {
1723 try {
1724 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001725 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001726 } catch (RemoteException e) {
1727 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001728 }
Nancy Chen443e5012014-10-15 15:48:21 -07001729 }
1730 return false;
1731 }
1732
1733 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001734 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001735 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001736 * @param accountHandle The handle for the phone account.
1737 * @return The voicemail number for the phone account, and {@code null} if one has not been
1738 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001739 */
Yorke Leec61d13662015-09-21 17:25:25 -07001740 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001741 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001742 ITelecomService service = getTelecomService();
1743 if (service != null) {
1744 try {
1745 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001746 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001747 } catch (RemoteException e) {
1748 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001749 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001750 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001751 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001752 }
1753
1754 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001755 * Return the line 1 phone number for given phone account.
1756 *
Michael Groover08490f12020-03-24 14:08:14 -07001757 * <p>Requires Permission:
1758 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1759 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1760 * or that the caller is the default SMS app for any API level.
1761 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1762 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001763 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001764 * @param accountHandle The handle for the account retrieve a number for.
1765 * @return A string representation of the line 1 phone number.
Meng Wang8665b512021-11-18 15:13:43 -08001766 * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1767 * Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1768 * from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
Nancy Chen5cf27842015-01-24 23:30:27 -08001769 */
Meng Wang8665b512021-11-18 15:13:43 -08001770 @Deprecated
Michael Groover08490f12020-03-24 14:08:14 -07001771 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1772 @RequiresPermission(anyOf = {
1773 android.Manifest.permission.READ_PHONE_STATE,
1774 android.Manifest.permission.READ_SMS,
1775 android.Manifest.permission.READ_PHONE_NUMBERS
1776 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001777 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001778 ITelecomService service = getTelecomService();
1779 if (service != null) {
1780 try {
1781 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001782 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001783 } catch (RemoteException e) {
1784 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001785 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001786 }
1787 return null;
1788 }
1789
1790 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001791 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001792 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001793 *
1794 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1795 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001796 */
Yorke Leec61d13662015-09-21 17:25:25 -07001797 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001798 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001799 ITelecomService service = getTelecomService();
1800 if (service != null) {
1801 try {
1802 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001803 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001804 } catch (RemoteException e) {
1805 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001806 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001807 }
1808 return false;
1809 }
1810
1811 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001812 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1813 * permission. The permission can be obtained by associating with a physical wearable device
1814 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1815 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001816 *
1817 * @return {@code true} if the caller has {@link InCallService} access for
1818 * companion app; {@code false} otherwise.
1819 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001820 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001821 ITelecomService service = getTelecomService();
1822 if (service != null) {
1823 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001824 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001825 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001826 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001827 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001828 if (!isSystemProcess()) {
1829 e.rethrowAsRuntimeException();
1830 }
Shuo Qian4d065262020-10-20 11:04:28 -07001831 }
1832 }
1833 return false;
1834 }
1835
1836 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001837 * Returns whether there is an ongoing call originating from a managed
1838 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1839 * states.
1840 * <p>
1841 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1842 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001843 *
1844 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1845 * {@code false} otherwise.
1846 */
1847 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1848 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001849 ITelecomService service = getTelecomService();
1850 if (service != null) {
1851 try {
1852 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001853 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001854 } catch (RemoteException e) {
1855 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001856 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001857 }
1858 return false;
1859 }
1860
1861 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001862 * Returns one of the following constants that represents the current state of Telecom:
1863 *
1864 * {@link TelephonyManager#CALL_STATE_RINGING}
1865 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1866 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001867 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001868 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001869 * <p>
1870 * Requires Permission:
1871 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1872 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001873 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001874 * @hide
1875 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001876 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1877 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001878 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001879 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001880 ITelecomService service = getTelecomService();
1881 if (service != null) {
1882 try {
Thomas Stuartde1f1f22022-11-16 22:17:42 +00001883 return service.getCallStateUsingPackage(mContext.getOpPackageName(),
Brad Ebingera8366ae2021-03-23 21:01:51 +00001884 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001885 } catch (RemoteException e) {
1886 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001887 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001888 }
1889 return TelephonyManager.CALL_STATE_IDLE;
1890 }
1891
1892 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001893 * Returns whether there currently exists is a ringing incoming-call.
1894 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001895 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001896 * @hide
1897 */
1898 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001899 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001900 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001901 android.Manifest.permission.READ_PHONE_STATE
1902 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001903 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001904 ITelecomService service = getTelecomService();
1905 if (service != null) {
1906 try {
1907 return service.isRinging(mContext.getOpPackageName());
1908 } catch (RemoteException e) {
1909 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001910 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001911 }
1912 return false;
1913 }
1914
1915 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001916 * Ends the foreground call on the device.
1917 * <p>
1918 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1919 * foreground call is ended.
1920 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001921 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1922 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001923 *
1924 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1925 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001926 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1927 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1928 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001929 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001930 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001931 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001932 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001933 ITelecomService service = getTelecomService();
1934 if (service != null) {
1935 try {
1936 return service.endCall(mContext.getPackageName());
1937 } catch (RemoteException e) {
1938 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001939 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001940 }
1941 return false;
1942 }
1943
1944 /**
1945 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001946 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001947 * If the incoming call is a video call, the call will be answered with the same video state as
1948 * the incoming call requests. This means, for example, that an incoming call requesting
1949 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001950 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001951 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1952 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001953 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001954 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1955 // this method (clockwork & gearhead).
1956 @RequiresPermission(anyOf =
1957 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001958 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001959 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001960 ITelecomService service = getTelecomService();
1961 if (service != null) {
1962 try {
1963 service.acceptRingingCall(mContext.getPackageName());
1964 } catch (RemoteException e) {
1965 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001966 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001967 }
1968 }
1969
1970 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001971 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1972 * with the specified video state.
1973 *
1974 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001975 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1976 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001977 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001978 @RequiresPermission(anyOf =
1979 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001980 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07001981 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001982 ITelecomService service = getTelecomService();
1983 if (service != null) {
1984 try {
1985 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001986 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001987 } catch (RemoteException e) {
1988 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001989 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07001990 }
1991 }
1992
1993 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001994 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07001995 * <p>
1996 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
1997 * already started playing. It is intended to handle use-cases such as silencing a ringing call
1998 * when the user presses the volume button during ringing.
1999 * <p>
2000 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
2001 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
2002 * <p>
2003 * A dialer app which wants to have more control over ringtone playing should declare
2004 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
2005 * {@link InCallService} implementation to indicate that the app wants to be responsible for
2006 * playing the ringtone for all incoming calls.
2007 * <p>
2008 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
2009 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07002010 */
Yorke Leec61d13662015-09-21 17:25:25 -07002011 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07002012 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002013 ITelecomService service = getTelecomService();
2014 if (service != null) {
2015 try {
2016 service.silenceRinger(mContext.getOpPackageName());
2017 } catch (RemoteException e) {
2018 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002019 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002020 }
2021 }
2022
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002023 /**
2024 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002025 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002026 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07002027 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002028 android.Manifest.permission.READ_PHONE_STATE
2029 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002030 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002031 ITelecomService service = getTelecomService();
2032 if (service != null) {
2033 try {
2034 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002035 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002036 } catch (RemoteException e) {
2037 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002038 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002039 }
2040 return false;
2041 }
2042
2043 /**
2044 * 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 -07002045 * settings and have a wired headset plugged in.
2046 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002047 * - {@link TelecomManager#TTY_MODE_OFF}
2048 * - {@link TelecomManager#TTY_MODE_FULL}
2049 * - {@link TelecomManager#TTY_MODE_HCO}
2050 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002051 * @hide
2052 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002053 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07002054 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002055 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002056 ITelecomService service = getTelecomService();
2057 if (service != null) {
2058 try {
2059 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002060 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002061 } catch (RemoteException e) {
2062 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002063 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002064 }
Evan Charlton10197192014-07-19 15:00:29 -07002065 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002066 }
2067
Santos Cordon96efb482014-07-19 14:57:05 -07002068 /**
2069 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08002070 * has an incoming call. For managed {@link ConnectionService}s, the specified
2071 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2072 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2073 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2074 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2075 * <p>
Tyler Gunnd8778662023-02-10 17:13:11 +00002076 * Specify the address associated with the incoming call using
2077 * {@link #EXTRA_INCOMING_CALL_ADDRESS}. If an incoming call is from an anonymous source, omit
2078 * this extra and ensure you specify a valid number presentation via
2079 * {@link Connection#setAddress(Uri, int)} on the {@link Connection} instance you return in
2080 * your
2081 * {@link ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)}
2082 * implementation.
2083 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002084 * The incoming call you are adding is assumed to have a video state of
2085 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2086 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2087 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002088 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2089 * associated with the {@link PhoneAccountHandle} and request additional information about the
2090 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002091 * call UI.
2092 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002093 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2094 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2095 * the associated {@link PhoneAccount} is not currently enabled by the user.
2096 * <p>
2097 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2098 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2099 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002100 * <p>
2101 * <p>
2102 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2103 * the call is added to Telecom in order for the notification to be non-dismissible.
Santos Cordon96efb482014-07-19 14:57:05 -07002104 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2105 * {@link #registerPhoneAccount}.
2106 * @param extras A bundle that will be passed through to
2107 * {@link ConnectionService#onCreateIncomingConnection}.
2108 */
2109 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002110 ITelecomService service = getTelecomService();
2111 if (service != null) {
2112 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002113 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2114 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2115 Build.VERSION_CODES.O_MR1) {
2116 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2117 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002118 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002119 }
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002120 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras,
2121 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002122 } catch (RemoteException e) {
2123 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002124 }
Santos Cordon96efb482014-07-19 14:57:05 -07002125 }
2126 }
2127
Nancy Chen0eb1e402014-08-21 22:52:29 -07002128 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302129 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002130 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2131 * call initiated on another device which the user is being invited to join in. For managed
2132 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2133 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2134 * corresponding {@link PhoneAccount}. This can be checked using
2135 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2136 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302137 * <p>
2138 * The incoming conference you are adding is assumed to have a video state of
2139 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2140 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2141 * <p>
2142 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2143 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002144 * call (See
2145 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2146 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302147 * <p>
2148 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2149 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2150 * the associated {@link PhoneAccount} is not currently enabled by the user.
2151 *
2152 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2153 * {@link #registerPhoneAccount}.
2154 * @param extras A bundle that will be passed through to
2155 * {@link ConnectionService#onCreateIncomingConference}.
2156 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302157 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2158 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002159 ITelecomService service = getTelecomService();
2160 if (service != null) {
2161 try {
2162 service.addNewIncomingConference(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002163 phoneAccount, extras == null ? new Bundle() : extras,
2164 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002165 } catch (RemoteException e) {
2166 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302167 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302168 }
2169 }
2170
2171 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002172 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2173 * service. This is invoked when Telephony detects a new unknown connection that was neither
2174 * a new incoming call, nor an user-initiated outgoing call.
2175 *
2176 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2177 * {@link #registerPhoneAccount}.
2178 * @param extras A bundle that will be passed through to
2179 * {@link ConnectionService#onCreateIncomingConnection}.
2180 * @hide
2181 */
2182 @SystemApi
2183 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002184 ITelecomService service = getTelecomService();
2185 if (service != null) {
2186 try {
2187 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002188 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002189 } catch (RemoteException e) {
2190 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002191 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002192 }
2193 }
2194
2195 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002196 * Processes the specified dial string as an MMI code.
2197 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2198 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002199 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002200 * <p>
2201 * Requires that the method-caller be set as the system dialer app.
2202 * </p>
2203 *
2204 * @param dialString The digits to dial.
2205 * @return True if the digits were processed as an MMI code, false otherwise.
2206 */
Yorke Leec61d13662015-09-21 17:25:25 -07002207 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002208 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002209 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002210 if (service != null) {
2211 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002212 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002213 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002214 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002215 }
2216 }
2217 return false;
2218 }
2219
2220 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002221 * Processes the specified dial string as an MMI code.
2222 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2223 * Some of these sequences launch special behavior through handled by Telephony.
2224 * <p>
2225 * Requires that the method-caller be set as the system dialer app.
2226 * </p>
2227 *
2228 * @param accountHandle The handle for the account the MMI code should apply to.
2229 * @param dialString The digits to dial.
2230 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002231 */
Yorke Leec61d13662015-09-21 17:25:25 -07002232 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002233 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002234 ITelecomService service = getTelecomService();
2235 if (service != null) {
2236 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002237 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2238 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002239 } catch (RemoteException e) {
2240 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2241 }
2242 }
2243 return false;
2244 }
2245
2246 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002247 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2248 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002249 * @param accountHandle The handle for the account to derive an adn query URI for or
2250 * {@code null} to return a URI which will use the default account.
2251 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2252 * for the the content retrieve.
2253 */
Yorke Leec61d13662015-09-21 17:25:25 -07002254 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002255 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2256 ITelecomService service = getTelecomService();
2257 if (service != null && accountHandle != null) {
2258 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002259 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002260 } catch (RemoteException e) {
2261 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2262 }
2263 }
2264 return Uri.parse("content://icc/adn");
2265 }
2266
2267 /**
Tyler Gunna2879412023-02-28 23:41:53 +00002268 * Removes the missed-call notification if one is present and marks missed calls in the call
2269 * log as read.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002270 * <p>
Tyler Gunna2879412023-02-28 23:41:53 +00002271 * Requires that the method-caller be set as the default dialer app.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002272 * </p>
2273 */
Yorke Leec61d13662015-09-21 17:25:25 -07002274 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002275 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002276 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002277 if (service != null) {
2278 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002279 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002280 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002281 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002282 }
2283 }
2284 }
2285
2286 /**
2287 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2288 * currently no ongoing call, then this method does nothing.
2289 * <p>
2290 * Requires that the method-caller be set as the system dialer app or have the
2291 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2292 * </p>
2293 *
2294 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2295 */
Yorke Leec61d13662015-09-21 17:25:25 -07002296 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002297 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002298 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002299 if (service != null) {
2300 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002301 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002302 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002303 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002304 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002305 }
2306 }
2307 }
2308
Yorke Lee3e56ba12015-04-23 12:32:36 -07002309 /**
2310 * Places a new outgoing call to the provided address using the system telecom service with
2311 * the specified extras.
2312 *
2313 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2314 * except that the outgoing call will always be sent via the system telecom service. If
2315 * method-caller is either the user selected default dialer app or preloaded system dialer
2316 * app, then emergency calls will also be allowed.
2317 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002318 * Placing a call via a managed {@link ConnectionService} requires permission:
2319 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002320 *
2321 * Usage example:
2322 * <pre>
2323 * Uri uri = Uri.fromParts("tel", "12345", null);
2324 * Bundle extras = new Bundle();
2325 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2326 * telecomManager.placeCall(uri, extras);
2327 * </pre>
2328 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002329 * The following keys are supported in the supplied extras.
2330 * <ul>
2331 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2332 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2333 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2334 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2335 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002336 * <p>
2337 * An app which implements the self-managed {@link ConnectionService} API uses
2338 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2339 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2340 * associated {@link android.telecom.PhoneAccountHandle}.
2341 *
2342 * Self-managed {@link ConnectionService}s require permission
2343 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002344 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002345 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2346 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2347 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2348 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2349 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2350 * </p>
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002351 * <p>
2352 * <p>
2353 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2354 * the call is placed in order for the notification to be non-dismissible.
Yorke Lee3e56ba12015-04-23 12:32:36 -07002355 * @param address The address to make the call to.
2356 * @param extras Bundle of extras to use with the call.
2357 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002358 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2359 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002360 public void placeCall(Uri address, Bundle extras) {
2361 ITelecomService service = getTelecomService();
2362 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002363 if (address == null) {
2364 Log.w(TAG, "Cannot place call to empty address.");
2365 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002366 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002367 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002368 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002369 } catch (RemoteException e) {
2370 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2371 }
2372 }
2373 }
2374
Ravi Paluri80aa2142019-12-02 11:57:37 +05302375
2376 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002377 * Place a new adhoc conference call with the provided participants using the system telecom
2378 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302379 *
2380 * An adhoc conference call is established by providing a list of addresses to
2381 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2382 * {@link ConnectionService} is responsible for connecting all indicated participants
2383 * to a conference simultaneously.
2384 * This is in contrast to conferences formed by merging calls together (e.g. using
2385 * {@link android.telecom.Call#mergeConference()}).
2386 *
2387 * The following keys are supported in the supplied extras.
2388 * <ul>
2389 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2390 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2391 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2392 * </ul>
2393 *
2394 * @param participants List of participants to start conference with
2395 * @param extras Bundle of extras to use with the call
2396 */
2397 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2398 public void startConference(@NonNull List<Uri> participants,
2399 @NonNull Bundle extras) {
2400 ITelecomService service = getTelecomService();
2401 if (service != null) {
2402 try {
2403 service.startConference(participants, extras,
2404 mContext.getOpPackageName());
2405 } catch (RemoteException e) {
2406 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2407 }
2408 }
2409 }
2410
Santos Cordon91371dc02015-05-08 13:52:09 -07002411 /**
2412 * Enables and disables specified phone account.
2413 *
2414 * @param handle Handle to the phone account.
2415 * @param isEnabled Enable state of the phone account.
2416 * @hide
2417 */
2418 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002419 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002420 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2421 ITelecomService service = getTelecomService();
2422 if (service != null) {
2423 try {
2424 service.enablePhoneAccount(handle, isEnabled);
2425 } catch (RemoteException e) {
2426 Log.e(TAG, "Error enablePhoneAbbount", e);
2427 }
2428 }
2429 }
2430
Hall Liu0464b9b2016-01-12 15:32:58 -08002431 /**
2432 * Dumps telecom analytics for uploading.
2433 *
2434 * @return
2435 * @hide
2436 */
2437 @SystemApi
2438 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002439 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002440 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002441 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002442 if (service != null) {
2443 try {
2444 result = service.dumpCallAnalytics();
2445 } catch (RemoteException e) {
2446 Log.e(TAG, "Error dumping call analytics", e);
2447 }
2448 }
2449 return result;
2450 }
2451
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002452 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002453 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2454 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002455 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002456 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2457 * {@code true} for the current user.
2458 */
2459 public Intent createManageBlockedNumbersIntent() {
2460 ITelecomService service = getTelecomService();
2461 Intent result = null;
2462 if (service != null) {
2463 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002464 result = service.createManageBlockedNumbersIntent(mContext.getPackageName());
Nan Wuc51fd762022-08-01 21:08:23 +00002465 if (result != null) {
2466 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2467 mContext.getAttributionSource());
2468 }
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002469 } catch (RemoteException e) {
2470 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2471 }
2472 }
2473 return result;
2474 }
2475
Fan Zhang5431ef52019-10-14 13:43:46 -07002476
2477 /**
2478 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2479 * launch the activity for emergency dialer.
2480 *
2481 * @param number Optional number to call in emergency dialer
2482 * @hide
2483 */
2484 @SystemApi
2485 @NonNull
2486 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2487 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002488 if (service != null) {
2489 try {
Nan Wuc51fd762022-08-01 21:08:23 +00002490 Intent result = service.createLaunchEmergencyDialerIntent(number);
2491 if (result != null) {
2492 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2493 mContext.getAttributionSource());
2494 }
2495 return result;
Fan Zhang5431ef52019-10-14 13:43:46 -07002496 } catch (RemoteException e) {
2497 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2498 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002499 } else {
2500 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002501 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002502
2503 // Telecom service knows the package name of the expected emergency dialer package; if it
2504 // is not available, then fallback to not targeting a specific package.
2505 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2506 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2507 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2508 }
2509 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002510 }
2511
Tyler Gunnf5035432017-01-09 09:43:12 -08002512 /**
2513 * Determines whether Telecom would permit an incoming call to be added via the
2514 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2515 * {@link PhoneAccountHandle}.
2516 * <p>
2517 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2518 * in the following situations:
2519 * <ul>
2520 * <li>{@link PhoneAccount} does not have property
2521 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2522 * {@link ConnectionService}), and the active or held call limit has
2523 * been reached.</li>
2524 * <li>There is an ongoing emergency call.</li>
2525 * </ul>
2526 *
2527 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2528 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2529 * otherwise.
2530 */
2531 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002532 if (phoneAccountHandle == null) {
2533 return false;
2534 }
2535
Tyler Gunnf5035432017-01-09 09:43:12 -08002536 ITelecomService service = getTelecomService();
2537 if (service != null) {
2538 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002539 return service.isIncomingCallPermitted(phoneAccountHandle,
2540 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002541 } catch (RemoteException e) {
2542 Log.e(TAG, "Error isIncomingCallPermitted", e);
2543 }
2544 }
2545 return false;
2546 }
2547
2548 /**
2549 * Determines whether Telecom would permit an outgoing call to be placed via the
2550 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2551 * <p>
2552 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2553 * in the following situations:
2554 * <ul>
2555 * <li>{@link PhoneAccount} does not have property
2556 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2557 * {@link ConnectionService}), and the active, held or ringing call limit has
2558 * been reached.</li>
2559 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2560 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2561 * another {@link ConnectionService}.</li>
2562 * <li>There is an ongoing emergency call.</li>
2563 * </ul>
2564 *
2565 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2566 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2567 * otherwise.
2568 */
2569 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2570 ITelecomService service = getTelecomService();
2571 if (service != null) {
2572 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002573 return service.isOutgoingCallPermitted(phoneAccountHandle,
2574 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002575 } catch (RemoteException e) {
2576 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2577 }
2578 }
2579 return false;
2580 }
2581
Sanket Padawea8eddd42017-11-03 11:07:35 -07002582 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002583 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2584 * {@link PhoneAccountHandle} it defines.
2585 * <p>
2586 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2587 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2588 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2589 * is referred to as the source of the handover, and the video calling app is referred to as the
2590 * destination.
2591 * <p>
2592 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2593 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2594 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2595 * device.
2596 * <p>
2597 * For a full discussion of the handover process and the APIs involved, see
2598 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2599 * <p>
2600 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2601 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002602 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2603 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2604 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2605 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2606 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2607 * <p>
2608 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2609 * associated with the {@link PhoneAccountHandle} destAcct and call
2610 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2611 * <p>
2612 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2613 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2614 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2615 * user.
2616 * <p>
2617 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2618 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2619 *
2620 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2621 * {@link ConnectionService}.
2622 * @param videoState Video state after the handover.
2623 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2624 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002625 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2626 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002627 ITelecomService service = getTelecomService();
2628 if (service != null) {
2629 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002630 service.acceptHandover(srcAddr, videoState, destAcct, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002631 } catch (RemoteException e) {
2632 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002633 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002634 }
2635 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002636
Tyler Gunn5bd90852018-09-21 09:37:07 -07002637 /**
2638 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2639 * call, as identified by the dialed number, or because a call was identified by the network
2640 * as an emergency call.
2641 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2642 * @hide
2643 */
2644 @SystemApi
2645 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2646 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002647 ITelecomService service = getTelecomService();
2648 if (service != null) {
2649 try {
2650 return service.isInEmergencyCall();
2651 } catch (RemoteException e) {
2652 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2653 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002654 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002655 }
2656 return false;
2657 }
2658
Tyler Gunnc37445c2018-09-28 16:16:20 -07002659 /**
Tyler Gunn27bf4342022-03-25 14:17:52 -07002660 * Determines whether there are any ongoing {@link PhoneAccount#CAPABILITY_SELF_MANAGED}
2661 * calls for a given {@code packageName} and {@code userHandle}.
2662 *
2663 * @param packageName the package name of the app to check calls for.
2664 * @param userHandle the user handle on which to check for calls.
2665 * @return {@code true} if there are ongoing calls, {@code false} otherwise.
2666 * @hide
2667 */
2668 @RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
2669 public boolean isInSelfManagedCall(@NonNull String packageName,
2670 @NonNull UserHandle userHandle) {
2671 ITelecomService service = getTelecomService();
2672 if (service != null) {
2673 try {
2674 return service.isInSelfManagedCall(packageName, userHandle,
2675 mContext.getOpPackageName());
2676 } catch (RemoteException e) {
2677 Log.e(TAG, "RemoteException isInSelfManagedCall: " + e);
2678 e.rethrowFromSystemServer();
2679 return false;
2680 }
2681 } else {
2682 throw new IllegalStateException("Telecom service is not present");
2683 }
2684 }
2685
2686 /**
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002687 * Add a call to the Android system service Telecom. This allows the system to start tracking an
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002688 * incoming or outgoing call with the specified {@link CallAttributes}. Once a call is added,
2689 * a {@link android.app.Notification.CallStyle} notification should be posted and when the
2690 * call is ready to be disconnected, use {@link CallControl#disconnect(DisconnectCause,
2691 * Executor, OutcomeReceiver)} which is provided by the
2692 * {@code pendingControl#onResult(CallControl)}.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002693 * <p>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002694 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002695 * <p>
2696 * <b>Call Lifecycle</b>: Your app is given foreground execution priority as long as you have a
2697 * valid call and are posting a {@link android.app.Notification.CallStyle} notification.
2698 * When your application is given foreground execution priority, your app is treated as a
2699 * foreground service. Foreground execution priority will prevent the
2700 * {@link android.app.ActivityManager} from killing your application when it is placed the
2701 * background. Foreground execution priority is removed from your app when all of your app's
2702 * calls terminate or your app no longer posts a valid notification.
2703 * <p>
2704 * <p>
2705 * <p>
2706 * <b>Note</b>: Only packages that register with
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002707 * {@link PhoneAccount#CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS}
2708 * can utilize this API. {@link PhoneAccount}s that set the capabilities
2709 * {@link PhoneAccount#CAPABILITY_SIM_SUBSCRIPTION},
2710 * {@link PhoneAccount#CAPABILITY_CALL_PROVIDER},
2711 * {@link PhoneAccount#CAPABILITY_CONNECTION_MANAGER}
2712 * are not supported and will cause an exception to be thrown.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002713 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002714 * <p>
2715 * <p>
2716 * <b>Usage example:</b>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002717 * <pre>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002718 * // Its up to your app on how you want to wrap the objects. One such implementation can be:
2719 * class MyVoipCall {
2720 * ...
2721 * public CallControlCallEventCallback handshakes = new CallControlCallback() {
2722 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002723 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002724 *
2725 * public CallEventCallback events = new CallEventCallback() {
2726 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002727 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002728 *
2729 * public MyVoipCall(String id){
2730 * ...
2731 * }
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002732 * }
2733 *
Thomas Stuart6e418b32023-02-06 08:22:08 -08002734 * MyVoipCall myFirstOutgoingCall = new MyVoipCall("1");
2735 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002736 * telecomManager.addCall(callAttributes,
2737 * Runnable::run,
2738 * new OutcomeReceiver() {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002739 * public void onResult(CallControl callControl) {
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002740 * // The call has been added successfully. For demonstration
2741 * // purposes, the call is disconnected immediately ...
2742 * callControl.disconnect(
2743 * new DisconnectCause(DisconnectCause.LOCAL) )
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002744 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002745 * },
2746 * myFirstOutgoingCall.handshakes,
2747 * myFirstOutgoingCall.events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002748 * </pre>
2749 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002750 * @param callAttributes attributes of the new call (incoming or outgoing, address, etc.)
2751 * @param executor execution context to run {@link CallControlCallback} updates on
2752 * @param pendingControl Receives the result of addCall transaction. Upon success, a
2753 * CallControl object is provided which can be used to do things like
2754 * disconnect the call that was added.
2755 * @param handshakes callback that receives <b>actionable</b> updates that originate from
2756 * Telecom.
2757 * @param events callback that receives <b>non</b>-actionable updates that originate
2758 * from Telecom.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002759 */
2760 @RequiresPermission(android.Manifest.permission.MANAGE_OWN_CALLS)
2761 @SuppressLint("SamShouldBeLast")
2762 public void addCall(@NonNull CallAttributes callAttributes,
2763 @NonNull @CallbackExecutor Executor executor,
2764 @NonNull OutcomeReceiver<CallControl, CallException> pendingControl,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002765 @NonNull CallControlCallback handshakes,
2766 @NonNull CallEventCallback events) {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002767 Objects.requireNonNull(callAttributes);
2768 Objects.requireNonNull(executor);
2769 Objects.requireNonNull(pendingControl);
Thomas Stuart6e418b32023-02-06 08:22:08 -08002770 Objects.requireNonNull(handshakes);
2771 Objects.requireNonNull(events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002772
2773 ITelecomService service = getTelecomService();
2774 if (service != null) {
2775 try {
2776 // create or add the new call to a service wrapper w/ the same phoneAccountHandle
2777 ClientTransactionalServiceWrapper transactionalServiceWrapper =
2778 mTransactionalServiceRepository.addNewCallForTransactionalServiceWrapper(
2779 callAttributes.getPhoneAccountHandle());
2780
2781 // couple all the args passed by the client
2782 String newCallId = transactionalServiceWrapper.trackCall(callAttributes, executor,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002783 pendingControl, handshakes, events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002784
2785 // send args to server to process new call
2786 service.addCall(callAttributes, transactionalServiceWrapper.getCallEventCallback(),
2787 newCallId, mContext.getOpPackageName());
2788 } catch (RemoteException e) {
2789 Log.e(TAG, "RemoteException addCall: " + e);
2790 e.rethrowFromSystemServer();
2791 }
2792 } else {
2793 throw new IllegalStateException("Telecom service is not present");
2794 }
2795 }
2796
2797 /**
Tyler Gunnc37445c2018-09-28 16:16:20 -07002798 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2799 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002800 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002801 * @hide
2802 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002803 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002804 ITelecomService service = getTelecomService();
2805 if (service != null) {
2806 try {
2807 service.handleCallIntent(intent, callingPackageProxy);
2808 } catch (RemoteException e) {
2809 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002810 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002811 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002812 }
2813
Shuo Qian4d065262020-10-20 11:04:28 -07002814 private boolean isSystemProcess() {
2815 return Process.myUid() == Process.SYSTEM_UID;
2816 }
2817
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002818 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002819 if (mTelecomServiceOverride != null) {
2820 return mTelecomServiceOverride;
2821 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002822 if (sTelecomService == null) {
2823 ITelecomService temp = ITelecomService.Stub.asInterface(
2824 ServiceManager.getService(Context.TELECOM_SERVICE));
2825 synchronized (CACHE_LOCK) {
2826 if (sTelecomService == null && temp != null) {
2827 try {
2828 sTelecomService = temp;
2829 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2830 } catch (Exception e) {
2831 sTelecomService = null;
2832 }
2833 }
2834 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002835 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002836 return sTelecomService;
2837 }
2838
2839 private static class DeathRecipient implements IBinder.DeathRecipient {
2840 @Override
2841 public void binderDied() {
2842 resetServiceCache();
2843 }
2844 }
2845
2846 private static void resetServiceCache() {
2847 synchronized (CACHE_LOCK) {
2848 if (sTelecomService != null) {
2849 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2850 sTelecomService = null;
2851 }
2852 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002853 }
Evan Charlton235c1592014-09-05 15:41:23 +00002854}