blob: d89c9c16eb098c815e2f6af50e46d15d4fb1213c [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 /**
Alexey Patosin8d3ec6f2024-01-05 18:09:48 +0000425 * Extra URI that is used by a dialer to query the {@link android.provider.CallLog} content
426 * provider and associate a missed call notification with a call log entry.
Kunduz Baryktabasovae2484c02023-10-02 10:46:49 +0000427 */
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
Pranav Madapurmath24616192024-01-16 15:26:40 -08001052 /**
1053 * Controls audio route for video calls.
1054 * 0 - Use the default audio routing strategy.
1055 * 1 - Disable the speaker. Route the audio to Headset or Bluetooth
1056 * or Earpiece, based on the default audio routing strategy.
1057 * @hide
1058 */
1059 public static final String PROPERTY_VIDEOCALL_AUDIO_OUTPUT = "persist.radio.call.audio.output";
1060
Hall Liu4a9fde12020-01-16 17:38:46 -08001061 /*
Pranav Madapurmath24616192024-01-16 15:26:40 -08001062 * Values for the adb property "persist.radio.call.audio.output"
Hall Liu4a9fde12020-01-16 17:38:46 -08001063 */
1064 /** @hide */
1065 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1066 /** @hide */
1067 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1068 /** @hide */
1069 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1070
Tyler Gunn00d737b2019-10-31 13:04:37 -07001071 /** @hide */
1072 @Retention(RetentionPolicy.SOURCE)
1073 @IntDef(
1074 prefix = { "PRESENTATION_" },
1075 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001076 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001077 public @interface Presentation {}
1078
Brad Ebingera8366ae2021-03-23 21:01:51 +00001079
1080 /**
1081 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1082 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1083 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001084 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001085 */
1086 @ChangeId
1087 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1088 // this magic number is a bug ID
1089 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1090
Grace Jiab13eb2c2021-04-21 14:13:26 -07001091 /**
1092 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1093 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1094 * @hide
1095 */
1096 @ChangeId
1097 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1098 // bug ID
1099 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1100
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001101 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001102
Kevin Jeon767cda32020-11-17 01:40:16 +00001103
1104 /** Cached service handles, cleared by resetServiceCache() at death */
1105 private static final Object CACHE_LOCK = new Object();
1106
1107 @GuardedBy("CACHE_LOCK")
1108 private static ITelecomService sTelecomService;
1109 @GuardedBy("CACHE_LOCK")
1110 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1111
Yorke Leeb4ce1432014-06-09 13:53:23 -07001112 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001113
Hall Liue1bc2ec2015-10-09 15:58:37 -07001114 private final ITelecomService mTelecomServiceOverride;
1115
Thomas Stuart9bfb2432022-09-27 15:02:07 -07001116 /** @hide **/
1117 private final ClientTransactionalServiceRepository mTransactionalServiceRepository =
1118 new ClientTransactionalServiceRepository();
1119 /** @hide **/
1120 public static final int TELECOM_TRANSACTION_SUCCESS = 0;
1121 /** @hide **/
1122 public static final String TRANSACTION_CALL_ID_KEY = "TelecomCallId";
1123
Santos Cordon6c7a3882014-06-25 15:30:08 -07001124 /**
1125 * @hide
1126 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001127 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001128 public static TelecomManager from(Context context) {
1129 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001130 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001131
1132 /**
1133 * @hide
1134 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001135 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001136 this(context, null);
1137 }
1138
1139 /**
1140 * @hide
1141 */
1142 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001143 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001144 if (appContext != null && Objects.equals(context.getAttributionTag(),
1145 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001146 mContext = appContext;
1147 } else {
1148 mContext = context;
1149 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001150 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001151 }
1152
1153 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001154 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1155 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1156 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1157 * account returned depends on the following priorities:
1158 * <ul>
1159 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1160 * be returned.
1161 * </li>
1162 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1163 * will be returned.
1164 * </li>
1165 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001166 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001167 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1168 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001169 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001170 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001171 */
Yorke Leec61d13662015-09-21 17:25:25 -07001172 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001173 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001174 ITelecomService service = getTelecomService();
1175 if (service != null) {
1176 try {
1177 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001178 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001179 } catch (RemoteException e) {
1180 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001181 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001182 }
1183 return null;
1184 }
1185
1186 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001187 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1188 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001189 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001190 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001191 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1192 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001193 * <p>
1194 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001195 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001196 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1197 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001198 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001199 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001200 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001201 ITelecomService service = getTelecomService();
1202 if (service != null) {
1203 try {
1204 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001205 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001206 } catch (RemoteException e) {
1207 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001208 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001209 }
1210 return null;
1211 }
1212
1213 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001214 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1215 *
1216 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001217 * outgoing voice calls, or {@code null} if no default is specified (the
1218 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001219 * @hide
1220 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001221 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1222 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001223 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001224 ITelecomService service = getTelecomService();
1225 if (service != null) {
1226 try {
1227 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1228 } catch (RemoteException e) {
1229 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001230 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001231 }
1232 }
1233
1234 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001235 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001236 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1237 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001238 *
Brad Ebingere7833312019-05-07 10:55:55 -07001239 * @return The phone account handle of the current sim call manager for the default voice
1240 * subscription.
1241 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001242 */
1243 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001244 ITelecomService service = getTelecomService();
1245 if (service != null) {
1246 try {
1247 return service.getSimCallManager(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001248 SubscriptionManager.getDefaultSubscriptionId(), mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001249 } catch (RemoteException e) {
1250 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001251 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001252 }
1253 return null;
1254 }
1255
1256 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001257 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1258 * prepared for this method to return {@code null}, indicating that there currently exists no
1259 * SIM call manager {@link PhoneAccount} for the subscription specified.
1260 *
1261 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1262 * queried for.
1263 * @return The phone account handle of the current sim call manager.
1264 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001265 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001266 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001267 ITelecomService service = getTelecomService();
1268 if (service != null) {
1269 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001270 return service.getSimCallManager(subscriptionId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001271 } catch (RemoteException e) {
1272 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001273 }
Brad Ebingere7833312019-05-07 10:55:55 -07001274 }
1275 return null;
1276 }
1277
1278 /**
1279 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1280 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1281 * must be prepared for this method to return {@code null}, indicating that there currently
1282 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001283 *
1284 * @return The phone account handle of the current sim call manager.
1285 *
1286 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001287 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001288 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001289 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001290 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001291 ITelecomService service = getTelecomService();
1292 if (service != null) {
1293 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001294 return service.getSimCallManagerForUser(userId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001295 } catch (RemoteException e) {
1296 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001297 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001298 }
1299 return null;
1300 }
1301
1302 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001303 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001304 * {@code null}, indicating that there currently exists no Connection Manager
1305 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001306 *
1307 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001308 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001309 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001310 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001311 public PhoneAccountHandle getConnectionManager() {
1312 return getSimCallManager();
1313 }
1314
1315 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001316 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1317 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001318 * <P>
1319 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1320 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1321 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1322 * such as {@code sip:example@sipexample.com}).
1323 *
1324 * @param uriScheme The URI scheme.
1325 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001326 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001327 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001328 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001329 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001330 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001331 android.Manifest.permission.READ_PHONE_STATE
1332 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001333 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001334 ITelecomService service = getTelecomService();
1335 if (service != null) {
1336 try {
1337 return service.getPhoneAccountsSupportingScheme(uriScheme,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001338 mContext.getOpPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001339 } catch (RemoteException e) {
1340 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001341 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001342 }
1343 return new ArrayList<>();
1344 }
1345
Nancy Chen513c8922014-09-17 14:47:20 -07001346
1347 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001348 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1349 * calls. The returned list includes only those accounts which have been explicitly enabled
1350 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001351 *
1352 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1353 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001354 */
Yorke Leec61d13662015-09-21 17:25:25 -07001355 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001356 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001357 return getCallCapablePhoneAccounts(false);
1358 }
1359
1360 /**
Hui Wang65d91e82023-10-31 10:58:28 -05001361 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
Hui Wang22747ec2024-02-02 12:05:27 -06001362 * calls. The returned list includes those accounts which have been explicitly enabled.
1363 * In contrast to {@link #getCallCapablePhoneAccounts}, this also includes accounts from
1364 * the calling user's {@link android.os.UserManager#getUserProfiles} profile group.
Hui Wang65d91e82023-10-31 10:58:28 -05001365 *
1366 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1367 * @return A list of {@code PhoneAccountHandle} objects.
1368 *
1369 * @throws IllegalStateException if telecom service is null.
1370 */
1371 @FlaggedApi(com.android.internal.telephony.flags.Flags.FLAG_WORK_PROFILE_API_SPLIT)
1372 @RequiresPermission(allOf = {android.Manifest.permission.READ_PHONE_STATE,
1373 android.Manifest.permission.INTERACT_ACROSS_PROFILES})
1374 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccountsAcrossProfiles() {
1375 return getCallCapablePhoneAccountsAcrossProfiles(false);
1376 }
1377
1378
1379 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001380 * Returns a list of {@link PhoneAccountHandle}s for all self-managed
1381 * {@link ConnectionService}s owned by the calling {@link UserHandle}.
Tyler Gunn89317072017-04-07 14:57:37 -07001382 * <p>
1383 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1384 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1385 * <p>
1386 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuart510f49a2022-01-28 23:06:57 +00001387 * is the default dialer app.
Tyler Gunn89317072017-04-07 14:57:37 -07001388 * <p>
Thomas Stuart510f49a2022-01-28 23:06:57 +00001389 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1390 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
Tyler Gunn89317072017-04-07 14:57:37 -07001391 *
1392 * @return A list of {@code PhoneAccountHandle} objects.
1393 */
Thomas Stuart510f49a2022-01-28 23:06:57 +00001394 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1395 public @NonNull List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001396 ITelecomService service = getTelecomService();
1397 if (service != null) {
1398 try {
1399 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001400 mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001401 } catch (RemoteException e) {
1402 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001403 }
Tyler Gunn89317072017-04-07 14:57:37 -07001404 }
1405 return new ArrayList<>();
1406 }
1407
1408 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001409 * Returns a list of {@link PhoneAccountHandle}s owned by the calling self-managed
1410 * {@link ConnectionService}.
1411 * <p>
1412 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1413 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1414 * <p>
1415 * Requires permission {@link android.Manifest.permission#MANAGE_OWN_CALLS}
1416 * <p>
1417 * A {@link SecurityException} will be thrown if a caller lacks the
1418 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission.
1419 *
1420 * @return A list of {@code PhoneAccountHandle} objects.
1421 */
1422 @RequiresPermission(Manifest.permission.MANAGE_OWN_CALLS)
1423 public @NonNull List<PhoneAccountHandle> getOwnSelfManagedPhoneAccounts() {
1424 ITelecomService service = getTelecomService();
1425 if (service != null) {
1426 try {
1427 return service.getOwnSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001428 mContext.getAttributionTag()).getList();
Thomas Stuart510f49a2022-01-28 23:06:57 +00001429 } catch (RemoteException e) {
1430 throw e.rethrowFromSystemServer();
1431 }
1432 }
1433 throw new IllegalStateException("Telecom is not available");
1434 }
1435
1436 /**
Thomas Stuart920b3872024-02-28 13:13:50 -08001437 * This API will return all {@link PhoneAccount}s the caller registered via
1438 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}. If a {@link PhoneAccount} appears
1439 * to be missing from the list, Telecom has either unregistered the {@link PhoneAccount} (for
1440 * cleanup purposes) or the caller registered the {@link PhoneAccount} under a different user
1441 * and does not have the {@link android.Manifest.permission#INTERACT_ACROSS_USERS} permission.
1442 * <b>Note:</b> This API will only return {@link PhoneAccount}s registered by the same app. For
1443 * system Dialers that need all the {@link PhoneAccount}s registered by every application, see
1444 * {@link TelecomManager#getAllPhoneAccounts()}.
Thomas Stuart1a9c30a2024-01-04 16:03:34 -08001445 *
1446 * @return all the {@link PhoneAccount}s registered by the caller.
1447 */
1448 @SuppressLint("RequiresPermission")
1449 @FlaggedApi(Flags.FLAG_GET_REGISTERED_PHONE_ACCOUNTS)
1450 public @NonNull List<PhoneAccount> getRegisteredPhoneAccounts() {
1451 ITelecomService service = getTelecomService();
1452 if (service != null) {
1453 try {
1454 return service.getRegisteredPhoneAccounts(
1455 mContext.getOpPackageName(),
1456 mContext.getAttributionTag()).getList();
1457 } catch (RemoteException e) {
1458 throw e.rethrowFromSystemServer();
1459 }
1460 }
1461 throw new IllegalStateException("Telecom is not available");
1462 }
1463
1464 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001465 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1466 * by the user.
1467 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001468 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001469 * when {@code false}, only enabled phone accounts will be
1470 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001471 * @return A list of {@code PhoneAccountHandle} objects.
1472 * @hide
1473 */
Hall Liub2306242019-11-15 17:13:05 -08001474 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001475 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1476 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1477 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001478 ITelecomService service = getTelecomService();
1479 if (service != null) {
1480 try {
1481 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Hui Wang65d91e82023-10-31 10:58:28 -05001482 mContext.getOpPackageName(), mContext.getAttributionTag(), false).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001483 } catch (RemoteException e) {
1484 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1485 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001486 }
Nancy Chen513c8922014-09-17 14:47:20 -07001487 }
1488 return new ArrayList<>();
1489 }
1490
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001491 /**
Hui Wang65d91e82023-10-31 10:58:28 -05001492 * Returns a list of {@link PhoneAccountHandle}s visible to current user including those which
1493 * have not been enabled by the user.
1494 *
1495 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
1496 * when {@code false}, only enabled phone accounts will be
1497 * included.
1498 * @return A list of {@code PhoneAccountHandle} objects.
1499 *
1500 * @throws IllegalStateException if telecom service is null.
1501 * @hide
1502 */
1503 @SystemApi
1504 @FlaggedApi(com.android.internal.telephony.flags.Flags.FLAG_WORK_PROFILE_API_SPLIT)
1505 @RequiresPermission(allOf = {android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
1506 android.Manifest.permission.INTERACT_ACROSS_PROFILES})
1507 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccountsAcrossProfiles(
1508 boolean includeDisabledAccounts) {
1509 ITelecomService service = getTelecomService();
1510 if (service == null) {
1511 throw new IllegalStateException("telecom service is null.");
1512 }
1513
1514 try {
1515 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
1516 mContext.getOpPackageName(), mContext.getAttributionTag(), true).getList();
1517 } catch (RemoteException e) {
Hui Wang75fbe5e2024-01-19 13:37:52 -06001518 throw e.rethrowFromSystemServer();
Hui Wang65d91e82023-10-31 10:58:28 -05001519 }
1520 }
1521
1522 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001523 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1524 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001525 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1526 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001527 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001528 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001529 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001530 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001531 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001532 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001533 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001534 ITelecomService service = getTelecomService();
1535 if (service != null) {
1536 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001537 return service.getPhoneAccountsForPackage(mContext.getPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001538 } catch (RemoteException e) {
1539 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001540 }
Nancy Chen513c8922014-09-17 14:47:20 -07001541 }
1542 return null;
1543 }
1544
1545 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001546 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1547 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001548 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001549 * Requires Permission:
1550 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1551 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001552 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001553 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001554 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001555 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001556 ITelecomService service = getTelecomService();
1557 if (service != null) {
1558 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001559 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001560 } catch (RemoteException e) {
1561 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001562 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001563 }
1564 return null;
1565 }
1566
1567 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001568 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001569 *
Nancy Chen210ef032014-09-15 17:58:42 -07001570 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001571 * @hide
1572 */
1573 @SystemApi
1574 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001575 ITelecomService service = getTelecomService();
1576 if (service != null) {
1577 try {
1578 return service.getAllPhoneAccountsCount();
1579 } catch (RemoteException e) {
1580 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001581 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001582 }
1583 return 0;
1584 }
1585
1586 /**
1587 * Returns a list of all {@link PhoneAccount}s.
1588 *
1589 * @return All {@link PhoneAccount}s.
1590 * @hide
1591 */
1592 @SystemApi
1593 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001594 ITelecomService service = getTelecomService();
1595 if (service != null) {
1596 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001597 return service.getAllPhoneAccounts().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001598 } catch (RemoteException e) {
1599 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001600 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001601 }
1602 return Collections.EMPTY_LIST;
1603 }
1604
1605 /**
1606 * Returns a list of all {@link PhoneAccountHandle}s.
1607 *
1608 * @return All {@link PhoneAccountHandle}s.
1609 * @hide
1610 */
1611 @SystemApi
1612 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001613 ITelecomService service = getTelecomService();
1614 if (service != null) {
1615 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001616 return service.getAllPhoneAccountHandles().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001617 } catch (RemoteException e) {
1618 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001619 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001620 }
1621 return Collections.EMPTY_LIST;
1622 }
1623
1624 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001625 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1626 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1627 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001628 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1629 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1630 * the phone app settings before the account is usable.
1631 * <p>
Thomas Stuarte0416212022-01-31 20:31:42 +00001632 * Note: Each package is limited to 10 {@link PhoneAccount} registrations.
1633 * <p>
Santos Cordond9e614f2014-10-28 13:10:36 -07001634 * A {@link SecurityException} will be thrown if an app tries to register a
1635 * {@link PhoneAccountHandle} where the package name specified within
1636 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Thomas Stuarte0416212022-01-31 20:31:42 +00001637 * <p>
1638 * A {@link IllegalArgumentException} will be thrown if an app tries to register a
1639 * {@link PhoneAccount} when the upper bound limit, 10, has already been reached.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001640 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001641 * @param account The complete {@link PhoneAccount}.
Pranav Madapurmath9ad30392024-02-05 15:05:16 -08001642 * @throws UnsupportedOperationException if the caller cannot modify phone state and the device
1643 * does not have the Telecom feature.
1644 * @throws SecurityException if:
1645 * <ol>
1646 * <li>the caller cannot modify phone state and the phone account doesn't belong to the
1647 * calling user.</li>
1648 * <li>the caller is registering a self-managed phone and either they are not allowed to
1649 * manage their own calls or if the account is call capable, a connection manager, or a
1650 * sim account.</li>
1651 * <li>the caller is registering a sim account without the ability to do so.</li>
1652 * <li>the caller is registering a multi-user phone account but isn't a system app.</li>
1653 * <li>the account can make SIM-based voice calls but the caller cannot register sim
1654 * accounts or isn't a sim call manager.</li>
1655 * <li>the account defines the EXTRA_SKIP_CALL_FILTERING extra but the caller isn't
1656 * able to modify the phone state.</li>
1657 * <li>the caller is registering an account for a different user but isn't able to
1658 * interact across users.</li>
1659 * <li>if simultaneous calling is available and the phone account package name doesn't
1660 * correspond to the simultaneous calling accounts associated with this phone account.</li>
1661 * </ol>
Ihab Awad807fe0a2014-07-09 12:30:52 -07001662 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001663 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001664 ITelecomService service = getTelecomService();
1665 if (service != null) {
1666 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001667 service.registerPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001668 } catch (RemoteException e) {
1669 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001670 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001671 }
1672 }
1673
1674 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001675 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001676 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001677 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001678 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001679 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001680 ITelecomService service = getTelecomService();
1681 if (service != null) {
1682 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001683 service.unregisterPhoneAccount(accountHandle, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001684 } catch (RemoteException e) {
1685 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001686 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001687 }
1688 }
1689
1690 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001691 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001692 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001693 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001694 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001695 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001696 public void clearPhoneAccounts() {
1697 clearAccounts();
1698 }
1699 /**
1700 * Remove all Accounts that belong to the calling package from the system.
1701 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1702 * @hide
1703 */
1704 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001705 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001706 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001707 ITelecomService service = getTelecomService();
1708 if (service != null) {
1709 try {
1710 service.clearAccounts(mContext.getPackageName());
1711 } catch (RemoteException e) {
1712 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001713 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001714 }
1715 }
1716
1717 /**
Anthony Lee67279262014-10-27 11:28:40 -07001718 * Remove all Accounts that belong to the specified package from the system.
1719 * @hide
1720 */
1721 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001722 ITelecomService service = getTelecomService();
1723 if (service != null) {
1724 try {
1725 if (!TextUtils.isEmpty(packageName)) {
1726 service.clearAccounts(packageName);
1727 }
1728 } catch (RemoteException e) {
1729 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001730 }
Anthony Lee67279262014-10-27 11:28:40 -07001731 }
1732 }
1733
Yorke Lee1011f482015-04-23 15:58:27 -07001734
Anthony Lee67279262014-10-27 11:28:40 -07001735 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001736 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1737 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001738 * @hide
1739 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001740 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001741 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001742 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001743 ITelecomService service = getTelecomService();
1744 if (service != null) {
1745 try {
1746 return service.getDefaultPhoneApp();
1747 } catch (RemoteException e) {
1748 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001749 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001750 }
1751 return null;
1752 }
1753
Santos Cordon9eb45932014-06-27 12:28:43 -07001754 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001755 * Used to determine the currently selected default dialer package.
1756 *
1757 * @return package name for the default dialer package or null if no package has been
1758 * selected as the default dialer.
1759 */
1760 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001761 ITelecomService service = getTelecomService();
1762 if (service != null) {
1763 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001764 return service.getDefaultDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001765 } catch (RemoteException e) {
1766 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001767 }
Yorke Lee1011f482015-04-23 15:58:27 -07001768 }
1769 return null;
1770 }
1771
1772 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001773 * Used to determine the currently selected default dialer package for a specific user.
1774 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001775 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001776 * @return package name for the default dialer package or null if no package has been
1777 * selected as the default dialer.
1778 * @hide
1779 */
1780 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001781 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001782 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001783 ITelecomService service = getTelecomService();
1784 if (service != null) {
1785 try {
1786 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001787 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001788 } catch (RemoteException e) {
1789 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001790 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001791 }
1792 return null;
1793 }
1794
1795 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001796 * Used to set the default dialer package.
1797 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001798 * @param packageName to set the default dialer to, or {@code null} if the system provided
1799 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001800 *
1801 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1802 * the specified package does not correspond to an installed dialer, or is already
1803 * the default dialer.
1804 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001805 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001806 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001807 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1808 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001809 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001810 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001811 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001812 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001813 @RequiresPermission(allOf = {
1814 android.Manifest.permission.MODIFY_PHONE_STATE,
1815 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001816 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001817 ITelecomService service = getTelecomService();
1818 if (service != null) {
1819 try {
1820 return service.setDefaultDialer(packageName);
1821 } catch (RemoteException e) {
1822 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001823 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001824 }
1825 return false;
1826 }
1827
1828 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001829 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001830 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001831 * @return package name for the system dialer package or {@code null} if no system dialer is
1832 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001833 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001834 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001835 ITelecomService service = getTelecomService();
1836 if (service != null) {
1837 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001838 return service.getSystemDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001839 } catch (RemoteException e) {
1840 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001841 }
Yorke Lee1011f482015-04-23 15:58:27 -07001842 }
1843 return null;
1844 }
1845
1846 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001847 * Return whether a given phone number is the configured voicemail number for a
1848 * particular phone account.
1849 *
1850 * @param accountHandle The handle for the account to check the voicemail number against
1851 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001852 */
Yorke Leec61d13662015-09-21 17:25:25 -07001853 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001854 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001855 ITelecomService service = getTelecomService();
1856 if (service != null) {
1857 try {
1858 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001859 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001860 } catch (RemoteException e) {
1861 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001862 }
Nancy Chen443e5012014-10-15 15:48:21 -07001863 }
1864 return false;
1865 }
1866
1867 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001868 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001869 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001870 * @param accountHandle The handle for the phone account.
1871 * @return The voicemail number for the phone account, and {@code null} if one has not been
1872 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001873 */
Yorke Leec61d13662015-09-21 17:25:25 -07001874 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001875 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001876 ITelecomService service = getTelecomService();
1877 if (service != null) {
1878 try {
1879 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001880 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001881 } catch (RemoteException e) {
1882 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001883 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001884 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001885 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001886 }
1887
1888 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001889 * Return the line 1 phone number for given phone account.
1890 *
Michael Groover08490f12020-03-24 14:08:14 -07001891 * <p>Requires Permission:
1892 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1893 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1894 * or that the caller is the default SMS app for any API level.
1895 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1896 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001897 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001898 * @param accountHandle The handle for the account retrieve a number for.
1899 * @return A string representation of the line 1 phone number.
Meng Wang8665b512021-11-18 15:13:43 -08001900 * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1901 * Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1902 * from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
Nancy Chen5cf27842015-01-24 23:30:27 -08001903 */
Meng Wang8665b512021-11-18 15:13:43 -08001904 @Deprecated
Michael Groover08490f12020-03-24 14:08:14 -07001905 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1906 @RequiresPermission(anyOf = {
1907 android.Manifest.permission.READ_PHONE_STATE,
1908 android.Manifest.permission.READ_SMS,
1909 android.Manifest.permission.READ_PHONE_NUMBERS
1910 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001911 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001912 ITelecomService service = getTelecomService();
1913 if (service != null) {
1914 try {
1915 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001916 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001917 } catch (RemoteException e) {
1918 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001919 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001920 }
1921 return null;
1922 }
1923
1924 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001925 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001926 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001927 *
1928 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1929 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001930 */
Yorke Leec61d13662015-09-21 17:25:25 -07001931 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001932 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001933 ITelecomService service = getTelecomService();
1934 if (service != null) {
1935 try {
1936 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001937 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001938 } catch (RemoteException e) {
1939 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001940 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001941 }
1942 return false;
1943 }
1944
1945 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001946 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1947 * permission. The permission can be obtained by associating with a physical wearable device
1948 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1949 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001950 *
1951 * @return {@code true} if the caller has {@link InCallService} access for
1952 * companion app; {@code false} otherwise.
1953 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001954 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001955 ITelecomService service = getTelecomService();
1956 if (service != null) {
1957 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001958 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001959 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001960 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001961 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001962 if (!isSystemProcess()) {
1963 e.rethrowAsRuntimeException();
1964 }
Shuo Qian4d065262020-10-20 11:04:28 -07001965 }
1966 }
1967 return false;
1968 }
1969
1970 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001971 * Returns whether there is an ongoing call originating from a managed
1972 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1973 * states.
1974 * <p>
1975 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1976 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001977 *
1978 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1979 * {@code false} otherwise.
1980 */
1981 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1982 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001983 ITelecomService service = getTelecomService();
1984 if (service != null) {
1985 try {
1986 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001987 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001988 } catch (RemoteException e) {
1989 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001990 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001991 }
1992 return false;
1993 }
1994
1995 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001996 * Returns one of the following constants that represents the current state of Telecom:
1997 *
1998 * {@link TelephonyManager#CALL_STATE_RINGING}
1999 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
2000 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07002001 *
Tyler Gunn24e18332017-02-10 09:42:49 -08002002 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00002003 * <p>
2004 * Requires Permission:
2005 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
2006 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08002007 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07002008 * @hide
2009 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00002010 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
2011 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07002012 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07002013 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002014 ITelecomService service = getTelecomService();
2015 if (service != null) {
2016 try {
Thomas Stuartde1f1f22022-11-16 22:17:42 +00002017 return service.getCallStateUsingPackage(mContext.getOpPackageName(),
Brad Ebingera8366ae2021-03-23 21:01:51 +00002018 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002019 } catch (RemoteException e) {
2020 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07002021 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07002022 }
2023 return TelephonyManager.CALL_STATE_IDLE;
2024 }
2025
2026 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07002027 * Returns whether there currently exists is a ringing incoming-call.
2028 *
Tyler Gunn24e18332017-02-10 09:42:49 -08002029 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07002030 * @hide
2031 */
2032 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002033 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07002034 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002035 android.Manifest.permission.READ_PHONE_STATE
2036 })
Santos Cordon9eb45932014-06-27 12:28:43 -07002037 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002038 ITelecomService service = getTelecomService();
2039 if (service != null) {
2040 try {
2041 return service.isRinging(mContext.getOpPackageName());
2042 } catch (RemoteException e) {
2043 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002044 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002045 }
2046 return false;
2047 }
2048
2049 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07002050 * Ends the foreground call on the device.
2051 * <p>
2052 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
2053 * foreground call is ended.
2054 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07002055 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
2056 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07002057 *
2058 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
2059 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002060 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
2061 * instead. Apps performing call screening should use the {@link CallScreeningService} API
2062 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07002063 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07002064 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002065 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07002066 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002067 ITelecomService service = getTelecomService();
2068 if (service != null) {
2069 try {
2070 return service.endCall(mContext.getPackageName());
2071 } catch (RemoteException e) {
2072 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002073 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002074 }
2075 return false;
2076 }
2077
2078 /**
2079 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002080 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07002081 * If the incoming call is a video call, the call will be answered with the same video state as
2082 * the incoming call requests. This means, for example, that an incoming call requesting
2083 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002084 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002085 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
2086 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07002087 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002088 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
2089 // this method (clockwork & gearhead).
2090 @RequiresPermission(anyOf =
2091 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002092 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07002093 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002094 ITelecomService service = getTelecomService();
2095 if (service != null) {
2096 try {
2097 service.acceptRingingCall(mContext.getPackageName());
2098 } catch (RemoteException e) {
2099 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002100 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002101 }
2102 }
2103
2104 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07002105 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
2106 * with the specified video state.
2107 *
2108 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002109 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
2110 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07002111 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002112 @RequiresPermission(anyOf =
2113 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08002114 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07002115 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002116 ITelecomService service = getTelecomService();
2117 if (service != null) {
2118 try {
2119 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002120 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002121 } catch (RemoteException e) {
2122 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07002123 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07002124 }
2125 }
2126
2127 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07002128 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07002129 * <p>
2130 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
2131 * already started playing. It is intended to handle use-cases such as silencing a ringing call
2132 * when the user presses the volume button during ringing.
2133 * <p>
2134 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
2135 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
2136 * <p>
2137 * A dialer app which wants to have more control over ringtone playing should declare
2138 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
2139 * {@link InCallService} implementation to indicate that the app wants to be responsible for
2140 * playing the ringtone for all incoming calls.
2141 * <p>
2142 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
2143 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07002144 */
Yorke Leec61d13662015-09-21 17:25:25 -07002145 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07002146 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002147 ITelecomService service = getTelecomService();
2148 if (service != null) {
2149 try {
2150 service.silenceRinger(mContext.getOpPackageName());
2151 } catch (RemoteException e) {
2152 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002153 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002154 }
2155 }
2156
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002157 /**
2158 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002159 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002160 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07002161 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002162 android.Manifest.permission.READ_PHONE_STATE
2163 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002164 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002165 ITelecomService service = getTelecomService();
2166 if (service != null) {
2167 try {
2168 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002169 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002170 } catch (RemoteException e) {
2171 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002172 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002173 }
2174 return false;
2175 }
2176
2177 /**
2178 * 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 -07002179 * settings and have a wired headset plugged in.
2180 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002181 * - {@link TelecomManager#TTY_MODE_OFF}
2182 * - {@link TelecomManager#TTY_MODE_FULL}
2183 * - {@link TelecomManager#TTY_MODE_HCO}
2184 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002185 * @hide
2186 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002187 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07002188 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002189 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002190 ITelecomService service = getTelecomService();
2191 if (service != null) {
2192 try {
2193 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002194 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002195 } catch (RemoteException e) {
2196 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002197 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002198 }
Evan Charlton10197192014-07-19 15:00:29 -07002199 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002200 }
2201
Santos Cordon96efb482014-07-19 14:57:05 -07002202 /**
2203 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08002204 * has an incoming call. For managed {@link ConnectionService}s, the specified
2205 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2206 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2207 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2208 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2209 * <p>
Tyler Gunnd8778662023-02-10 17:13:11 +00002210 * Specify the address associated with the incoming call using
2211 * {@link #EXTRA_INCOMING_CALL_ADDRESS}. If an incoming call is from an anonymous source, omit
2212 * this extra and ensure you specify a valid number presentation via
2213 * {@link Connection#setAddress(Uri, int)} on the {@link Connection} instance you return in
2214 * your
2215 * {@link ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)}
2216 * implementation.
2217 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002218 * The incoming call you are adding is assumed to have a video state of
2219 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2220 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2221 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002222 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2223 * associated with the {@link PhoneAccountHandle} and request additional information about the
2224 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002225 * call UI.
2226 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002227 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2228 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2229 * the associated {@link PhoneAccount} is not currently enabled by the user.
2230 * <p>
2231 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2232 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2233 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002234 * <p>
2235 * <p>
2236 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2237 * the call is added to Telecom in order for the notification to be non-dismissible.
Santos Cordon96efb482014-07-19 14:57:05 -07002238 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2239 * {@link #registerPhoneAccount}.
2240 * @param extras A bundle that will be passed through to
2241 * {@link ConnectionService#onCreateIncomingConnection}.
2242 */
2243 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002244 ITelecomService service = getTelecomService();
2245 if (service != null) {
2246 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002247 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2248 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2249 Build.VERSION_CODES.O_MR1) {
2250 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2251 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002252 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002253 }
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002254 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras,
2255 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002256 } catch (RemoteException e) {
2257 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002258 }
Santos Cordon96efb482014-07-19 14:57:05 -07002259 }
2260 }
2261
Nancy Chen0eb1e402014-08-21 22:52:29 -07002262 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302263 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002264 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2265 * call initiated on another device which the user is being invited to join in. For managed
2266 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2267 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2268 * corresponding {@link PhoneAccount}. This can be checked using
2269 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2270 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302271 * <p>
2272 * The incoming conference you are adding is assumed to have a video state of
2273 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2274 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2275 * <p>
2276 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2277 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002278 * call (See
2279 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2280 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302281 * <p>
2282 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2283 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2284 * the associated {@link PhoneAccount} is not currently enabled by the user.
2285 *
2286 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2287 * {@link #registerPhoneAccount}.
2288 * @param extras A bundle that will be passed through to
2289 * {@link ConnectionService#onCreateIncomingConference}.
2290 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302291 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2292 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002293 ITelecomService service = getTelecomService();
2294 if (service != null) {
2295 try {
2296 service.addNewIncomingConference(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002297 phoneAccount, extras == null ? new Bundle() : extras,
2298 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002299 } catch (RemoteException e) {
2300 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302301 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302302 }
2303 }
2304
2305 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002306 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2307 * service. This is invoked when Telephony detects a new unknown connection that was neither
2308 * a new incoming call, nor an user-initiated outgoing call.
2309 *
2310 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2311 * {@link #registerPhoneAccount}.
2312 * @param extras A bundle that will be passed through to
2313 * {@link ConnectionService#onCreateIncomingConnection}.
2314 * @hide
2315 */
2316 @SystemApi
2317 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002318 ITelecomService service = getTelecomService();
2319 if (service != null) {
2320 try {
2321 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002322 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002323 } catch (RemoteException e) {
2324 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002325 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002326 }
2327 }
2328
2329 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002330 * Processes the specified dial string as an MMI code.
2331 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2332 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002333 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002334 * <p>
2335 * Requires that the method-caller be set as the system dialer app.
2336 * </p>
2337 *
2338 * @param dialString The digits to dial.
2339 * @return True if the digits were processed as an MMI code, false otherwise.
2340 */
Yorke Leec61d13662015-09-21 17:25:25 -07002341 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Tomasz Wasilczyk46fddbb2024-08-30 15:05:20 -07002342 @RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002343 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002344 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002345 if (service != null) {
2346 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002347 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002348 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002349 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002350 }
2351 }
2352 return false;
2353 }
2354
2355 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002356 * Processes the specified dial string as an MMI code.
2357 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2358 * Some of these sequences launch special behavior through handled by Telephony.
2359 * <p>
2360 * Requires that the method-caller be set as the system dialer app.
2361 * </p>
2362 *
2363 * @param accountHandle The handle for the account the MMI code should apply to.
2364 * @param dialString The digits to dial.
2365 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002366 */
Yorke Leec61d13662015-09-21 17:25:25 -07002367 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Tomasz Wasilczyk46fddbb2024-08-30 15:05:20 -07002368 @RequiresFeature(PackageManager.FEATURE_TELEPHONY_CALLING)
Yorke Lee06044272015-04-14 15:16:59 -07002369 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002370 ITelecomService service = getTelecomService();
2371 if (service != null) {
2372 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002373 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2374 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002375 } catch (RemoteException e) {
2376 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2377 }
2378 }
2379 return false;
2380 }
2381
2382 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002383 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2384 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002385 * @param accountHandle The handle for the account to derive an adn query URI for or
2386 * {@code null} to return a URI which will use the default account.
2387 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2388 * for the the content retrieve.
2389 */
Yorke Leec61d13662015-09-21 17:25:25 -07002390 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002391 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2392 ITelecomService service = getTelecomService();
2393 if (service != null && accountHandle != null) {
2394 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002395 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002396 } catch (RemoteException e) {
2397 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2398 }
2399 }
2400 return Uri.parse("content://icc/adn");
2401 }
2402
2403 /**
Tyler Gunna2879412023-02-28 23:41:53 +00002404 * Removes the missed-call notification if one is present and marks missed calls in the call
2405 * log as read.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002406 * <p>
Tyler Gunna2879412023-02-28 23:41:53 +00002407 * Requires that the method-caller be set as the default dialer app.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002408 * </p>
2409 */
Yorke Leec61d13662015-09-21 17:25:25 -07002410 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002411 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002412 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002413 if (service != null) {
2414 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002415 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002416 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002417 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002418 }
2419 }
2420 }
2421
2422 /**
2423 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2424 * currently no ongoing call, then this method does nothing.
2425 * <p>
2426 * Requires that the method-caller be set as the system dialer app or have the
2427 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2428 * </p>
2429 *
2430 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2431 */
Yorke Leec61d13662015-09-21 17:25:25 -07002432 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002433 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002434 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002435 if (service != null) {
2436 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002437 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002438 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002439 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002440 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002441 }
2442 }
2443 }
2444
Yorke Lee3e56ba12015-04-23 12:32:36 -07002445 /**
2446 * Places a new outgoing call to the provided address using the system telecom service with
2447 * the specified extras.
2448 *
2449 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2450 * except that the outgoing call will always be sent via the system telecom service. If
2451 * method-caller is either the user selected default dialer app or preloaded system dialer
2452 * app, then emergency calls will also be allowed.
2453 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002454 * Placing a call via a managed {@link ConnectionService} requires permission:
2455 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002456 *
2457 * Usage example:
2458 * <pre>
2459 * Uri uri = Uri.fromParts("tel", "12345", null);
2460 * Bundle extras = new Bundle();
2461 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2462 * telecomManager.placeCall(uri, extras);
2463 * </pre>
2464 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002465 * The following keys are supported in the supplied extras.
2466 * <ul>
2467 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2468 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2469 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2470 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2471 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002472 * <p>
2473 * An app which implements the self-managed {@link ConnectionService} API uses
2474 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2475 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2476 * associated {@link android.telecom.PhoneAccountHandle}.
2477 *
2478 * Self-managed {@link ConnectionService}s require permission
2479 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002480 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002481 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2482 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2483 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2484 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2485 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2486 * </p>
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002487 * <p>
2488 * <p>
2489 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2490 * the call is placed in order for the notification to be non-dismissible.
Brad Ebinger8ad07c82023-10-30 20:39:09 +00002491 * <p><b>Note</b>: Call Forwarding MMI codes can only be dialed by applications that are
2492 * configured as the user defined default dialer or system dialer role. If a call containing a
2493 * call forwarding MMI code is placed by an application that is not in one of these roles, the
2494 * dialer will be launched with a UI showing the MMI code already populated so that the user can
2495 * confirm the action before the call is placed.
Yorke Lee3e56ba12015-04-23 12:32:36 -07002496 * @param address The address to make the call to.
2497 * @param extras Bundle of extras to use with the call.
2498 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002499 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2500 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002501 public void placeCall(Uri address, Bundle extras) {
2502 ITelecomService service = getTelecomService();
2503 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002504 if (address == null) {
2505 Log.w(TAG, "Cannot place call to empty address.");
2506 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002507 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002508 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002509 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002510 } catch (RemoteException e) {
2511 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2512 }
2513 }
2514 }
2515
Ravi Paluri80aa2142019-12-02 11:57:37 +05302516
2517 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002518 * Place a new adhoc conference call with the provided participants using the system telecom
2519 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302520 *
2521 * An adhoc conference call is established by providing a list of addresses to
2522 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2523 * {@link ConnectionService} is responsible for connecting all indicated participants
2524 * to a conference simultaneously.
2525 * This is in contrast to conferences formed by merging calls together (e.g. using
2526 * {@link android.telecom.Call#mergeConference()}).
2527 *
2528 * The following keys are supported in the supplied extras.
2529 * <ul>
2530 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2531 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2532 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2533 * </ul>
2534 *
2535 * @param participants List of participants to start conference with
2536 * @param extras Bundle of extras to use with the call
2537 */
2538 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2539 public void startConference(@NonNull List<Uri> participants,
2540 @NonNull Bundle extras) {
2541 ITelecomService service = getTelecomService();
2542 if (service != null) {
2543 try {
2544 service.startConference(participants, extras,
2545 mContext.getOpPackageName());
2546 } catch (RemoteException e) {
2547 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2548 }
2549 }
2550 }
2551
Santos Cordon91371dc02015-05-08 13:52:09 -07002552 /**
2553 * Enables and disables specified phone account.
2554 *
2555 * @param handle Handle to the phone account.
2556 * @param isEnabled Enable state of the phone account.
2557 * @hide
2558 */
2559 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002560 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002561 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2562 ITelecomService service = getTelecomService();
2563 if (service != null) {
2564 try {
2565 service.enablePhoneAccount(handle, isEnabled);
2566 } catch (RemoteException e) {
2567 Log.e(TAG, "Error enablePhoneAbbount", e);
2568 }
2569 }
2570 }
2571
Hall Liu0464b9b2016-01-12 15:32:58 -08002572 /**
2573 * Dumps telecom analytics for uploading.
2574 *
2575 * @return
2576 * @hide
2577 */
2578 @SystemApi
2579 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002580 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002581 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002582 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002583 if (service != null) {
2584 try {
2585 result = service.dumpCallAnalytics();
2586 } catch (RemoteException e) {
2587 Log.e(TAG, "Error dumping call analytics", e);
2588 }
2589 }
2590 return result;
2591 }
2592
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002593 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002594 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2595 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002596 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002597 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2598 * {@code true} for the current user.
2599 */
2600 public Intent createManageBlockedNumbersIntent() {
2601 ITelecomService service = getTelecomService();
2602 Intent result = null;
2603 if (service != null) {
2604 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002605 result = service.createManageBlockedNumbersIntent(mContext.getPackageName());
Nan Wuc51fd762022-08-01 21:08:23 +00002606 if (result != null) {
2607 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2608 mContext.getAttributionSource());
2609 }
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002610 } catch (RemoteException e) {
2611 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2612 }
2613 }
2614 return result;
2615 }
2616
Fan Zhang5431ef52019-10-14 13:43:46 -07002617
2618 /**
2619 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2620 * launch the activity for emergency dialer.
2621 *
2622 * @param number Optional number to call in emergency dialer
2623 * @hide
2624 */
2625 @SystemApi
2626 @NonNull
2627 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2628 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002629 if (service != null) {
2630 try {
Nan Wuc51fd762022-08-01 21:08:23 +00002631 Intent result = service.createLaunchEmergencyDialerIntent(number);
2632 if (result != null) {
2633 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2634 mContext.getAttributionSource());
2635 }
2636 return result;
Fan Zhang5431ef52019-10-14 13:43:46 -07002637 } catch (RemoteException e) {
2638 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2639 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002640 } else {
2641 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002642 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002643
2644 // Telecom service knows the package name of the expected emergency dialer package; if it
2645 // is not available, then fallback to not targeting a specific package.
2646 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2647 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2648 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2649 }
2650 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002651 }
2652
Tyler Gunnf5035432017-01-09 09:43:12 -08002653 /**
2654 * Determines whether Telecom would permit an incoming call to be added via the
2655 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2656 * {@link PhoneAccountHandle}.
2657 * <p>
2658 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2659 * in the following situations:
2660 * <ul>
2661 * <li>{@link PhoneAccount} does not have property
2662 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2663 * {@link ConnectionService}), and the active or held call limit has
2664 * been reached.</li>
2665 * <li>There is an ongoing emergency call.</li>
2666 * </ul>
2667 *
2668 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2669 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2670 * otherwise.
2671 */
2672 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002673 if (phoneAccountHandle == null) {
2674 return false;
2675 }
2676
Tyler Gunnf5035432017-01-09 09:43:12 -08002677 ITelecomService service = getTelecomService();
2678 if (service != null) {
2679 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002680 return service.isIncomingCallPermitted(phoneAccountHandle,
2681 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002682 } catch (RemoteException e) {
2683 Log.e(TAG, "Error isIncomingCallPermitted", e);
2684 }
2685 }
2686 return false;
2687 }
2688
2689 /**
2690 * Determines whether Telecom would permit an outgoing call to be placed via the
2691 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2692 * <p>
2693 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2694 * in the following situations:
2695 * <ul>
2696 * <li>{@link PhoneAccount} does not have property
2697 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2698 * {@link ConnectionService}), and the active, held or ringing call limit has
2699 * been reached.</li>
2700 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2701 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2702 * another {@link ConnectionService}.</li>
2703 * <li>There is an ongoing emergency call.</li>
2704 * </ul>
2705 *
2706 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2707 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2708 * otherwise.
2709 */
2710 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2711 ITelecomService service = getTelecomService();
2712 if (service != null) {
2713 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002714 return service.isOutgoingCallPermitted(phoneAccountHandle,
2715 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002716 } catch (RemoteException e) {
2717 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2718 }
2719 }
2720 return false;
2721 }
2722
Sanket Padawea8eddd42017-11-03 11:07:35 -07002723 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002724 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2725 * {@link PhoneAccountHandle} it defines.
2726 * <p>
2727 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2728 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2729 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2730 * is referred to as the source of the handover, and the video calling app is referred to as the
2731 * destination.
2732 * <p>
2733 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2734 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2735 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2736 * device.
2737 * <p>
2738 * For a full discussion of the handover process and the APIs involved, see
2739 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2740 * <p>
2741 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2742 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002743 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2744 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2745 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2746 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2747 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2748 * <p>
2749 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2750 * associated with the {@link PhoneAccountHandle} destAcct and call
2751 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2752 * <p>
2753 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2754 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2755 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2756 * user.
2757 * <p>
2758 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2759 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2760 *
2761 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2762 * {@link ConnectionService}.
2763 * @param videoState Video state after the handover.
2764 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2765 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002766 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2767 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002768 ITelecomService service = getTelecomService();
2769 if (service != null) {
2770 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002771 service.acceptHandover(srcAddr, videoState, destAcct, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002772 } catch (RemoteException e) {
2773 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002774 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002775 }
2776 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002777
Tyler Gunn5bd90852018-09-21 09:37:07 -07002778 /**
2779 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2780 * call, as identified by the dialed number, or because a call was identified by the network
2781 * as an emergency call.
2782 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2783 * @hide
2784 */
2785 @SystemApi
2786 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2787 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002788 ITelecomService service = getTelecomService();
2789 if (service != null) {
2790 try {
2791 return service.isInEmergencyCall();
2792 } catch (RemoteException e) {
2793 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2794 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002795 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002796 }
2797 return false;
2798 }
2799
Tyler Gunnc37445c2018-09-28 16:16:20 -07002800 /**
Tyler Gunn27bf4342022-03-25 14:17:52 -07002801 * Determines whether there are any ongoing {@link PhoneAccount#CAPABILITY_SELF_MANAGED}
Pranav Madapurmathdbb2887d2024-03-04 07:14:26 +00002802 * calls for a given {@code packageName} and {@code userHandle}. If UserHandle.ALL or a user
2803 * that isn't the calling user is passed in, the caller will need to have granted the ability
2804 * to interact across users.
Tyler Gunn27bf4342022-03-25 14:17:52 -07002805 *
2806 * @param packageName the package name of the app to check calls for.
Pranav Madapurmath4d509e02024-02-14 12:39:01 -08002807 * @param userHandle the user handle to check calls for.
Tyler Gunn27bf4342022-03-25 14:17:52 -07002808 * @return {@code true} if there are ongoing calls, {@code false} otherwise.
Pranav Madapurmath4d509e02024-02-14 12:39:01 -08002809 * @throws SecurityException if the userHandle is not the calling user and the caller does not
2810 * grant the ability to interact across users.
Tyler Gunn27bf4342022-03-25 14:17:52 -07002811 * @hide
2812 */
Pranav Madapurmathf6e8b18f2024-01-26 15:55:53 -08002813 @SystemApi
2814 @FlaggedApi(Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
Pranav Madapurmath63490382024-02-05 21:56:45 -08002815 @RequiresPermission(allOf = {Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
2816 Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
Tyler Gunn27bf4342022-03-25 14:17:52 -07002817 public boolean isInSelfManagedCall(@NonNull String packageName,
Pranav Madapurmath4d509e02024-02-14 12:39:01 -08002818 @NonNull UserHandle userHandle) {
Tyler Gunn27bf4342022-03-25 14:17:52 -07002819 ITelecomService service = getTelecomService();
2820 if (service != null) {
2821 try {
2822 return service.isInSelfManagedCall(packageName, userHandle,
Pranav Madapurmathdbb2887d2024-03-04 07:14:26 +00002823 mContext.getOpPackageName());
Tyler Gunn27bf4342022-03-25 14:17:52 -07002824 } catch (RemoteException e) {
2825 Log.e(TAG, "RemoteException isInSelfManagedCall: " + e);
2826 e.rethrowFromSystemServer();
2827 return false;
2828 }
2829 } else {
2830 throw new IllegalStateException("Telecom service is not present");
2831 }
2832 }
2833
2834 /**
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002835 * Add a call to the Android system service Telecom. This allows the system to start tracking an
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002836 * incoming or outgoing call with the specified {@link CallAttributes}. Once a call is added,
2837 * a {@link android.app.Notification.CallStyle} notification should be posted and when the
2838 * call is ready to be disconnected, use {@link CallControl#disconnect(DisconnectCause,
2839 * Executor, OutcomeReceiver)} which is provided by the
2840 * {@code pendingControl#onResult(CallControl)}.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002841 * <p>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002842 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002843 * <p>
2844 * <b>Call Lifecycle</b>: Your app is given foreground execution priority as long as you have a
2845 * valid call and are posting a {@link android.app.Notification.CallStyle} notification.
2846 * When your application is given foreground execution priority, your app is treated as a
2847 * foreground service. Foreground execution priority will prevent the
2848 * {@link android.app.ActivityManager} from killing your application when it is placed the
2849 * background. Foreground execution priority is removed from your app when all of your app's
2850 * calls terminate or your app no longer posts a valid notification.
2851 * <p>
2852 * <p>
2853 * <p>
2854 * <b>Note</b>: Only packages that register with
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002855 * {@link PhoneAccount#CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS}
2856 * can utilize this API. {@link PhoneAccount}s that set the capabilities
2857 * {@link PhoneAccount#CAPABILITY_SIM_SUBSCRIPTION},
2858 * {@link PhoneAccount#CAPABILITY_CALL_PROVIDER},
2859 * {@link PhoneAccount#CAPABILITY_CONNECTION_MANAGER}
2860 * are not supported and will cause an exception to be thrown.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002861 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002862 * <p>
2863 * <p>
2864 * <b>Usage example:</b>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002865 * <pre>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002866 * // Its up to your app on how you want to wrap the objects. One such implementation can be:
2867 * class MyVoipCall {
2868 * ...
2869 * public CallControlCallEventCallback handshakes = new CallControlCallback() {
2870 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002871 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002872 *
2873 * public CallEventCallback events = new CallEventCallback() {
2874 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002875 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002876 *
2877 * public MyVoipCall(String id){
2878 * ...
2879 * }
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002880 * }
2881 *
Thomas Stuart6e418b32023-02-06 08:22:08 -08002882 * MyVoipCall myFirstOutgoingCall = new MyVoipCall("1");
2883 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002884 * telecomManager.addCall(callAttributes,
2885 * Runnable::run,
2886 * new OutcomeReceiver() {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002887 * public void onResult(CallControl callControl) {
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002888 * // The call has been added successfully. For demonstration
2889 * // purposes, the call is disconnected immediately ...
2890 * callControl.disconnect(
2891 * new DisconnectCause(DisconnectCause.LOCAL) )
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002892 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002893 * },
2894 * myFirstOutgoingCall.handshakes,
2895 * myFirstOutgoingCall.events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002896 * </pre>
2897 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002898 * @param callAttributes attributes of the new call (incoming or outgoing, address, etc.)
2899 * @param executor execution context to run {@link CallControlCallback} updates on
2900 * @param pendingControl Receives the result of addCall transaction. Upon success, a
2901 * CallControl object is provided which can be used to do things like
2902 * disconnect the call that was added.
2903 * @param handshakes callback that receives <b>actionable</b> updates that originate from
2904 * Telecom.
2905 * @param events callback that receives <b>non</b>-actionable updates that originate
2906 * from Telecom.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002907 */
2908 @RequiresPermission(android.Manifest.permission.MANAGE_OWN_CALLS)
2909 @SuppressLint("SamShouldBeLast")
2910 public void addCall(@NonNull CallAttributes callAttributes,
2911 @NonNull @CallbackExecutor Executor executor,
2912 @NonNull OutcomeReceiver<CallControl, CallException> pendingControl,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002913 @NonNull CallControlCallback handshakes,
2914 @NonNull CallEventCallback events) {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002915 Objects.requireNonNull(callAttributes);
2916 Objects.requireNonNull(executor);
2917 Objects.requireNonNull(pendingControl);
Thomas Stuart6e418b32023-02-06 08:22:08 -08002918 Objects.requireNonNull(handshakes);
2919 Objects.requireNonNull(events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002920
2921 ITelecomService service = getTelecomService();
2922 if (service != null) {
2923 try {
2924 // create or add the new call to a service wrapper w/ the same phoneAccountHandle
2925 ClientTransactionalServiceWrapper transactionalServiceWrapper =
2926 mTransactionalServiceRepository.addNewCallForTransactionalServiceWrapper(
2927 callAttributes.getPhoneAccountHandle());
2928
2929 // couple all the args passed by the client
2930 String newCallId = transactionalServiceWrapper.trackCall(callAttributes, executor,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002931 pendingControl, handshakes, events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002932
2933 // send args to server to process new call
2934 service.addCall(callAttributes, transactionalServiceWrapper.getCallEventCallback(),
2935 newCallId, mContext.getOpPackageName());
2936 } catch (RemoteException e) {
2937 Log.e(TAG, "RemoteException addCall: " + e);
2938 e.rethrowFromSystemServer();
2939 }
2940 } else {
2941 throw new IllegalStateException("Telecom service is not present");
2942 }
2943 }
2944
2945 /**
Tyler Gunnc37445c2018-09-28 16:16:20 -07002946 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2947 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002948 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002949 * @hide
2950 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002951 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002952 ITelecomService service = getTelecomService();
2953 if (service != null) {
2954 try {
2955 service.handleCallIntent(intent, callingPackageProxy);
2956 } catch (RemoteException e) {
2957 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002958 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002959 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002960 }
2961
Shuo Qian4d065262020-10-20 11:04:28 -07002962 private boolean isSystemProcess() {
2963 return Process.myUid() == Process.SYSTEM_UID;
2964 }
2965
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002966 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002967 if (mTelecomServiceOverride != null) {
2968 return mTelecomServiceOverride;
2969 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002970 if (sTelecomService == null) {
2971 ITelecomService temp = ITelecomService.Stub.asInterface(
2972 ServiceManager.getService(Context.TELECOM_SERVICE));
2973 synchronized (CACHE_LOCK) {
2974 if (sTelecomService == null && temp != null) {
2975 try {
2976 sTelecomService = temp;
2977 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2978 } catch (Exception e) {
2979 sTelecomService = null;
2980 }
2981 }
2982 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002983 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002984 return sTelecomService;
2985 }
2986
2987 private static class DeathRecipient implements IBinder.DeathRecipient {
2988 @Override
2989 public void binderDied() {
2990 resetServiceCache();
2991 }
2992 }
2993
2994 private static void resetServiceCache() {
2995 synchronized (CACHE_LOCK) {
2996 if (sTelecomService != null) {
2997 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2998 sTelecomService = null;
2999 }
3000 }
Santos Cordon9eb45932014-06-27 12:28:43 -07003001 }
Evan Charlton235c1592014-09-05 15:41:23 +00003002}