blob: e3f7c1688a49b51478a450773d6fa90351b1c038 [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;
18
Hall Liu0464b9b2016-01-12 15:32:58 -080019import android.Manifest;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080020import android.annotation.IntDef;
Fan Zhang5431ef52019-10-14 13:43:46 -070021import android.annotation.NonNull;
Slava Shklyaeve65e4012019-03-04 16:02:34 +000022import android.annotation.Nullable;
Hui Wangc47df7f2021-12-14 20:37:47 +000023import android.annotation.RequiresFeature;
Yorke Leec61d13662015-09-21 17:25:25 -070024import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060025import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060026import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070027import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060028import android.annotation.SystemService;
Brad Ebingera8366ae2021-03-23 21:01:51 +000029import android.compat.annotation.ChangeId;
30import android.compat.annotation.EnabledSince;
Artur Satayev2ebb31c2020-01-08 12:24:36 +000031import android.compat.annotation.UnsupportedAppUsage;
Santos Cordon6c7a3882014-06-25 15:30:08 -070032import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070033import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070034import android.content.Intent;
Hui Wangc47df7f2021-12-14 20:37:47 +000035import android.content.pm.PackageManager;
Nancy Chenb2299c12014-10-29 18:22:11 -070036import android.net.Uri;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -080037import android.os.Build;
Santos Cordon96efb482014-07-19 14:57:05 -070038import android.os.Bundle;
Kevin Jeon767cda32020-11-17 01:40:16 +000039import android.os.IBinder;
Shuo Qian4d065262020-10-20 11:04:28 -070040import android.os.Process;
Santos Cordon6c7a3882014-06-25 15:30:08 -070041import android.os.RemoteException;
42import android.os.ServiceManager;
Tyler Gunn7e45b722018-12-04 12:56:45 -080043import android.os.UserHandle;
Chen Xuc9d4ee12019-09-26 16:11:59 -070044import android.telephony.Annotation.CallState;
Brad Ebingere7833312019-05-07 10:55:55 -070045import android.telephony.SubscriptionManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070046import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070047import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070048import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070049
Kevin Jeon767cda32020-11-17 01:40:16 +000050import com.android.internal.annotations.GuardedBy;
Tyler Gunnef9f6f92014-09-12 22:16:17 -070051import com.android.internal.telecom.ITelecomService;
Yorke Leeb4ce1432014-06-09 13:53:23 -070052
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080053import java.lang.annotation.Retention;
54import java.lang.annotation.RetentionPolicy;
Jay Shrauner7746a942014-08-26 12:15:15 -070055import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070056import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070057import java.util.List;
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -080058import java.util.Objects;
Tyler Gunn7e45b722018-12-04 12:56:45 -080059import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070060
Yorke Leeb4ce1432014-06-09 13:53:23 -070061/**
Santos Cordond9e614f2014-10-28 13:10:36 -070062 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080063 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070064 * <p>
65 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
66 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
67 * <p>
68 * Note that access to some telecom information is permission-protected. Your app cannot access the
69 * protected information or gain access to protected functionality unless it has the appropriate
70 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
71 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070072 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060073@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060074@SystemService(Context.TELECOM_SERVICE)
Hui Wangc47df7f2021-12-14 20:37:47 +000075@RequiresFeature(PackageManager.FEATURE_TELECOM)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070076public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070077
Evan Charlton10197192014-07-19 15:00:29 -070078 /**
Santos Cordon96efb482014-07-19 14:57:05 -070079 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070080 * UI by notifying the Telecom system that an incoming call exists for a specific call service
81 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
82 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070083 * ultimately use to control and get information about the call.
84 * <p>
85 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070086 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070087 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080088 *
89 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070090 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070091 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070092
93 /**
Yorke Leec3cf9822014-10-02 09:38:39 -070094 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
95 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080096 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -070097 * @hide
98 */
99 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
100
101 /**
Santos Cordon895d4b82015-06-25 16:41:48 -0700102 * An {@link android.content.Intent} action sent by the telecom framework to start a
103 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
104 * and each app that registers a {@link PhoneAccount} should provide one if desired.
105 * <p>
106 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
107 * app's settings menu. For each entry, the settings app will add a click action. When
108 * triggered, the click-action will start this intent along with the extra
109 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
110 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
111 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700112 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700113 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
114 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700115
116 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800117 * The {@link android.content.Intent} action used to show the call accessibility settings page.
118 */
119 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
120 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
121
122 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700123 * The {@link android.content.Intent} action used to show the call settings page.
124 */
125 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700126 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700127
128 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800129 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
130 */
131 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
132 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
133
134 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700135 * The {@link android.content.Intent} action used to show the settings page used to configure
136 * {@link PhoneAccount} preferences.
137 */
138 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700139 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700140
141 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700142 * {@link android.content.Intent} action used indicate that a new phone account was just
143 * registered.
144 * <p>
145 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
146 * to indicate which {@link PhoneAccount} was registered.
147 * <p>
148 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800149 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800150 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
151 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
152
153 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700154 * {@link android.content.Intent} action used indicate that a phone account was just
155 * unregistered.
156 * <p>
157 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
158 * to indicate which {@link PhoneAccount} was unregistered.
159 * <p>
160 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700161 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700162 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
163 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
164
165 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700166 * Activity action: Shows a dialog asking the user whether or not they want to replace the
167 * current default Dialer with the one specified in
168 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
169 *
170 * Usage example:
171 * <pre>
172 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
173 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
174 * getActivity().getPackageName());
175 * startActivity(intent);
176 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800177 * <p>
178 * This is no longer supported since Q, please use
179 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
180 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700181 */
182 public static final String ACTION_CHANGE_DEFAULT_DIALER =
183 "android.telecom.action.CHANGE_DEFAULT_DIALER";
184
185 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700186 * Broadcast intent action indicating that the current default dialer has changed.
187 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
188 * name of the package that the default dialer was changed to.
189 *
190 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
191 */
192 public static final String ACTION_DEFAULT_DIALER_CHANGED =
193 "android.telecom.action.DEFAULT_DIALER_CHANGED";
194
195 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700196 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
197 */
198 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
199 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
200
201 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800202 * Broadcast intent action indicating that the current default call screening app has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700203 * <p>
204 * Note: This intent is NEVER actually broadcast and will be deprecated in the future.
205 * <p>
206 * An app that want to know if it holds the
207 * {@link android.app.role.RoleManager#ROLE_CALL_SCREENING} role can use
208 * {@link android.app.role.RoleManager#isRoleHeld(String)} to confirm if it holds the role or
209 * not.
tonyzhuff60f5e2018-10-01 19:14:59 +0800210 */
211 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
212 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
213
214 /**
215 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
216 * indicate the ComponentName of the call screening app which has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700217 * <p>
218 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800219 */
220 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
221 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
222
223 /**
224 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
225 * indicate whether an app is the default call screening app.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700226 * <p>
227 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800228 */
229 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
230 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
231
232 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700233 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
234 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700235 */
236 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700237 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700238
239 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700240 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
241 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700242 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700243 * {@link VideoProfile#STATE_AUDIO_ONLY},
244 * {@link VideoProfile#STATE_BIDIRECTIONAL},
245 * {@link VideoProfile#STATE_RX_ENABLED},
246 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700247 */
248 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700249 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700250
251 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700252 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
253 * integer that determines the requested video state for an incoming call.
254 * Valid options:
255 * {@link VideoProfile#STATE_AUDIO_ONLY},
256 * {@link VideoProfile#STATE_BIDIRECTIONAL},
257 * {@link VideoProfile#STATE_RX_ENABLED},
258 * {@link VideoProfile#STATE_TX_ENABLED}.
259 */
260 public static final String EXTRA_INCOMING_VIDEO_STATE =
261 "android.telecom.extra.INCOMING_VIDEO_STATE";
262
263 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700264 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
265 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
266 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700267 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700268 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700269 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700270 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700271 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700272
273 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700274 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
275 * subject which will be associated with an outgoing call. Should only be specified if the
Shuo Qian3ed38832020-11-30 21:54:36 -0800276 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
277 * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700278 */
279 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
280
Shuo Qian3ed38832020-11-30 21:54:36 -0800281 // Values for EXTRA_PRIORITY
282 /**
283 * Indicates the call composer call priority is normal.
284 *
285 * Reference: RCC.20 Section 2.4.4.2
286 */
287 public static final int PRIORITY_NORMAL = 0;
288
289 /**
290 * Indicates the call composer call priority is urgent.
291 *
292 * Reference: RCC.20 Section 2.4.4.2
293 */
294 public static final int PRIORITY_URGENT = 1;
295
296 /**
297 * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
298 * {@link #PRIORITY_URGENT}.
299 *
300 * Reference: RCC.20 Section 2.4.4.2
301 */
302 public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
303
304 /**
305 * Extra for the call composer call location, an {@link android.location.Location} parcelable
306 * class to represent the geolocation as a latitude and longitude pair.
307 *
308 * Reference: RCC.20 Section 2.4.3.2
309 */
310 public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
311
312 /**
313 * A boolean extra set on incoming calls to indicate that the call has a picture specified.
314 * Given that image download could take a (short) time, the EXTRA is set immediately upon
315 * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
316 * if one is expected. The EXTRA may be unset if the image download ends up failing for some
317 * reason.
318 */
319 public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
320
321 /**
Hall Liu48c3c142021-03-11 16:14:22 -0800322 * A {@link Uri} representing the picture that was downloaded when a call is received or
323 * uploaded when a call is placed.
Hall Liu8fee7ea2021-01-21 16:37:51 -0800324 *
Shuo Qian3ed38832020-11-30 21:54:36 -0800325 * This is a content URI within the call log provider which can be used to open a file
326 * 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 -0800327 * download/upload is delayed for some reason. The Dialer app will receive a callback via
Shuo Qian3ed38832020-11-30 21:54:36 -0800328 * {@link Call.Callback#onDetailsChanged} when this value has changed.
329 *
330 * Reference: RCC.20 Section 2.4.3.2
331 */
Hall Liu8fee7ea2021-01-21 16:37:51 -0800332 public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
Shuo Qian3ed38832020-11-30 21:54:36 -0800333
Shuo Qian3ed38832020-11-30 21:54:36 -0800334 /**
335 * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
Hall Liua749abc2021-01-21 10:05:43 -0800336 * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
337 * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
Shuo Qian3ed38832020-11-30 21:54:36 -0800338 */
339 public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
340
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700341 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700342 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
343 * has initiated a new incoming call.
344 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700345 public static final String EXTRA_INCOMING_CALL_ADDRESS =
346 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700347
348 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700349 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
350 * metadata about the call. This {@link Bundle} will be returned to the
351 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700352 */
353 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700354 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700355
356 /**
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800357 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} used to indicate
358 * that a call has an in-band ringtone associated with it. This is used when the device is
359 * acting as an HFP headset and the Bluetooth stack has received an in-band ringtone from the
360 * the HFP host which must be played instead of any local ringtone the device would otherwise
361 * have generated.
362 *
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800363 * @hide
364 */
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800365 @SystemApi
366 public static final String EXTRA_CALL_HAS_IN_BAND_RINGTONE =
367 "android.telecom.extra.CALL_HAS_IN_BAND_RINGTONE";
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800368
369 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700370 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
371 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
372 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700373 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700374 */
375 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700376 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700377
378 /**
sqian6d9e7452019-02-08 21:42:15 -0800379 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
380 * whether the user's dial intent is emergency; this is required to specify when the dialed
381 * number is ambiguous, identified as both emergency number and any other non-emergency number;
382 * e.g. in some situation, 611 could be both an emergency number in a country and a
383 * non-emergency number of a carrier's customer service hotline.
384 *
385 * @hide
386 */
387 @SystemApi
388 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
389 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
390
391 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800392 * A mandatory extra containing a {@link Uri} to be passed in when calling
393 * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
394 * the remote handle of the new call.
Yorke Leec3cf9822014-10-02 09:38:39 -0700395 * @hide
396 */
Hall Liu2ef04112020-09-14 18:34:10 -0700397 @SystemApi
Yorke Leec3cf9822014-10-02 09:38:39 -0700398 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
399 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
400
401 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700402 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
403 * call was created. This value is in milliseconds since boot.
Hall Liudbb17f12020-03-10 18:28:58 -0700404 * @hide
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700405 */
406 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
407 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
408
409 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800410 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
411 * time the call was created.
412 * @hide
413 */
414 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
415 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
416
417 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700418 * Optional extra for incoming and outgoing calls containing a long which specifies the time
419 * telecom began routing the call. This value is in milliseconds since boot.
420 * @hide
421 */
422 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
423 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
424
425 /**
426 * Optional extra for incoming and outgoing calls containing a long which specifies the time
427 * telecom finished routing the call. This value is in milliseconds since boot.
428 * @hide
429 */
430 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
431 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
432
433 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700434 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
435 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700436 */
437 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700438 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700439
440 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700441 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
442 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700443 */
444 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700445 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700446
447 /**
radhika0dd90652020-11-04 11:12:51 -0800448 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
449 * lower layers
450 * @hide
451 */
452 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
453 "Call dropped by lower layers";
454
455 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700456 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
457 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800458 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700459 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800460 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700461 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700462 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700463
464 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800465 * Optional extra for communicating the call technology used by a {@link ConnectionService}
466 * to Telecom. Valid values are:
467 * <ul>
468 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
469 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
470 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
471 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
472 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
473 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800474 * @hide
475 */
Hall Liu2ef04112020-09-14 18:34:10 -0700476 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800477 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
478 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
479
480 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800481 * Optional extra for communicating the call network technology used by a
482 * {@link android.telecom.Connection} to Telecom and InCallUI.
483 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700484 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800485 */
486 public static final String EXTRA_CALL_NETWORK_TYPE =
487 "android.telecom.extra.CALL_NETWORK_TYPE";
488
489 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700490 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
491 * package name of the app specifying an alternative gateway for the call.
492 * The value is a string.
493 *
494 * (The following comment corresponds to the all GATEWAY_* extras)
495 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
496 * alternative address to dial which is different from the one specified and displayed to
497 * the user. This alternative address is referred to as the gateway address.
498 */
499 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700500 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700501
502 /**
503 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
504 * original address to dial for the call. This is used when an alternative gateway address is
505 * provided to recall the original address.
506 * The value is a {@link android.net.Uri}.
507 *
508 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
509 */
510 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700511 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700512
513 /**
Evan Charlton10197192014-07-19 15:00:29 -0700514 * The number which the party on the other side of the line will see (and use to return the
515 * call).
516 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700517 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
518 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
519 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700520 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700521 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700522
523 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800524 * The number of milliseconds that Telecom should wait after disconnecting a call via the
525 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
526 * to make a new one.
527 * @hide
528 */
529 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
530 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
531
532 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700533 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700534 * existing call from the user's device to a different {@link PhoneAccount}.
535 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700536 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
537 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
538 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
539 * the receiving side of a handover.
540 * <p>
541 * Used when Telecom calls
542 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
543 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
544 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
545 * occurs on the initiating side of a handover.
546 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700547 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700548 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800549 * @deprecated Use the public handover APIs. See
550 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700551 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800552 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700553 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
554
555 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800556 * When {@code true} indicates that a request to create a new connection is for the purpose of
557 * a handover. Note: This is used with the
558 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
559 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
560 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
561 * @hide
562 */
563 public static final String EXTRA_IS_HANDOVER_CONNECTION =
564 "android.telecom.extra.IS_HANDOVER_CONNECTION";
565
566 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700567 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
568 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
569 * the handover is from.
570 * @hide
571 */
572 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
573 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
574
575 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700576 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
577 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
578 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
579 * {@link Connection} will be.
580 * @hide
581 */
582 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
583
584 /**
Hall Liu95d55872017-01-25 17:12:49 -0800585 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
586 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
587 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
588 */
589 public static final String EXTRA_START_CALL_WITH_RTT =
590 "android.telecom.extra.START_CALL_WITH_RTT";
591
592 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800593 * Start an activity indicating that the completion of an outgoing call or an incoming call
594 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
595 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
596 *
597 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
598 * call which completed.
599 *
600 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
601 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
602 *
603 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
604 * {@link #EXTRA_CALL_DURATION} for more information.
605 */
606 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
607
608 /**
609 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
610 * uri handle(phone number) of the completed call.
611 */
612 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
613
614 /**
615 * A integer value provided for completed calls to indicate the reason for the call
616 * disconnection.
617 * <p>
618 * Allowed values:
619 * <ul>
620 * <li>{@link DisconnectCause#UNKNOWN}</li>
621 * <li>{@link DisconnectCause#LOCAL}</li>
622 * <li>{@link DisconnectCause#REMOTE}</li>
623 * <li>{@link DisconnectCause#REJECTED}</li>
624 * <li>{@link DisconnectCause#MISSED}</li>
625 * </ul>
626 * </p>
627 */
628 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
629
630 /**
631 * A integer value provided for completed calls to indicate the duration of the call.
632 * <p>
633 * Allowed values:
634 * <ul>
635 * <li>{@link #DURATION_VERY_SHORT}</li>
636 * <li>{@link #DURATION_SHORT}</li>
637 * <li>{@link #DURATION_MEDIUM}</li>
638 * <li>{@link #DURATION_LONG}</li>
639 * </ul>
640 * </p>
641 */
642 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
643
644 /**
645 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
646 * call was < 3 seconds.
647 */
648 public static final int DURATION_VERY_SHORT = 0;
649
650 /**
651 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
652 * call was >= 3 seconds and < 60 seconds.
653 */
654 public static final int DURATION_SHORT = 1;
655
656 /**
657 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
658 * call was >= 60 seconds and < 120 seconds.
659 */
660 public static final int DURATION_MEDIUM = 2;
661
662 /**
663 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
664 * call was >= 120 seconds.
665 */
666 public static final int DURATION_LONG = 3;
667
668 /**
669 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
670 * milliseconds.
671 * @hide
672 */
673 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
674
675 /**
676 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
677 * milliseconds.
678 * @hide
679 */
680 public static final long SHORT_CALL_TIME_MS = 60000;
681
682 /**
683 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
684 * milliseconds.
685 * @hide
686 */
687 public static final long MEDIUM_CALL_TIME_MS = 120000;
688
689 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700690 * A boolean meta-data value indicating whether an {@link InCallService} implements an
691 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
692 * would also like to replace the in-call interface should set this meta-data to {@code true} in
693 * the manifest registration of their {@link InCallService}.
694 */
695 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
696
697 /**
Santos Cordon88881552015-12-10 17:29:54 -0800698 * A boolean meta-data value indicating whether an {@link InCallService} implements an
699 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000700 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800701 */
702 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
703 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
704
705 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800706 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
707 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
708 * override the system provided ringing should set this meta-data to {@code true} in the
709 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700710 * <p>
711 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
712 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800713 */
714 public static final String METADATA_IN_CALL_SERVICE_RINGING =
715 "android.telecom.IN_CALL_SERVICE_RINGING";
716
717 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700718 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
719 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
720 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
721 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
722 * informed of external calls should set this meta-data to {@code true} in the manifest
723 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
724 * be informed of external calls.
725 */
726 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
727 "android.telecom.INCLUDE_EXTERNAL_CALLS";
728
729 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800730 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
731 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
732 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
733 * to implement its own call user interface. An {@link InCallService} implementation which
734 * would like to be informed of external calls should set this meta-data to {@code true} in the
735 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
736 * will NOT be informed about self-managed calls.
737 * <p>
738 * An {@link InCallService} which receives self-managed calls is free to view and control the
739 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700740 * exposing these calls to an automotive device via its companion app.
741 * <p>
742 * This meta-data can only be set for an {@link InCallService} which also sets
743 * {@link #METADATA_IN_CALL_SERVICE_UI}. Only the default phone/dialer app, or a car-mode
744 * {@link InCallService} can see self-managed calls.
Tyler Gunn24e18332017-02-10 09:42:49 -0800745 * <p>
746 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
747 */
748 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
749 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
750
751 /**
Evan Charlton10197192014-07-19 15:00:29 -0700752 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
753 * pause for a predefined period.
754 */
755 public static final char DTMF_CHARACTER_PAUSE = ',';
756
757 /**
758 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
759 * wait for user confirmation before proceeding.
760 */
761 public static final char DTMF_CHARACTER_WAIT = ';';
762
763 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800764 * @hide
765 */
766 @IntDef(prefix = { "TTY_MODE_" },
767 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
768 @Retention(RetentionPolicy.SOURCE)
769 public @interface TtyMode {}
770
771 /**
Evan Charlton10197192014-07-19 15:00:29 -0700772 * TTY (teletypewriter) mode is off.
773 *
774 * @hide
775 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800776 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700777 public static final int TTY_MODE_OFF = 0;
778
779 /**
780 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
781 * will communicate with the remote party by sending and receiving text messages.
782 *
783 * @hide
784 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800785 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700786 public static final int TTY_MODE_FULL = 1;
787
788 /**
789 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
790 * speaker is on. The user will communicate with the remote party by sending text messages and
791 * hearing an audible reply.
792 *
793 * @hide
794 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800795 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700796 public static final int TTY_MODE_HCO = 2;
797
798 /**
799 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
800 * microphone is still on. User will communicate with the remote party by speaking and receiving
801 * text message replies.
802 *
803 * @hide
804 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800805 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700806 public static final int TTY_MODE_VCO = 3;
807
808 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700809 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700810 *
Hall Liu2ef04112020-09-14 18:34:10 -0700811 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
812 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700813 * @hide
814 */
Hall Liu2ef04112020-09-14 18:34:10 -0700815 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700816 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700817 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700818
819 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700820 * Integer extra key that indicates the current TTY mode.
821 *
822 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
823 *
824 * Valid modes are:
825 * <ul>
826 * <li>{@link #TTY_MODE_OFF}</li>
827 * <li>{@link #TTY_MODE_FULL}</li>
828 * <li>{@link #TTY_MODE_HCO}</li>
829 * <li>{@link #TTY_MODE_VCO}</li>
830 * </ul>
831 *
832 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
833 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
834 * plugged into the device.
835 * @hide
836 */
Hall Liu2ef04112020-09-14 18:34:10 -0700837 @SystemApi
838 public static final String EXTRA_CURRENT_TTY_MODE =
839 "android.telecom.extra.CURRENT_TTY_MODE";
840
841 /**
842 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
843 *
844 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
845 * preferred TTY mode.
846 * @hide
847 */
Hall Liu2ef04112020-09-14 18:34:10 -0700848 @SystemApi
849 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
850 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
851
852 /**
853 * Integer extra key that indicates the preferred TTY mode.
854 *
855 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
856 *
Evan Charlton10197192014-07-19 15:00:29 -0700857 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800858 * <ul>
859 * <li>{@link #TTY_MODE_OFF}</li>
860 * <li>{@link #TTY_MODE_FULL}</li>
861 * <li>{@link #TTY_MODE_HCO}</li>
862 * <li>{@link #TTY_MODE_VCO}</li>
863 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700864 * @hide
865 */
Hall Liu2ef04112020-09-14 18:34:10 -0700866 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700867 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800868 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700869
Nancy Chen9d568c02014-09-08 14:17:59 -0700870 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700871 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800872 * notification. If no custom component exists then this is sent to the default dialer which
873 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700874 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700875 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
876 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
877
878 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800879 * The number of calls associated with the notification. If the number is zero then the missed
880 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700881 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700882 public static final String EXTRA_NOTIFICATION_COUNT =
883 "android.telecom.extra.NOTIFICATION_COUNT";
884
885 /**
886 * The number associated with the missed calls. This number is only relevant
887 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700888 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700889 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
890 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
891
892 /**
Tyler Gunna2879412023-02-28 23:41:53 +0000893 * Included in the extras of the {@link #ACTION_SHOW_MISSED_CALLS_NOTIFICATION}, provides a
894 * pending intent which can be used to clear the missed calls notification and mark unread
895 * missed call log entries as read.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700896 * @hide
Tyler Gunna2879412023-02-28 23:41:53 +0000897 * @deprecated Use {@link #cancelMissedCallsNotification()} instead.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700898 */
Tyler Gunna2879412023-02-28 23:41:53 +0000899 @Deprecated
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700900 @SystemApi
901 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
902 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
903
904 /**
905 * The intent to call back a missed call.
906 * @hide
907 */
908 @SystemApi
909 public static final String EXTRA_CALL_BACK_INTENT =
910 "android.telecom.extra.CALL_BACK_INTENT";
911
912 /**
Charles He858f1322017-11-27 17:11:04 -0800913 * The dialer activity responsible for placing emergency calls from, for example, a locked
914 * keyguard.
915 * @hide
916 */
917 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
918 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
919
920 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800921 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
922 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700923 * <p>
924 * The call initiator can use this extra to indicate that a call used assisted dialing to help
925 * place the call. This is most commonly used by a Dialer app which provides the ability to
926 * automatically add dialing prefixes when placing international calls.
927 * <p>
928 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800929 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
930 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700931 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
932 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
933 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800934 */
935 public static final String EXTRA_USE_ASSISTED_DIALING =
936 "android.telecom.extra.USE_ASSISTED_DIALING";
937
938 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800939 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
940 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800941 * Valid sources are:
942 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
943 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
944 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800945 *
Hall Liu2ef04112020-09-14 18:34:10 -0700946 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800947 * @hide
948 */
Hall Liu2ef04112020-09-14 18:34:10 -0700949 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800950 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
951
952 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800953 * Indicating the call is initiated via emergency dialer's shortcut button.
954 *
955 * @hide
956 */
Hall Liu2ef04112020-09-14 18:34:10 -0700957 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800958 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
959
960 /**
961 * Indicating the call is initiated via emergency dialer's dialpad.
962 *
963 * @hide
964 */
Hall Liu2ef04112020-09-14 18:34:10 -0700965 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800966 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
967
968 /**
969 * Indicating the call source is not specified.
970 *
971 * @hide
972 */
Hall Liu2ef04112020-09-14 18:34:10 -0700973 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800974 public static final int CALL_SOURCE_UNSPECIFIED = 0;
975
976 /**
Nancy Chen9d568c02014-09-08 14:17:59 -0700977 * The following 4 constants define how properties such as phone numbers and names are
978 * displayed to the user.
979 */
980
Santos Cordoned769ae2015-05-13 18:47:38 -0700981 /**
982 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -0800983 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700984 public static final int PRESENTATION_ALLOWED = 1;
985
Santos Cordoned769ae2015-05-13 18:47:38 -0700986 /**
987 * Indicates that the address or number of a call is blocked by the other party.
988 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700989 public static final int PRESENTATION_RESTRICTED = 2;
990
Santos Cordoned769ae2015-05-13 18:47:38 -0700991 /**
992 * Indicates that the address or number of a call is not specified or known by the carrier.
993 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700994 public static final int PRESENTATION_UNKNOWN = 3;
995
Santos Cordoned769ae2015-05-13 18:47:38 -0700996 /**
997 * Indicates that the address or number of a call belongs to a pay phone.
998 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700999 public static final int PRESENTATION_PAYPHONE = 4;
1000
Grace Jiacc16b042021-08-09 09:06:11 -07001001 /**
1002 * Indicates that the address or number of a call is unavailable.
1003 */
1004 public static final int PRESENTATION_UNAVAILABLE = 5;
1005
Hall Liu4a9fde12020-01-16 17:38:46 -08001006
1007 /*
1008 * Values for the adb property "persist.radio.videocall.audio.output"
1009 */
1010 /** @hide */
1011 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1012 /** @hide */
1013 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1014 /** @hide */
1015 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1016
Tyler Gunn00d737b2019-10-31 13:04:37 -07001017 /** @hide */
1018 @Retention(RetentionPolicy.SOURCE)
1019 @IntDef(
1020 prefix = { "PRESENTATION_" },
1021 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001022 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001023 public @interface Presentation {}
1024
Brad Ebingera8366ae2021-03-23 21:01:51 +00001025
1026 /**
1027 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1028 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1029 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001030 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001031 */
1032 @ChangeId
1033 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1034 // this magic number is a bug ID
1035 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1036
Grace Jiab13eb2c2021-04-21 14:13:26 -07001037 /**
1038 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1039 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1040 * @hide
1041 */
1042 @ChangeId
1043 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1044 // bug ID
1045 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1046
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001047 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001048
Kevin Jeon767cda32020-11-17 01:40:16 +00001049
1050 /** Cached service handles, cleared by resetServiceCache() at death */
1051 private static final Object CACHE_LOCK = new Object();
1052
1053 @GuardedBy("CACHE_LOCK")
1054 private static ITelecomService sTelecomService;
1055 @GuardedBy("CACHE_LOCK")
1056 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1057
Yorke Leeb4ce1432014-06-09 13:53:23 -07001058 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001059
Hall Liue1bc2ec2015-10-09 15:58:37 -07001060 private final ITelecomService mTelecomServiceOverride;
1061
Santos Cordon6c7a3882014-06-25 15:30:08 -07001062 /**
1063 * @hide
1064 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001065 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001066 public static TelecomManager from(Context context) {
1067 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001068 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001069
1070 /**
1071 * @hide
1072 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001073 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001074 this(context, null);
1075 }
1076
1077 /**
1078 * @hide
1079 */
1080 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001081 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001082 if (appContext != null && Objects.equals(context.getAttributionTag(),
1083 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001084 mContext = appContext;
1085 } else {
1086 mContext = context;
1087 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001088 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001089 }
1090
1091 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001092 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1093 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1094 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1095 * account returned depends on the following priorities:
1096 * <ul>
1097 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1098 * be returned.
1099 * </li>
1100 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1101 * will be returned.
1102 * </li>
1103 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001104 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001105 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1106 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001107 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001108 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001109 */
Yorke Leec61d13662015-09-21 17:25:25 -07001110 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001111 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001112 ITelecomService service = getTelecomService();
1113 if (service != null) {
1114 try {
1115 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001116 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001117 } catch (RemoteException e) {
1118 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001119 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001120 }
1121 return null;
1122 }
1123
1124 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001125 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1126 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001127 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001128 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001129 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1130 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001131 * <p>
1132 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001133 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001134 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1135 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001136 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001137 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001138 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001139 ITelecomService service = getTelecomService();
1140 if (service != null) {
1141 try {
1142 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001143 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001144 } catch (RemoteException e) {
1145 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001146 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001147 }
1148 return null;
1149 }
1150
1151 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001152 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1153 *
1154 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001155 * outgoing voice calls, or {@code null} if no default is specified (the
1156 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001157 * @hide
1158 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001159 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1160 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001161 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001162 ITelecomService service = getTelecomService();
1163 if (service != null) {
1164 try {
1165 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1166 } catch (RemoteException e) {
1167 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001168 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001169 }
1170 }
1171
1172 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001173 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001174 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1175 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001176 *
Brad Ebingere7833312019-05-07 10:55:55 -07001177 * @return The phone account handle of the current sim call manager for the default voice
1178 * subscription.
1179 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001180 */
1181 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001182 ITelecomService service = getTelecomService();
1183 if (service != null) {
1184 try {
1185 return service.getSimCallManager(
Brad Ebingere7833312019-05-07 10:55:55 -07001186 SubscriptionManager.getDefaultSubscriptionId());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001187 } catch (RemoteException e) {
1188 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001189 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001190 }
1191 return null;
1192 }
1193
1194 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001195 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1196 * prepared for this method to return {@code null}, indicating that there currently exists no
1197 * SIM call manager {@link PhoneAccount} for the subscription specified.
1198 *
1199 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1200 * queried for.
1201 * @return The phone account handle of the current sim call manager.
1202 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001203 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001204 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001205 ITelecomService service = getTelecomService();
1206 if (service != null) {
1207 try {
1208 return service.getSimCallManager(subscriptionId);
1209 } catch (RemoteException e) {
1210 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001211 }
Brad Ebingere7833312019-05-07 10:55:55 -07001212 }
1213 return null;
1214 }
1215
1216 /**
1217 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1218 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1219 * must be prepared for this method to return {@code null}, indicating that there currently
1220 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001221 *
1222 * @return The phone account handle of the current sim call manager.
1223 *
1224 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001225 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001226 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001227 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001228 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001229 ITelecomService service = getTelecomService();
1230 if (service != null) {
1231 try {
1232 return service.getSimCallManagerForUser(userId);
1233 } catch (RemoteException e) {
1234 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001235 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001236 }
1237 return null;
1238 }
1239
1240 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001241 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001242 * {@code null}, indicating that there currently exists no Connection Manager
1243 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001244 *
1245 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001246 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001247 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001248 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001249 public PhoneAccountHandle getConnectionManager() {
1250 return getSimCallManager();
1251 }
1252
1253 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001254 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1255 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001256 * <P>
1257 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1258 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1259 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1260 * such as {@code sip:example@sipexample.com}).
1261 *
1262 * @param uriScheme The URI scheme.
1263 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001264 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001265 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001266 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001267 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001268 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001269 android.Manifest.permission.READ_PHONE_STATE
1270 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001271 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001272 ITelecomService service = getTelecomService();
1273 if (service != null) {
1274 try {
1275 return service.getPhoneAccountsSupportingScheme(uriScheme,
Thomas Stuart76769dc2022-06-23 14:27:43 -07001276 mContext.getOpPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001277 } catch (RemoteException e) {
1278 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001279 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001280 }
1281 return new ArrayList<>();
1282 }
1283
Nancy Chen513c8922014-09-17 14:47:20 -07001284
1285 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001286 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1287 * calls. The returned list includes only those accounts which have been explicitly enabled
1288 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001289 *
1290 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1291 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001292 */
Yorke Leec61d13662015-09-21 17:25:25 -07001293 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001294 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001295 return getCallCapablePhoneAccounts(false);
1296 }
1297
1298 /**
Thomas Stuart4e1184d2022-01-28 23:06:57 +00001299 * Returns a list of {@link PhoneAccountHandle}s for all self-managed
1300 * {@link ConnectionService}s owned by the calling {@link UserHandle}.
Tyler Gunn89317072017-04-07 14:57:37 -07001301 * <p>
1302 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1303 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1304 * <p>
1305 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuart4e1184d2022-01-28 23:06:57 +00001306 * is the default dialer app.
Tyler Gunn89317072017-04-07 14:57:37 -07001307 * <p>
Thomas Stuart4e1184d2022-01-28 23:06:57 +00001308 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1309 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
Tyler Gunn89317072017-04-07 14:57:37 -07001310 *
1311 * @return A list of {@code PhoneAccountHandle} objects.
1312 */
Thomas Stuart4e1184d2022-01-28 23:06:57 +00001313 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1314 public @NonNull List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001315 ITelecomService service = getTelecomService();
1316 if (service != null) {
1317 try {
1318 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart76769dc2022-06-23 14:27:43 -07001319 mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001320 } catch (RemoteException e) {
1321 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001322 }
Tyler Gunn89317072017-04-07 14:57:37 -07001323 }
1324 return new ArrayList<>();
1325 }
1326
1327 /**
Thomas Stuart4e1184d2022-01-28 23:06:57 +00001328 * Returns a list of {@link PhoneAccountHandle}s owned by the calling self-managed
1329 * {@link ConnectionService}.
1330 * <p>
1331 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1332 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1333 * <p>
1334 * Requires permission {@link android.Manifest.permission#MANAGE_OWN_CALLS}
1335 * <p>
1336 * A {@link SecurityException} will be thrown if a caller lacks the
1337 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission.
1338 *
1339 * @return A list of {@code PhoneAccountHandle} objects.
1340 */
1341 @RequiresPermission(Manifest.permission.MANAGE_OWN_CALLS)
1342 public @NonNull List<PhoneAccountHandle> getOwnSelfManagedPhoneAccounts() {
1343 ITelecomService service = getTelecomService();
1344 if (service != null) {
1345 try {
1346 return service.getOwnSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart76769dc2022-06-23 14:27:43 -07001347 mContext.getAttributionTag()).getList();
Thomas Stuart4e1184d2022-01-28 23:06:57 +00001348 } catch (RemoteException e) {
1349 throw e.rethrowFromSystemServer();
1350 }
1351 }
1352 throw new IllegalStateException("Telecom is not available");
1353 }
1354
1355 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001356 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1357 * by the user.
1358 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001359 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001360 * when {@code false}, only enabled phone accounts will be
1361 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001362 * @return A list of {@code PhoneAccountHandle} objects.
1363 * @hide
1364 */
Hall Liub2306242019-11-15 17:13:05 -08001365 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001366 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1367 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1368 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001369 ITelecomService service = getTelecomService();
1370 if (service != null) {
1371 try {
1372 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Thomas Stuart76769dc2022-06-23 14:27:43 -07001373 mContext.getOpPackageName(), mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001374 } catch (RemoteException e) {
1375 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1376 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001377 }
Nancy Chen513c8922014-09-17 14:47:20 -07001378 }
1379 return new ArrayList<>();
1380 }
1381
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001382 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001383 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1384 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001385 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1386 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001387 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001388 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001389 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001390 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001391 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001392 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001393 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001394 ITelecomService service = getTelecomService();
1395 if (service != null) {
1396 try {
Thomas Stuart76769dc2022-06-23 14:27:43 -07001397 return service.getPhoneAccountsForPackage(mContext.getPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001398 } catch (RemoteException e) {
1399 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001400 }
Nancy Chen513c8922014-09-17 14:47:20 -07001401 }
1402 return null;
1403 }
1404
1405 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001406 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1407 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001408 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001409 * Requires Permission:
1410 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1411 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001412 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001413 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001414 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001415 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001416 ITelecomService service = getTelecomService();
1417 if (service != null) {
1418 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001419 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001420 } catch (RemoteException e) {
1421 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001422 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001423 }
1424 return null;
1425 }
1426
1427 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001428 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001429 *
Nancy Chen210ef032014-09-15 17:58:42 -07001430 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001431 * @hide
1432 */
1433 @SystemApi
1434 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001435 ITelecomService service = getTelecomService();
1436 if (service != null) {
1437 try {
1438 return service.getAllPhoneAccountsCount();
1439 } catch (RemoteException e) {
1440 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001441 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001442 }
1443 return 0;
1444 }
1445
1446 /**
1447 * Returns a list of all {@link PhoneAccount}s.
1448 *
1449 * @return All {@link PhoneAccount}s.
1450 * @hide
1451 */
1452 @SystemApi
1453 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001454 ITelecomService service = getTelecomService();
1455 if (service != null) {
1456 try {
Thomas Stuart76769dc2022-06-23 14:27:43 -07001457 return service.getAllPhoneAccounts().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001458 } catch (RemoteException e) {
1459 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001460 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001461 }
1462 return Collections.EMPTY_LIST;
1463 }
1464
1465 /**
1466 * Returns a list of all {@link PhoneAccountHandle}s.
1467 *
1468 * @return All {@link PhoneAccountHandle}s.
1469 * @hide
1470 */
1471 @SystemApi
1472 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001473 ITelecomService service = getTelecomService();
1474 if (service != null) {
1475 try {
Thomas Stuart76769dc2022-06-23 14:27:43 -07001476 return service.getAllPhoneAccountHandles().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001477 } catch (RemoteException e) {
1478 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001479 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001480 }
1481 return Collections.EMPTY_LIST;
1482 }
1483
1484 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001485 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1486 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1487 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001488 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1489 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1490 * the phone app settings before the account is usable.
1491 * <p>
Thomas Stuarte0416212022-01-31 20:31:42 +00001492 * Note: Each package is limited to 10 {@link PhoneAccount} registrations.
1493 * <p>
Santos Cordond9e614f2014-10-28 13:10:36 -07001494 * A {@link SecurityException} will be thrown if an app tries to register a
1495 * {@link PhoneAccountHandle} where the package name specified within
1496 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Thomas Stuarte0416212022-01-31 20:31:42 +00001497 * <p>
1498 * A {@link IllegalArgumentException} will be thrown if an app tries to register a
1499 * {@link PhoneAccount} when the upper bound limit, 10, has already been reached.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001500 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001501 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001502 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001503 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001504 ITelecomService service = getTelecomService();
1505 if (service != null) {
1506 try {
1507 service.registerPhoneAccount(account);
1508 } catch (RemoteException e) {
1509 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001510 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001511 }
1512 }
1513
1514 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001515 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001516 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001517 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001518 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001519 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001520 ITelecomService service = getTelecomService();
1521 if (service != null) {
1522 try {
1523 service.unregisterPhoneAccount(accountHandle);
1524 } catch (RemoteException e) {
1525 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001526 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001527 }
1528 }
1529
1530 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001531 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001532 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001533 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001534 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001535 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001536 public void clearPhoneAccounts() {
1537 clearAccounts();
1538 }
1539 /**
1540 * Remove all Accounts that belong to the calling package from the system.
1541 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1542 * @hide
1543 */
1544 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001545 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001546 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001547 ITelecomService service = getTelecomService();
1548 if (service != null) {
1549 try {
1550 service.clearAccounts(mContext.getPackageName());
1551 } catch (RemoteException e) {
1552 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001553 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001554 }
1555 }
1556
1557 /**
Anthony Lee67279262014-10-27 11:28:40 -07001558 * Remove all Accounts that belong to the specified package from the system.
1559 * @hide
1560 */
1561 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001562 ITelecomService service = getTelecomService();
1563 if (service != null) {
1564 try {
1565 if (!TextUtils.isEmpty(packageName)) {
1566 service.clearAccounts(packageName);
1567 }
1568 } catch (RemoteException e) {
1569 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001570 }
Anthony Lee67279262014-10-27 11:28:40 -07001571 }
1572 }
1573
Yorke Lee1011f482015-04-23 15:58:27 -07001574
Anthony Lee67279262014-10-27 11:28:40 -07001575 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001576 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1577 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001578 * @hide
1579 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001580 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001581 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001582 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001583 ITelecomService service = getTelecomService();
1584 if (service != null) {
1585 try {
1586 return service.getDefaultPhoneApp();
1587 } catch (RemoteException e) {
1588 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001589 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001590 }
1591 return null;
1592 }
1593
Santos Cordon9eb45932014-06-27 12:28:43 -07001594 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001595 * Used to determine the currently selected default dialer package.
1596 *
1597 * @return package name for the default dialer package or null if no package has been
1598 * selected as the default dialer.
1599 */
1600 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001601 ITelecomService service = getTelecomService();
1602 if (service != null) {
1603 try {
1604 return service.getDefaultDialerPackage();
1605 } catch (RemoteException e) {
1606 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001607 }
Yorke Lee1011f482015-04-23 15:58:27 -07001608 }
1609 return null;
1610 }
1611
1612 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001613 * Used to determine the currently selected default dialer package for a specific user.
1614 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001615 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001616 * @return package name for the default dialer package or null if no package has been
1617 * selected as the default dialer.
1618 * @hide
1619 */
1620 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001621 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001622 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001623 ITelecomService service = getTelecomService();
1624 if (service != null) {
1625 try {
1626 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001627 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001628 } catch (RemoteException e) {
1629 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001630 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001631 }
1632 return null;
1633 }
1634
1635 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001636 * Used to set the default dialer package.
1637 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001638 * @param packageName to set the default dialer to, or {@code null} if the system provided
1639 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001640 *
1641 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1642 * the specified package does not correspond to an installed dialer, or is already
1643 * the default dialer.
1644 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001645 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001646 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001647 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1648 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001649 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001650 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001651 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001652 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001653 @RequiresPermission(allOf = {
1654 android.Manifest.permission.MODIFY_PHONE_STATE,
1655 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001656 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001657 ITelecomService service = getTelecomService();
1658 if (service != null) {
1659 try {
1660 return service.setDefaultDialer(packageName);
1661 } catch (RemoteException e) {
1662 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001663 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001664 }
1665 return false;
1666 }
1667
1668 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001669 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001670 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001671 * @return package name for the system dialer package or {@code null} if no system dialer is
1672 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001673 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001674 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001675 ITelecomService service = getTelecomService();
1676 if (service != null) {
1677 try {
1678 return service.getSystemDialerPackage();
1679 } catch (RemoteException e) {
1680 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001681 }
Yorke Lee1011f482015-04-23 15:58:27 -07001682 }
1683 return null;
1684 }
1685
1686 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001687 * Return whether a given phone number is the configured voicemail number for a
1688 * particular phone account.
1689 *
1690 * @param accountHandle The handle for the account to check the voicemail number against
1691 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001692 */
Yorke Leec61d13662015-09-21 17:25:25 -07001693 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001694 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001695 ITelecomService service = getTelecomService();
1696 if (service != null) {
1697 try {
1698 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001699 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001700 } catch (RemoteException e) {
1701 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001702 }
Nancy Chen443e5012014-10-15 15:48:21 -07001703 }
1704 return false;
1705 }
1706
1707 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001708 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001709 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001710 * @param accountHandle The handle for the phone account.
1711 * @return The voicemail number for the phone account, and {@code null} if one has not been
1712 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001713 */
Yorke Leec61d13662015-09-21 17:25:25 -07001714 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001715 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001716 ITelecomService service = getTelecomService();
1717 if (service != null) {
1718 try {
1719 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001720 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001721 } catch (RemoteException e) {
1722 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001723 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001724 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001725 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001726 }
1727
1728 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001729 * Return the line 1 phone number for given phone account.
1730 *
Michael Groover08490f12020-03-24 14:08:14 -07001731 * <p>Requires Permission:
1732 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1733 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1734 * or that the caller is the default SMS app for any API level.
1735 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1736 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001737 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001738 * @param accountHandle The handle for the account retrieve a number for.
1739 * @return A string representation of the line 1 phone number.
Meng Wang8665b512021-11-18 15:13:43 -08001740 * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1741 * Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1742 * from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
Nancy Chen5cf27842015-01-24 23:30:27 -08001743 */
Meng Wang8665b512021-11-18 15:13:43 -08001744 @Deprecated
Michael Groover08490f12020-03-24 14:08:14 -07001745 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1746 @RequiresPermission(anyOf = {
1747 android.Manifest.permission.READ_PHONE_STATE,
1748 android.Manifest.permission.READ_SMS,
1749 android.Manifest.permission.READ_PHONE_NUMBERS
1750 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001751 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001752 ITelecomService service = getTelecomService();
1753 if (service != null) {
1754 try {
1755 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001756 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001757 } catch (RemoteException e) {
1758 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001759 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001760 }
1761 return null;
1762 }
1763
1764 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001765 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001766 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001767 *
1768 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1769 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001770 */
Yorke Leec61d13662015-09-21 17:25:25 -07001771 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001772 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001773 ITelecomService service = getTelecomService();
1774 if (service != null) {
1775 try {
1776 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001777 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001778 } catch (RemoteException e) {
1779 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001780 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001781 }
1782 return false;
1783 }
1784
1785 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001786 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1787 * permission. The permission can be obtained by associating with a physical wearable device
1788 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1789 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001790 *
1791 * @return {@code true} if the caller has {@link InCallService} access for
1792 * companion app; {@code false} otherwise.
1793 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001794 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001795 ITelecomService service = getTelecomService();
1796 if (service != null) {
1797 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001798 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001799 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001800 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001801 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001802 if (!isSystemProcess()) {
1803 e.rethrowAsRuntimeException();
1804 }
Shuo Qian4d065262020-10-20 11:04:28 -07001805 }
1806 }
1807 return false;
1808 }
1809
1810 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001811 * Returns whether there is an ongoing call originating from a managed
1812 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1813 * states.
1814 * <p>
1815 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1816 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001817 *
1818 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1819 * {@code false} otherwise.
1820 */
1821 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1822 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001823 ITelecomService service = getTelecomService();
1824 if (service != null) {
1825 try {
1826 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001827 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001828 } catch (RemoteException e) {
1829 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001830 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001831 }
1832 return false;
1833 }
1834
1835 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001836 * Returns one of the following constants that represents the current state of Telecom:
1837 *
1838 * {@link TelephonyManager#CALL_STATE_RINGING}
1839 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1840 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001841 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001842 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001843 * <p>
1844 * Requires Permission:
1845 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1846 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001847 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001848 * @hide
1849 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001850 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1851 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001852 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001853 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001854 ITelecomService service = getTelecomService();
1855 if (service != null) {
1856 try {
Brad Ebingera8366ae2021-03-23 21:01:51 +00001857 return service.getCallStateUsingPackage(mContext.getPackageName(),
1858 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001859 } catch (RemoteException e) {
1860 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001861 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001862 }
1863 return TelephonyManager.CALL_STATE_IDLE;
1864 }
1865
1866 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001867 * Returns whether there currently exists is a ringing incoming-call.
1868 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001869 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001870 * @hide
1871 */
1872 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001873 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001874 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001875 android.Manifest.permission.READ_PHONE_STATE
1876 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001877 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001878 ITelecomService service = getTelecomService();
1879 if (service != null) {
1880 try {
1881 return service.isRinging(mContext.getOpPackageName());
1882 } catch (RemoteException e) {
1883 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001884 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001885 }
1886 return false;
1887 }
1888
1889 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001890 * Ends the foreground call on the device.
1891 * <p>
1892 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1893 * foreground call is ended.
1894 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001895 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1896 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001897 *
1898 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1899 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001900 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1901 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1902 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001903 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001904 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001905 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001906 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001907 ITelecomService service = getTelecomService();
1908 if (service != null) {
1909 try {
1910 return service.endCall(mContext.getPackageName());
1911 } catch (RemoteException e) {
1912 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001913 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001914 }
1915 return false;
1916 }
1917
1918 /**
1919 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001920 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001921 * If the incoming call is a video call, the call will be answered with the same video state as
1922 * the incoming call requests. This means, for example, that an incoming call requesting
1923 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001924 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001925 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1926 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001927 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001928 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1929 // this method (clockwork & gearhead).
1930 @RequiresPermission(anyOf =
1931 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001932 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001933 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001934 ITelecomService service = getTelecomService();
1935 if (service != null) {
1936 try {
1937 service.acceptRingingCall(mContext.getPackageName());
1938 } catch (RemoteException e) {
1939 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001940 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001941 }
1942 }
1943
1944 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001945 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1946 * with the specified video state.
1947 *
1948 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001949 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1950 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001951 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001952 @RequiresPermission(anyOf =
1953 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001954 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07001955 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001956 ITelecomService service = getTelecomService();
1957 if (service != null) {
1958 try {
1959 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001960 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001961 } catch (RemoteException e) {
1962 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001963 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07001964 }
1965 }
1966
1967 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001968 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07001969 * <p>
1970 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
1971 * already started playing. It is intended to handle use-cases such as silencing a ringing call
1972 * when the user presses the volume button during ringing.
1973 * <p>
1974 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
1975 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
1976 * <p>
1977 * A dialer app which wants to have more control over ringtone playing should declare
1978 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
1979 * {@link InCallService} implementation to indicate that the app wants to be responsible for
1980 * playing the ringtone for all incoming calls.
1981 * <p>
1982 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
1983 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07001984 */
Yorke Leec61d13662015-09-21 17:25:25 -07001985 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07001986 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001987 ITelecomService service = getTelecomService();
1988 if (service != null) {
1989 try {
1990 service.silenceRinger(mContext.getOpPackageName());
1991 } catch (RemoteException e) {
1992 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001993 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001994 }
1995 }
1996
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001997 /**
1998 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001999 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002000 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07002001 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002002 android.Manifest.permission.READ_PHONE_STATE
2003 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002004 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002005 ITelecomService service = getTelecomService();
2006 if (service != null) {
2007 try {
2008 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002009 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002010 } catch (RemoteException e) {
2011 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002012 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002013 }
2014 return false;
2015 }
2016
2017 /**
2018 * 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 -07002019 * settings and have a wired headset plugged in.
2020 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002021 * - {@link TelecomManager#TTY_MODE_OFF}
2022 * - {@link TelecomManager#TTY_MODE_FULL}
2023 * - {@link TelecomManager#TTY_MODE_HCO}
2024 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002025 * @hide
2026 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002027 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07002028 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002029 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002030 ITelecomService service = getTelecomService();
2031 if (service != null) {
2032 try {
2033 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002034 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002035 } catch (RemoteException e) {
2036 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002037 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002038 }
Evan Charlton10197192014-07-19 15:00:29 -07002039 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002040 }
2041
Santos Cordon96efb482014-07-19 14:57:05 -07002042 /**
2043 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08002044 * has an incoming call. For managed {@link ConnectionService}s, the specified
2045 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2046 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2047 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2048 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2049 * <p>
Tyler Gunnd8778662023-02-10 17:13:11 +00002050 * Specify the address associated with the incoming call using
2051 * {@link #EXTRA_INCOMING_CALL_ADDRESS}. If an incoming call is from an anonymous source, omit
2052 * this extra and ensure you specify a valid number presentation via
2053 * {@link Connection#setAddress(Uri, int)} on the {@link Connection} instance you return in
2054 * your
2055 * {@link ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)}
2056 * implementation.
2057 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002058 * The incoming call you are adding is assumed to have a video state of
2059 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2060 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2061 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002062 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2063 * associated with the {@link PhoneAccountHandle} and request additional information about the
2064 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002065 * call UI.
2066 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002067 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2068 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2069 * the associated {@link PhoneAccount} is not currently enabled by the user.
2070 * <p>
2071 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2072 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2073 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2074 *
Santos Cordon96efb482014-07-19 14:57:05 -07002075 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2076 * {@link #registerPhoneAccount}.
2077 * @param extras A bundle that will be passed through to
2078 * {@link ConnectionService#onCreateIncomingConnection}.
2079 */
2080 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002081 ITelecomService service = getTelecomService();
2082 if (service != null) {
2083 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002084 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2085 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2086 Build.VERSION_CODES.O_MR1) {
2087 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2088 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002089 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002090 }
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002091 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras);
2092 } catch (RemoteException e) {
2093 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002094 }
Santos Cordon96efb482014-07-19 14:57:05 -07002095 }
2096 }
2097
Nancy Chen0eb1e402014-08-21 22:52:29 -07002098 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302099 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002100 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2101 * call initiated on another device which the user is being invited to join in. For managed
2102 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2103 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2104 * corresponding {@link PhoneAccount}. This can be checked using
2105 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2106 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302107 * <p>
2108 * The incoming conference you are adding is assumed to have a video state of
2109 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2110 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2111 * <p>
2112 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2113 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002114 * call (See
2115 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2116 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302117 * <p>
2118 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2119 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2120 * the associated {@link PhoneAccount} is not currently enabled by the user.
2121 *
2122 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2123 * {@link #registerPhoneAccount}.
2124 * @param extras A bundle that will be passed through to
2125 * {@link ConnectionService#onCreateIncomingConference}.
2126 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302127 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2128 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002129 ITelecomService service = getTelecomService();
2130 if (service != null) {
2131 try {
2132 service.addNewIncomingConference(
Ravi Paluri80aa2142019-12-02 11:57:37 +05302133 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002134 } catch (RemoteException e) {
2135 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302136 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302137 }
2138 }
2139
2140 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002141 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2142 * service. This is invoked when Telephony detects a new unknown connection that was neither
2143 * a new incoming call, nor an user-initiated outgoing call.
2144 *
2145 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2146 * {@link #registerPhoneAccount}.
2147 * @param extras A bundle that will be passed through to
2148 * {@link ConnectionService#onCreateIncomingConnection}.
2149 * @hide
2150 */
2151 @SystemApi
2152 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002153 ITelecomService service = getTelecomService();
2154 if (service != null) {
2155 try {
2156 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002157 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002158 } catch (RemoteException e) {
2159 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002160 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002161 }
2162 }
2163
2164 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002165 * Processes the specified dial string as an MMI code.
2166 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2167 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002168 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002169 * <p>
2170 * Requires that the method-caller be set as the system dialer app.
2171 * </p>
2172 *
2173 * @param dialString The digits to dial.
2174 * @return True if the digits were processed as an MMI code, false otherwise.
2175 */
Yorke Leec61d13662015-09-21 17:25:25 -07002176 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002177 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002178 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002179 if (service != null) {
2180 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002181 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002182 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002183 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002184 }
2185 }
2186 return false;
2187 }
2188
2189 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002190 * Processes the specified dial string as an MMI code.
2191 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2192 * Some of these sequences launch special behavior through handled by Telephony.
2193 * <p>
2194 * Requires that the method-caller be set as the system dialer app.
2195 * </p>
2196 *
2197 * @param accountHandle The handle for the account the MMI code should apply to.
2198 * @param dialString The digits to dial.
2199 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002200 */
Yorke Leec61d13662015-09-21 17:25:25 -07002201 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002202 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002203 ITelecomService service = getTelecomService();
2204 if (service != null) {
2205 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002206 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2207 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002208 } catch (RemoteException e) {
2209 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2210 }
2211 }
2212 return false;
2213 }
2214
2215 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002216 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2217 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002218 * @param accountHandle The handle for the account to derive an adn query URI for or
2219 * {@code null} to return a URI which will use the default account.
2220 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2221 * for the the content retrieve.
2222 */
Yorke Leec61d13662015-09-21 17:25:25 -07002223 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002224 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2225 ITelecomService service = getTelecomService();
2226 if (service != null && accountHandle != null) {
2227 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002228 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002229 } catch (RemoteException e) {
2230 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2231 }
2232 }
2233 return Uri.parse("content://icc/adn");
2234 }
2235
2236 /**
Tyler Gunna2879412023-02-28 23:41:53 +00002237 * Removes the missed-call notification if one is present and marks missed calls in the call
2238 * log as read.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002239 * <p>
Tyler Gunna2879412023-02-28 23:41:53 +00002240 * Requires that the method-caller be set as the default dialer app.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002241 * </p>
2242 */
Yorke Leec61d13662015-09-21 17:25:25 -07002243 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002244 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002245 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002246 if (service != null) {
2247 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002248 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002249 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002250 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002251 }
2252 }
2253 }
2254
2255 /**
2256 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2257 * currently no ongoing call, then this method does nothing.
2258 * <p>
2259 * Requires that the method-caller be set as the system dialer app or have the
2260 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2261 * </p>
2262 *
2263 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2264 */
Yorke Leec61d13662015-09-21 17:25:25 -07002265 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002266 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002267 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002268 if (service != null) {
2269 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002270 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002271 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002272 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002273 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002274 }
2275 }
2276 }
2277
Yorke Lee3e56ba12015-04-23 12:32:36 -07002278 /**
2279 * Places a new outgoing call to the provided address using the system telecom service with
2280 * the specified extras.
2281 *
2282 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2283 * except that the outgoing call will always be sent via the system telecom service. If
2284 * method-caller is either the user selected default dialer app or preloaded system dialer
2285 * app, then emergency calls will also be allowed.
2286 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002287 * Placing a call via a managed {@link ConnectionService} requires permission:
2288 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002289 *
2290 * Usage example:
2291 * <pre>
2292 * Uri uri = Uri.fromParts("tel", "12345", null);
2293 * Bundle extras = new Bundle();
2294 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2295 * telecomManager.placeCall(uri, extras);
2296 * </pre>
2297 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002298 * The following keys are supported in the supplied extras.
2299 * <ul>
2300 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2301 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2302 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2303 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2304 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002305 * <p>
2306 * An app which implements the self-managed {@link ConnectionService} API uses
2307 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2308 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2309 * associated {@link android.telecom.PhoneAccountHandle}.
2310 *
2311 * Self-managed {@link ConnectionService}s require permission
2312 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002313 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002314 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2315 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2316 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2317 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2318 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2319 * </p>
2320 *
Yorke Lee3e56ba12015-04-23 12:32:36 -07002321 * @param address The address to make the call to.
2322 * @param extras Bundle of extras to use with the call.
2323 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002324 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2325 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002326 public void placeCall(Uri address, Bundle extras) {
2327 ITelecomService service = getTelecomService();
2328 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002329 if (address == null) {
2330 Log.w(TAG, "Cannot place call to empty address.");
2331 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002332 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002333 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002334 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002335 } catch (RemoteException e) {
2336 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2337 }
2338 }
2339 }
2340
Ravi Paluri80aa2142019-12-02 11:57:37 +05302341
2342 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002343 * Place a new adhoc conference call with the provided participants using the system telecom
2344 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302345 *
2346 * An adhoc conference call is established by providing a list of addresses to
2347 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2348 * {@link ConnectionService} is responsible for connecting all indicated participants
2349 * to a conference simultaneously.
2350 * This is in contrast to conferences formed by merging calls together (e.g. using
2351 * {@link android.telecom.Call#mergeConference()}).
2352 *
2353 * The following keys are supported in the supplied extras.
2354 * <ul>
2355 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2356 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2357 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2358 * </ul>
2359 *
2360 * @param participants List of participants to start conference with
2361 * @param extras Bundle of extras to use with the call
2362 */
2363 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2364 public void startConference(@NonNull List<Uri> participants,
2365 @NonNull Bundle extras) {
2366 ITelecomService service = getTelecomService();
2367 if (service != null) {
2368 try {
2369 service.startConference(participants, extras,
2370 mContext.getOpPackageName());
2371 } catch (RemoteException e) {
2372 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2373 }
2374 }
2375 }
2376
Santos Cordon91371dc02015-05-08 13:52:09 -07002377 /**
2378 * Enables and disables specified phone account.
2379 *
2380 * @param handle Handle to the phone account.
2381 * @param isEnabled Enable state of the phone account.
2382 * @hide
2383 */
2384 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002385 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002386 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2387 ITelecomService service = getTelecomService();
2388 if (service != null) {
2389 try {
2390 service.enablePhoneAccount(handle, isEnabled);
2391 } catch (RemoteException e) {
2392 Log.e(TAG, "Error enablePhoneAbbount", e);
2393 }
2394 }
2395 }
2396
Hall Liu0464b9b2016-01-12 15:32:58 -08002397 /**
2398 * Dumps telecom analytics for uploading.
2399 *
2400 * @return
2401 * @hide
2402 */
2403 @SystemApi
2404 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002405 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002406 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002407 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002408 if (service != null) {
2409 try {
2410 result = service.dumpCallAnalytics();
2411 } catch (RemoteException e) {
2412 Log.e(TAG, "Error dumping call analytics", e);
2413 }
2414 }
2415 return result;
2416 }
2417
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002418 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002419 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2420 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002421 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002422 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2423 * {@code true} for the current user.
2424 */
2425 public Intent createManageBlockedNumbersIntent() {
2426 ITelecomService service = getTelecomService();
2427 Intent result = null;
2428 if (service != null) {
2429 try {
2430 result = service.createManageBlockedNumbersIntent();
2431 } catch (RemoteException e) {
2432 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2433 }
2434 }
2435 return result;
2436 }
2437
Fan Zhang5431ef52019-10-14 13:43:46 -07002438
2439 /**
2440 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2441 * launch the activity for emergency dialer.
2442 *
2443 * @param number Optional number to call in emergency dialer
2444 * @hide
2445 */
2446 @SystemApi
2447 @NonNull
2448 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2449 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002450 if (service != null) {
2451 try {
Tyler Gunn753aa102020-04-23 10:16:26 -07002452 return service.createLaunchEmergencyDialerIntent(number);
Fan Zhang5431ef52019-10-14 13:43:46 -07002453 } catch (RemoteException e) {
2454 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2455 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002456 } else {
2457 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002458 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002459
2460 // Telecom service knows the package name of the expected emergency dialer package; if it
2461 // is not available, then fallback to not targeting a specific package.
2462 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2463 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2464 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2465 }
2466 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002467 }
2468
Tyler Gunnf5035432017-01-09 09:43:12 -08002469 /**
2470 * Determines whether Telecom would permit an incoming call to be added via the
2471 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2472 * {@link PhoneAccountHandle}.
2473 * <p>
2474 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2475 * in the following situations:
2476 * <ul>
2477 * <li>{@link PhoneAccount} does not have property
2478 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2479 * {@link ConnectionService}), and the active or held call limit has
2480 * been reached.</li>
2481 * <li>There is an ongoing emergency call.</li>
2482 * </ul>
2483 *
2484 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2485 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2486 * otherwise.
2487 */
2488 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002489 if (phoneAccountHandle == null) {
2490 return false;
2491 }
2492
Tyler Gunnf5035432017-01-09 09:43:12 -08002493 ITelecomService service = getTelecomService();
2494 if (service != null) {
2495 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002496 return service.isIncomingCallPermitted(phoneAccountHandle,
2497 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002498 } catch (RemoteException e) {
2499 Log.e(TAG, "Error isIncomingCallPermitted", e);
2500 }
2501 }
2502 return false;
2503 }
2504
2505 /**
2506 * Determines whether Telecom would permit an outgoing call to be placed via the
2507 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2508 * <p>
2509 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2510 * in the following situations:
2511 * <ul>
2512 * <li>{@link PhoneAccount} does not have property
2513 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2514 * {@link ConnectionService}), and the active, held or ringing call limit has
2515 * been reached.</li>
2516 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2517 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2518 * another {@link ConnectionService}.</li>
2519 * <li>There is an ongoing emergency call.</li>
2520 * </ul>
2521 *
2522 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2523 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2524 * otherwise.
2525 */
2526 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2527 ITelecomService service = getTelecomService();
2528 if (service != null) {
2529 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002530 return service.isOutgoingCallPermitted(phoneAccountHandle,
2531 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002532 } catch (RemoteException e) {
2533 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2534 }
2535 }
2536 return false;
2537 }
2538
Sanket Padawea8eddd42017-11-03 11:07:35 -07002539 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002540 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2541 * {@link PhoneAccountHandle} it defines.
2542 * <p>
2543 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2544 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2545 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2546 * is referred to as the source of the handover, and the video calling app is referred to as the
2547 * destination.
2548 * <p>
2549 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2550 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2551 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2552 * device.
2553 * <p>
2554 * For a full discussion of the handover process and the APIs involved, see
2555 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2556 * <p>
2557 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2558 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002559 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2560 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2561 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2562 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2563 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2564 * <p>
2565 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2566 * associated with the {@link PhoneAccountHandle} destAcct and call
2567 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2568 * <p>
2569 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2570 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2571 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2572 * user.
2573 * <p>
2574 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2575 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2576 *
2577 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2578 * {@link ConnectionService}.
2579 * @param videoState Video state after the handover.
2580 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2581 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002582 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2583 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002584 ITelecomService service = getTelecomService();
2585 if (service != null) {
2586 try {
2587 service.acceptHandover(srcAddr, videoState, destAcct);
2588 } catch (RemoteException e) {
2589 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002590 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002591 }
2592 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002593
Tyler Gunn5bd90852018-09-21 09:37:07 -07002594 /**
2595 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2596 * call, as identified by the dialed number, or because a call was identified by the network
2597 * as an emergency call.
2598 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2599 * @hide
2600 */
2601 @SystemApi
2602 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2603 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002604 ITelecomService service = getTelecomService();
2605 if (service != null) {
2606 try {
2607 return service.isInEmergencyCall();
2608 } catch (RemoteException e) {
2609 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2610 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002611 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002612 }
2613 return false;
2614 }
2615
Tyler Gunnc37445c2018-09-28 16:16:20 -07002616 /**
Tyler Gunn27bf4342022-03-25 14:17:52 -07002617 * Determines whether there are any ongoing {@link PhoneAccount#CAPABILITY_SELF_MANAGED}
2618 * calls for a given {@code packageName} and {@code userHandle}.
2619 *
2620 * @param packageName the package name of the app to check calls for.
2621 * @param userHandle the user handle on which to check for calls.
2622 * @return {@code true} if there are ongoing calls, {@code false} otherwise.
2623 * @hide
2624 */
2625 @RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
2626 public boolean isInSelfManagedCall(@NonNull String packageName,
2627 @NonNull UserHandle userHandle) {
2628 ITelecomService service = getTelecomService();
2629 if (service != null) {
2630 try {
2631 return service.isInSelfManagedCall(packageName, userHandle,
2632 mContext.getOpPackageName());
2633 } catch (RemoteException e) {
2634 Log.e(TAG, "RemoteException isInSelfManagedCall: " + e);
2635 e.rethrowFromSystemServer();
2636 return false;
2637 }
2638 } else {
2639 throw new IllegalStateException("Telecom service is not present");
2640 }
2641 }
2642
2643 /**
Tyler Gunnc37445c2018-09-28 16:16:20 -07002644 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2645 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002646 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002647 * @hide
2648 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002649 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002650 ITelecomService service = getTelecomService();
2651 if (service != null) {
2652 try {
2653 service.handleCallIntent(intent, callingPackageProxy);
2654 } catch (RemoteException e) {
2655 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002656 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002657 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002658 }
2659
Shuo Qian4d065262020-10-20 11:04:28 -07002660 private boolean isSystemProcess() {
2661 return Process.myUid() == Process.SYSTEM_UID;
2662 }
2663
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002664 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002665 if (mTelecomServiceOverride != null) {
2666 return mTelecomServiceOverride;
2667 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002668 if (sTelecomService == null) {
2669 ITelecomService temp = ITelecomService.Stub.asInterface(
2670 ServiceManager.getService(Context.TELECOM_SERVICE));
2671 synchronized (CACHE_LOCK) {
2672 if (sTelecomService == null && temp != null) {
2673 try {
2674 sTelecomService = temp;
2675 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2676 } catch (Exception e) {
2677 sTelecomService = null;
2678 }
2679 }
2680 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002681 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002682 return sTelecomService;
2683 }
2684
2685 private static class DeathRecipient implements IBinder.DeathRecipient {
2686 @Override
2687 public void binderDied() {
2688 resetServiceCache();
2689 }
2690 }
2691
2692 private static void resetServiceCache() {
2693 synchronized (CACHE_LOCK) {
2694 if (sTelecomService != null) {
2695 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2696 sTelecomService = null;
2697 }
2698 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002699 }
Evan Charlton235c1592014-09-05 15:41:23 +00002700}