blob: 3b9d3d9c640df68c9c9170dfab616e113b42d37f [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;
Grace Jiae086d082021-10-28 17:04:29 -070057import java.util.HashSet;
Ihab Awad807fe0a2014-07-09 12:30:52 -070058import java.util.List;
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -080059import java.util.Objects;
Grace Jiae086d082021-10-28 17:04:29 -070060import java.util.Set;
Tyler Gunn7e45b722018-12-04 12:56:45 -080061import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070062
Yorke Leeb4ce1432014-06-09 13:53:23 -070063/**
Santos Cordond9e614f2014-10-28 13:10:36 -070064 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080065 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070066 * <p>
67 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
68 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
69 * <p>
70 * Note that access to some telecom information is permission-protected. Your app cannot access the
71 * protected information or gain access to protected functionality unless it has the appropriate
72 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
73 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070074 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060075@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060076@SystemService(Context.TELECOM_SERVICE)
Hui Wangc47df7f2021-12-14 20:37:47 +000077@RequiresFeature(PackageManager.FEATURE_TELECOM)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070078public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070079
Evan Charlton10197192014-07-19 15:00:29 -070080 /**
Santos Cordon96efb482014-07-19 14:57:05 -070081 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070082 * UI by notifying the Telecom system that an incoming call exists for a specific call service
83 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
84 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070085 * ultimately use to control and get information about the call.
86 * <p>
87 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070088 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070089 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080090 *
91 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070092 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070093 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070094
95 /**
Yorke Leec3cf9822014-10-02 09:38:39 -070096 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
97 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080098 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -070099 * @hide
100 */
101 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
102
103 /**
Santos Cordon895d4b82015-06-25 16:41:48 -0700104 * An {@link android.content.Intent} action sent by the telecom framework to start a
105 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
106 * and each app that registers a {@link PhoneAccount} should provide one if desired.
107 * <p>
108 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
109 * app's settings menu. For each entry, the settings app will add a click action. When
110 * triggered, the click-action will start this intent along with the extra
111 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
112 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
113 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700114 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700115 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
116 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700117
118 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800119 * The {@link android.content.Intent} action used to show the call accessibility settings page.
120 */
121 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
122 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
123
124 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700125 * The {@link android.content.Intent} action used to show the call settings page.
126 */
127 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700128 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700129
130 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800131 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
132 */
133 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
134 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
135
136 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700137 * The {@link android.content.Intent} action used to show the settings page used to configure
138 * {@link PhoneAccount} preferences.
139 */
140 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700141 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700142
143 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700144 * {@link android.content.Intent} action used indicate that a new phone account was just
145 * registered.
146 * <p>
147 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
148 * to indicate which {@link PhoneAccount} was registered.
149 * <p>
150 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800151 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800152 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
153 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
154
155 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700156 * {@link android.content.Intent} action used indicate that a phone account was just
157 * unregistered.
158 * <p>
159 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
160 * to indicate which {@link PhoneAccount} was unregistered.
161 * <p>
162 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700163 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700164 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
165 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
166
167 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700168 * Activity action: Shows a dialog asking the user whether or not they want to replace the
169 * current default Dialer with the one specified in
170 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
171 *
172 * Usage example:
173 * <pre>
174 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
175 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
176 * getActivity().getPackageName());
177 * startActivity(intent);
178 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800179 * <p>
180 * This is no longer supported since Q, please use
181 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
182 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700183 */
184 public static final String ACTION_CHANGE_DEFAULT_DIALER =
185 "android.telecom.action.CHANGE_DEFAULT_DIALER";
186
187 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700188 * Broadcast intent action indicating that the current default dialer has changed.
189 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
190 * name of the package that the default dialer was changed to.
191 *
192 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
193 */
194 public static final String ACTION_DEFAULT_DIALER_CHANGED =
195 "android.telecom.action.DEFAULT_DIALER_CHANGED";
196
197 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700198 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
199 */
200 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
201 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
202
203 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800204 * Broadcast intent action indicating that the current default call screening app has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700205 * <p>
206 * Note: This intent is NEVER actually broadcast and will be deprecated in the future.
207 * <p>
208 * An app that want to know if it holds the
209 * {@link android.app.role.RoleManager#ROLE_CALL_SCREENING} role can use
210 * {@link android.app.role.RoleManager#isRoleHeld(String)} to confirm if it holds the role or
211 * not.
tonyzhuff60f5e2018-10-01 19:14:59 +0800212 */
213 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
214 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
215
216 /**
217 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
218 * indicate the ComponentName of the call screening app which has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700219 * <p>
220 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800221 */
222 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
223 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
224
225 /**
226 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
227 * indicate whether an app is the default call screening app.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700228 * <p>
229 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800230 */
231 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
232 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
233
234 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700235 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
236 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700237 */
238 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700239 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700240
241 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700242 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
243 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700244 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700245 * {@link VideoProfile#STATE_AUDIO_ONLY},
246 * {@link VideoProfile#STATE_BIDIRECTIONAL},
247 * {@link VideoProfile#STATE_RX_ENABLED},
248 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700249 */
250 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700251 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700252
253 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700254 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
255 * integer that determines the requested video state for an incoming call.
256 * Valid options:
257 * {@link VideoProfile#STATE_AUDIO_ONLY},
258 * {@link VideoProfile#STATE_BIDIRECTIONAL},
259 * {@link VideoProfile#STATE_RX_ENABLED},
260 * {@link VideoProfile#STATE_TX_ENABLED}.
261 */
262 public static final String EXTRA_INCOMING_VIDEO_STATE =
263 "android.telecom.extra.INCOMING_VIDEO_STATE";
264
265 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700266 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
267 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
268 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700269 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700270 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700271 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700272 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700273 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700274
275 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700276 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
277 * subject which will be associated with an outgoing call. Should only be specified if the
Shuo Qian3ed38832020-11-30 21:54:36 -0800278 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
279 * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700280 */
281 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
282
Shuo Qian3ed38832020-11-30 21:54:36 -0800283 // Values for EXTRA_PRIORITY
284 /**
285 * Indicates the call composer call priority is normal.
286 *
287 * Reference: RCC.20 Section 2.4.4.2
288 */
289 public static final int PRIORITY_NORMAL = 0;
290
291 /**
292 * Indicates the call composer call priority is urgent.
293 *
294 * Reference: RCC.20 Section 2.4.4.2
295 */
296 public static final int PRIORITY_URGENT = 1;
297
298 /**
299 * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
300 * {@link #PRIORITY_URGENT}.
301 *
302 * Reference: RCC.20 Section 2.4.4.2
303 */
304 public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
305
306 /**
307 * Extra for the call composer call location, an {@link android.location.Location} parcelable
308 * class to represent the geolocation as a latitude and longitude pair.
309 *
310 * Reference: RCC.20 Section 2.4.3.2
311 */
312 public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
313
314 /**
315 * A boolean extra set on incoming calls to indicate that the call has a picture specified.
316 * Given that image download could take a (short) time, the EXTRA is set immediately upon
317 * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
318 * if one is expected. The EXTRA may be unset if the image download ends up failing for some
319 * reason.
320 */
321 public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
322
323 /**
Hall Liu48c3c142021-03-11 16:14:22 -0800324 * A {@link Uri} representing the picture that was downloaded when a call is received or
325 * uploaded when a call is placed.
Hall Liu8fee7ea2021-01-21 16:37:51 -0800326 *
Shuo Qian3ed38832020-11-30 21:54:36 -0800327 * This is a content URI within the call log provider which can be used to open a file
328 * 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 -0800329 * download/upload is delayed for some reason. The Dialer app will receive a callback via
Shuo Qian3ed38832020-11-30 21:54:36 -0800330 * {@link Call.Callback#onDetailsChanged} when this value has changed.
331 *
332 * Reference: RCC.20 Section 2.4.3.2
333 */
Hall Liu8fee7ea2021-01-21 16:37:51 -0800334 public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
Shuo Qian3ed38832020-11-30 21:54:36 -0800335
Shuo Qian3ed38832020-11-30 21:54:36 -0800336 /**
337 * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
Hall Liua749abc2021-01-21 10:05:43 -0800338 * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
339 * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
Shuo Qian3ed38832020-11-30 21:54:36 -0800340 */
341 public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
342
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700343 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700344 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
345 * has initiated a new incoming call.
346 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700347 public static final String EXTRA_INCOMING_CALL_ADDRESS =
348 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700349
350 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700351 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
352 * metadata about the call. This {@link Bundle} will be returned to the
353 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700354 */
355 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700356 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700357
358 /**
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800359 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a boolean to indicate that the
360 * call has an externally generated ringer. Used by the HfpClientConnectionService when In Band
361 * Ringtone is enabled to prevent two ringers from being generated.
362 * @hide
363 */
364 public static final String EXTRA_CALL_EXTERNAL_RINGER =
365 "android.telecom.extra.CALL_EXTERNAL_RINGER";
366
367 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700368 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
369 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
370 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700371 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700372 */
373 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700374 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700375
376 /**
sqian6d9e7452019-02-08 21:42:15 -0800377 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
378 * whether the user's dial intent is emergency; this is required to specify when the dialed
379 * number is ambiguous, identified as both emergency number and any other non-emergency number;
380 * e.g. in some situation, 611 could be both an emergency number in a country and a
381 * non-emergency number of a carrier's customer service hotline.
382 *
383 * @hide
384 */
385 @SystemApi
386 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
387 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
388
389 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800390 * A mandatory extra containing a {@link Uri} to be passed in when calling
391 * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
392 * the remote handle of the new call.
Yorke Leec3cf9822014-10-02 09:38:39 -0700393 * @hide
394 */
Hall Liu2ef04112020-09-14 18:34:10 -0700395 @SystemApi
Yorke Leec3cf9822014-10-02 09:38:39 -0700396 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
397 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
398
399 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700400 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
401 * call was created. This value is in milliseconds since boot.
Hall Liudbb17f12020-03-10 18:28:58 -0700402 * @hide
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700403 */
404 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
405 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
406
407 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800408 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
409 * time the call was created.
410 * @hide
411 */
412 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
413 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
414
415 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700416 * Optional extra for incoming and outgoing calls containing a long which specifies the time
417 * telecom began routing the call. This value is in milliseconds since boot.
418 * @hide
419 */
420 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
421 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
422
423 /**
424 * Optional extra for incoming and outgoing calls containing a long which specifies the time
425 * telecom finished routing the call. This value is in milliseconds since boot.
426 * @hide
427 */
428 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
429 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
430
431 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700432 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
433 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700434 */
435 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700436 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700437
438 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700439 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
440 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700441 */
442 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700443 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700444
445 /**
radhika0dd90652020-11-04 11:12:51 -0800446 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
447 * lower layers
448 * @hide
449 */
450 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
451 "Call dropped by lower layers";
452
453 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700454 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
455 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800456 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700457 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800458 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700459 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700460 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700461
462 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800463 * Optional extra for communicating the call technology used by a {@link ConnectionService}
464 * to Telecom. Valid values are:
465 * <ul>
466 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
467 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
468 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
469 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
470 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
471 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800472 * @hide
473 */
Hall Liu2ef04112020-09-14 18:34:10 -0700474 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800475 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
476 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
477
478 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800479 * Optional extra for communicating the call network technology used by a
480 * {@link android.telecom.Connection} to Telecom and InCallUI.
481 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700482 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800483 */
484 public static final String EXTRA_CALL_NETWORK_TYPE =
485 "android.telecom.extra.CALL_NETWORK_TYPE";
486
487 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700488 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
489 * package name of the app specifying an alternative gateway for the call.
490 * The value is a string.
491 *
492 * (The following comment corresponds to the all GATEWAY_* extras)
493 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
494 * alternative address to dial which is different from the one specified and displayed to
495 * the user. This alternative address is referred to as the gateway address.
496 */
497 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700498 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700499
500 /**
501 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
502 * original address to dial for the call. This is used when an alternative gateway address is
503 * provided to recall the original address.
504 * The value is a {@link android.net.Uri}.
505 *
506 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
507 */
508 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700509 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700510
511 /**
Evan Charlton10197192014-07-19 15:00:29 -0700512 * The number which the party on the other side of the line will see (and use to return the
513 * call).
514 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700515 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
516 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
517 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700518 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700519 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700520
521 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800522 * The number of milliseconds that Telecom should wait after disconnecting a call via the
523 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
524 * to make a new one.
525 * @hide
526 */
527 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
528 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
529
530 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700531 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700532 * existing call from the user's device to a different {@link PhoneAccount}.
533 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700534 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
535 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
536 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
537 * the receiving side of a handover.
538 * <p>
539 * Used when Telecom calls
540 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
541 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
542 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
543 * occurs on the initiating side of a handover.
544 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700545 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700546 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800547 * @deprecated Use the public handover APIs. See
548 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700549 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800550 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700551 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
552
553 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800554 * When {@code true} indicates that a request to create a new connection is for the purpose of
555 * a handover. Note: This is used with the
556 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
557 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
558 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
559 * @hide
560 */
561 public static final String EXTRA_IS_HANDOVER_CONNECTION =
562 "android.telecom.extra.IS_HANDOVER_CONNECTION";
563
564 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700565 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
566 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
567 * the handover is from.
568 * @hide
569 */
570 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
571 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
572
573 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700574 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
575 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
576 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
577 * {@link Connection} will be.
578 * @hide
579 */
580 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
581
582 /**
Hall Liu95d55872017-01-25 17:12:49 -0800583 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
584 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
585 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
586 */
587 public static final String EXTRA_START_CALL_WITH_RTT =
588 "android.telecom.extra.START_CALL_WITH_RTT";
589
590 /**
Grace Jiae086d082021-10-28 17:04:29 -0700591 * A parcelable extra, which when set on the bundle passed into {@link #placeCall(Uri, Bundle)},
592 * indicates that the call should be initiated with an active {@link CallEndpoint} to stream
593 * the call as a tethered call.
594 */
595 public static final String EXTRA_START_CALL_ON_ENDPOINT =
596 "android.telecom.extra.START_CALL_ON_ENDPOINT";
597
598 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800599 * Start an activity indicating that the completion of an outgoing call or an incoming call
600 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
601 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
602 *
603 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
604 * call which completed.
605 *
606 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
607 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
608 *
609 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
610 * {@link #EXTRA_CALL_DURATION} for more information.
611 */
612 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
613
614 /**
615 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
616 * uri handle(phone number) of the completed call.
617 */
618 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
619
620 /**
621 * A integer value provided for completed calls to indicate the reason for the call
622 * disconnection.
623 * <p>
624 * Allowed values:
625 * <ul>
626 * <li>{@link DisconnectCause#UNKNOWN}</li>
627 * <li>{@link DisconnectCause#LOCAL}</li>
628 * <li>{@link DisconnectCause#REMOTE}</li>
629 * <li>{@link DisconnectCause#REJECTED}</li>
630 * <li>{@link DisconnectCause#MISSED}</li>
631 * </ul>
632 * </p>
633 */
634 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
635
636 /**
637 * A integer value provided for completed calls to indicate the duration of the call.
638 * <p>
639 * Allowed values:
640 * <ul>
641 * <li>{@link #DURATION_VERY_SHORT}</li>
642 * <li>{@link #DURATION_SHORT}</li>
643 * <li>{@link #DURATION_MEDIUM}</li>
644 * <li>{@link #DURATION_LONG}</li>
645 * </ul>
646 * </p>
647 */
648 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
649
650 /**
651 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
652 * call was < 3 seconds.
653 */
654 public static final int DURATION_VERY_SHORT = 0;
655
656 /**
657 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
658 * call was >= 3 seconds and < 60 seconds.
659 */
660 public static final int DURATION_SHORT = 1;
661
662 /**
663 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
664 * call was >= 60 seconds and < 120 seconds.
665 */
666 public static final int DURATION_MEDIUM = 2;
667
668 /**
669 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
670 * call was >= 120 seconds.
671 */
672 public static final int DURATION_LONG = 3;
673
674 /**
675 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
676 * milliseconds.
677 * @hide
678 */
679 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
680
681 /**
682 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
683 * milliseconds.
684 * @hide
685 */
686 public static final long SHORT_CALL_TIME_MS = 60000;
687
688 /**
689 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
690 * milliseconds.
691 * @hide
692 */
693 public static final long MEDIUM_CALL_TIME_MS = 120000;
694
695 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700696 * A boolean meta-data value indicating whether an {@link InCallService} implements an
697 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
698 * would also like to replace the in-call interface should set this meta-data to {@code true} in
699 * the manifest registration of their {@link InCallService}.
700 */
701 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
702
703 /**
Santos Cordon88881552015-12-10 17:29:54 -0800704 * A boolean meta-data value indicating whether an {@link InCallService} implements an
705 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000706 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800707 */
708 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
709 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
710
711 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800712 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
713 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
714 * override the system provided ringing should set this meta-data to {@code true} in the
715 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700716 * <p>
717 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
718 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800719 */
720 public static final String METADATA_IN_CALL_SERVICE_RINGING =
721 "android.telecom.IN_CALL_SERVICE_RINGING";
722
723 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700724 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
725 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
726 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
727 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
728 * informed of external calls should set this meta-data to {@code true} in the manifest
729 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
730 * be informed of external calls.
731 */
732 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
733 "android.telecom.INCLUDE_EXTERNAL_CALLS";
734
735 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800736 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
737 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
738 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
739 * to implement its own call user interface. An {@link InCallService} implementation which
740 * would like to be informed of external calls should set this meta-data to {@code true} in the
741 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
742 * will NOT be informed about self-managed calls.
743 * <p>
744 * An {@link InCallService} which receives self-managed calls is free to view and control the
745 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700746 * exposing these calls to an automotive device via its companion app.
747 * <p>
748 * This meta-data can only be set for an {@link InCallService} which also sets
749 * {@link #METADATA_IN_CALL_SERVICE_UI}. Only the default phone/dialer app, or a car-mode
750 * {@link InCallService} can see self-managed calls.
Tyler Gunn24e18332017-02-10 09:42:49 -0800751 * <p>
752 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
753 */
754 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
755 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
756
757 /**
Grace Jiae086d082021-10-28 17:04:29 -0700758 * A boolean meta-data value indicating this {@link InCallService} implementation is aimed at
759 * working as a streaming app for a tethered call. When there's a tethered call
760 * requesting to a {@link CallEndpoint} registered with this app, Telecom will bind to this
761 * streaming app and let the app streaming the call to the requested endpoint.
762 * <p>
763 * This meta-data can only be set for an {@link InCallService} which doesn't set neither
764 * {@link #METADATA_IN_CALL_SERVICE_UI} nor {@link #METADATA_IN_CALL_SERVICE_CAR_MODE_UI}.
765 * Otherwise, the app will be treated as a phone/dialer app or a car-mode app.
766 * <p>
767 * The {@link InCallService} declared this meta-data must implement
768 * {@link InCallService#onCallEndpointActivationRequested(CallEndpoint, CallEndpointSession)}.
769 * See this method for more information.
770 */
771 public static final String METADATA_STREAMING_TETHERED_CALLS =
772 "android.telecom.STREAMING_TETHERED_CALLS";
773
774 /**
Evan Charlton10197192014-07-19 15:00:29 -0700775 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
776 * pause for a predefined period.
777 */
778 public static final char DTMF_CHARACTER_PAUSE = ',';
779
780 /**
781 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
782 * wait for user confirmation before proceeding.
783 */
784 public static final char DTMF_CHARACTER_WAIT = ';';
785
786 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800787 * @hide
788 */
789 @IntDef(prefix = { "TTY_MODE_" },
790 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
791 @Retention(RetentionPolicy.SOURCE)
792 public @interface TtyMode {}
793
794 /**
Evan Charlton10197192014-07-19 15:00:29 -0700795 * TTY (teletypewriter) mode is off.
796 *
797 * @hide
798 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800799 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700800 public static final int TTY_MODE_OFF = 0;
801
802 /**
803 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
804 * will communicate with the remote party by sending and receiving text messages.
805 *
806 * @hide
807 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800808 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700809 public static final int TTY_MODE_FULL = 1;
810
811 /**
812 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
813 * speaker is on. The user will communicate with the remote party by sending text messages and
814 * hearing an audible reply.
815 *
816 * @hide
817 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800818 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700819 public static final int TTY_MODE_HCO = 2;
820
821 /**
822 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
823 * microphone is still on. User will communicate with the remote party by speaking and receiving
824 * text message replies.
825 *
826 * @hide
827 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800828 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700829 public static final int TTY_MODE_VCO = 3;
830
831 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700832 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700833 *
Hall Liu2ef04112020-09-14 18:34:10 -0700834 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
835 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700836 * @hide
837 */
Hall Liu2ef04112020-09-14 18:34:10 -0700838 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700839 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700840 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700841
842 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700843 * Integer extra key that indicates the current TTY mode.
844 *
845 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
846 *
847 * Valid modes are:
848 * <ul>
849 * <li>{@link #TTY_MODE_OFF}</li>
850 * <li>{@link #TTY_MODE_FULL}</li>
851 * <li>{@link #TTY_MODE_HCO}</li>
852 * <li>{@link #TTY_MODE_VCO}</li>
853 * </ul>
854 *
855 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
856 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
857 * plugged into the device.
858 * @hide
859 */
Hall Liu2ef04112020-09-14 18:34:10 -0700860 @SystemApi
861 public static final String EXTRA_CURRENT_TTY_MODE =
862 "android.telecom.extra.CURRENT_TTY_MODE";
863
864 /**
865 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
866 *
867 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
868 * preferred TTY mode.
869 * @hide
870 */
Hall Liu2ef04112020-09-14 18:34:10 -0700871 @SystemApi
872 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
873 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
874
875 /**
876 * Integer extra key that indicates the preferred TTY mode.
877 *
878 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
879 *
Evan Charlton10197192014-07-19 15:00:29 -0700880 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800881 * <ul>
882 * <li>{@link #TTY_MODE_OFF}</li>
883 * <li>{@link #TTY_MODE_FULL}</li>
884 * <li>{@link #TTY_MODE_HCO}</li>
885 * <li>{@link #TTY_MODE_VCO}</li>
886 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700887 * @hide
888 */
Hall Liu2ef04112020-09-14 18:34:10 -0700889 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700890 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800891 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700892
Nancy Chen9d568c02014-09-08 14:17:59 -0700893 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700894 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800895 * notification. If no custom component exists then this is sent to the default dialer which
896 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700897 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700898 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
899 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
900
901 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800902 * The number of calls associated with the notification. If the number is zero then the missed
903 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700904 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700905 public static final String EXTRA_NOTIFICATION_COUNT =
906 "android.telecom.extra.NOTIFICATION_COUNT";
907
908 /**
909 * The number associated with the missed calls. This number is only relevant
910 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700911 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700912 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
913 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
914
915 /**
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700916 * The intent to clear missed calls.
917 * @hide
918 */
919 @SystemApi
920 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
921 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
922
923 /**
924 * The intent to call back a missed call.
925 * @hide
926 */
927 @SystemApi
928 public static final String EXTRA_CALL_BACK_INTENT =
929 "android.telecom.extra.CALL_BACK_INTENT";
930
931 /**
Charles He858f1322017-11-27 17:11:04 -0800932 * The dialer activity responsible for placing emergency calls from, for example, a locked
933 * keyguard.
934 * @hide
935 */
936 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
937 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
938
939 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800940 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
941 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700942 * <p>
943 * The call initiator can use this extra to indicate that a call used assisted dialing to help
944 * place the call. This is most commonly used by a Dialer app which provides the ability to
945 * automatically add dialing prefixes when placing international calls.
946 * <p>
947 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800948 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
949 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700950 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
951 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
952 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800953 */
954 public static final String EXTRA_USE_ASSISTED_DIALING =
955 "android.telecom.extra.USE_ASSISTED_DIALING";
956
957 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800958 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
959 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800960 * Valid sources are:
961 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
962 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
963 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800964 *
Hall Liu2ef04112020-09-14 18:34:10 -0700965 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800966 * @hide
967 */
Hall Liu2ef04112020-09-14 18:34:10 -0700968 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800969 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
970
971 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800972 * Indicating the call is initiated via emergency dialer's shortcut button.
973 *
974 * @hide
975 */
Hall Liu2ef04112020-09-14 18:34:10 -0700976 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800977 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
978
979 /**
980 * Indicating the call is initiated via emergency dialer's dialpad.
981 *
982 * @hide
983 */
Hall Liu2ef04112020-09-14 18:34:10 -0700984 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800985 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
986
987 /**
988 * Indicating the call source is not specified.
989 *
990 * @hide
991 */
Hall Liu2ef04112020-09-14 18:34:10 -0700992 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800993 public static final int CALL_SOURCE_UNSPECIFIED = 0;
994
995 /**
Nancy Chen9d568c02014-09-08 14:17:59 -0700996 * The following 4 constants define how properties such as phone numbers and names are
997 * displayed to the user.
998 */
999
Santos Cordoned769ae2015-05-13 18:47:38 -07001000 /**
1001 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -08001002 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001003 public static final int PRESENTATION_ALLOWED = 1;
1004
Santos Cordoned769ae2015-05-13 18:47:38 -07001005 /**
1006 * Indicates that the address or number of a call is blocked by the other party.
1007 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001008 public static final int PRESENTATION_RESTRICTED = 2;
1009
Santos Cordoned769ae2015-05-13 18:47:38 -07001010 /**
1011 * Indicates that the address or number of a call is not specified or known by the carrier.
1012 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001013 public static final int PRESENTATION_UNKNOWN = 3;
1014
Santos Cordoned769ae2015-05-13 18:47:38 -07001015 /**
1016 * Indicates that the address or number of a call belongs to a pay phone.
1017 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001018 public static final int PRESENTATION_PAYPHONE = 4;
1019
Grace Jiacc16b042021-08-09 09:06:11 -07001020 /**
1021 * Indicates that the address or number of a call is unavailable.
1022 */
1023 public static final int PRESENTATION_UNAVAILABLE = 5;
1024
Hall Liu4a9fde12020-01-16 17:38:46 -08001025
1026 /*
1027 * Values for the adb property "persist.radio.videocall.audio.output"
1028 */
1029 /** @hide */
1030 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1031 /** @hide */
1032 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1033 /** @hide */
1034 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1035
Tyler Gunn00d737b2019-10-31 13:04:37 -07001036 /** @hide */
1037 @Retention(RetentionPolicy.SOURCE)
1038 @IntDef(
1039 prefix = { "PRESENTATION_" },
1040 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001041 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001042 public @interface Presentation {}
1043
Brad Ebingera8366ae2021-03-23 21:01:51 +00001044
1045 /**
1046 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1047 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1048 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001049 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001050 */
1051 @ChangeId
1052 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1053 // this magic number is a bug ID
1054 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1055
Grace Jiab13eb2c2021-04-21 14:13:26 -07001056 /**
1057 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1058 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1059 * @hide
1060 */
1061 @ChangeId
1062 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1063 // bug ID
1064 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1065
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001066 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001067
Kevin Jeon767cda32020-11-17 01:40:16 +00001068
1069 /** Cached service handles, cleared by resetServiceCache() at death */
1070 private static final Object CACHE_LOCK = new Object();
1071
1072 @GuardedBy("CACHE_LOCK")
1073 private static ITelecomService sTelecomService;
1074 @GuardedBy("CACHE_LOCK")
1075 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1076
Yorke Leeb4ce1432014-06-09 13:53:23 -07001077 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001078
Hall Liue1bc2ec2015-10-09 15:58:37 -07001079 private final ITelecomService mTelecomServiceOverride;
1080
Santos Cordon6c7a3882014-06-25 15:30:08 -07001081 /**
1082 * @hide
1083 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001084 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001085 public static TelecomManager from(Context context) {
1086 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001087 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001088
1089 /**
1090 * @hide
1091 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001092 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001093 this(context, null);
1094 }
1095
1096 /**
1097 * @hide
1098 */
1099 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001100 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001101 if (appContext != null && Objects.equals(context.getAttributionTag(),
1102 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001103 mContext = appContext;
1104 } else {
1105 mContext = context;
1106 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001107 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001108 }
1109
1110 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001111 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1112 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1113 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1114 * account returned depends on the following priorities:
1115 * <ul>
1116 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1117 * be returned.
1118 * </li>
1119 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1120 * will be returned.
1121 * </li>
1122 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001123 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001124 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1125 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001126 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001127 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001128 */
Yorke Leec61d13662015-09-21 17:25:25 -07001129 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001130 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001131 ITelecomService service = getTelecomService();
1132 if (service != null) {
1133 try {
1134 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001135 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001136 } catch (RemoteException e) {
1137 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001138 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001139 }
1140 return null;
1141 }
1142
1143 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001144 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1145 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001146 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001147 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001148 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1149 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001150 * <p>
1151 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001152 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001153 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1154 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001155 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001156 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001157 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001158 ITelecomService service = getTelecomService();
1159 if (service != null) {
1160 try {
1161 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001162 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001163 } catch (RemoteException e) {
1164 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001165 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001166 }
1167 return null;
1168 }
1169
1170 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001171 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1172 *
1173 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001174 * outgoing voice calls, or {@code null} if no default is specified (the
1175 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001176 * @hide
1177 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001178 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1179 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001180 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001181 ITelecomService service = getTelecomService();
1182 if (service != null) {
1183 try {
1184 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1185 } catch (RemoteException e) {
1186 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001187 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001188 }
1189 }
1190
1191 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001192 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001193 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1194 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001195 *
Brad Ebingere7833312019-05-07 10:55:55 -07001196 * @return The phone account handle of the current sim call manager for the default voice
1197 * subscription.
1198 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001199 */
1200 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001201 ITelecomService service = getTelecomService();
1202 if (service != null) {
1203 try {
1204 return service.getSimCallManager(
Brad Ebingere7833312019-05-07 10:55:55 -07001205 SubscriptionManager.getDefaultSubscriptionId());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001206 } catch (RemoteException e) {
1207 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001208 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001209 }
1210 return null;
1211 }
1212
1213 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001214 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1215 * prepared for this method to return {@code null}, indicating that there currently exists no
1216 * SIM call manager {@link PhoneAccount} for the subscription specified.
1217 *
1218 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1219 * queried for.
1220 * @return The phone account handle of the current sim call manager.
1221 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001222 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001223 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001224 ITelecomService service = getTelecomService();
1225 if (service != null) {
1226 try {
1227 return service.getSimCallManager(subscriptionId);
1228 } catch (RemoteException e) {
1229 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001230 }
Brad Ebingere7833312019-05-07 10:55:55 -07001231 }
1232 return null;
1233 }
1234
1235 /**
1236 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1237 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1238 * must be prepared for this method to return {@code null}, indicating that there currently
1239 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001240 *
1241 * @return The phone account handle of the current sim call manager.
1242 *
1243 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001244 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001245 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001246 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001247 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001248 ITelecomService service = getTelecomService();
1249 if (service != null) {
1250 try {
1251 return service.getSimCallManagerForUser(userId);
1252 } catch (RemoteException e) {
1253 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001254 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001255 }
1256 return null;
1257 }
1258
1259 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001260 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001261 * {@code null}, indicating that there currently exists no Connection Manager
1262 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001263 *
1264 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001265 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001266 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001267 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001268 public PhoneAccountHandle getConnectionManager() {
1269 return getSimCallManager();
1270 }
1271
1272 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001273 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1274 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001275 * <P>
1276 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1277 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1278 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1279 * such as {@code sip:example@sipexample.com}).
1280 *
1281 * @param uriScheme The URI scheme.
1282 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001283 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001284 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001285 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001286 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001287 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001288 android.Manifest.permission.READ_PHONE_STATE
1289 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001290 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001291 ITelecomService service = getTelecomService();
1292 if (service != null) {
1293 try {
1294 return service.getPhoneAccountsSupportingScheme(uriScheme,
Svet Ganov16a16892015-04-16 10:32:04 -07001295 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001296 } catch (RemoteException e) {
1297 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001298 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001299 }
1300 return new ArrayList<>();
1301 }
1302
Nancy Chen513c8922014-09-17 14:47:20 -07001303
1304 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001305 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1306 * calls. The returned list includes only those accounts which have been explicitly enabled
1307 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001308 *
1309 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1310 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001311 */
Yorke Leec61d13662015-09-21 17:25:25 -07001312 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001313 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001314 return getCallCapablePhoneAccounts(false);
1315 }
1316
1317 /**
Tyler Gunn89317072017-04-07 14:57:37 -07001318 * Returns a list of {@link PhoneAccountHandle}s for self-managed {@link ConnectionService}s.
1319 * <p>
1320 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1321 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1322 * <p>
1323 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuartb90f5c92022-01-15 00:22:59 +00001324 * is the default dialer app to get all phone account handles.
1325 * <P>
1326 * If the caller doesn't meet any of the above requirements and has {@link
1327 * android.Manifest.permission#MANAGE_OWN_CALLS}, the caller can get only the phone account
1328 * handles they have registered.
Tyler Gunn89317072017-04-07 14:57:37 -07001329 * <p>
Thomas Stuartb90f5c92022-01-15 00:22:59 +00001330 * A {@link SecurityException} will be thrown if the caller is not the default dialer
1331 * or the caller does not have at least one of the following permissions:
1332 * {@link android.Manifest.permission#READ_PHONE_STATE} permission,
1333 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission
Tyler Gunn89317072017-04-07 14:57:37 -07001334 *
1335 * @return A list of {@code PhoneAccountHandle} objects.
1336 */
Thomas Stuartb90f5c92022-01-15 00:22:59 +00001337 @RequiresPermission(anyOf = {
1338 READ_PRIVILEGED_PHONE_STATE,
1339 android.Manifest.permission.READ_PHONE_STATE,
1340 android.Manifest.permission.MANAGE_OWN_CALLS
1341 })
Tyler Gunn89317072017-04-07 14:57:37 -07001342 public List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001343 ITelecomService service = getTelecomService();
1344 if (service != null) {
1345 try {
1346 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001347 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001348 } catch (RemoteException e) {
1349 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001350 }
Tyler Gunn89317072017-04-07 14:57:37 -07001351 }
1352 return new ArrayList<>();
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,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001373 mContext.getOpPackageName(), mContext.getAttributionTag());
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 {
1397 return service.getPhoneAccountsForPackage(mContext.getPackageName());
1398 } 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 {
1457 return service.getAllPhoneAccounts();
1458 } 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 {
1476 return service.getAllPhoneAccountHandles();
1477 } 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 Gunn37653562017-03-13 18:15:15 -07002050 * The incoming call you are adding is assumed to have a video state of
2051 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2052 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2053 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002054 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2055 * associated with the {@link PhoneAccountHandle} and request additional information about the
2056 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002057 * call UI.
2058 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002059 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2060 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2061 * the associated {@link PhoneAccount} is not currently enabled by the user.
2062 * <p>
2063 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2064 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2065 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2066 *
Santos Cordon96efb482014-07-19 14:57:05 -07002067 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2068 * {@link #registerPhoneAccount}.
2069 * @param extras A bundle that will be passed through to
2070 * {@link ConnectionService#onCreateIncomingConnection}.
2071 */
2072 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002073 ITelecomService service = getTelecomService();
2074 if (service != null) {
2075 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002076 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2077 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2078 Build.VERSION_CODES.O_MR1) {
2079 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2080 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002081 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002082 }
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002083 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras);
2084 } catch (RemoteException e) {
2085 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002086 }
Santos Cordon96efb482014-07-19 14:57:05 -07002087 }
2088 }
2089
Nancy Chen0eb1e402014-08-21 22:52:29 -07002090 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302091 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002092 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2093 * call initiated on another device which the user is being invited to join in. For managed
2094 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2095 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2096 * corresponding {@link PhoneAccount}. This can be checked using
2097 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2098 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302099 * <p>
2100 * The incoming conference you are adding is assumed to have a video state of
2101 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2102 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2103 * <p>
2104 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2105 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002106 * call (See
2107 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2108 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302109 * <p>
2110 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2111 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2112 * the associated {@link PhoneAccount} is not currently enabled by the user.
2113 *
2114 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2115 * {@link #registerPhoneAccount}.
2116 * @param extras A bundle that will be passed through to
2117 * {@link ConnectionService#onCreateIncomingConference}.
2118 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302119 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2120 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002121 ITelecomService service = getTelecomService();
2122 if (service != null) {
2123 try {
2124 service.addNewIncomingConference(
Ravi Paluri80aa2142019-12-02 11:57:37 +05302125 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002126 } catch (RemoteException e) {
2127 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302128 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302129 }
2130 }
2131
2132 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002133 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2134 * service. This is invoked when Telephony detects a new unknown connection that was neither
2135 * a new incoming call, nor an user-initiated outgoing call.
2136 *
2137 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2138 * {@link #registerPhoneAccount}.
2139 * @param extras A bundle that will be passed through to
2140 * {@link ConnectionService#onCreateIncomingConnection}.
2141 * @hide
2142 */
2143 @SystemApi
2144 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002145 ITelecomService service = getTelecomService();
2146 if (service != null) {
2147 try {
2148 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002149 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002150 } catch (RemoteException e) {
2151 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002152 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002153 }
2154 }
2155
2156 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002157 * Processes the specified dial string as an MMI code.
2158 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2159 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002160 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002161 * <p>
2162 * Requires that the method-caller be set as the system dialer app.
2163 * </p>
2164 *
2165 * @param dialString The digits to dial.
2166 * @return True if the digits were processed as an MMI code, false otherwise.
2167 */
Yorke Leec61d13662015-09-21 17:25:25 -07002168 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002169 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002170 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002171 if (service != null) {
2172 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002173 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002174 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002175 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002176 }
2177 }
2178 return false;
2179 }
2180
2181 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002182 * Processes the specified dial string as an MMI code.
2183 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2184 * Some of these sequences launch special behavior through handled by Telephony.
2185 * <p>
2186 * Requires that the method-caller be set as the system dialer app.
2187 * </p>
2188 *
2189 * @param accountHandle The handle for the account the MMI code should apply to.
2190 * @param dialString The digits to dial.
2191 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002192 */
Yorke Leec61d13662015-09-21 17:25:25 -07002193 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002194 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002195 ITelecomService service = getTelecomService();
2196 if (service != null) {
2197 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002198 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2199 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002200 } catch (RemoteException e) {
2201 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2202 }
2203 }
2204 return false;
2205 }
2206
2207 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002208 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2209 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002210 * @param accountHandle The handle for the account to derive an adn query URI for or
2211 * {@code null} to return a URI which will use the default account.
2212 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2213 * for the the content retrieve.
2214 */
Yorke Leec61d13662015-09-21 17:25:25 -07002215 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002216 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2217 ITelecomService service = getTelecomService();
2218 if (service != null && accountHandle != null) {
2219 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002220 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002221 } catch (RemoteException e) {
2222 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2223 }
2224 }
2225 return Uri.parse("content://icc/adn");
2226 }
2227
2228 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002229 * Removes the missed-call notification if one is present.
2230 * <p>
2231 * Requires that the method-caller be set as the system dialer app.
2232 * </p>
2233 */
Yorke Leec61d13662015-09-21 17:25:25 -07002234 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002235 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002236 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002237 if (service != null) {
2238 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002239 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002240 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002241 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002242 }
2243 }
2244 }
2245
2246 /**
2247 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2248 * currently no ongoing call, then this method does nothing.
2249 * <p>
2250 * Requires that the method-caller be set as the system dialer app or have the
2251 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2252 * </p>
2253 *
2254 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2255 */
Yorke Leec61d13662015-09-21 17:25:25 -07002256 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002257 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002258 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002259 if (service != null) {
2260 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002261 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002262 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002263 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002264 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002265 }
2266 }
2267 }
2268
Yorke Lee3e56ba12015-04-23 12:32:36 -07002269 /**
2270 * Places a new outgoing call to the provided address using the system telecom service with
2271 * the specified extras.
2272 *
2273 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2274 * except that the outgoing call will always be sent via the system telecom service. If
2275 * method-caller is either the user selected default dialer app or preloaded system dialer
2276 * app, then emergency calls will also be allowed.
2277 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002278 * Placing a call via a managed {@link ConnectionService} requires permission:
2279 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002280 *
2281 * Usage example:
2282 * <pre>
2283 * Uri uri = Uri.fromParts("tel", "12345", null);
2284 * Bundle extras = new Bundle();
2285 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2286 * telecomManager.placeCall(uri, extras);
2287 * </pre>
2288 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002289 * The following keys are supported in the supplied extras.
2290 * <ul>
2291 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2292 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2293 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2294 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
Grace Jiae086d082021-10-28 17:04:29 -07002295 * <li>{@link #EXTRA_START_CALL_ON_ENDPOINT}</li>
Santos Cordon7a060d52015-06-19 14:52:04 -07002296 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002297 * <p>
2298 * An app which implements the self-managed {@link ConnectionService} API uses
2299 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2300 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2301 * associated {@link android.telecom.PhoneAccountHandle}.
2302 *
2303 * Self-managed {@link ConnectionService}s require permission
2304 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002305 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002306 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2307 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2308 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2309 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2310 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2311 * </p>
2312 *
Yorke Lee3e56ba12015-04-23 12:32:36 -07002313 * @param address The address to make the call to.
2314 * @param extras Bundle of extras to use with the call.
2315 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002316 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2317 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002318 public void placeCall(Uri address, Bundle extras) {
2319 ITelecomService service = getTelecomService();
2320 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002321 if (address == null) {
2322 Log.w(TAG, "Cannot place call to empty address.");
2323 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002324 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002325 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002326 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002327 } catch (RemoteException e) {
2328 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2329 }
2330 }
2331 }
2332
Ravi Paluri80aa2142019-12-02 11:57:37 +05302333
2334 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002335 * Place a new adhoc conference call with the provided participants using the system telecom
2336 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302337 *
2338 * An adhoc conference call is established by providing a list of addresses to
2339 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2340 * {@link ConnectionService} is responsible for connecting all indicated participants
2341 * to a conference simultaneously.
2342 * This is in contrast to conferences formed by merging calls together (e.g. using
2343 * {@link android.telecom.Call#mergeConference()}).
2344 *
2345 * The following keys are supported in the supplied extras.
2346 * <ul>
2347 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2348 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2349 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2350 * </ul>
2351 *
2352 * @param participants List of participants to start conference with
2353 * @param extras Bundle of extras to use with the call
2354 */
2355 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2356 public void startConference(@NonNull List<Uri> participants,
2357 @NonNull Bundle extras) {
2358 ITelecomService service = getTelecomService();
2359 if (service != null) {
2360 try {
2361 service.startConference(participants, extras,
2362 mContext.getOpPackageName());
2363 } catch (RemoteException e) {
2364 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2365 }
2366 }
2367 }
2368
Santos Cordon91371dc02015-05-08 13:52:09 -07002369 /**
2370 * Enables and disables specified phone account.
2371 *
2372 * @param handle Handle to the phone account.
2373 * @param isEnabled Enable state of the phone account.
2374 * @hide
2375 */
2376 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002377 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002378 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2379 ITelecomService service = getTelecomService();
2380 if (service != null) {
2381 try {
2382 service.enablePhoneAccount(handle, isEnabled);
2383 } catch (RemoteException e) {
2384 Log.e(TAG, "Error enablePhoneAbbount", e);
2385 }
2386 }
2387 }
2388
Hall Liu0464b9b2016-01-12 15:32:58 -08002389 /**
2390 * Dumps telecom analytics for uploading.
2391 *
2392 * @return
2393 * @hide
2394 */
2395 @SystemApi
2396 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002397 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002398 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002399 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002400 if (service != null) {
2401 try {
2402 result = service.dumpCallAnalytics();
2403 } catch (RemoteException e) {
2404 Log.e(TAG, "Error dumping call analytics", e);
2405 }
2406 }
2407 return result;
2408 }
2409
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002410 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002411 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2412 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002413 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002414 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2415 * {@code true} for the current user.
2416 */
2417 public Intent createManageBlockedNumbersIntent() {
2418 ITelecomService service = getTelecomService();
2419 Intent result = null;
2420 if (service != null) {
2421 try {
2422 result = service.createManageBlockedNumbersIntent();
2423 } catch (RemoteException e) {
2424 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2425 }
2426 }
2427 return result;
2428 }
2429
Fan Zhang5431ef52019-10-14 13:43:46 -07002430
2431 /**
2432 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2433 * launch the activity for emergency dialer.
2434 *
2435 * @param number Optional number to call in emergency dialer
2436 * @hide
2437 */
2438 @SystemApi
2439 @NonNull
2440 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2441 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002442 if (service != null) {
2443 try {
Tyler Gunn753aa102020-04-23 10:16:26 -07002444 return service.createLaunchEmergencyDialerIntent(number);
Fan Zhang5431ef52019-10-14 13:43:46 -07002445 } catch (RemoteException e) {
2446 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2447 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002448 } else {
2449 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002450 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002451
2452 // Telecom service knows the package name of the expected emergency dialer package; if it
2453 // is not available, then fallback to not targeting a specific package.
2454 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2455 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2456 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2457 }
2458 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002459 }
2460
Tyler Gunnf5035432017-01-09 09:43:12 -08002461 /**
2462 * Determines whether Telecom would permit an incoming call to be added via the
2463 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2464 * {@link PhoneAccountHandle}.
2465 * <p>
2466 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2467 * in the following situations:
2468 * <ul>
2469 * <li>{@link PhoneAccount} does not have property
2470 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2471 * {@link ConnectionService}), and the active or held call limit has
2472 * been reached.</li>
2473 * <li>There is an ongoing emergency call.</li>
2474 * </ul>
2475 *
2476 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2477 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2478 * otherwise.
2479 */
2480 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002481 if (phoneAccountHandle == null) {
2482 return false;
2483 }
2484
Tyler Gunnf5035432017-01-09 09:43:12 -08002485 ITelecomService service = getTelecomService();
2486 if (service != null) {
2487 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002488 return service.isIncomingCallPermitted(phoneAccountHandle,
2489 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002490 } catch (RemoteException e) {
2491 Log.e(TAG, "Error isIncomingCallPermitted", e);
2492 }
2493 }
2494 return false;
2495 }
2496
2497 /**
2498 * Determines whether Telecom would permit an outgoing call to be placed via the
2499 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2500 * <p>
2501 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2502 * in the following situations:
2503 * <ul>
2504 * <li>{@link PhoneAccount} does not have property
2505 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2506 * {@link ConnectionService}), and the active, held or ringing call limit has
2507 * been reached.</li>
2508 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2509 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2510 * another {@link ConnectionService}.</li>
2511 * <li>There is an ongoing emergency call.</li>
2512 * </ul>
2513 *
2514 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2515 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2516 * otherwise.
2517 */
2518 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2519 ITelecomService service = getTelecomService();
2520 if (service != null) {
2521 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002522 return service.isOutgoingCallPermitted(phoneAccountHandle,
2523 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002524 } catch (RemoteException e) {
2525 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2526 }
2527 }
2528 return false;
2529 }
2530
Sanket Padawea8eddd42017-11-03 11:07:35 -07002531 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002532 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2533 * {@link PhoneAccountHandle} it defines.
2534 * <p>
2535 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2536 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2537 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2538 * is referred to as the source of the handover, and the video calling app is referred to as the
2539 * destination.
2540 * <p>
2541 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2542 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2543 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2544 * device.
2545 * <p>
2546 * For a full discussion of the handover process and the APIs involved, see
2547 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2548 * <p>
2549 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2550 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002551 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2552 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2553 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2554 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2555 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2556 * <p>
2557 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2558 * associated with the {@link PhoneAccountHandle} destAcct and call
2559 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2560 * <p>
2561 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2562 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2563 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2564 * user.
2565 * <p>
2566 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2567 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2568 *
2569 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2570 * {@link ConnectionService}.
2571 * @param videoState Video state after the handover.
2572 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2573 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002574 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2575 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002576 ITelecomService service = getTelecomService();
2577 if (service != null) {
2578 try {
2579 service.acceptHandover(srcAddr, videoState, destAcct);
2580 } catch (RemoteException e) {
2581 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002582 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002583 }
2584 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002585
Tyler Gunn5bd90852018-09-21 09:37:07 -07002586 /**
2587 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2588 * call, as identified by the dialed number, or because a call was identified by the network
2589 * as an emergency call.
2590 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2591 * @hide
2592 */
2593 @SystemApi
2594 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2595 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002596 ITelecomService service = getTelecomService();
2597 if (service != null) {
2598 try {
2599 return service.isInEmergencyCall();
2600 } catch (RemoteException e) {
2601 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2602 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002603 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002604 }
2605 return false;
2606 }
2607
Tyler Gunnc37445c2018-09-28 16:16:20 -07002608 /**
2609 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2610 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002611 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002612 * @hide
2613 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002614 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002615 ITelecomService service = getTelecomService();
2616 if (service != null) {
2617 try {
2618 service.handleCallIntent(intent, callingPackageProxy);
2619 } catch (RemoteException e) {
2620 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002621 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002622 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002623 }
2624
Grace Jiae086d082021-10-28 17:04:29 -07002625 /**
2626 * Register a set of {@link CallEndpoint} to telecom. All registered {@link CallEndpoint} can
2627 * be provided as options for push, place or answer call externally.
2628 *
2629 * @param endpoints Endpoints to be registered.
2630 */
2631 // TODO: add permission requirements
2632 // @RequiresPermission{}
2633 public void registerCallEndpoints(@NonNull Set<CallEndpoint> endpoints) {
2634 ITelecomService service = getTelecomService();
2635 List<CallEndpoint> endpointList = new ArrayList<>(endpoints);
2636 if (service != null) {
2637 try {
2638 service.registerCallEndpoints(endpointList, mContext.getOpPackageName());
2639 } catch (RemoteException e) {
2640 Log.e(TAG, "RemoteException registerCallEndpoints: " + e);
2641 e.rethrowAsRuntimeException();
2642 }
2643 } else {
2644 throw new IllegalStateException("Telecom service is null.");
2645 }
2646 }
2647
2648 /**
2649 * Unregister all {@link CallEndpoint} from telecom in the set provided. After un-registration,
2650 * telecom will stop tracking and maintaining these {@link CallEndpoint}, user can no longer
2651 * carry a call on them.
2652 *
2653 * @param endpoints
2654 */
2655 // TODO: add permission requirements
2656 // @RequiresPermission{}
2657 public void unregisterCallEndpoints(@NonNull Set<CallEndpoint> endpoints) {
2658 ITelecomService service = getTelecomService();
2659 List<CallEndpoint> endpointList = new ArrayList<>(endpoints);
2660 if (service != null) {
2661 try {
2662 service.unregisterCallEndpoints(endpointList, mContext.getOpPackageName());
2663 } catch (RemoteException e) {
2664 Log.e(TAG, "RemoteException unregisterCallEndpoints: " + e);
2665 e.rethrowAsRuntimeException();
2666 }
2667 } else {
2668 throw new IllegalStateException("Telecom service is null.");
2669 }
2670 }
2671
2672 /**
2673 * Return a set all registered {@link CallEndpoint} that can be used to stream and carry an
2674 * external call.
2675 *
2676 * @return A set of all available {@link CallEndpoint}.
2677 */
2678 // TODO: add permission requirements
2679 // @RequiresPermission{}
2680 public @NonNull Set<CallEndpoint> getCallEndpoints() {
2681 Set<CallEndpoint> endpoints = new HashSet<>();
2682 List<CallEndpoint> endpointList;
2683 ITelecomService service = getTelecomService();
2684 if (service != null) {
2685 try {
2686 endpointList = service.getCallEndpoints(mContext.getOpPackageName());
2687 return new HashSet<>(endpointList);
2688 } catch (RemoteException e) {
2689 Log.e(TAG, "RemoteException registerCallEndpoints: " + e);
2690 e.rethrowAsRuntimeException();
2691 }
2692 } else {
2693 throw new IllegalStateException("Telecom service is null.");
2694 }
2695 return endpoints;
2696 }
2697
Shuo Qian4d065262020-10-20 11:04:28 -07002698 private boolean isSystemProcess() {
2699 return Process.myUid() == Process.SYSTEM_UID;
2700 }
2701
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002702 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002703 if (mTelecomServiceOverride != null) {
2704 return mTelecomServiceOverride;
2705 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002706 if (sTelecomService == null) {
2707 ITelecomService temp = ITelecomService.Stub.asInterface(
2708 ServiceManager.getService(Context.TELECOM_SERVICE));
2709 synchronized (CACHE_LOCK) {
2710 if (sTelecomService == null && temp != null) {
2711 try {
2712 sTelecomService = temp;
2713 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2714 } catch (Exception e) {
2715 sTelecomService = null;
2716 }
2717 }
2718 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002719 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002720 return sTelecomService;
2721 }
2722
2723 private static class DeathRecipient implements IBinder.DeathRecipient {
2724 @Override
2725 public void binderDied() {
2726 resetServiceCache();
2727 }
2728 }
2729
2730 private static void resetServiceCache() {
2731 synchronized (CACHE_LOCK) {
2732 if (sTelecomService != null) {
2733 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2734 sTelecomService = null;
2735 }
2736 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002737 }
Evan Charlton235c1592014-09-05 15:41:23 +00002738}