blob: b167f1bdfe20a65b68e376190f7b81286bbe6587 [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;
Kunduz Baryktabasovae2484c02023-10-02 10:46:49 +000022import android.annotation.FlaggedApi;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080023import android.annotation.IntDef;
Fan Zhang5431ef52019-10-14 13:43:46 -070024import android.annotation.NonNull;
Slava Shklyaeve65e4012019-03-04 16:02:34 +000025import android.annotation.Nullable;
Hui Wangc47df7f2021-12-14 20:37:47 +000026import android.annotation.RequiresFeature;
Yorke Leec61d13662015-09-21 17:25:25 -070027import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060028import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060029import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070030import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060031import android.annotation.SystemService;
Brad Ebingera8366ae2021-03-23 21:01:51 +000032import android.compat.annotation.ChangeId;
33import android.compat.annotation.EnabledSince;
Artur Satayev2ebb31c2020-01-08 12:24:36 +000034import android.compat.annotation.UnsupportedAppUsage;
Santos Cordon6c7a3882014-06-25 15:30:08 -070035import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070036import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070037import android.content.Intent;
Hui Wangc47df7f2021-12-14 20:37:47 +000038import android.content.pm.PackageManager;
Nancy Chenb2299c12014-10-29 18:22:11 -070039import android.net.Uri;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -080040import android.os.Build;
Santos Cordon96efb482014-07-19 14:57:05 -070041import android.os.Bundle;
Kevin Jeon767cda32020-11-17 01:40:16 +000042import android.os.IBinder;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070043import android.os.OutcomeReceiver;
Shuo Qian4d065262020-10-20 11:04:28 -070044import android.os.Process;
Santos Cordon6c7a3882014-06-25 15:30:08 -070045import android.os.RemoteException;
46import android.os.ServiceManager;
Tyler Gunn7e45b722018-12-04 12:56:45 -080047import android.os.UserHandle;
Chen Xuc9d4ee12019-09-26 16:11:59 -070048import android.telephony.Annotation.CallState;
Brad Ebingere7833312019-05-07 10:55:55 -070049import android.telephony.SubscriptionManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070050import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070051import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070052import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070053
Kevin Jeon767cda32020-11-17 01:40:16 +000054import com.android.internal.annotations.GuardedBy;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070055import com.android.internal.telecom.ClientTransactionalServiceRepository;
56import com.android.internal.telecom.ClientTransactionalServiceWrapper;
Tyler Gunnef9f6f92014-09-12 22:16:17 -070057import com.android.internal.telecom.ITelecomService;
Kunduz Baryktabasovae2484c02023-10-02 10:46:49 +000058import com.android.server.telecom.flags.Flags;
Yorke Leeb4ce1432014-06-09 13:53:23 -070059
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080060import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
Jay Shrauner7746a942014-08-26 12:15:15 -070062import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070063import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070064import java.util.List;
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -080065import java.util.Objects;
Tyler Gunn7e45b722018-12-04 12:56:45 -080066import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070067
Yorke Leeb4ce1432014-06-09 13:53:23 -070068/**
Santos Cordond9e614f2014-10-28 13:10:36 -070069 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080070 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070071 * <p>
72 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
73 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
74 * <p>
75 * Note that access to some telecom information is permission-protected. Your app cannot access the
76 * protected information or gain access to protected functionality unless it has the appropriate
77 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
78 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070079 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060080@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060081@SystemService(Context.TELECOM_SERVICE)
Hui Wangc47df7f2021-12-14 20:37:47 +000082@RequiresFeature(PackageManager.FEATURE_TELECOM)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070083public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070084
Evan Charlton10197192014-07-19 15:00:29 -070085 /**
Santos Cordon96efb482014-07-19 14:57:05 -070086 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070087 * UI by notifying the Telecom system that an incoming call exists for a specific call service
88 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
89 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070090 * ultimately use to control and get information about the call.
91 * <p>
92 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070093 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070094 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080095 *
96 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070097 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070098 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070099
100 /**
Yorke Leec3cf9822014-10-02 09:38:39 -0700101 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
102 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -0800103 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -0700104 * @hide
105 */
106 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
107
108 /**
Santos Cordon895d4b82015-06-25 16:41:48 -0700109 * An {@link android.content.Intent} action sent by the telecom framework to start a
110 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
111 * and each app that registers a {@link PhoneAccount} should provide one if desired.
112 * <p>
113 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
114 * app's settings menu. For each entry, the settings app will add a click action. When
115 * triggered, the click-action will start this intent along with the extra
116 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
117 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
118 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700119 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700120 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
121 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700122
123 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800124 * The {@link android.content.Intent} action used to show the call accessibility settings page.
125 */
126 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
127 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
128
129 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700130 * The {@link android.content.Intent} action used to show the call settings page.
131 */
132 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700133 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700134
135 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800136 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
137 */
138 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
139 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
140
141 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700142 * The {@link android.content.Intent} action used to show the settings page used to configure
143 * {@link PhoneAccount} preferences.
144 */
145 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700146 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700147
148 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700149 * {@link android.content.Intent} action used indicate that a new phone account was just
150 * registered.
151 * <p>
152 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
153 * to indicate which {@link PhoneAccount} was registered.
154 * <p>
155 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800156 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800157 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
158 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
159
160 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700161 * {@link android.content.Intent} action used indicate that a phone account was just
162 * unregistered.
163 * <p>
164 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
165 * to indicate which {@link PhoneAccount} was unregistered.
166 * <p>
167 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700168 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700169 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
170 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
171
172 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700173 * Activity action: Shows a dialog asking the user whether or not they want to replace the
174 * current default Dialer with the one specified in
175 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
176 *
177 * Usage example:
178 * <pre>
179 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
180 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
181 * getActivity().getPackageName());
182 * startActivity(intent);
183 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800184 * <p>
185 * This is no longer supported since Q, please use
186 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
187 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700188 */
189 public static final String ACTION_CHANGE_DEFAULT_DIALER =
190 "android.telecom.action.CHANGE_DEFAULT_DIALER";
191
192 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700193 * Broadcast intent action indicating that the current default dialer has changed.
194 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
195 * name of the package that the default dialer was changed to.
196 *
197 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
198 */
199 public static final String ACTION_DEFAULT_DIALER_CHANGED =
200 "android.telecom.action.DEFAULT_DIALER_CHANGED";
201
202 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700203 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
204 */
205 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
206 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
207
208 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800209 * Broadcast intent action indicating that the current default call screening app has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700210 * <p>
211 * Note: This intent is NEVER actually broadcast and will be deprecated in the future.
212 * <p>
213 * An app that want to know if it holds the
214 * {@link android.app.role.RoleManager#ROLE_CALL_SCREENING} role can use
215 * {@link android.app.role.RoleManager#isRoleHeld(String)} to confirm if it holds the role or
216 * not.
tonyzhuff60f5e2018-10-01 19:14:59 +0800217 */
218 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
219 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
220
221 /**
222 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
223 * indicate the ComponentName of the call screening app which has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700224 * <p>
225 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800226 */
227 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
228 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
229
230 /**
Rana Mouawice746772023-08-23 09:27:18 +0000231 * Optional extra to indicate a call should not be added to the call log.
232 *
233 * @hide
234 */
235 public static final String EXTRA_DO_NOT_LOG_CALL =
236 "android.telecom.extra.DO_NOT_LOG_CALL";
237
238 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800239 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
240 * indicate whether an app is the default call screening app.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700241 * <p>
242 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800243 */
244 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
245 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
246
247 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700248 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
249 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700250 */
251 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700252 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700253
254 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700255 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
256 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700257 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700258 * {@link VideoProfile#STATE_AUDIO_ONLY},
259 * {@link VideoProfile#STATE_BIDIRECTIONAL},
260 * {@link VideoProfile#STATE_RX_ENABLED},
261 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700262 */
263 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700264 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700265
266 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700267 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
268 * integer that determines the requested video state for an incoming call.
269 * Valid options:
270 * {@link VideoProfile#STATE_AUDIO_ONLY},
271 * {@link VideoProfile#STATE_BIDIRECTIONAL},
272 * {@link VideoProfile#STATE_RX_ENABLED},
273 * {@link VideoProfile#STATE_TX_ENABLED}.
274 */
275 public static final String EXTRA_INCOMING_VIDEO_STATE =
276 "android.telecom.extra.INCOMING_VIDEO_STATE";
277
278 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700279 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
280 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
281 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700282 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700283 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700284 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700285 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700286 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700287
288 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700289 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
290 * subject which will be associated with an outgoing call. Should only be specified if the
Shuo Qian3ed38832020-11-30 21:54:36 -0800291 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
292 * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700293 */
294 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
295
Shuo Qian3ed38832020-11-30 21:54:36 -0800296 // Values for EXTRA_PRIORITY
297 /**
298 * Indicates the call composer call priority is normal.
299 *
300 * Reference: RCC.20 Section 2.4.4.2
301 */
302 public static final int PRIORITY_NORMAL = 0;
303
304 /**
305 * Indicates the call composer call priority is urgent.
306 *
307 * Reference: RCC.20 Section 2.4.4.2
308 */
309 public static final int PRIORITY_URGENT = 1;
310
311 /**
312 * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
313 * {@link #PRIORITY_URGENT}.
314 *
315 * Reference: RCC.20 Section 2.4.4.2
316 */
317 public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
318
319 /**
320 * Extra for the call composer call location, an {@link android.location.Location} parcelable
321 * class to represent the geolocation as a latitude and longitude pair.
322 *
323 * Reference: RCC.20 Section 2.4.3.2
324 */
325 public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
326
327 /**
328 * A boolean extra set on incoming calls to indicate that the call has a picture specified.
329 * Given that image download could take a (short) time, the EXTRA is set immediately upon
330 * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
331 * if one is expected. The EXTRA may be unset if the image download ends up failing for some
332 * reason.
333 */
334 public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
335
336 /**
Hall Liu48c3c142021-03-11 16:14:22 -0800337 * A {@link Uri} representing the picture that was downloaded when a call is received or
338 * uploaded when a call is placed.
Hall Liu8fee7ea2021-01-21 16:37:51 -0800339 *
Shuo Qian3ed38832020-11-30 21:54:36 -0800340 * This is a content URI within the call log provider which can be used to open a file
341 * 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 -0800342 * download/upload is delayed for some reason. The Dialer app will receive a callback via
Shuo Qian3ed38832020-11-30 21:54:36 -0800343 * {@link Call.Callback#onDetailsChanged} when this value has changed.
344 *
345 * Reference: RCC.20 Section 2.4.3.2
346 */
Hall Liu8fee7ea2021-01-21 16:37:51 -0800347 public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
Shuo Qian3ed38832020-11-30 21:54:36 -0800348
Shuo Qian3ed38832020-11-30 21:54:36 -0800349 /**
350 * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
Hall Liua749abc2021-01-21 10:05:43 -0800351 * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
352 * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
Shuo Qian3ed38832020-11-30 21:54:36 -0800353 */
354 public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
355
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700356 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700357 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
358 * has initiated a new incoming call.
359 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700360 public static final String EXTRA_INCOMING_CALL_ADDRESS =
361 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700362
363 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700364 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
365 * metadata about the call. This {@link Bundle} will be returned to the
366 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700367 */
368 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700369 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700370
371 /**
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800372 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} used to indicate
373 * that a call has an in-band ringtone associated with it. This is used when the device is
374 * acting as an HFP headset and the Bluetooth stack has received an in-band ringtone from the
375 * the HFP host which must be played instead of any local ringtone the device would otherwise
376 * have generated.
377 *
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800378 * @hide
379 */
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800380 @SystemApi
381 public static final String EXTRA_CALL_HAS_IN_BAND_RINGTONE =
382 "android.telecom.extra.CALL_HAS_IN_BAND_RINGTONE";
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800383
384 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700385 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
386 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
387 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700388 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700389 */
390 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700391 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700392
393 /**
sqian6d9e7452019-02-08 21:42:15 -0800394 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
395 * whether the user's dial intent is emergency; this is required to specify when the dialed
396 * number is ambiguous, identified as both emergency number and any other non-emergency number;
397 * e.g. in some situation, 611 could be both an emergency number in a country and a
398 * non-emergency number of a carrier's customer service hotline.
399 *
400 * @hide
401 */
402 @SystemApi
403 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
404 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
405
406 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800407 * A mandatory extra containing a {@link Uri} to be passed in when calling
408 * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
409 * the remote handle of the new call.
Yorke Leec3cf9822014-10-02 09:38:39 -0700410 * @hide
411 */
Hall Liu2ef04112020-09-14 18:34:10 -0700412 @SystemApi
Yorke Leec3cf9822014-10-02 09:38:39 -0700413 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
414 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
415
416 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700417 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
418 * call was created. This value is in milliseconds since boot.
Hall Liudbb17f12020-03-10 18:28:58 -0700419 * @hide
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700420 */
421 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
422 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
423
424 /**
Kunduz Baryktabasovae2484c02023-10-02 10:46:49 +0000425 * The extra for call log uri that was used to mark missed calls as read when dialer gets the
426 * notification on reboot.
427 */
428 @FlaggedApi(Flags.FLAG_ADD_CALL_URI_FOR_MISSED_CALLS)
429 public static final String EXTRA_CALL_LOG_URI =
430 "android.telecom.extra.CALL_LOG_URI";
431
432 /**
qing90c40cf2023-02-22 22:46:00 +0000433 * Optional extra for incoming containing a long which specifies the time the
434 * call was answered by user. This value is in milliseconds.
435 * @hide
436 */
437 public static final String EXTRA_CALL_ANSWERED_TIME_MILLIS =
438 "android.telecom.extra.CALL_ANSWERED_TIME_MILLIS";
439
440
441 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800442 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
443 * time the call was created.
444 * @hide
445 */
446 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
447 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
448
449 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700450 * Optional extra for incoming and outgoing calls containing a long which specifies the time
451 * telecom began routing the call. This value is in milliseconds since boot.
452 * @hide
453 */
454 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
455 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
456
457 /**
458 * Optional extra for incoming and outgoing calls containing a long which specifies the time
459 * telecom finished routing the call. This value is in milliseconds since boot.
460 * @hide
461 */
462 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
463 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
464
465 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700466 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
467 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700468 */
469 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700470 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700471
472 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700473 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
474 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700475 */
476 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700477 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700478
479 /**
radhika0dd90652020-11-04 11:12:51 -0800480 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
481 * lower layers
482 * @hide
483 */
484 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
485 "Call dropped by lower layers";
486
487 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700488 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
489 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800490 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700491 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800492 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700493 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700494 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700495
496 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800497 * Optional extra for communicating the call technology used by a {@link ConnectionService}
498 * to Telecom. Valid values are:
499 * <ul>
500 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
501 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
502 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
503 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
504 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
505 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800506 * @hide
507 */
Hall Liu2ef04112020-09-14 18:34:10 -0700508 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800509 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
510 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
511
512 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800513 * Optional extra for communicating the call network technology used by a
514 * {@link android.telecom.Connection} to Telecom and InCallUI.
515 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700516 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800517 */
518 public static final String EXTRA_CALL_NETWORK_TYPE =
519 "android.telecom.extra.CALL_NETWORK_TYPE";
520
521 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700522 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
523 * package name of the app specifying an alternative gateway for the call.
524 * The value is a string.
525 *
526 * (The following comment corresponds to the all GATEWAY_* extras)
527 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
528 * alternative address to dial which is different from the one specified and displayed to
529 * the user. This alternative address is referred to as the gateway address.
530 */
531 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700532 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700533
534 /**
535 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
536 * original address to dial for the call. This is used when an alternative gateway address is
537 * provided to recall the original address.
538 * The value is a {@link android.net.Uri}.
539 *
540 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
541 */
542 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700543 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700544
545 /**
Evan Charlton10197192014-07-19 15:00:29 -0700546 * The number which the party on the other side of the line will see (and use to return the
547 * call).
548 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700549 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
550 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
551 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700552 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700553 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700554
555 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800556 * The number of milliseconds that Telecom should wait after disconnecting a call via the
557 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
558 * to make a new one.
559 * @hide
560 */
561 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
562 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
563
564 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700565 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700566 * existing call from the user's device to a different {@link PhoneAccount}.
567 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700568 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
569 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
570 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
571 * the receiving side of a handover.
572 * <p>
573 * Used when Telecom calls
574 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
575 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
576 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
577 * occurs on the initiating side of a handover.
578 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700579 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700580 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800581 * @deprecated Use the public handover APIs. See
582 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700583 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800584 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700585 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
586
587 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800588 * When {@code true} indicates that a request to create a new connection is for the purpose of
589 * a handover. Note: This is used with the
590 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
591 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
592 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
593 * @hide
594 */
595 public static final String EXTRA_IS_HANDOVER_CONNECTION =
596 "android.telecom.extra.IS_HANDOVER_CONNECTION";
597
598 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700599 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
600 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
601 * the handover is from.
602 * @hide
603 */
604 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
605 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
606
607 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700608 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
609 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
610 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
611 * {@link Connection} will be.
612 * @hide
613 */
614 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
615
616 /**
Hall Liu95d55872017-01-25 17:12:49 -0800617 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
618 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
619 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
620 */
621 public static final String EXTRA_START_CALL_WITH_RTT =
622 "android.telecom.extra.START_CALL_WITH_RTT";
623
624 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800625 * Start an activity indicating that the completion of an outgoing call or an incoming call
626 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
627 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
628 *
629 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
630 * call which completed.
631 *
632 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
633 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
634 *
635 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
636 * {@link #EXTRA_CALL_DURATION} for more information.
637 */
638 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
639
640 /**
641 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
642 * uri handle(phone number) of the completed call.
643 */
644 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
645
646 /**
647 * A integer value provided for completed calls to indicate the reason for the call
648 * disconnection.
649 * <p>
650 * Allowed values:
651 * <ul>
652 * <li>{@link DisconnectCause#UNKNOWN}</li>
653 * <li>{@link DisconnectCause#LOCAL}</li>
654 * <li>{@link DisconnectCause#REMOTE}</li>
655 * <li>{@link DisconnectCause#REJECTED}</li>
656 * <li>{@link DisconnectCause#MISSED}</li>
657 * </ul>
658 * </p>
659 */
660 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
661
662 /**
663 * A integer value provided for completed calls to indicate the duration of the call.
664 * <p>
665 * Allowed values:
666 * <ul>
667 * <li>{@link #DURATION_VERY_SHORT}</li>
668 * <li>{@link #DURATION_SHORT}</li>
669 * <li>{@link #DURATION_MEDIUM}</li>
670 * <li>{@link #DURATION_LONG}</li>
671 * </ul>
672 * </p>
673 */
674 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
675
676 /**
677 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
678 * call was < 3 seconds.
679 */
680 public static final int DURATION_VERY_SHORT = 0;
681
682 /**
683 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
684 * call was >= 3 seconds and < 60 seconds.
685 */
686 public static final int DURATION_SHORT = 1;
687
688 /**
689 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
690 * call was >= 60 seconds and < 120 seconds.
691 */
692 public static final int DURATION_MEDIUM = 2;
693
694 /**
695 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
696 * call was >= 120 seconds.
697 */
698 public static final int DURATION_LONG = 3;
699
700 /**
701 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
702 * milliseconds.
703 * @hide
704 */
705 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
706
707 /**
708 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
709 * milliseconds.
710 * @hide
711 */
712 public static final long SHORT_CALL_TIME_MS = 60000;
713
714 /**
715 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
716 * milliseconds.
717 * @hide
718 */
719 public static final long MEDIUM_CALL_TIME_MS = 120000;
720
721 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700722 * A boolean meta-data value indicating whether an {@link InCallService} implements an
723 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
724 * would also like to replace the in-call interface should set this meta-data to {@code true} in
725 * the manifest registration of their {@link InCallService}.
726 */
727 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
728
729 /**
Santos Cordon88881552015-12-10 17:29:54 -0800730 * A boolean meta-data value indicating whether an {@link InCallService} implements an
731 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000732 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800733 */
734 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
735 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
736
737 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800738 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
739 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
740 * override the system provided ringing should set this meta-data to {@code true} in the
741 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700742 * <p>
743 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
744 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800745 */
746 public static final String METADATA_IN_CALL_SERVICE_RINGING =
747 "android.telecom.IN_CALL_SERVICE_RINGING";
748
749 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700750 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
751 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
752 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
753 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
754 * informed of external calls should set this meta-data to {@code true} in the manifest
755 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
756 * be informed of external calls.
757 */
758 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
759 "android.telecom.INCLUDE_EXTERNAL_CALLS";
760
761 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800762 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
763 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
764 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
765 * to implement its own call user interface. An {@link InCallService} implementation which
766 * would like to be informed of external calls should set this meta-data to {@code true} in the
767 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
768 * will NOT be informed about self-managed calls.
769 * <p>
770 * An {@link InCallService} which receives self-managed calls is free to view and control the
771 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700772 * exposing these calls to an automotive device via its companion app.
773 * <p>
Tyler Gunn24e18332017-02-10 09:42:49 -0800774 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
775 */
776 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
777 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
778
779 /**
Evan Charlton10197192014-07-19 15:00:29 -0700780 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
781 * pause for a predefined period.
782 */
783 public static final char DTMF_CHARACTER_PAUSE = ',';
784
785 /**
786 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
787 * wait for user confirmation before proceeding.
788 */
789 public static final char DTMF_CHARACTER_WAIT = ';';
790
791 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800792 * @hide
793 */
794 @IntDef(prefix = { "TTY_MODE_" },
795 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
796 @Retention(RetentionPolicy.SOURCE)
797 public @interface TtyMode {}
798
799 /**
Evan Charlton10197192014-07-19 15:00:29 -0700800 * TTY (teletypewriter) mode is off.
801 *
802 * @hide
803 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800804 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700805 public static final int TTY_MODE_OFF = 0;
806
807 /**
808 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
809 * will communicate with the remote party by sending and receiving text messages.
810 *
811 * @hide
812 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800813 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700814 public static final int TTY_MODE_FULL = 1;
815
816 /**
817 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
818 * speaker is on. The user will communicate with the remote party by sending text messages and
819 * hearing an audible reply.
820 *
821 * @hide
822 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800823 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700824 public static final int TTY_MODE_HCO = 2;
825
826 /**
827 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
828 * microphone is still on. User will communicate with the remote party by speaking and receiving
829 * text message replies.
830 *
831 * @hide
832 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800833 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700834 public static final int TTY_MODE_VCO = 3;
835
836 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700837 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700838 *
Hall Liu2ef04112020-09-14 18:34:10 -0700839 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
840 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700841 * @hide
842 */
Hall Liu2ef04112020-09-14 18:34:10 -0700843 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700844 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700845 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700846
847 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700848 * Integer extra key that indicates the current TTY mode.
849 *
850 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
851 *
852 * Valid modes are:
853 * <ul>
854 * <li>{@link #TTY_MODE_OFF}</li>
855 * <li>{@link #TTY_MODE_FULL}</li>
856 * <li>{@link #TTY_MODE_HCO}</li>
857 * <li>{@link #TTY_MODE_VCO}</li>
858 * </ul>
859 *
860 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
861 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
862 * plugged into the device.
863 * @hide
864 */
Hall Liu2ef04112020-09-14 18:34:10 -0700865 @SystemApi
866 public static final String EXTRA_CURRENT_TTY_MODE =
867 "android.telecom.extra.CURRENT_TTY_MODE";
868
869 /**
870 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
871 *
872 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
873 * preferred TTY mode.
874 * @hide
875 */
Hall Liu2ef04112020-09-14 18:34:10 -0700876 @SystemApi
877 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
878 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
879
880 /**
881 * Integer extra key that indicates the preferred TTY mode.
882 *
883 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
884 *
Evan Charlton10197192014-07-19 15:00:29 -0700885 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800886 * <ul>
887 * <li>{@link #TTY_MODE_OFF}</li>
888 * <li>{@link #TTY_MODE_FULL}</li>
889 * <li>{@link #TTY_MODE_HCO}</li>
890 * <li>{@link #TTY_MODE_VCO}</li>
891 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700892 * @hide
893 */
Hall Liu2ef04112020-09-14 18:34:10 -0700894 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700895 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800896 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700897
Nancy Chen9d568c02014-09-08 14:17:59 -0700898 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700899 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800900 * notification. If no custom component exists then this is sent to the default dialer which
901 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700902 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700903 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
904 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
905
906 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800907 * The number of calls associated with the notification. If the number is zero then the missed
908 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700909 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700910 public static final String EXTRA_NOTIFICATION_COUNT =
911 "android.telecom.extra.NOTIFICATION_COUNT";
912
913 /**
914 * The number associated with the missed calls. This number is only relevant
915 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700916 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700917 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
918 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
919
920 /**
Tyler Gunna2879412023-02-28 23:41:53 +0000921 * Included in the extras of the {@link #ACTION_SHOW_MISSED_CALLS_NOTIFICATION}, provides a
922 * pending intent which can be used to clear the missed calls notification and mark unread
923 * missed call log entries as read.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700924 * @hide
Tyler Gunna2879412023-02-28 23:41:53 +0000925 * @deprecated Use {@link #cancelMissedCallsNotification()} instead.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700926 */
Tyler Gunna2879412023-02-28 23:41:53 +0000927 @Deprecated
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700928 @SystemApi
929 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
930 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
931
932 /**
933 * The intent to call back a missed call.
934 * @hide
935 */
936 @SystemApi
937 public static final String EXTRA_CALL_BACK_INTENT =
938 "android.telecom.extra.CALL_BACK_INTENT";
939
940 /**
Charles He858f1322017-11-27 17:11:04 -0800941 * The dialer activity responsible for placing emergency calls from, for example, a locked
942 * keyguard.
943 * @hide
944 */
945 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
946 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
947
948 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800949 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
950 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700951 * <p>
952 * The call initiator can use this extra to indicate that a call used assisted dialing to help
953 * place the call. This is most commonly used by a Dialer app which provides the ability to
954 * automatically add dialing prefixes when placing international calls.
955 * <p>
956 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800957 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
958 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700959 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
960 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
961 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800962 */
963 public static final String EXTRA_USE_ASSISTED_DIALING =
964 "android.telecom.extra.USE_ASSISTED_DIALING";
965
966 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800967 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
968 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800969 * Valid sources are:
970 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
971 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
972 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800973 *
Hall Liu2ef04112020-09-14 18:34:10 -0700974 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800975 * @hide
976 */
Hall Liu2ef04112020-09-14 18:34:10 -0700977 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800978 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
979
980 /**
Ayush Sharma527b5072023-01-06 10:14:43 +0000981 * Intent action to trigger "switch to managed profile" dialog for call in SystemUI
982 *
983 * @hide
984 */
985 public static final String ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG =
986 "android.telecom.action.SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG";
987
988 /**
989 * Extra specifying the managed profile user id.
990 * This is used with {@link TelecomManager#ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG}
991 *
992 * @hide
993 */
994 public static final String EXTRA_MANAGED_PROFILE_USER_ID =
995 "android.telecom.extra.MANAGED_PROFILE_USER_ID";
996
997 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800998 * Indicating the call is initiated via emergency dialer's shortcut button.
999 *
1000 * @hide
1001 */
Hall Liu2ef04112020-09-14 18:34:10 -07001002 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -08001003 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
1004
1005 /**
1006 * Indicating the call is initiated via emergency dialer's dialpad.
1007 *
1008 * @hide
1009 */
Hall Liu2ef04112020-09-14 18:34:10 -07001010 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -08001011 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
1012
1013 /**
1014 * Indicating the call source is not specified.
1015 *
1016 * @hide
1017 */
Hall Liu2ef04112020-09-14 18:34:10 -07001018 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -08001019 public static final int CALL_SOURCE_UNSPECIFIED = 0;
1020
1021 /**
Nancy Chen9d568c02014-09-08 14:17:59 -07001022 * The following 4 constants define how properties such as phone numbers and names are
1023 * displayed to the user.
1024 */
1025
Santos Cordoned769ae2015-05-13 18:47:38 -07001026 /**
1027 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -08001028 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001029 public static final int PRESENTATION_ALLOWED = 1;
1030
Santos Cordoned769ae2015-05-13 18:47:38 -07001031 /**
1032 * Indicates that the address or number of a call is blocked by the other party.
1033 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001034 public static final int PRESENTATION_RESTRICTED = 2;
1035
Santos Cordoned769ae2015-05-13 18:47:38 -07001036 /**
1037 * Indicates that the address or number of a call is not specified or known by the carrier.
1038 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001039 public static final int PRESENTATION_UNKNOWN = 3;
1040
Santos Cordoned769ae2015-05-13 18:47:38 -07001041 /**
1042 * Indicates that the address or number of a call belongs to a pay phone.
1043 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001044 public static final int PRESENTATION_PAYPHONE = 4;
1045
Grace Jiacc16b042021-08-09 09:06:11 -07001046 /**
1047 * Indicates that the address or number of a call is unavailable.
1048 */
1049 public static final int PRESENTATION_UNAVAILABLE = 5;
1050
Hall Liu4a9fde12020-01-16 17:38:46 -08001051
1052 /*
1053 * Values for the adb property "persist.radio.videocall.audio.output"
1054 */
1055 /** @hide */
1056 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1057 /** @hide */
1058 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1059 /** @hide */
1060 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1061
Tyler Gunn00d737b2019-10-31 13:04:37 -07001062 /** @hide */
1063 @Retention(RetentionPolicy.SOURCE)
1064 @IntDef(
1065 prefix = { "PRESENTATION_" },
1066 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001067 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001068 public @interface Presentation {}
1069
Brad Ebingera8366ae2021-03-23 21:01:51 +00001070
1071 /**
1072 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1073 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1074 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001075 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001076 */
1077 @ChangeId
1078 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1079 // this magic number is a bug ID
1080 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1081
Grace Jiab13eb2c2021-04-21 14:13:26 -07001082 /**
1083 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1084 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1085 * @hide
1086 */
1087 @ChangeId
1088 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1089 // bug ID
1090 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1091
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001092 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001093
Kevin Jeon767cda32020-11-17 01:40:16 +00001094
1095 /** Cached service handles, cleared by resetServiceCache() at death */
1096 private static final Object CACHE_LOCK = new Object();
1097
1098 @GuardedBy("CACHE_LOCK")
1099 private static ITelecomService sTelecomService;
1100 @GuardedBy("CACHE_LOCK")
1101 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1102
Yorke Leeb4ce1432014-06-09 13:53:23 -07001103 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001104
Hall Liue1bc2ec2015-10-09 15:58:37 -07001105 private final ITelecomService mTelecomServiceOverride;
1106
Thomas Stuart9bfb2432022-09-27 15:02:07 -07001107 /** @hide **/
1108 private final ClientTransactionalServiceRepository mTransactionalServiceRepository =
1109 new ClientTransactionalServiceRepository();
1110 /** @hide **/
1111 public static final int TELECOM_TRANSACTION_SUCCESS = 0;
1112 /** @hide **/
1113 public static final String TRANSACTION_CALL_ID_KEY = "TelecomCallId";
1114
Santos Cordon6c7a3882014-06-25 15:30:08 -07001115 /**
1116 * @hide
1117 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001118 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001119 public static TelecomManager from(Context context) {
1120 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001121 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001122
1123 /**
1124 * @hide
1125 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001126 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001127 this(context, null);
1128 }
1129
1130 /**
1131 * @hide
1132 */
1133 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001134 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001135 if (appContext != null && Objects.equals(context.getAttributionTag(),
1136 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001137 mContext = appContext;
1138 } else {
1139 mContext = context;
1140 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001141 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001142 }
1143
1144 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001145 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1146 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1147 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1148 * account returned depends on the following priorities:
1149 * <ul>
1150 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1151 * be returned.
1152 * </li>
1153 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1154 * will be returned.
1155 * </li>
1156 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001157 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001158 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1159 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001160 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001161 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001162 */
Yorke Leec61d13662015-09-21 17:25:25 -07001163 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001164 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001165 ITelecomService service = getTelecomService();
1166 if (service != null) {
1167 try {
1168 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001169 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001170 } catch (RemoteException e) {
1171 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001172 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001173 }
1174 return null;
1175 }
1176
1177 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001178 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1179 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001180 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001181 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001182 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1183 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001184 * <p>
1185 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001186 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001187 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1188 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001189 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001190 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001191 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001192 ITelecomService service = getTelecomService();
1193 if (service != null) {
1194 try {
1195 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001196 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001197 } catch (RemoteException e) {
1198 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001199 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001200 }
1201 return null;
1202 }
1203
1204 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001205 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1206 *
1207 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001208 * outgoing voice calls, or {@code null} if no default is specified (the
1209 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001210 * @hide
1211 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001212 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1213 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001214 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001215 ITelecomService service = getTelecomService();
1216 if (service != null) {
1217 try {
1218 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1219 } catch (RemoteException e) {
1220 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001221 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001222 }
1223 }
1224
1225 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001226 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001227 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1228 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001229 *
Brad Ebingere7833312019-05-07 10:55:55 -07001230 * @return The phone account handle of the current sim call manager for the default voice
1231 * subscription.
1232 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001233 */
1234 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001235 ITelecomService service = getTelecomService();
1236 if (service != null) {
1237 try {
1238 return service.getSimCallManager(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001239 SubscriptionManager.getDefaultSubscriptionId(), mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001240 } catch (RemoteException e) {
1241 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001242 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001243 }
1244 return null;
1245 }
1246
1247 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001248 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1249 * prepared for this method to return {@code null}, indicating that there currently exists no
1250 * SIM call manager {@link PhoneAccount} for the subscription specified.
1251 *
1252 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1253 * queried for.
1254 * @return The phone account handle of the current sim call manager.
1255 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001256 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001257 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001258 ITelecomService service = getTelecomService();
1259 if (service != null) {
1260 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001261 return service.getSimCallManager(subscriptionId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001262 } catch (RemoteException e) {
1263 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001264 }
Brad Ebingere7833312019-05-07 10:55:55 -07001265 }
1266 return null;
1267 }
1268
1269 /**
1270 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1271 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1272 * must be prepared for this method to return {@code null}, indicating that there currently
1273 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001274 *
1275 * @return The phone account handle of the current sim call manager.
1276 *
1277 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001278 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001279 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001280 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001281 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001282 ITelecomService service = getTelecomService();
1283 if (service != null) {
1284 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001285 return service.getSimCallManagerForUser(userId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001286 } catch (RemoteException e) {
1287 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001288 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001289 }
1290 return null;
1291 }
1292
1293 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001294 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001295 * {@code null}, indicating that there currently exists no Connection Manager
1296 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001297 *
1298 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001299 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001300 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001301 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001302 public PhoneAccountHandle getConnectionManager() {
1303 return getSimCallManager();
1304 }
1305
1306 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001307 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1308 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001309 * <P>
1310 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1311 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1312 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1313 * such as {@code sip:example@sipexample.com}).
1314 *
1315 * @param uriScheme The URI scheme.
1316 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001317 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001318 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001319 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001320 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001321 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001322 android.Manifest.permission.READ_PHONE_STATE
1323 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001324 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001325 ITelecomService service = getTelecomService();
1326 if (service != null) {
1327 try {
1328 return service.getPhoneAccountsSupportingScheme(uriScheme,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001329 mContext.getOpPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001330 } catch (RemoteException e) {
1331 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001332 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001333 }
1334 return new ArrayList<>();
1335 }
1336
Nancy Chen513c8922014-09-17 14:47:20 -07001337
1338 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001339 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1340 * calls. The returned list includes only those accounts which have been explicitly enabled
1341 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001342 *
1343 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1344 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001345 */
Yorke Leec61d13662015-09-21 17:25:25 -07001346 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001347 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001348 return getCallCapablePhoneAccounts(false);
1349 }
1350
1351 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001352 * Returns a list of {@link PhoneAccountHandle}s for all self-managed
1353 * {@link ConnectionService}s owned by the calling {@link UserHandle}.
Tyler Gunn89317072017-04-07 14:57:37 -07001354 * <p>
1355 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1356 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1357 * <p>
1358 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuart510f49a2022-01-28 23:06:57 +00001359 * is the default dialer app.
Tyler Gunn89317072017-04-07 14:57:37 -07001360 * <p>
Thomas Stuart510f49a2022-01-28 23:06:57 +00001361 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1362 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
Tyler Gunn89317072017-04-07 14:57:37 -07001363 *
1364 * @return A list of {@code PhoneAccountHandle} objects.
1365 */
Thomas Stuart510f49a2022-01-28 23:06:57 +00001366 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1367 public @NonNull List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001368 ITelecomService service = getTelecomService();
1369 if (service != null) {
1370 try {
1371 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001372 mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001373 } catch (RemoteException e) {
1374 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001375 }
Tyler Gunn89317072017-04-07 14:57:37 -07001376 }
1377 return new ArrayList<>();
1378 }
1379
1380 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001381 * Returns a list of {@link PhoneAccountHandle}s owned by the calling self-managed
1382 * {@link ConnectionService}.
1383 * <p>
1384 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1385 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1386 * <p>
1387 * Requires permission {@link android.Manifest.permission#MANAGE_OWN_CALLS}
1388 * <p>
1389 * A {@link SecurityException} will be thrown if a caller lacks the
1390 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission.
1391 *
1392 * @return A list of {@code PhoneAccountHandle} objects.
1393 */
1394 @RequiresPermission(Manifest.permission.MANAGE_OWN_CALLS)
1395 public @NonNull List<PhoneAccountHandle> getOwnSelfManagedPhoneAccounts() {
1396 ITelecomService service = getTelecomService();
1397 if (service != null) {
1398 try {
1399 return service.getOwnSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001400 mContext.getAttributionTag()).getList();
Thomas Stuart510f49a2022-01-28 23:06:57 +00001401 } catch (RemoteException e) {
1402 throw e.rethrowFromSystemServer();
1403 }
1404 }
1405 throw new IllegalStateException("Telecom is not available");
1406 }
1407
1408 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001409 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1410 * by the user.
1411 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001412 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001413 * when {@code false}, only enabled phone accounts will be
1414 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001415 * @return A list of {@code PhoneAccountHandle} objects.
1416 * @hide
1417 */
Hall Liub2306242019-11-15 17:13:05 -08001418 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001419 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1420 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1421 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001422 ITelecomService service = getTelecomService();
1423 if (service != null) {
1424 try {
1425 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001426 mContext.getOpPackageName(), mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001427 } catch (RemoteException e) {
1428 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1429 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001430 }
Nancy Chen513c8922014-09-17 14:47:20 -07001431 }
1432 return new ArrayList<>();
1433 }
1434
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001435 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001436 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1437 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001438 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1439 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001440 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001441 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001442 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001443 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001444 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001445 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001446 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001447 ITelecomService service = getTelecomService();
1448 if (service != null) {
1449 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001450 return service.getPhoneAccountsForPackage(mContext.getPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001451 } catch (RemoteException e) {
1452 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001453 }
Nancy Chen513c8922014-09-17 14:47:20 -07001454 }
1455 return null;
1456 }
1457
1458 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001459 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1460 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001461 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001462 * Requires Permission:
1463 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1464 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001465 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001466 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001467 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001468 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001469 ITelecomService service = getTelecomService();
1470 if (service != null) {
1471 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001472 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001473 } catch (RemoteException e) {
1474 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001475 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001476 }
1477 return null;
1478 }
1479
1480 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001481 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001482 *
Nancy Chen210ef032014-09-15 17:58:42 -07001483 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001484 * @hide
1485 */
1486 @SystemApi
1487 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001488 ITelecomService service = getTelecomService();
1489 if (service != null) {
1490 try {
1491 return service.getAllPhoneAccountsCount();
1492 } catch (RemoteException e) {
1493 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001494 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001495 }
1496 return 0;
1497 }
1498
1499 /**
1500 * Returns a list of all {@link PhoneAccount}s.
1501 *
1502 * @return All {@link PhoneAccount}s.
1503 * @hide
1504 */
1505 @SystemApi
1506 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001507 ITelecomService service = getTelecomService();
1508 if (service != null) {
1509 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001510 return service.getAllPhoneAccounts().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001511 } catch (RemoteException e) {
1512 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001513 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001514 }
1515 return Collections.EMPTY_LIST;
1516 }
1517
1518 /**
1519 * Returns a list of all {@link PhoneAccountHandle}s.
1520 *
1521 * @return All {@link PhoneAccountHandle}s.
1522 * @hide
1523 */
1524 @SystemApi
1525 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001526 ITelecomService service = getTelecomService();
1527 if (service != null) {
1528 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001529 return service.getAllPhoneAccountHandles().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001530 } catch (RemoteException e) {
1531 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001532 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001533 }
1534 return Collections.EMPTY_LIST;
1535 }
1536
1537 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001538 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1539 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1540 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001541 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1542 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1543 * the phone app settings before the account is usable.
1544 * <p>
Thomas Stuarte0416212022-01-31 20:31:42 +00001545 * Note: Each package is limited to 10 {@link PhoneAccount} registrations.
1546 * <p>
Santos Cordond9e614f2014-10-28 13:10:36 -07001547 * A {@link SecurityException} will be thrown if an app tries to register a
1548 * {@link PhoneAccountHandle} where the package name specified within
1549 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Thomas Stuarte0416212022-01-31 20:31:42 +00001550 * <p>
1551 * A {@link IllegalArgumentException} will be thrown if an app tries to register a
1552 * {@link PhoneAccount} when the upper bound limit, 10, has already been reached.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001553 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001554 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001555 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001556 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001557 ITelecomService service = getTelecomService();
1558 if (service != null) {
1559 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001560 service.registerPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001561 } catch (RemoteException e) {
1562 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001563 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001564 }
1565 }
1566
1567 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001568 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001569 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001570 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001571 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001572 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001573 ITelecomService service = getTelecomService();
1574 if (service != null) {
1575 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001576 service.unregisterPhoneAccount(accountHandle, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001577 } catch (RemoteException e) {
1578 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001579 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001580 }
1581 }
1582
1583 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001584 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001585 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001586 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001587 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001588 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001589 public void clearPhoneAccounts() {
1590 clearAccounts();
1591 }
1592 /**
1593 * Remove all Accounts that belong to the calling package from the system.
1594 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1595 * @hide
1596 */
1597 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001598 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001599 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001600 ITelecomService service = getTelecomService();
1601 if (service != null) {
1602 try {
1603 service.clearAccounts(mContext.getPackageName());
1604 } catch (RemoteException e) {
1605 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001606 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001607 }
1608 }
1609
1610 /**
Anthony Lee67279262014-10-27 11:28:40 -07001611 * Remove all Accounts that belong to the specified package from the system.
1612 * @hide
1613 */
1614 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001615 ITelecomService service = getTelecomService();
1616 if (service != null) {
1617 try {
1618 if (!TextUtils.isEmpty(packageName)) {
1619 service.clearAccounts(packageName);
1620 }
1621 } catch (RemoteException e) {
1622 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001623 }
Anthony Lee67279262014-10-27 11:28:40 -07001624 }
1625 }
1626
Yorke Lee1011f482015-04-23 15:58:27 -07001627
Anthony Lee67279262014-10-27 11:28:40 -07001628 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001629 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1630 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001631 * @hide
1632 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001633 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001634 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001635 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001636 ITelecomService service = getTelecomService();
1637 if (service != null) {
1638 try {
1639 return service.getDefaultPhoneApp();
1640 } catch (RemoteException e) {
1641 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001642 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001643 }
1644 return null;
1645 }
1646
Santos Cordon9eb45932014-06-27 12:28:43 -07001647 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001648 * Used to determine the currently selected default dialer package.
1649 *
1650 * @return package name for the default dialer package or null if no package has been
1651 * selected as the default dialer.
1652 */
1653 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001654 ITelecomService service = getTelecomService();
1655 if (service != null) {
1656 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001657 return service.getDefaultDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001658 } catch (RemoteException e) {
1659 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001660 }
Yorke Lee1011f482015-04-23 15:58:27 -07001661 }
1662 return null;
1663 }
1664
1665 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001666 * Used to determine the currently selected default dialer package for a specific user.
1667 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001668 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001669 * @return package name for the default dialer package or null if no package has been
1670 * selected as the default dialer.
1671 * @hide
1672 */
1673 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001674 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001675 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001676 ITelecomService service = getTelecomService();
1677 if (service != null) {
1678 try {
1679 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001680 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001681 } catch (RemoteException e) {
1682 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001683 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001684 }
1685 return null;
1686 }
1687
1688 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001689 * Used to set the default dialer package.
1690 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001691 * @param packageName to set the default dialer to, or {@code null} if the system provided
1692 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001693 *
1694 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1695 * the specified package does not correspond to an installed dialer, or is already
1696 * the default dialer.
1697 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001698 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001699 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001700 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1701 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001702 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001703 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001704 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001705 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001706 @RequiresPermission(allOf = {
1707 android.Manifest.permission.MODIFY_PHONE_STATE,
1708 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001709 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001710 ITelecomService service = getTelecomService();
1711 if (service != null) {
1712 try {
1713 return service.setDefaultDialer(packageName);
1714 } catch (RemoteException e) {
1715 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001716 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001717 }
1718 return false;
1719 }
1720
1721 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001722 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001723 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001724 * @return package name for the system dialer package or {@code null} if no system dialer is
1725 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001726 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001727 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001728 ITelecomService service = getTelecomService();
1729 if (service != null) {
1730 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001731 return service.getSystemDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001732 } catch (RemoteException e) {
1733 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001734 }
Yorke Lee1011f482015-04-23 15:58:27 -07001735 }
1736 return null;
1737 }
1738
1739 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001740 * Return whether a given phone number is the configured voicemail number for a
1741 * particular phone account.
1742 *
1743 * @param accountHandle The handle for the account to check the voicemail number against
1744 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001745 */
Yorke Leec61d13662015-09-21 17:25:25 -07001746 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001747 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001748 ITelecomService service = getTelecomService();
1749 if (service != null) {
1750 try {
1751 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001752 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001753 } catch (RemoteException e) {
1754 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001755 }
Nancy Chen443e5012014-10-15 15:48:21 -07001756 }
1757 return false;
1758 }
1759
1760 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001761 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001762 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001763 * @param accountHandle The handle for the phone account.
1764 * @return The voicemail number for the phone account, and {@code null} if one has not been
1765 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001766 */
Yorke Leec61d13662015-09-21 17:25:25 -07001767 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001768 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001769 ITelecomService service = getTelecomService();
1770 if (service != null) {
1771 try {
1772 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001773 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001774 } catch (RemoteException e) {
1775 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001776 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001777 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001778 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001779 }
1780
1781 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001782 * Return the line 1 phone number for given phone account.
1783 *
Michael Groover08490f12020-03-24 14:08:14 -07001784 * <p>Requires Permission:
1785 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1786 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1787 * or that the caller is the default SMS app for any API level.
1788 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1789 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001790 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001791 * @param accountHandle The handle for the account retrieve a number for.
1792 * @return A string representation of the line 1 phone number.
Meng Wang8665b512021-11-18 15:13:43 -08001793 * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1794 * Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1795 * from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
Nancy Chen5cf27842015-01-24 23:30:27 -08001796 */
Meng Wang8665b512021-11-18 15:13:43 -08001797 @Deprecated
Michael Groover08490f12020-03-24 14:08:14 -07001798 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1799 @RequiresPermission(anyOf = {
1800 android.Manifest.permission.READ_PHONE_STATE,
1801 android.Manifest.permission.READ_SMS,
1802 android.Manifest.permission.READ_PHONE_NUMBERS
1803 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001804 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001805 ITelecomService service = getTelecomService();
1806 if (service != null) {
1807 try {
1808 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001809 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001810 } catch (RemoteException e) {
1811 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001812 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001813 }
1814 return null;
1815 }
1816
1817 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001818 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001819 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001820 *
1821 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1822 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001823 */
Yorke Leec61d13662015-09-21 17:25:25 -07001824 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001825 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001826 ITelecomService service = getTelecomService();
1827 if (service != null) {
1828 try {
1829 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001830 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001831 } catch (RemoteException e) {
1832 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001833 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001834 }
1835 return false;
1836 }
1837
1838 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001839 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1840 * permission. The permission can be obtained by associating with a physical wearable device
1841 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1842 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001843 *
1844 * @return {@code true} if the caller has {@link InCallService} access for
1845 * companion app; {@code false} otherwise.
1846 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001847 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001848 ITelecomService service = getTelecomService();
1849 if (service != null) {
1850 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001851 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001852 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001853 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001854 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001855 if (!isSystemProcess()) {
1856 e.rethrowAsRuntimeException();
1857 }
Shuo Qian4d065262020-10-20 11:04:28 -07001858 }
1859 }
1860 return false;
1861 }
1862
1863 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001864 * Returns whether there is an ongoing call originating from a managed
1865 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1866 * states.
1867 * <p>
1868 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1869 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001870 *
1871 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1872 * {@code false} otherwise.
1873 */
1874 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1875 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001876 ITelecomService service = getTelecomService();
1877 if (service != null) {
1878 try {
1879 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001880 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001881 } catch (RemoteException e) {
1882 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001883 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001884 }
1885 return false;
1886 }
1887
1888 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001889 * Returns one of the following constants that represents the current state of Telecom:
1890 *
1891 * {@link TelephonyManager#CALL_STATE_RINGING}
1892 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1893 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001894 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001895 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001896 * <p>
1897 * Requires Permission:
1898 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1899 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001900 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001901 * @hide
1902 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001903 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1904 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001905 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001906 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001907 ITelecomService service = getTelecomService();
1908 if (service != null) {
1909 try {
Thomas Stuartde1f1f22022-11-16 22:17:42 +00001910 return service.getCallStateUsingPackage(mContext.getOpPackageName(),
Brad Ebingera8366ae2021-03-23 21:01:51 +00001911 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001912 } catch (RemoteException e) {
1913 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001914 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001915 }
1916 return TelephonyManager.CALL_STATE_IDLE;
1917 }
1918
1919 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001920 * Returns whether there currently exists is a ringing incoming-call.
1921 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001922 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001923 * @hide
1924 */
1925 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001926 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001927 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001928 android.Manifest.permission.READ_PHONE_STATE
1929 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001930 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001931 ITelecomService service = getTelecomService();
1932 if (service != null) {
1933 try {
1934 return service.isRinging(mContext.getOpPackageName());
1935 } catch (RemoteException e) {
1936 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001937 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001938 }
1939 return false;
1940 }
1941
1942 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001943 * Ends the foreground call on the device.
1944 * <p>
1945 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1946 * foreground call is ended.
1947 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001948 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1949 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001950 *
1951 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1952 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001953 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1954 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1955 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001956 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001957 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001958 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001959 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001960 ITelecomService service = getTelecomService();
1961 if (service != null) {
1962 try {
1963 return service.endCall(mContext.getPackageName());
1964 } catch (RemoteException e) {
1965 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001966 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001967 }
1968 return false;
1969 }
1970
1971 /**
1972 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001973 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001974 * If the incoming call is a video call, the call will be answered with the same video state as
1975 * the incoming call requests. This means, for example, that an incoming call requesting
1976 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001977 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001978 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1979 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001980 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001981 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1982 // this method (clockwork & gearhead).
1983 @RequiresPermission(anyOf =
1984 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001985 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001986 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001987 ITelecomService service = getTelecomService();
1988 if (service != null) {
1989 try {
1990 service.acceptRingingCall(mContext.getPackageName());
1991 } catch (RemoteException e) {
1992 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001993 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001994 }
1995 }
1996
1997 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001998 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1999 * with the specified video state.
2000 *
2001 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002002 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
2003 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07002004 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002005 @RequiresPermission(anyOf =
2006 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002007 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07002008 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002009 ITelecomService service = getTelecomService();
2010 if (service != null) {
2011 try {
2012 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002013 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002014 } catch (RemoteException e) {
2015 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07002016 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07002017 }
2018 }
2019
2020 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07002021 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07002022 * <p>
2023 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
2024 * already started playing. It is intended to handle use-cases such as silencing a ringing call
2025 * when the user presses the volume button during ringing.
2026 * <p>
2027 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
2028 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
2029 * <p>
2030 * A dialer app which wants to have more control over ringtone playing should declare
2031 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
2032 * {@link InCallService} implementation to indicate that the app wants to be responsible for
2033 * playing the ringtone for all incoming calls.
2034 * <p>
2035 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
2036 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07002037 */
Yorke Leec61d13662015-09-21 17:25:25 -07002038 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07002039 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002040 ITelecomService service = getTelecomService();
2041 if (service != null) {
2042 try {
2043 service.silenceRinger(mContext.getOpPackageName());
2044 } catch (RemoteException e) {
2045 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002046 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002047 }
2048 }
2049
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002050 /**
2051 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002052 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002053 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07002054 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002055 android.Manifest.permission.READ_PHONE_STATE
2056 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002057 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002058 ITelecomService service = getTelecomService();
2059 if (service != null) {
2060 try {
2061 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002062 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002063 } catch (RemoteException e) {
2064 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002065 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002066 }
2067 return false;
2068 }
2069
2070 /**
2071 * 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 -07002072 * settings and have a wired headset plugged in.
2073 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002074 * - {@link TelecomManager#TTY_MODE_OFF}
2075 * - {@link TelecomManager#TTY_MODE_FULL}
2076 * - {@link TelecomManager#TTY_MODE_HCO}
2077 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002078 * @hide
2079 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002080 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07002081 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002082 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002083 ITelecomService service = getTelecomService();
2084 if (service != null) {
2085 try {
2086 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002087 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002088 } catch (RemoteException e) {
2089 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002090 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002091 }
Evan Charlton10197192014-07-19 15:00:29 -07002092 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002093 }
2094
Santos Cordon96efb482014-07-19 14:57:05 -07002095 /**
2096 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08002097 * has an incoming call. For managed {@link ConnectionService}s, the specified
2098 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2099 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2100 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2101 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2102 * <p>
Tyler Gunnd8778662023-02-10 17:13:11 +00002103 * Specify the address associated with the incoming call using
2104 * {@link #EXTRA_INCOMING_CALL_ADDRESS}. If an incoming call is from an anonymous source, omit
2105 * this extra and ensure you specify a valid number presentation via
2106 * {@link Connection#setAddress(Uri, int)} on the {@link Connection} instance you return in
2107 * your
2108 * {@link ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)}
2109 * implementation.
2110 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002111 * The incoming call you are adding is assumed to have a video state of
2112 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2113 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2114 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002115 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2116 * associated with the {@link PhoneAccountHandle} and request additional information about the
2117 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002118 * call UI.
2119 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002120 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2121 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2122 * the associated {@link PhoneAccount} is not currently enabled by the user.
2123 * <p>
2124 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2125 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2126 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002127 * <p>
2128 * <p>
2129 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2130 * the call is added to Telecom in order for the notification to be non-dismissible.
Santos Cordon96efb482014-07-19 14:57:05 -07002131 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2132 * {@link #registerPhoneAccount}.
2133 * @param extras A bundle that will be passed through to
2134 * {@link ConnectionService#onCreateIncomingConnection}.
2135 */
2136 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002137 ITelecomService service = getTelecomService();
2138 if (service != null) {
2139 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002140 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2141 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2142 Build.VERSION_CODES.O_MR1) {
2143 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2144 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002145 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002146 }
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002147 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras,
2148 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002149 } catch (RemoteException e) {
2150 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002151 }
Santos Cordon96efb482014-07-19 14:57:05 -07002152 }
2153 }
2154
Nancy Chen0eb1e402014-08-21 22:52:29 -07002155 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302156 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002157 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2158 * call initiated on another device which the user is being invited to join in. For managed
2159 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2160 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2161 * corresponding {@link PhoneAccount}. This can be checked using
2162 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2163 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302164 * <p>
2165 * The incoming conference you are adding is assumed to have a video state of
2166 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2167 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2168 * <p>
2169 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2170 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002171 * call (See
2172 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2173 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302174 * <p>
2175 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2176 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2177 * the associated {@link PhoneAccount} is not currently enabled by the user.
2178 *
2179 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2180 * {@link #registerPhoneAccount}.
2181 * @param extras A bundle that will be passed through to
2182 * {@link ConnectionService#onCreateIncomingConference}.
2183 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302184 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2185 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002186 ITelecomService service = getTelecomService();
2187 if (service != null) {
2188 try {
2189 service.addNewIncomingConference(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002190 phoneAccount, extras == null ? new Bundle() : extras,
2191 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002192 } catch (RemoteException e) {
2193 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302194 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302195 }
2196 }
2197
2198 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002199 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2200 * service. This is invoked when Telephony detects a new unknown connection that was neither
2201 * a new incoming call, nor an user-initiated outgoing call.
2202 *
2203 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2204 * {@link #registerPhoneAccount}.
2205 * @param extras A bundle that will be passed through to
2206 * {@link ConnectionService#onCreateIncomingConnection}.
2207 * @hide
2208 */
2209 @SystemApi
2210 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002211 ITelecomService service = getTelecomService();
2212 if (service != null) {
2213 try {
2214 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002215 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002216 } catch (RemoteException e) {
2217 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002218 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002219 }
2220 }
2221
2222 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002223 * Processes the specified dial string as an MMI code.
2224 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2225 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002226 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002227 * <p>
2228 * Requires that the method-caller be set as the system dialer app.
2229 * </p>
2230 *
2231 * @param dialString The digits to dial.
2232 * @return True if the digits were processed as an MMI code, false otherwise.
2233 */
Yorke Leec61d13662015-09-21 17:25:25 -07002234 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002235 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002236 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002237 if (service != null) {
2238 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002239 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002240 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002241 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002242 }
2243 }
2244 return false;
2245 }
2246
2247 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002248 * Processes the specified dial string as an MMI code.
2249 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2250 * Some of these sequences launch special behavior through handled by Telephony.
2251 * <p>
2252 * Requires that the method-caller be set as the system dialer app.
2253 * </p>
2254 *
2255 * @param accountHandle The handle for the account the MMI code should apply to.
2256 * @param dialString The digits to dial.
2257 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002258 */
Yorke Leec61d13662015-09-21 17:25:25 -07002259 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002260 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002261 ITelecomService service = getTelecomService();
2262 if (service != null) {
2263 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002264 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2265 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002266 } catch (RemoteException e) {
2267 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2268 }
2269 }
2270 return false;
2271 }
2272
2273 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002274 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2275 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002276 * @param accountHandle The handle for the account to derive an adn query URI for or
2277 * {@code null} to return a URI which will use the default account.
2278 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2279 * for the the content retrieve.
2280 */
Yorke Leec61d13662015-09-21 17:25:25 -07002281 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002282 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2283 ITelecomService service = getTelecomService();
2284 if (service != null && accountHandle != null) {
2285 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002286 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002287 } catch (RemoteException e) {
2288 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2289 }
2290 }
2291 return Uri.parse("content://icc/adn");
2292 }
2293
2294 /**
Tyler Gunna2879412023-02-28 23:41:53 +00002295 * Removes the missed-call notification if one is present and marks missed calls in the call
2296 * log as read.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002297 * <p>
Tyler Gunna2879412023-02-28 23:41:53 +00002298 * Requires that the method-caller be set as the default dialer app.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002299 * </p>
2300 */
Yorke Leec61d13662015-09-21 17:25:25 -07002301 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002302 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002303 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002304 if (service != null) {
2305 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002306 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002307 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002308 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002309 }
2310 }
2311 }
2312
2313 /**
2314 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2315 * currently no ongoing call, then this method does nothing.
2316 * <p>
2317 * Requires that the method-caller be set as the system dialer app or have the
2318 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2319 * </p>
2320 *
2321 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2322 */
Yorke Leec61d13662015-09-21 17:25:25 -07002323 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002324 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002325 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002326 if (service != null) {
2327 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002328 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002329 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002330 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002331 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002332 }
2333 }
2334 }
2335
Yorke Lee3e56ba12015-04-23 12:32:36 -07002336 /**
2337 * Places a new outgoing call to the provided address using the system telecom service with
2338 * the specified extras.
2339 *
2340 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2341 * except that the outgoing call will always be sent via the system telecom service. If
2342 * method-caller is either the user selected default dialer app or preloaded system dialer
2343 * app, then emergency calls will also be allowed.
2344 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002345 * Placing a call via a managed {@link ConnectionService} requires permission:
2346 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002347 *
2348 * Usage example:
2349 * <pre>
2350 * Uri uri = Uri.fromParts("tel", "12345", null);
2351 * Bundle extras = new Bundle();
2352 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2353 * telecomManager.placeCall(uri, extras);
2354 * </pre>
2355 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002356 * The following keys are supported in the supplied extras.
2357 * <ul>
2358 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2359 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2360 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2361 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2362 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002363 * <p>
2364 * An app which implements the self-managed {@link ConnectionService} API uses
2365 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2366 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2367 * associated {@link android.telecom.PhoneAccountHandle}.
2368 *
2369 * Self-managed {@link ConnectionService}s require permission
2370 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002371 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002372 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2373 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2374 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2375 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2376 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2377 * </p>
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002378 * <p>
2379 * <p>
2380 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2381 * the call is placed in order for the notification to be non-dismissible.
Brad Ebinger8ad07c82023-10-30 20:39:09 +00002382 * <p><b>Note</b>: Call Forwarding MMI codes can only be dialed by applications that are
2383 * configured as the user defined default dialer or system dialer role. If a call containing a
2384 * call forwarding MMI code is placed by an application that is not in one of these roles, the
2385 * dialer will be launched with a UI showing the MMI code already populated so that the user can
2386 * confirm the action before the call is placed.
Yorke Lee3e56ba12015-04-23 12:32:36 -07002387 * @param address The address to make the call to.
2388 * @param extras Bundle of extras to use with the call.
2389 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002390 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2391 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002392 public void placeCall(Uri address, Bundle extras) {
2393 ITelecomService service = getTelecomService();
2394 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002395 if (address == null) {
2396 Log.w(TAG, "Cannot place call to empty address.");
2397 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002398 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002399 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002400 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002401 } catch (RemoteException e) {
2402 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2403 }
2404 }
2405 }
2406
Ravi Paluri80aa2142019-12-02 11:57:37 +05302407
2408 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002409 * Place a new adhoc conference call with the provided participants using the system telecom
2410 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302411 *
2412 * An adhoc conference call is established by providing a list of addresses to
2413 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2414 * {@link ConnectionService} is responsible for connecting all indicated participants
2415 * to a conference simultaneously.
2416 * This is in contrast to conferences formed by merging calls together (e.g. using
2417 * {@link android.telecom.Call#mergeConference()}).
2418 *
2419 * The following keys are supported in the supplied extras.
2420 * <ul>
2421 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2422 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2423 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2424 * </ul>
2425 *
2426 * @param participants List of participants to start conference with
2427 * @param extras Bundle of extras to use with the call
2428 */
2429 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2430 public void startConference(@NonNull List<Uri> participants,
2431 @NonNull Bundle extras) {
2432 ITelecomService service = getTelecomService();
2433 if (service != null) {
2434 try {
2435 service.startConference(participants, extras,
2436 mContext.getOpPackageName());
2437 } catch (RemoteException e) {
2438 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2439 }
2440 }
2441 }
2442
Santos Cordon91371dc02015-05-08 13:52:09 -07002443 /**
2444 * Enables and disables specified phone account.
2445 *
2446 * @param handle Handle to the phone account.
2447 * @param isEnabled Enable state of the phone account.
2448 * @hide
2449 */
2450 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002451 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002452 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2453 ITelecomService service = getTelecomService();
2454 if (service != null) {
2455 try {
2456 service.enablePhoneAccount(handle, isEnabled);
2457 } catch (RemoteException e) {
2458 Log.e(TAG, "Error enablePhoneAbbount", e);
2459 }
2460 }
2461 }
2462
Hall Liu0464b9b2016-01-12 15:32:58 -08002463 /**
2464 * Dumps telecom analytics for uploading.
2465 *
2466 * @return
2467 * @hide
2468 */
2469 @SystemApi
2470 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002471 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002472 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002473 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002474 if (service != null) {
2475 try {
2476 result = service.dumpCallAnalytics();
2477 } catch (RemoteException e) {
2478 Log.e(TAG, "Error dumping call analytics", e);
2479 }
2480 }
2481 return result;
2482 }
2483
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002484 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002485 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2486 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002487 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002488 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2489 * {@code true} for the current user.
2490 */
2491 public Intent createManageBlockedNumbersIntent() {
2492 ITelecomService service = getTelecomService();
2493 Intent result = null;
2494 if (service != null) {
2495 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002496 result = service.createManageBlockedNumbersIntent(mContext.getPackageName());
Nan Wuc51fd762022-08-01 21:08:23 +00002497 if (result != null) {
2498 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2499 mContext.getAttributionSource());
2500 }
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002501 } catch (RemoteException e) {
2502 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2503 }
2504 }
2505 return result;
2506 }
2507
Fan Zhang5431ef52019-10-14 13:43:46 -07002508
2509 /**
2510 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2511 * launch the activity for emergency dialer.
2512 *
2513 * @param number Optional number to call in emergency dialer
2514 * @hide
2515 */
2516 @SystemApi
2517 @NonNull
2518 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2519 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002520 if (service != null) {
2521 try {
Nan Wuc51fd762022-08-01 21:08:23 +00002522 Intent result = service.createLaunchEmergencyDialerIntent(number);
2523 if (result != null) {
2524 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2525 mContext.getAttributionSource());
2526 }
2527 return result;
Fan Zhang5431ef52019-10-14 13:43:46 -07002528 } catch (RemoteException e) {
2529 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2530 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002531 } else {
2532 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002533 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002534
2535 // Telecom service knows the package name of the expected emergency dialer package; if it
2536 // is not available, then fallback to not targeting a specific package.
2537 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2538 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2539 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2540 }
2541 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002542 }
2543
Tyler Gunnf5035432017-01-09 09:43:12 -08002544 /**
2545 * Determines whether Telecom would permit an incoming call to be added via the
2546 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2547 * {@link PhoneAccountHandle}.
2548 * <p>
2549 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2550 * in the following situations:
2551 * <ul>
2552 * <li>{@link PhoneAccount} does not have property
2553 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2554 * {@link ConnectionService}), and the active or held call limit has
2555 * been reached.</li>
2556 * <li>There is an ongoing emergency call.</li>
2557 * </ul>
2558 *
2559 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2560 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2561 * otherwise.
2562 */
2563 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002564 if (phoneAccountHandle == null) {
2565 return false;
2566 }
2567
Tyler Gunnf5035432017-01-09 09:43:12 -08002568 ITelecomService service = getTelecomService();
2569 if (service != null) {
2570 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002571 return service.isIncomingCallPermitted(phoneAccountHandle,
2572 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002573 } catch (RemoteException e) {
2574 Log.e(TAG, "Error isIncomingCallPermitted", e);
2575 }
2576 }
2577 return false;
2578 }
2579
2580 /**
2581 * Determines whether Telecom would permit an outgoing call to be placed via the
2582 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2583 * <p>
2584 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2585 * in the following situations:
2586 * <ul>
2587 * <li>{@link PhoneAccount} does not have property
2588 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2589 * {@link ConnectionService}), and the active, held or ringing call limit has
2590 * been reached.</li>
2591 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2592 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2593 * another {@link ConnectionService}.</li>
2594 * <li>There is an ongoing emergency call.</li>
2595 * </ul>
2596 *
2597 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2598 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2599 * otherwise.
2600 */
2601 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2602 ITelecomService service = getTelecomService();
2603 if (service != null) {
2604 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002605 return service.isOutgoingCallPermitted(phoneAccountHandle,
2606 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002607 } catch (RemoteException e) {
2608 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2609 }
2610 }
2611 return false;
2612 }
2613
Sanket Padawea8eddd42017-11-03 11:07:35 -07002614 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002615 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2616 * {@link PhoneAccountHandle} it defines.
2617 * <p>
2618 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2619 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2620 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2621 * is referred to as the source of the handover, and the video calling app is referred to as the
2622 * destination.
2623 * <p>
2624 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2625 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2626 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2627 * device.
2628 * <p>
2629 * For a full discussion of the handover process and the APIs involved, see
2630 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2631 * <p>
2632 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2633 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002634 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2635 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2636 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2637 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2638 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2639 * <p>
2640 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2641 * associated with the {@link PhoneAccountHandle} destAcct and call
2642 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2643 * <p>
2644 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2645 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2646 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2647 * user.
2648 * <p>
2649 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2650 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2651 *
2652 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2653 * {@link ConnectionService}.
2654 * @param videoState Video state after the handover.
2655 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2656 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002657 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2658 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002659 ITelecomService service = getTelecomService();
2660 if (service != null) {
2661 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002662 service.acceptHandover(srcAddr, videoState, destAcct, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002663 } catch (RemoteException e) {
2664 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002665 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002666 }
2667 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002668
Tyler Gunn5bd90852018-09-21 09:37:07 -07002669 /**
2670 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2671 * call, as identified by the dialed number, or because a call was identified by the network
2672 * as an emergency call.
2673 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2674 * @hide
2675 */
2676 @SystemApi
2677 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2678 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002679 ITelecomService service = getTelecomService();
2680 if (service != null) {
2681 try {
2682 return service.isInEmergencyCall();
2683 } catch (RemoteException e) {
2684 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2685 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002686 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002687 }
2688 return false;
2689 }
2690
Tyler Gunnc37445c2018-09-28 16:16:20 -07002691 /**
Tyler Gunn27bf4342022-03-25 14:17:52 -07002692 * Determines whether there are any ongoing {@link PhoneAccount#CAPABILITY_SELF_MANAGED}
2693 * calls for a given {@code packageName} and {@code userHandle}.
2694 *
2695 * @param packageName the package name of the app to check calls for.
2696 * @param userHandle the user handle on which to check for calls.
2697 * @return {@code true} if there are ongoing calls, {@code false} otherwise.
2698 * @hide
2699 */
2700 @RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
2701 public boolean isInSelfManagedCall(@NonNull String packageName,
2702 @NonNull UserHandle userHandle) {
2703 ITelecomService service = getTelecomService();
2704 if (service != null) {
2705 try {
2706 return service.isInSelfManagedCall(packageName, userHandle,
2707 mContext.getOpPackageName());
2708 } catch (RemoteException e) {
2709 Log.e(TAG, "RemoteException isInSelfManagedCall: " + e);
2710 e.rethrowFromSystemServer();
2711 return false;
2712 }
2713 } else {
2714 throw new IllegalStateException("Telecom service is not present");
2715 }
2716 }
2717
2718 /**
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002719 * Add a call to the Android system service Telecom. This allows the system to start tracking an
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002720 * incoming or outgoing call with the specified {@link CallAttributes}. Once a call is added,
2721 * a {@link android.app.Notification.CallStyle} notification should be posted and when the
2722 * call is ready to be disconnected, use {@link CallControl#disconnect(DisconnectCause,
2723 * Executor, OutcomeReceiver)} which is provided by the
2724 * {@code pendingControl#onResult(CallControl)}.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002725 * <p>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002726 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002727 * <p>
2728 * <b>Call Lifecycle</b>: Your app is given foreground execution priority as long as you have a
2729 * valid call and are posting a {@link android.app.Notification.CallStyle} notification.
2730 * When your application is given foreground execution priority, your app is treated as a
2731 * foreground service. Foreground execution priority will prevent the
2732 * {@link android.app.ActivityManager} from killing your application when it is placed the
2733 * background. Foreground execution priority is removed from your app when all of your app's
2734 * calls terminate or your app no longer posts a valid notification.
2735 * <p>
2736 * <p>
2737 * <p>
2738 * <b>Note</b>: Only packages that register with
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002739 * {@link PhoneAccount#CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS}
2740 * can utilize this API. {@link PhoneAccount}s that set the capabilities
2741 * {@link PhoneAccount#CAPABILITY_SIM_SUBSCRIPTION},
2742 * {@link PhoneAccount#CAPABILITY_CALL_PROVIDER},
2743 * {@link PhoneAccount#CAPABILITY_CONNECTION_MANAGER}
2744 * are not supported and will cause an exception to be thrown.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002745 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002746 * <p>
2747 * <p>
2748 * <b>Usage example:</b>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002749 * <pre>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002750 * // Its up to your app on how you want to wrap the objects. One such implementation can be:
2751 * class MyVoipCall {
2752 * ...
2753 * public CallControlCallEventCallback handshakes = new CallControlCallback() {
2754 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002755 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002756 *
2757 * public CallEventCallback events = new CallEventCallback() {
2758 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002759 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002760 *
2761 * public MyVoipCall(String id){
2762 * ...
2763 * }
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002764 * }
2765 *
Thomas Stuart6e418b32023-02-06 08:22:08 -08002766 * MyVoipCall myFirstOutgoingCall = new MyVoipCall("1");
2767 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002768 * telecomManager.addCall(callAttributes,
2769 * Runnable::run,
2770 * new OutcomeReceiver() {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002771 * public void onResult(CallControl callControl) {
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002772 * // The call has been added successfully. For demonstration
2773 * // purposes, the call is disconnected immediately ...
2774 * callControl.disconnect(
2775 * new DisconnectCause(DisconnectCause.LOCAL) )
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002776 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002777 * },
2778 * myFirstOutgoingCall.handshakes,
2779 * myFirstOutgoingCall.events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002780 * </pre>
2781 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002782 * @param callAttributes attributes of the new call (incoming or outgoing, address, etc.)
2783 * @param executor execution context to run {@link CallControlCallback} updates on
2784 * @param pendingControl Receives the result of addCall transaction. Upon success, a
2785 * CallControl object is provided which can be used to do things like
2786 * disconnect the call that was added.
2787 * @param handshakes callback that receives <b>actionable</b> updates that originate from
2788 * Telecom.
2789 * @param events callback that receives <b>non</b>-actionable updates that originate
2790 * from Telecom.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002791 */
2792 @RequiresPermission(android.Manifest.permission.MANAGE_OWN_CALLS)
2793 @SuppressLint("SamShouldBeLast")
2794 public void addCall(@NonNull CallAttributes callAttributes,
2795 @NonNull @CallbackExecutor Executor executor,
2796 @NonNull OutcomeReceiver<CallControl, CallException> pendingControl,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002797 @NonNull CallControlCallback handshakes,
2798 @NonNull CallEventCallback events) {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002799 Objects.requireNonNull(callAttributes);
2800 Objects.requireNonNull(executor);
2801 Objects.requireNonNull(pendingControl);
Thomas Stuart6e418b32023-02-06 08:22:08 -08002802 Objects.requireNonNull(handshakes);
2803 Objects.requireNonNull(events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002804
2805 ITelecomService service = getTelecomService();
2806 if (service != null) {
2807 try {
2808 // create or add the new call to a service wrapper w/ the same phoneAccountHandle
2809 ClientTransactionalServiceWrapper transactionalServiceWrapper =
2810 mTransactionalServiceRepository.addNewCallForTransactionalServiceWrapper(
2811 callAttributes.getPhoneAccountHandle());
2812
2813 // couple all the args passed by the client
2814 String newCallId = transactionalServiceWrapper.trackCall(callAttributes, executor,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002815 pendingControl, handshakes, events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002816
2817 // send args to server to process new call
2818 service.addCall(callAttributes, transactionalServiceWrapper.getCallEventCallback(),
2819 newCallId, mContext.getOpPackageName());
2820 } catch (RemoteException e) {
2821 Log.e(TAG, "RemoteException addCall: " + e);
2822 e.rethrowFromSystemServer();
2823 }
2824 } else {
2825 throw new IllegalStateException("Telecom service is not present");
2826 }
2827 }
2828
2829 /**
Tyler Gunnc37445c2018-09-28 16:16:20 -07002830 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2831 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002832 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002833 * @hide
2834 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002835 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002836 ITelecomService service = getTelecomService();
2837 if (service != null) {
2838 try {
2839 service.handleCallIntent(intent, callingPackageProxy);
2840 } catch (RemoteException e) {
2841 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002842 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002843 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002844 }
2845
Shuo Qian4d065262020-10-20 11:04:28 -07002846 private boolean isSystemProcess() {
2847 return Process.myUid() == Process.SYSTEM_UID;
2848 }
2849
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002850 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002851 if (mTelecomServiceOverride != null) {
2852 return mTelecomServiceOverride;
2853 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002854 if (sTelecomService == null) {
2855 ITelecomService temp = ITelecomService.Stub.asInterface(
2856 ServiceManager.getService(Context.TELECOM_SERVICE));
2857 synchronized (CACHE_LOCK) {
2858 if (sTelecomService == null && temp != null) {
2859 try {
2860 sTelecomService = temp;
2861 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2862 } catch (Exception e) {
2863 sTelecomService = null;
2864 }
2865 }
2866 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002867 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002868 return sTelecomService;
2869 }
2870
2871 private static class DeathRecipient implements IBinder.DeathRecipient {
2872 @Override
2873 public void binderDied() {
2874 resetServiceCache();
2875 }
2876 }
2877
2878 private static void resetServiceCache() {
2879 synchronized (CACHE_LOCK) {
2880 if (sTelecomService != null) {
2881 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2882 sTelecomService = null;
2883 }
2884 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002885 }
Evan Charlton235c1592014-09-05 15:41:23 +00002886}