blob: ecb85957d6d9b9b91cf0bf834b16e80392293f21 [file] [log] [blame]
Yorke Leeb4ce1432014-06-09 13:53:23 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
Santos Cordon9eb45932014-06-27 12:28:43 -07004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5 * in compliance with the License. You may obtain a copy of the License at
Yorke Leeb4ce1432014-06-09 13:53:23 -07006 *
Santos Cordon9eb45932014-06-27 12:28:43 -07007 * http://www.apache.org/licenses/LICENSE-2.0
Yorke Leeb4ce1432014-06-09 13:53:23 -07008 *
Santos Cordon9eb45932014-06-27 12:28:43 -07009 * Unless required by applicable law or agreed to in writing, software distributed under the License
10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11 * or implied. See the License for the specific language governing permissions and limitations under
12 * the License.
Yorke Leeb4ce1432014-06-09 13:53:23 -070013 */
14
Tyler Gunnef9f6f92014-09-12 22:16:17 -070015package android.telecom;
Yorke Leeb4ce1432014-06-09 13:53:23 -070016
Tyler Gunn00d737b2019-10-31 13:04:37 -070017import static android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE;
18
Hall Liu0464b9b2016-01-12 15:32:58 -080019import android.Manifest;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080020import android.annotation.IntDef;
Fan Zhang5431ef52019-10-14 13:43:46 -070021import android.annotation.NonNull;
Slava Shklyaeve65e4012019-03-04 16:02:34 +000022import android.annotation.Nullable;
Hui Wangc47df7f2021-12-14 20:37:47 +000023import android.annotation.RequiresFeature;
Yorke Leec61d13662015-09-21 17:25:25 -070024import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060025import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060026import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070027import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060028import android.annotation.SystemService;
Brad Ebingera8366ae2021-03-23 21:01:51 +000029import android.compat.annotation.ChangeId;
30import android.compat.annotation.EnabledSince;
Artur Satayev2ebb31c2020-01-08 12:24:36 +000031import android.compat.annotation.UnsupportedAppUsage;
Santos Cordon6c7a3882014-06-25 15:30:08 -070032import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070033import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070034import android.content.Intent;
Hui Wangc47df7f2021-12-14 20:37:47 +000035import android.content.pm.PackageManager;
Nancy Chenb2299c12014-10-29 18:22:11 -070036import android.net.Uri;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -080037import android.os.Build;
Santos Cordon96efb482014-07-19 14:57:05 -070038import android.os.Bundle;
Kevin Jeon767cda32020-11-17 01:40:16 +000039import android.os.IBinder;
Shuo Qian4d065262020-10-20 11:04:28 -070040import android.os.Process;
Santos Cordon6c7a3882014-06-25 15:30:08 -070041import android.os.RemoteException;
42import android.os.ServiceManager;
Tyler Gunn7e45b722018-12-04 12:56:45 -080043import android.os.UserHandle;
Chen Xuc9d4ee12019-09-26 16:11:59 -070044import android.telephony.Annotation.CallState;
Brad Ebingere7833312019-05-07 10:55:55 -070045import android.telephony.SubscriptionManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070046import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070047import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070048import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070049
Kevin Jeon767cda32020-11-17 01:40:16 +000050import com.android.internal.annotations.GuardedBy;
Tyler Gunnef9f6f92014-09-12 22:16:17 -070051import com.android.internal.telecom.ITelecomService;
Yorke Leeb4ce1432014-06-09 13:53:23 -070052
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080053import java.lang.annotation.Retention;
54import java.lang.annotation.RetentionPolicy;
Jay Shrauner7746a942014-08-26 12:15:15 -070055import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070056import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070057import java.util.List;
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -080058import java.util.Objects;
Tyler Gunn7e45b722018-12-04 12:56:45 -080059import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070060
Yorke Leeb4ce1432014-06-09 13:53:23 -070061/**
Santos Cordond9e614f2014-10-28 13:10:36 -070062 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080063 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070064 * <p>
65 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
66 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
67 * <p>
68 * Note that access to some telecom information is permission-protected. Your app cannot access the
69 * protected information or gain access to protected functionality unless it has the appropriate
70 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
71 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070072 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060073@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060074@SystemService(Context.TELECOM_SERVICE)
Hui Wangc47df7f2021-12-14 20:37:47 +000075@RequiresFeature(PackageManager.FEATURE_TELECOM)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070076public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070077
Evan Charlton10197192014-07-19 15:00:29 -070078 /**
Santos Cordon96efb482014-07-19 14:57:05 -070079 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070080 * UI by notifying the Telecom system that an incoming call exists for a specific call service
81 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
82 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070083 * ultimately use to control and get information about the call.
84 * <p>
85 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070086 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070087 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080088 *
89 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070090 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070091 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070092
93 /**
Yorke Leec3cf9822014-10-02 09:38:39 -070094 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
95 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080096 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -070097 * @hide
98 */
99 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
100
101 /**
Santos Cordon895d4b82015-06-25 16:41:48 -0700102 * An {@link android.content.Intent} action sent by the telecom framework to start a
103 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
104 * and each app that registers a {@link PhoneAccount} should provide one if desired.
105 * <p>
106 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
107 * app's settings menu. For each entry, the settings app will add a click action. When
108 * triggered, the click-action will start this intent along with the extra
109 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
110 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
111 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700112 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700113 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
114 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700115
116 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800117 * The {@link android.content.Intent} action used to show the call accessibility settings page.
118 */
119 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
120 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
121
122 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700123 * The {@link android.content.Intent} action used to show the call settings page.
124 */
125 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700126 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700127
128 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800129 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
130 */
131 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
132 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
133
134 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700135 * The {@link android.content.Intent} action used to show the settings page used to configure
136 * {@link PhoneAccount} preferences.
137 */
138 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700139 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700140
141 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700142 * {@link android.content.Intent} action used indicate that a new phone account was just
143 * registered.
144 * <p>
145 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
146 * to indicate which {@link PhoneAccount} was registered.
147 * <p>
148 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800149 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800150 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
151 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
152
153 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700154 * {@link android.content.Intent} action used indicate that a phone account was just
155 * unregistered.
156 * <p>
157 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
158 * to indicate which {@link PhoneAccount} was unregistered.
159 * <p>
160 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700161 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700162 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
163 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
164
165 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700166 * Activity action: Shows a dialog asking the user whether or not they want to replace the
167 * current default Dialer with the one specified in
168 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
169 *
170 * Usage example:
171 * <pre>
172 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
173 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
174 * getActivity().getPackageName());
175 * startActivity(intent);
176 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800177 * <p>
178 * This is no longer supported since Q, please use
179 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
180 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700181 */
182 public static final String ACTION_CHANGE_DEFAULT_DIALER =
183 "android.telecom.action.CHANGE_DEFAULT_DIALER";
184
185 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700186 * Broadcast intent action indicating that the current default dialer has changed.
187 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
188 * name of the package that the default dialer was changed to.
189 *
190 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
191 */
192 public static final String ACTION_DEFAULT_DIALER_CHANGED =
193 "android.telecom.action.DEFAULT_DIALER_CHANGED";
194
195 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700196 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
197 */
198 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
199 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
200
201 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800202 * Broadcast intent action indicating that the current default call screening app has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700203 * <p>
204 * Note: This intent is NEVER actually broadcast and will be deprecated in the future.
205 * <p>
206 * An app that want to know if it holds the
207 * {@link android.app.role.RoleManager#ROLE_CALL_SCREENING} role can use
208 * {@link android.app.role.RoleManager#isRoleHeld(String)} to confirm if it holds the role or
209 * not.
tonyzhuff60f5e2018-10-01 19:14:59 +0800210 */
211 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
212 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
213
214 /**
215 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
216 * indicate the ComponentName of the call screening app which has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700217 * <p>
218 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800219 */
220 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
221 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
222
223 /**
224 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
225 * indicate whether an app is the default call screening app.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700226 * <p>
227 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800228 */
229 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
230 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
231
232 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700233 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
234 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700235 */
236 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700237 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700238
239 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700240 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
241 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700242 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700243 * {@link VideoProfile#STATE_AUDIO_ONLY},
244 * {@link VideoProfile#STATE_BIDIRECTIONAL},
245 * {@link VideoProfile#STATE_RX_ENABLED},
246 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700247 */
248 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700249 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700250
251 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700252 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
253 * integer that determines the requested video state for an incoming call.
254 * Valid options:
255 * {@link VideoProfile#STATE_AUDIO_ONLY},
256 * {@link VideoProfile#STATE_BIDIRECTIONAL},
257 * {@link VideoProfile#STATE_RX_ENABLED},
258 * {@link VideoProfile#STATE_TX_ENABLED}.
259 */
260 public static final String EXTRA_INCOMING_VIDEO_STATE =
261 "android.telecom.extra.INCOMING_VIDEO_STATE";
262
263 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700264 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
265 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
266 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700267 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700268 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700269 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700270 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700271 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700272
273 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700274 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
275 * subject which will be associated with an outgoing call. Should only be specified if the
Shuo Qian3ed38832020-11-30 21:54:36 -0800276 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
277 * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700278 */
279 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
280
Shuo Qian3ed38832020-11-30 21:54:36 -0800281 // Values for EXTRA_PRIORITY
282 /**
283 * Indicates the call composer call priority is normal.
284 *
285 * Reference: RCC.20 Section 2.4.4.2
286 */
287 public static final int PRIORITY_NORMAL = 0;
288
289 /**
290 * Indicates the call composer call priority is urgent.
291 *
292 * Reference: RCC.20 Section 2.4.4.2
293 */
294 public static final int PRIORITY_URGENT = 1;
295
296 /**
297 * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
298 * {@link #PRIORITY_URGENT}.
299 *
300 * Reference: RCC.20 Section 2.4.4.2
301 */
302 public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
303
304 /**
305 * Extra for the call composer call location, an {@link android.location.Location} parcelable
306 * class to represent the geolocation as a latitude and longitude pair.
307 *
308 * Reference: RCC.20 Section 2.4.3.2
309 */
310 public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
311
312 /**
313 * A boolean extra set on incoming calls to indicate that the call has a picture specified.
314 * Given that image download could take a (short) time, the EXTRA is set immediately upon
315 * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
316 * if one is expected. The EXTRA may be unset if the image download ends up failing for some
317 * reason.
318 */
319 public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
320
321 /**
Hall Liu48c3c142021-03-11 16:14:22 -0800322 * A {@link Uri} representing the picture that was downloaded when a call is received or
323 * uploaded when a call is placed.
Hall Liu8fee7ea2021-01-21 16:37:51 -0800324 *
Shuo Qian3ed38832020-11-30 21:54:36 -0800325 * This is a content URI within the call log provider which can be used to open a file
326 * descriptor. This could be set a short time after a call is added to the Dialer app if the
Hall Liu8fee7ea2021-01-21 16:37:51 -0800327 * download/upload is delayed for some reason. The Dialer app will receive a callback via
Shuo Qian3ed38832020-11-30 21:54:36 -0800328 * {@link Call.Callback#onDetailsChanged} when this value has changed.
329 *
330 * Reference: RCC.20 Section 2.4.3.2
331 */
Hall Liu8fee7ea2021-01-21 16:37:51 -0800332 public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
Shuo Qian3ed38832020-11-30 21:54:36 -0800333
Shuo Qian3ed38832020-11-30 21:54:36 -0800334 /**
335 * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
Hall Liua749abc2021-01-21 10:05:43 -0800336 * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
337 * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
Shuo Qian3ed38832020-11-30 21:54:36 -0800338 */
339 public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
340
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700341 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700342 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
343 * has initiated a new incoming call.
344 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700345 public static final String EXTRA_INCOMING_CALL_ADDRESS =
346 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700347
348 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700349 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
350 * metadata about the call. This {@link Bundle} will be returned to the
351 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700352 */
353 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700354 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700355
356 /**
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800357 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a boolean to indicate that the
358 * call has an externally generated ringer. Used by the HfpClientConnectionService when In Band
359 * Ringtone is enabled to prevent two ringers from being generated.
360 * @hide
361 */
362 public static final String EXTRA_CALL_EXTERNAL_RINGER =
363 "android.telecom.extra.CALL_EXTERNAL_RINGER";
364
365 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700366 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
367 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
368 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700369 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700370 */
371 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700372 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700373
374 /**
sqian6d9e7452019-02-08 21:42:15 -0800375 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
376 * whether the user's dial intent is emergency; this is required to specify when the dialed
377 * number is ambiguous, identified as both emergency number and any other non-emergency number;
378 * e.g. in some situation, 611 could be both an emergency number in a country and a
379 * non-emergency number of a carrier's customer service hotline.
380 *
381 * @hide
382 */
383 @SystemApi
384 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
385 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
386
387 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800388 * A mandatory extra containing a {@link Uri} to be passed in when calling
389 * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
390 * the remote handle of the new call.
Yorke Leec3cf9822014-10-02 09:38:39 -0700391 * @hide
392 */
Hall Liu2ef04112020-09-14 18:34:10 -0700393 @SystemApi
Yorke Leec3cf9822014-10-02 09:38:39 -0700394 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
395 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
396
397 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700398 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
399 * call was created. This value is in milliseconds since boot.
Hall Liudbb17f12020-03-10 18:28:58 -0700400 * @hide
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700401 */
402 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
403 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
404
405 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800406 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
407 * time the call was created.
408 * @hide
409 */
410 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
411 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
412
413 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700414 * Optional extra for incoming and outgoing calls containing a long which specifies the time
415 * telecom began routing the call. This value is in milliseconds since boot.
416 * @hide
417 */
418 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
419 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
420
421 /**
422 * Optional extra for incoming and outgoing calls containing a long which specifies the time
423 * telecom finished routing the call. This value is in milliseconds since boot.
424 * @hide
425 */
426 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
427 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
428
429 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700430 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
431 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700432 */
433 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700434 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700435
436 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700437 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
438 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700439 */
440 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700441 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700442
443 /**
radhika0dd90652020-11-04 11:12:51 -0800444 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
445 * lower layers
446 * @hide
447 */
448 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
449 "Call dropped by lower layers";
450
451 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700452 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
453 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800454 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700455 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800456 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700457 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700458 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700459
460 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800461 * Optional extra for communicating the call technology used by a {@link ConnectionService}
462 * to Telecom. Valid values are:
463 * <ul>
464 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
465 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
466 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
467 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
468 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
469 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800470 * @hide
471 */
Hall Liu2ef04112020-09-14 18:34:10 -0700472 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800473 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
474 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
475
476 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800477 * Optional extra for communicating the call network technology used by a
478 * {@link android.telecom.Connection} to Telecom and InCallUI.
479 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700480 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800481 */
482 public static final String EXTRA_CALL_NETWORK_TYPE =
483 "android.telecom.extra.CALL_NETWORK_TYPE";
484
485 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700486 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
487 * package name of the app specifying an alternative gateway for the call.
488 * The value is a string.
489 *
490 * (The following comment corresponds to the all GATEWAY_* extras)
491 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
492 * alternative address to dial which is different from the one specified and displayed to
493 * the user. This alternative address is referred to as the gateway address.
494 */
495 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700496 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700497
498 /**
499 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
500 * original address to dial for the call. This is used when an alternative gateway address is
501 * provided to recall the original address.
502 * The value is a {@link android.net.Uri}.
503 *
504 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
505 */
506 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700507 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700508
509 /**
Evan Charlton10197192014-07-19 15:00:29 -0700510 * The number which the party on the other side of the line will see (and use to return the
511 * call).
512 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700513 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
514 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
515 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700516 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700517 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700518
519 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800520 * The number of milliseconds that Telecom should wait after disconnecting a call via the
521 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
522 * to make a new one.
523 * @hide
524 */
525 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
526 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
527
528 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700529 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700530 * existing call from the user's device to a different {@link PhoneAccount}.
531 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700532 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
533 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
534 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
535 * the receiving side of a handover.
536 * <p>
537 * Used when Telecom calls
538 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
539 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
540 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
541 * occurs on the initiating side of a handover.
542 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700543 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700544 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800545 * @deprecated Use the public handover APIs. See
546 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700547 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800548 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700549 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
550
551 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800552 * When {@code true} indicates that a request to create a new connection is for the purpose of
553 * a handover. Note: This is used with the
554 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
555 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
556 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
557 * @hide
558 */
559 public static final String EXTRA_IS_HANDOVER_CONNECTION =
560 "android.telecom.extra.IS_HANDOVER_CONNECTION";
561
562 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700563 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
564 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
565 * the handover is from.
566 * @hide
567 */
568 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
569 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
570
571 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700572 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
573 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
574 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
575 * {@link Connection} will be.
576 * @hide
577 */
578 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
579
580 /**
Hall Liu95d55872017-01-25 17:12:49 -0800581 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
582 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
583 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
584 */
585 public static final String EXTRA_START_CALL_WITH_RTT =
586 "android.telecom.extra.START_CALL_WITH_RTT";
587
588 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800589 * Start an activity indicating that the completion of an outgoing call or an incoming call
590 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
591 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
592 *
593 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
594 * call which completed.
595 *
596 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
597 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
598 *
599 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
600 * {@link #EXTRA_CALL_DURATION} for more information.
601 */
602 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
603
604 /**
605 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
606 * uri handle(phone number) of the completed call.
607 */
608 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
609
610 /**
611 * A integer value provided for completed calls to indicate the reason for the call
612 * disconnection.
613 * <p>
614 * Allowed values:
615 * <ul>
616 * <li>{@link DisconnectCause#UNKNOWN}</li>
617 * <li>{@link DisconnectCause#LOCAL}</li>
618 * <li>{@link DisconnectCause#REMOTE}</li>
619 * <li>{@link DisconnectCause#REJECTED}</li>
620 * <li>{@link DisconnectCause#MISSED}</li>
621 * </ul>
622 * </p>
623 */
624 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
625
626 /**
627 * A integer value provided for completed calls to indicate the duration of the call.
628 * <p>
629 * Allowed values:
630 * <ul>
631 * <li>{@link #DURATION_VERY_SHORT}</li>
632 * <li>{@link #DURATION_SHORT}</li>
633 * <li>{@link #DURATION_MEDIUM}</li>
634 * <li>{@link #DURATION_LONG}</li>
635 * </ul>
636 * </p>
637 */
638 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
639
640 /**
641 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
642 * call was < 3 seconds.
643 */
644 public static final int DURATION_VERY_SHORT = 0;
645
646 /**
647 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
648 * call was >= 3 seconds and < 60 seconds.
649 */
650 public static final int DURATION_SHORT = 1;
651
652 /**
653 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
654 * call was >= 60 seconds and < 120 seconds.
655 */
656 public static final int DURATION_MEDIUM = 2;
657
658 /**
659 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
660 * call was >= 120 seconds.
661 */
662 public static final int DURATION_LONG = 3;
663
664 /**
665 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
666 * milliseconds.
667 * @hide
668 */
669 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
670
671 /**
672 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
673 * milliseconds.
674 * @hide
675 */
676 public static final long SHORT_CALL_TIME_MS = 60000;
677
678 /**
679 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
680 * milliseconds.
681 * @hide
682 */
683 public static final long MEDIUM_CALL_TIME_MS = 120000;
684
685 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700686 * A boolean meta-data value indicating whether an {@link InCallService} implements an
687 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
688 * would also like to replace the in-call interface should set this meta-data to {@code true} in
689 * the manifest registration of their {@link InCallService}.
690 */
691 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
692
693 /**
Santos Cordon88881552015-12-10 17:29:54 -0800694 * A boolean meta-data value indicating whether an {@link InCallService} implements an
695 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000696 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800697 */
698 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
699 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
700
701 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800702 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
703 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
704 * override the system provided ringing should set this meta-data to {@code true} in the
705 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700706 * <p>
707 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
708 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800709 */
710 public static final String METADATA_IN_CALL_SERVICE_RINGING =
711 "android.telecom.IN_CALL_SERVICE_RINGING";
712
713 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700714 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
715 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
716 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
717 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
718 * informed of external calls should set this meta-data to {@code true} in the manifest
719 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
720 * be informed of external calls.
721 */
722 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
723 "android.telecom.INCLUDE_EXTERNAL_CALLS";
724
725 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800726 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
727 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
728 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
729 * to implement its own call user interface. An {@link InCallService} implementation which
730 * would like to be informed of external calls should set this meta-data to {@code true} in the
731 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
732 * will NOT be informed about self-managed calls.
733 * <p>
734 * An {@link InCallService} which receives self-managed calls is free to view and control the
735 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700736 * exposing these calls to an automotive device via its companion app.
737 * <p>
738 * This meta-data can only be set for an {@link InCallService} which also sets
739 * {@link #METADATA_IN_CALL_SERVICE_UI}. Only the default phone/dialer app, or a car-mode
740 * {@link InCallService} can see self-managed calls.
Tyler Gunn24e18332017-02-10 09:42:49 -0800741 * <p>
742 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
743 */
744 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
745 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
746
747 /**
Evan Charlton10197192014-07-19 15:00:29 -0700748 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
749 * pause for a predefined period.
750 */
751 public static final char DTMF_CHARACTER_PAUSE = ',';
752
753 /**
754 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
755 * wait for user confirmation before proceeding.
756 */
757 public static final char DTMF_CHARACTER_WAIT = ';';
758
759 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800760 * @hide
761 */
762 @IntDef(prefix = { "TTY_MODE_" },
763 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
764 @Retention(RetentionPolicy.SOURCE)
765 public @interface TtyMode {}
766
767 /**
Evan Charlton10197192014-07-19 15:00:29 -0700768 * TTY (teletypewriter) mode is off.
769 *
770 * @hide
771 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800772 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700773 public static final int TTY_MODE_OFF = 0;
774
775 /**
776 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
777 * will communicate with the remote party by sending and receiving text messages.
778 *
779 * @hide
780 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800781 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700782 public static final int TTY_MODE_FULL = 1;
783
784 /**
785 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
786 * speaker is on. The user will communicate with the remote party by sending text messages and
787 * hearing an audible reply.
788 *
789 * @hide
790 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800791 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700792 public static final int TTY_MODE_HCO = 2;
793
794 /**
795 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
796 * microphone is still on. User will communicate with the remote party by speaking and receiving
797 * text message replies.
798 *
799 * @hide
800 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800801 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700802 public static final int TTY_MODE_VCO = 3;
803
804 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700805 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700806 *
Hall Liu2ef04112020-09-14 18:34:10 -0700807 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
808 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700809 * @hide
810 */
Hall Liu2ef04112020-09-14 18:34:10 -0700811 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700812 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700813 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700814
815 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700816 * Integer extra key that indicates the current TTY mode.
817 *
818 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
819 *
820 * Valid modes are:
821 * <ul>
822 * <li>{@link #TTY_MODE_OFF}</li>
823 * <li>{@link #TTY_MODE_FULL}</li>
824 * <li>{@link #TTY_MODE_HCO}</li>
825 * <li>{@link #TTY_MODE_VCO}</li>
826 * </ul>
827 *
828 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
829 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
830 * plugged into the device.
831 * @hide
832 */
Hall Liu2ef04112020-09-14 18:34:10 -0700833 @SystemApi
834 public static final String EXTRA_CURRENT_TTY_MODE =
835 "android.telecom.extra.CURRENT_TTY_MODE";
836
837 /**
838 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
839 *
840 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
841 * preferred TTY mode.
842 * @hide
843 */
Hall Liu2ef04112020-09-14 18:34:10 -0700844 @SystemApi
845 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
846 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
847
848 /**
849 * Integer extra key that indicates the preferred TTY mode.
850 *
851 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
852 *
Evan Charlton10197192014-07-19 15:00:29 -0700853 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800854 * <ul>
855 * <li>{@link #TTY_MODE_OFF}</li>
856 * <li>{@link #TTY_MODE_FULL}</li>
857 * <li>{@link #TTY_MODE_HCO}</li>
858 * <li>{@link #TTY_MODE_VCO}</li>
859 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700860 * @hide
861 */
Hall Liu2ef04112020-09-14 18:34:10 -0700862 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700863 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800864 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700865
Nancy Chen9d568c02014-09-08 14:17:59 -0700866 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700867 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800868 * notification. If no custom component exists then this is sent to the default dialer which
869 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700870 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700871 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
872 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
873
874 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800875 * The number of calls associated with the notification. If the number is zero then the missed
876 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700877 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700878 public static final String EXTRA_NOTIFICATION_COUNT =
879 "android.telecom.extra.NOTIFICATION_COUNT";
880
881 /**
882 * The number associated with the missed calls. This number is only relevant
883 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700884 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700885 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
886 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
887
888 /**
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700889 * The intent to clear missed calls.
890 * @hide
891 */
892 @SystemApi
893 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
894 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
895
896 /**
897 * The intent to call back a missed call.
898 * @hide
899 */
900 @SystemApi
901 public static final String EXTRA_CALL_BACK_INTENT =
902 "android.telecom.extra.CALL_BACK_INTENT";
903
904 /**
Charles He858f1322017-11-27 17:11:04 -0800905 * The dialer activity responsible for placing emergency calls from, for example, a locked
906 * keyguard.
907 * @hide
908 */
909 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
910 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
911
912 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800913 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
914 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700915 * <p>
916 * The call initiator can use this extra to indicate that a call used assisted dialing to help
917 * place the call. This is most commonly used by a Dialer app which provides the ability to
918 * automatically add dialing prefixes when placing international calls.
919 * <p>
920 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800921 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
922 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700923 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
924 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
925 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800926 */
927 public static final String EXTRA_USE_ASSISTED_DIALING =
928 "android.telecom.extra.USE_ASSISTED_DIALING";
929
930 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800931 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
932 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800933 * Valid sources are:
934 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
935 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
936 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800937 *
Hall Liu2ef04112020-09-14 18:34:10 -0700938 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800939 * @hide
940 */
Hall Liu2ef04112020-09-14 18:34:10 -0700941 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800942 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
943
944 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800945 * Indicating the call is initiated via emergency dialer's shortcut button.
946 *
947 * @hide
948 */
Hall Liu2ef04112020-09-14 18:34:10 -0700949 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800950 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
951
952 /**
953 * Indicating the call is initiated via emergency dialer's dialpad.
954 *
955 * @hide
956 */
Hall Liu2ef04112020-09-14 18:34:10 -0700957 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800958 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
959
960 /**
961 * Indicating the call source is not specified.
962 *
963 * @hide
964 */
Hall Liu2ef04112020-09-14 18:34:10 -0700965 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800966 public static final int CALL_SOURCE_UNSPECIFIED = 0;
967
968 /**
Nancy Chen9d568c02014-09-08 14:17:59 -0700969 * The following 4 constants define how properties such as phone numbers and names are
970 * displayed to the user.
971 */
972
Santos Cordoned769ae2015-05-13 18:47:38 -0700973 /**
974 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -0800975 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700976 public static final int PRESENTATION_ALLOWED = 1;
977
Santos Cordoned769ae2015-05-13 18:47:38 -0700978 /**
979 * Indicates that the address or number of a call is blocked by the other party.
980 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700981 public static final int PRESENTATION_RESTRICTED = 2;
982
Santos Cordoned769ae2015-05-13 18:47:38 -0700983 /**
984 * Indicates that the address or number of a call is not specified or known by the carrier.
985 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700986 public static final int PRESENTATION_UNKNOWN = 3;
987
Santos Cordoned769ae2015-05-13 18:47:38 -0700988 /**
989 * Indicates that the address or number of a call belongs to a pay phone.
990 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700991 public static final int PRESENTATION_PAYPHONE = 4;
992
Grace Jiacc16b042021-08-09 09:06:11 -0700993 /**
994 * Indicates that the address or number of a call is unavailable.
995 */
996 public static final int PRESENTATION_UNAVAILABLE = 5;
997
Hall Liu4a9fde12020-01-16 17:38:46 -0800998
999 /*
1000 * Values for the adb property "persist.radio.videocall.audio.output"
1001 */
1002 /** @hide */
1003 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1004 /** @hide */
1005 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1006 /** @hide */
1007 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1008
Tyler Gunn00d737b2019-10-31 13:04:37 -07001009 /** @hide */
1010 @Retention(RetentionPolicy.SOURCE)
1011 @IntDef(
1012 prefix = { "PRESENTATION_" },
1013 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001014 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001015 public @interface Presentation {}
1016
Brad Ebingera8366ae2021-03-23 21:01:51 +00001017
1018 /**
1019 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1020 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1021 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001022 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001023 */
1024 @ChangeId
1025 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1026 // this magic number is a bug ID
1027 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1028
Grace Jiab13eb2c2021-04-21 14:13:26 -07001029 /**
1030 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1031 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1032 * @hide
1033 */
1034 @ChangeId
1035 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1036 // bug ID
1037 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1038
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001039 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001040
Kevin Jeon767cda32020-11-17 01:40:16 +00001041
1042 /** Cached service handles, cleared by resetServiceCache() at death */
1043 private static final Object CACHE_LOCK = new Object();
1044
1045 @GuardedBy("CACHE_LOCK")
1046 private static ITelecomService sTelecomService;
1047 @GuardedBy("CACHE_LOCK")
1048 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1049
Yorke Leeb4ce1432014-06-09 13:53:23 -07001050 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001051
Hall Liue1bc2ec2015-10-09 15:58:37 -07001052 private final ITelecomService mTelecomServiceOverride;
1053
Santos Cordon6c7a3882014-06-25 15:30:08 -07001054 /**
1055 * @hide
1056 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001057 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001058 public static TelecomManager from(Context context) {
1059 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001060 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001061
1062 /**
1063 * @hide
1064 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001065 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001066 this(context, null);
1067 }
1068
1069 /**
1070 * @hide
1071 */
1072 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001073 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001074 if (appContext != null && Objects.equals(context.getAttributionTag(),
1075 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001076 mContext = appContext;
1077 } else {
1078 mContext = context;
1079 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001080 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001081 }
1082
1083 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001084 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1085 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1086 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1087 * account returned depends on the following priorities:
1088 * <ul>
1089 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1090 * be returned.
1091 * </li>
1092 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1093 * will be returned.
1094 * </li>
1095 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001096 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001097 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1098 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001099 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001100 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001101 */
Yorke Leec61d13662015-09-21 17:25:25 -07001102 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001103 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001104 ITelecomService service = getTelecomService();
1105 if (service != null) {
1106 try {
1107 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001108 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001109 } catch (RemoteException e) {
1110 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001111 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001112 }
1113 return null;
1114 }
1115
1116 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001117 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1118 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001119 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001120 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001121 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1122 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001123 * <p>
1124 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001125 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001126 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1127 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001128 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001129 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001130 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001131 ITelecomService service = getTelecomService();
1132 if (service != null) {
1133 try {
1134 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001135 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001136 } catch (RemoteException e) {
1137 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001138 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001139 }
1140 return null;
1141 }
1142
1143 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001144 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1145 *
1146 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001147 * outgoing voice calls, or {@code null} if no default is specified (the
1148 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001149 * @hide
1150 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001151 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1152 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001153 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001154 ITelecomService service = getTelecomService();
1155 if (service != null) {
1156 try {
1157 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1158 } catch (RemoteException e) {
1159 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001160 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001161 }
1162 }
1163
1164 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001165 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001166 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1167 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001168 *
Brad Ebingere7833312019-05-07 10:55:55 -07001169 * @return The phone account handle of the current sim call manager for the default voice
1170 * subscription.
1171 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001172 */
1173 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001174 ITelecomService service = getTelecomService();
1175 if (service != null) {
1176 try {
1177 return service.getSimCallManager(
Brad Ebingere7833312019-05-07 10:55:55 -07001178 SubscriptionManager.getDefaultSubscriptionId());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001179 } catch (RemoteException e) {
1180 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001181 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001182 }
1183 return null;
1184 }
1185
1186 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001187 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1188 * prepared for this method to return {@code null}, indicating that there currently exists no
1189 * SIM call manager {@link PhoneAccount} for the subscription specified.
1190 *
1191 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1192 * queried for.
1193 * @return The phone account handle of the current sim call manager.
1194 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001195 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001196 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001197 ITelecomService service = getTelecomService();
1198 if (service != null) {
1199 try {
1200 return service.getSimCallManager(subscriptionId);
1201 } catch (RemoteException e) {
1202 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001203 }
Brad Ebingere7833312019-05-07 10:55:55 -07001204 }
1205 return null;
1206 }
1207
1208 /**
1209 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1210 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1211 * must be prepared for this method to return {@code null}, indicating that there currently
1212 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001213 *
1214 * @return The phone account handle of the current sim call manager.
1215 *
1216 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001217 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001218 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001219 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001220 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001221 ITelecomService service = getTelecomService();
1222 if (service != null) {
1223 try {
1224 return service.getSimCallManagerForUser(userId);
1225 } catch (RemoteException e) {
1226 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001227 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001228 }
1229 return null;
1230 }
1231
1232 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001233 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001234 * {@code null}, indicating that there currently exists no Connection Manager
1235 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001236 *
1237 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001238 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001239 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001240 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001241 public PhoneAccountHandle getConnectionManager() {
1242 return getSimCallManager();
1243 }
1244
1245 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001246 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1247 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001248 * <P>
1249 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1250 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1251 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1252 * such as {@code sip:example@sipexample.com}).
1253 *
1254 * @param uriScheme The URI scheme.
1255 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001256 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001257 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001258 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001259 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001260 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001261 android.Manifest.permission.READ_PHONE_STATE
1262 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001263 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001264 ITelecomService service = getTelecomService();
1265 if (service != null) {
1266 try {
1267 return service.getPhoneAccountsSupportingScheme(uriScheme,
Svet Ganov16a16892015-04-16 10:32:04 -07001268 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001269 } catch (RemoteException e) {
1270 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001271 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001272 }
1273 return new ArrayList<>();
1274 }
1275
Nancy Chen513c8922014-09-17 14:47:20 -07001276
1277 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001278 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1279 * calls. The returned list includes only those accounts which have been explicitly enabled
1280 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001281 *
1282 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1283 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001284 */
Yorke Leec61d13662015-09-21 17:25:25 -07001285 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001286 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001287 return getCallCapablePhoneAccounts(false);
1288 }
1289
1290 /**
Tyler Gunn89317072017-04-07 14:57:37 -07001291 * Returns a list of {@link PhoneAccountHandle}s for self-managed {@link ConnectionService}s.
1292 * <p>
1293 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1294 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1295 * <p>
1296 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuartb90f5c92022-01-15 00:22:59 +00001297 * is the default dialer app to get all phone account handles.
1298 * <P>
1299 * If the caller doesn't meet any of the above requirements and has {@link
1300 * android.Manifest.permission#MANAGE_OWN_CALLS}, the caller can get only the phone account
1301 * handles they have registered.
Tyler Gunn89317072017-04-07 14:57:37 -07001302 * <p>
Thomas Stuartb90f5c92022-01-15 00:22:59 +00001303 * A {@link SecurityException} will be thrown if the caller is not the default dialer
1304 * or the caller does not have at least one of the following permissions:
1305 * {@link android.Manifest.permission#READ_PHONE_STATE} permission,
1306 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission
Tyler Gunn89317072017-04-07 14:57:37 -07001307 *
1308 * @return A list of {@code PhoneAccountHandle} objects.
1309 */
Thomas Stuartb90f5c92022-01-15 00:22:59 +00001310 @RequiresPermission(anyOf = {
1311 READ_PRIVILEGED_PHONE_STATE,
1312 android.Manifest.permission.READ_PHONE_STATE,
1313 android.Manifest.permission.MANAGE_OWN_CALLS
1314 })
Tyler Gunn89317072017-04-07 14:57:37 -07001315 public List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001316 ITelecomService service = getTelecomService();
1317 if (service != null) {
1318 try {
1319 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001320 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001321 } catch (RemoteException e) {
1322 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001323 }
Tyler Gunn89317072017-04-07 14:57:37 -07001324 }
1325 return new ArrayList<>();
1326 }
1327
1328 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001329 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1330 * by the user.
1331 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001332 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001333 * when {@code false}, only enabled phone accounts will be
1334 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001335 * @return A list of {@code PhoneAccountHandle} objects.
1336 * @hide
1337 */
Hall Liub2306242019-11-15 17:13:05 -08001338 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001339 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1340 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1341 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001342 ITelecomService service = getTelecomService();
1343 if (service != null) {
1344 try {
1345 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001346 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001347 } catch (RemoteException e) {
1348 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1349 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001350 }
Nancy Chen513c8922014-09-17 14:47:20 -07001351 }
1352 return new ArrayList<>();
1353 }
1354
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001355 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001356 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1357 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001358 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1359 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001360 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001361 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001362 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001363 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001364 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001365 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001366 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001367 ITelecomService service = getTelecomService();
1368 if (service != null) {
1369 try {
1370 return service.getPhoneAccountsForPackage(mContext.getPackageName());
1371 } catch (RemoteException e) {
1372 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001373 }
Nancy Chen513c8922014-09-17 14:47:20 -07001374 }
1375 return null;
1376 }
1377
1378 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001379 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1380 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001381 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001382 * Requires Permission:
1383 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1384 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001385 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001386 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001387 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001388 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001389 ITelecomService service = getTelecomService();
1390 if (service != null) {
1391 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001392 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001393 } catch (RemoteException e) {
1394 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001395 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001396 }
1397 return null;
1398 }
1399
1400 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001401 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001402 *
Nancy Chen210ef032014-09-15 17:58:42 -07001403 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001404 * @hide
1405 */
1406 @SystemApi
1407 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001408 ITelecomService service = getTelecomService();
1409 if (service != null) {
1410 try {
1411 return service.getAllPhoneAccountsCount();
1412 } catch (RemoteException e) {
1413 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001414 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001415 }
1416 return 0;
1417 }
1418
1419 /**
1420 * Returns a list of all {@link PhoneAccount}s.
1421 *
1422 * @return All {@link PhoneAccount}s.
1423 * @hide
1424 */
1425 @SystemApi
1426 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001427 ITelecomService service = getTelecomService();
1428 if (service != null) {
1429 try {
1430 return service.getAllPhoneAccounts();
1431 } catch (RemoteException e) {
1432 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001433 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001434 }
1435 return Collections.EMPTY_LIST;
1436 }
1437
1438 /**
1439 * Returns a list of all {@link PhoneAccountHandle}s.
1440 *
1441 * @return All {@link PhoneAccountHandle}s.
1442 * @hide
1443 */
1444 @SystemApi
1445 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001446 ITelecomService service = getTelecomService();
1447 if (service != null) {
1448 try {
1449 return service.getAllPhoneAccountHandles();
1450 } catch (RemoteException e) {
1451 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001452 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001453 }
1454 return Collections.EMPTY_LIST;
1455 }
1456
1457 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001458 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1459 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1460 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001461 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1462 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1463 * the phone app settings before the account is usable.
1464 * <p>
1465 * A {@link SecurityException} will be thrown if an app tries to register a
1466 * {@link PhoneAccountHandle} where the package name specified within
1467 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001468 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001469 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001470 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001471 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001472 ITelecomService service = getTelecomService();
1473 if (service != null) {
1474 try {
1475 service.registerPhoneAccount(account);
1476 } catch (RemoteException e) {
1477 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001478 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001479 }
1480 }
1481
1482 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001483 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001484 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001485 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001486 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001487 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001488 ITelecomService service = getTelecomService();
1489 if (service != null) {
1490 try {
1491 service.unregisterPhoneAccount(accountHandle);
1492 } catch (RemoteException e) {
1493 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001494 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001495 }
1496 }
1497
1498 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001499 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001500 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001501 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001502 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001503 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001504 public void clearPhoneAccounts() {
1505 clearAccounts();
1506 }
1507 /**
1508 * Remove all Accounts that belong to the calling package from the system.
1509 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1510 * @hide
1511 */
1512 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001513 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001514 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001515 ITelecomService service = getTelecomService();
1516 if (service != null) {
1517 try {
1518 service.clearAccounts(mContext.getPackageName());
1519 } catch (RemoteException e) {
1520 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001521 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001522 }
1523 }
1524
1525 /**
Anthony Lee67279262014-10-27 11:28:40 -07001526 * Remove all Accounts that belong to the specified package from the system.
1527 * @hide
1528 */
1529 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001530 ITelecomService service = getTelecomService();
1531 if (service != null) {
1532 try {
1533 if (!TextUtils.isEmpty(packageName)) {
1534 service.clearAccounts(packageName);
1535 }
1536 } catch (RemoteException e) {
1537 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001538 }
Anthony Lee67279262014-10-27 11:28:40 -07001539 }
1540 }
1541
Yorke Lee1011f482015-04-23 15:58:27 -07001542
Anthony Lee67279262014-10-27 11:28:40 -07001543 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001544 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1545 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001546 * @hide
1547 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001548 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001549 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001550 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001551 ITelecomService service = getTelecomService();
1552 if (service != null) {
1553 try {
1554 return service.getDefaultPhoneApp();
1555 } catch (RemoteException e) {
1556 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001557 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001558 }
1559 return null;
1560 }
1561
Santos Cordon9eb45932014-06-27 12:28:43 -07001562 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001563 * Used to determine the currently selected default dialer package.
1564 *
1565 * @return package name for the default dialer package or null if no package has been
1566 * selected as the default dialer.
1567 */
1568 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001569 ITelecomService service = getTelecomService();
1570 if (service != null) {
1571 try {
1572 return service.getDefaultDialerPackage();
1573 } catch (RemoteException e) {
1574 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001575 }
Yorke Lee1011f482015-04-23 15:58:27 -07001576 }
1577 return null;
1578 }
1579
1580 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001581 * Used to determine the currently selected default dialer package for a specific user.
1582 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001583 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001584 * @return package name for the default dialer package or null if no package has been
1585 * selected as the default dialer.
1586 * @hide
1587 */
1588 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001589 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001590 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001591 ITelecomService service = getTelecomService();
1592 if (service != null) {
1593 try {
1594 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001595 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001596 } catch (RemoteException e) {
1597 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001598 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001599 }
1600 return null;
1601 }
1602
1603 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001604 * Used to set the default dialer package.
1605 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001606 * @param packageName to set the default dialer to, or {@code null} if the system provided
1607 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001608 *
1609 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1610 * the specified package does not correspond to an installed dialer, or is already
1611 * the default dialer.
1612 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001613 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001614 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001615 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1616 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001617 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001618 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001619 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001620 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001621 @RequiresPermission(allOf = {
1622 android.Manifest.permission.MODIFY_PHONE_STATE,
1623 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001624 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001625 ITelecomService service = getTelecomService();
1626 if (service != null) {
1627 try {
1628 return service.setDefaultDialer(packageName);
1629 } catch (RemoteException e) {
1630 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001631 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001632 }
1633 return false;
1634 }
1635
1636 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001637 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001638 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001639 * @return package name for the system dialer package or {@code null} if no system dialer is
1640 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001641 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001642 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001643 ITelecomService service = getTelecomService();
1644 if (service != null) {
1645 try {
1646 return service.getSystemDialerPackage();
1647 } catch (RemoteException e) {
1648 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001649 }
Yorke Lee1011f482015-04-23 15:58:27 -07001650 }
1651 return null;
1652 }
1653
1654 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001655 * Return whether a given phone number is the configured voicemail number for a
1656 * particular phone account.
1657 *
1658 * @param accountHandle The handle for the account to check the voicemail number against
1659 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001660 */
Yorke Leec61d13662015-09-21 17:25:25 -07001661 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001662 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001663 ITelecomService service = getTelecomService();
1664 if (service != null) {
1665 try {
1666 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001667 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001668 } catch (RemoteException e) {
1669 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001670 }
Nancy Chen443e5012014-10-15 15:48:21 -07001671 }
1672 return false;
1673 }
1674
1675 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001676 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001677 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001678 * @param accountHandle The handle for the phone account.
1679 * @return The voicemail number for the phone account, and {@code null} if one has not been
1680 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001681 */
Yorke Leec61d13662015-09-21 17:25:25 -07001682 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001683 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001684 ITelecomService service = getTelecomService();
1685 if (service != null) {
1686 try {
1687 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001688 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001689 } catch (RemoteException e) {
1690 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001691 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001692 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001693 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001694 }
1695
1696 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001697 * Return the line 1 phone number for given phone account.
1698 *
Michael Groover08490f12020-03-24 14:08:14 -07001699 * <p>Requires Permission:
1700 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1701 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1702 * or that the caller is the default SMS app for any API level.
1703 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1704 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001705 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001706 * @param accountHandle The handle for the account retrieve a number for.
1707 * @return A string representation of the line 1 phone number.
Meng Wang8665b512021-11-18 15:13:43 -08001708 * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1709 * Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1710 * from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
Nancy Chen5cf27842015-01-24 23:30:27 -08001711 */
Meng Wang8665b512021-11-18 15:13:43 -08001712 @Deprecated
Michael Groover08490f12020-03-24 14:08:14 -07001713 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1714 @RequiresPermission(anyOf = {
1715 android.Manifest.permission.READ_PHONE_STATE,
1716 android.Manifest.permission.READ_SMS,
1717 android.Manifest.permission.READ_PHONE_NUMBERS
1718 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001719 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001720 ITelecomService service = getTelecomService();
1721 if (service != null) {
1722 try {
1723 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001724 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001725 } catch (RemoteException e) {
1726 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001727 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001728 }
1729 return null;
1730 }
1731
1732 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001733 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001734 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001735 *
1736 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1737 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001738 */
Yorke Leec61d13662015-09-21 17:25:25 -07001739 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001740 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001741 ITelecomService service = getTelecomService();
1742 if (service != null) {
1743 try {
1744 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001745 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001746 } catch (RemoteException e) {
1747 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001748 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001749 }
1750 return false;
1751 }
1752
1753 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001754 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1755 * permission. The permission can be obtained by associating with a physical wearable device
1756 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1757 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001758 *
1759 * @return {@code true} if the caller has {@link InCallService} access for
1760 * companion app; {@code false} otherwise.
1761 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001762 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001763 ITelecomService service = getTelecomService();
1764 if (service != null) {
1765 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001766 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001767 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001768 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001769 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001770 if (!isSystemProcess()) {
1771 e.rethrowAsRuntimeException();
1772 }
Shuo Qian4d065262020-10-20 11:04:28 -07001773 }
1774 }
1775 return false;
1776 }
1777
1778 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001779 * Returns whether there is an ongoing call originating from a managed
1780 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1781 * states.
1782 * <p>
1783 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1784 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001785 *
1786 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1787 * {@code false} otherwise.
1788 */
1789 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1790 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001791 ITelecomService service = getTelecomService();
1792 if (service != null) {
1793 try {
1794 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001795 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001796 } catch (RemoteException e) {
1797 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001798 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001799 }
1800 return false;
1801 }
1802
1803 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001804 * Returns one of the following constants that represents the current state of Telecom:
1805 *
1806 * {@link TelephonyManager#CALL_STATE_RINGING}
1807 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1808 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001809 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001810 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001811 * <p>
1812 * Requires Permission:
1813 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1814 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001815 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001816 * @hide
1817 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001818 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1819 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001820 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001821 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001822 ITelecomService service = getTelecomService();
1823 if (service != null) {
1824 try {
Brad Ebingera8366ae2021-03-23 21:01:51 +00001825 return service.getCallStateUsingPackage(mContext.getPackageName(),
1826 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001827 } catch (RemoteException e) {
1828 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001829 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001830 }
1831 return TelephonyManager.CALL_STATE_IDLE;
1832 }
1833
1834 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001835 * Returns whether there currently exists is a ringing incoming-call.
1836 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001837 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001838 * @hide
1839 */
1840 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001841 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001842 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001843 android.Manifest.permission.READ_PHONE_STATE
1844 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001845 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001846 ITelecomService service = getTelecomService();
1847 if (service != null) {
1848 try {
1849 return service.isRinging(mContext.getOpPackageName());
1850 } catch (RemoteException e) {
1851 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001852 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001853 }
1854 return false;
1855 }
1856
1857 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001858 * Ends the foreground call on the device.
1859 * <p>
1860 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1861 * foreground call is ended.
1862 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001863 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1864 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001865 *
1866 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1867 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001868 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1869 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1870 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001871 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001872 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001873 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001874 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001875 ITelecomService service = getTelecomService();
1876 if (service != null) {
1877 try {
1878 return service.endCall(mContext.getPackageName());
1879 } catch (RemoteException e) {
1880 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001881 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001882 }
1883 return false;
1884 }
1885
1886 /**
1887 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001888 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001889 * If the incoming call is a video call, the call will be answered with the same video state as
1890 * the incoming call requests. This means, for example, that an incoming call requesting
1891 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001892 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001893 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1894 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001895 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001896 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1897 // this method (clockwork & gearhead).
1898 @RequiresPermission(anyOf =
1899 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001900 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001901 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001902 ITelecomService service = getTelecomService();
1903 if (service != null) {
1904 try {
1905 service.acceptRingingCall(mContext.getPackageName());
1906 } catch (RemoteException e) {
1907 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001908 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001909 }
1910 }
1911
1912 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001913 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1914 * with the specified video state.
1915 *
1916 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001917 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1918 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001919 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001920 @RequiresPermission(anyOf =
1921 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001922 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07001923 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001924 ITelecomService service = getTelecomService();
1925 if (service != null) {
1926 try {
1927 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001928 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001929 } catch (RemoteException e) {
1930 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001931 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07001932 }
1933 }
1934
1935 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001936 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07001937 * <p>
1938 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
1939 * already started playing. It is intended to handle use-cases such as silencing a ringing call
1940 * when the user presses the volume button during ringing.
1941 * <p>
1942 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
1943 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
1944 * <p>
1945 * A dialer app which wants to have more control over ringtone playing should declare
1946 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
1947 * {@link InCallService} implementation to indicate that the app wants to be responsible for
1948 * playing the ringtone for all incoming calls.
1949 * <p>
1950 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
1951 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07001952 */
Yorke Leec61d13662015-09-21 17:25:25 -07001953 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07001954 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001955 ITelecomService service = getTelecomService();
1956 if (service != null) {
1957 try {
1958 service.silenceRinger(mContext.getOpPackageName());
1959 } catch (RemoteException e) {
1960 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001961 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001962 }
1963 }
1964
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001965 /**
1966 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001967 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001968 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001969 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001970 android.Manifest.permission.READ_PHONE_STATE
1971 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001972 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001973 ITelecomService service = getTelecomService();
1974 if (service != null) {
1975 try {
1976 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001977 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001978 } catch (RemoteException e) {
1979 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001980 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001981 }
1982 return false;
1983 }
1984
1985 /**
1986 * 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 -07001987 * settings and have a wired headset plugged in.
1988 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001989 * - {@link TelecomManager#TTY_MODE_OFF}
1990 * - {@link TelecomManager#TTY_MODE_FULL}
1991 * - {@link TelecomManager#TTY_MODE_HCO}
1992 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001993 * @hide
1994 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001995 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001996 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001997 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001998 ITelecomService service = getTelecomService();
1999 if (service != null) {
2000 try {
2001 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002002 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002003 } catch (RemoteException e) {
2004 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002005 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002006 }
Evan Charlton10197192014-07-19 15:00:29 -07002007 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002008 }
2009
Santos Cordon96efb482014-07-19 14:57:05 -07002010 /**
2011 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08002012 * has an incoming call. For managed {@link ConnectionService}s, the specified
2013 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2014 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2015 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2016 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2017 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002018 * The incoming call you are adding is assumed to have a video state of
2019 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2020 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2021 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002022 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2023 * associated with the {@link PhoneAccountHandle} and request additional information about the
2024 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002025 * call UI.
2026 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002027 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2028 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2029 * the associated {@link PhoneAccount} is not currently enabled by the user.
2030 * <p>
2031 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2032 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2033 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2034 *
Santos Cordon96efb482014-07-19 14:57:05 -07002035 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2036 * {@link #registerPhoneAccount}.
2037 * @param extras A bundle that will be passed through to
2038 * {@link ConnectionService#onCreateIncomingConnection}.
2039 */
2040 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002041 ITelecomService service = getTelecomService();
2042 if (service != null) {
2043 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002044 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2045 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2046 Build.VERSION_CODES.O_MR1) {
2047 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2048 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002049 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002050 }
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002051 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras);
2052 } catch (RemoteException e) {
2053 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002054 }
Santos Cordon96efb482014-07-19 14:57:05 -07002055 }
2056 }
2057
Nancy Chen0eb1e402014-08-21 22:52:29 -07002058 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302059 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002060 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2061 * call initiated on another device which the user is being invited to join in. For managed
2062 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2063 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2064 * corresponding {@link PhoneAccount}. This can be checked using
2065 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2066 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302067 * <p>
2068 * The incoming conference you are adding is assumed to have a video state of
2069 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2070 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2071 * <p>
2072 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2073 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002074 * call (See
2075 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2076 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302077 * <p>
2078 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2079 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2080 * the associated {@link PhoneAccount} is not currently enabled by the user.
2081 *
2082 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2083 * {@link #registerPhoneAccount}.
2084 * @param extras A bundle that will be passed through to
2085 * {@link ConnectionService#onCreateIncomingConference}.
2086 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302087 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2088 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002089 ITelecomService service = getTelecomService();
2090 if (service != null) {
2091 try {
2092 service.addNewIncomingConference(
Ravi Paluri80aa2142019-12-02 11:57:37 +05302093 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002094 } catch (RemoteException e) {
2095 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302096 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302097 }
2098 }
2099
2100 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002101 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2102 * service. This is invoked when Telephony detects a new unknown connection that was neither
2103 * a new incoming call, nor an user-initiated outgoing call.
2104 *
2105 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2106 * {@link #registerPhoneAccount}.
2107 * @param extras A bundle that will be passed through to
2108 * {@link ConnectionService#onCreateIncomingConnection}.
2109 * @hide
2110 */
2111 @SystemApi
2112 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002113 ITelecomService service = getTelecomService();
2114 if (service != null) {
2115 try {
2116 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002117 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002118 } catch (RemoteException e) {
2119 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002120 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002121 }
2122 }
2123
2124 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002125 * Processes the specified dial string as an MMI code.
2126 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2127 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002128 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002129 * <p>
2130 * Requires that the method-caller be set as the system dialer app.
2131 * </p>
2132 *
2133 * @param dialString The digits to dial.
2134 * @return True if the digits were processed as an MMI code, false otherwise.
2135 */
Yorke Leec61d13662015-09-21 17:25:25 -07002136 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002137 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002138 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002139 if (service != null) {
2140 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002141 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002142 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002143 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002144 }
2145 }
2146 return false;
2147 }
2148
2149 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002150 * Processes the specified dial string as an MMI code.
2151 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2152 * Some of these sequences launch special behavior through handled by Telephony.
2153 * <p>
2154 * Requires that the method-caller be set as the system dialer app.
2155 * </p>
2156 *
2157 * @param accountHandle The handle for the account the MMI code should apply to.
2158 * @param dialString The digits to dial.
2159 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002160 */
Yorke Leec61d13662015-09-21 17:25:25 -07002161 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002162 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002163 ITelecomService service = getTelecomService();
2164 if (service != null) {
2165 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002166 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2167 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002168 } catch (RemoteException e) {
2169 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2170 }
2171 }
2172 return false;
2173 }
2174
2175 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002176 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2177 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002178 * @param accountHandle The handle for the account to derive an adn query URI for or
2179 * {@code null} to return a URI which will use the default account.
2180 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2181 * for the the content retrieve.
2182 */
Yorke Leec61d13662015-09-21 17:25:25 -07002183 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002184 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2185 ITelecomService service = getTelecomService();
2186 if (service != null && accountHandle != null) {
2187 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002188 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002189 } catch (RemoteException e) {
2190 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2191 }
2192 }
2193 return Uri.parse("content://icc/adn");
2194 }
2195
2196 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002197 * Removes the missed-call notification if one is present.
2198 * <p>
2199 * Requires that the method-caller be set as the system dialer app.
2200 * </p>
2201 */
Yorke Leec61d13662015-09-21 17:25:25 -07002202 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002203 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002204 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002205 if (service != null) {
2206 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002207 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002208 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002209 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002210 }
2211 }
2212 }
2213
2214 /**
2215 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2216 * currently no ongoing call, then this method does nothing.
2217 * <p>
2218 * Requires that the method-caller be set as the system dialer app or have the
2219 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2220 * </p>
2221 *
2222 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2223 */
Yorke Leec61d13662015-09-21 17:25:25 -07002224 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002225 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002226 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002227 if (service != null) {
2228 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002229 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002230 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002231 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002232 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002233 }
2234 }
2235 }
2236
Yorke Lee3e56ba12015-04-23 12:32:36 -07002237 /**
2238 * Places a new outgoing call to the provided address using the system telecom service with
2239 * the specified extras.
2240 *
2241 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2242 * except that the outgoing call will always be sent via the system telecom service. If
2243 * method-caller is either the user selected default dialer app or preloaded system dialer
2244 * app, then emergency calls will also be allowed.
2245 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002246 * Placing a call via a managed {@link ConnectionService} requires permission:
2247 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002248 *
2249 * Usage example:
2250 * <pre>
2251 * Uri uri = Uri.fromParts("tel", "12345", null);
2252 * Bundle extras = new Bundle();
2253 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2254 * telecomManager.placeCall(uri, extras);
2255 * </pre>
2256 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002257 * The following keys are supported in the supplied extras.
2258 * <ul>
2259 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2260 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2261 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2262 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2263 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002264 * <p>
2265 * An app which implements the self-managed {@link ConnectionService} API uses
2266 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2267 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2268 * associated {@link android.telecom.PhoneAccountHandle}.
2269 *
2270 * Self-managed {@link ConnectionService}s require permission
2271 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002272 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002273 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2274 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2275 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2276 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2277 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2278 * </p>
2279 *
Yorke Lee3e56ba12015-04-23 12:32:36 -07002280 * @param address The address to make the call to.
2281 * @param extras Bundle of extras to use with the call.
2282 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002283 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2284 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002285 public void placeCall(Uri address, Bundle extras) {
2286 ITelecomService service = getTelecomService();
2287 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002288 if (address == null) {
2289 Log.w(TAG, "Cannot place call to empty address.");
2290 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002291 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002292 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002293 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002294 } catch (RemoteException e) {
2295 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2296 }
2297 }
2298 }
2299
Ravi Paluri80aa2142019-12-02 11:57:37 +05302300
2301 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002302 * Place a new adhoc conference call with the provided participants using the system telecom
2303 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302304 *
2305 * An adhoc conference call is established by providing a list of addresses to
2306 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2307 * {@link ConnectionService} is responsible for connecting all indicated participants
2308 * to a conference simultaneously.
2309 * This is in contrast to conferences formed by merging calls together (e.g. using
2310 * {@link android.telecom.Call#mergeConference()}).
2311 *
2312 * The following keys are supported in the supplied extras.
2313 * <ul>
2314 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2315 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2316 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2317 * </ul>
2318 *
2319 * @param participants List of participants to start conference with
2320 * @param extras Bundle of extras to use with the call
2321 */
2322 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2323 public void startConference(@NonNull List<Uri> participants,
2324 @NonNull Bundle extras) {
2325 ITelecomService service = getTelecomService();
2326 if (service != null) {
2327 try {
2328 service.startConference(participants, extras,
2329 mContext.getOpPackageName());
2330 } catch (RemoteException e) {
2331 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2332 }
2333 }
2334 }
2335
Santos Cordon91371dc02015-05-08 13:52:09 -07002336 /**
2337 * Enables and disables specified phone account.
2338 *
2339 * @param handle Handle to the phone account.
2340 * @param isEnabled Enable state of the phone account.
2341 * @hide
2342 */
2343 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002344 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002345 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2346 ITelecomService service = getTelecomService();
2347 if (service != null) {
2348 try {
2349 service.enablePhoneAccount(handle, isEnabled);
2350 } catch (RemoteException e) {
2351 Log.e(TAG, "Error enablePhoneAbbount", e);
2352 }
2353 }
2354 }
2355
Hall Liu0464b9b2016-01-12 15:32:58 -08002356 /**
2357 * Dumps telecom analytics for uploading.
2358 *
2359 * @return
2360 * @hide
2361 */
2362 @SystemApi
2363 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002364 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002365 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002366 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002367 if (service != null) {
2368 try {
2369 result = service.dumpCallAnalytics();
2370 } catch (RemoteException e) {
2371 Log.e(TAG, "Error dumping call analytics", e);
2372 }
2373 }
2374 return result;
2375 }
2376
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002377 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002378 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2379 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002380 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002381 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2382 * {@code true} for the current user.
2383 */
2384 public Intent createManageBlockedNumbersIntent() {
2385 ITelecomService service = getTelecomService();
2386 Intent result = null;
2387 if (service != null) {
2388 try {
2389 result = service.createManageBlockedNumbersIntent();
2390 } catch (RemoteException e) {
2391 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2392 }
2393 }
2394 return result;
2395 }
2396
Fan Zhang5431ef52019-10-14 13:43:46 -07002397
2398 /**
2399 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2400 * launch the activity for emergency dialer.
2401 *
2402 * @param number Optional number to call in emergency dialer
2403 * @hide
2404 */
2405 @SystemApi
2406 @NonNull
2407 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2408 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002409 if (service != null) {
2410 try {
Tyler Gunn753aa102020-04-23 10:16:26 -07002411 return service.createLaunchEmergencyDialerIntent(number);
Fan Zhang5431ef52019-10-14 13:43:46 -07002412 } catch (RemoteException e) {
2413 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2414 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002415 } else {
2416 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002417 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002418
2419 // Telecom service knows the package name of the expected emergency dialer package; if it
2420 // is not available, then fallback to not targeting a specific package.
2421 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2422 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2423 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2424 }
2425 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002426 }
2427
Tyler Gunnf5035432017-01-09 09:43:12 -08002428 /**
2429 * Determines whether Telecom would permit an incoming call to be added via the
2430 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2431 * {@link PhoneAccountHandle}.
2432 * <p>
2433 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2434 * in the following situations:
2435 * <ul>
2436 * <li>{@link PhoneAccount} does not have property
2437 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2438 * {@link ConnectionService}), and the active or held call limit has
2439 * been reached.</li>
2440 * <li>There is an ongoing emergency call.</li>
2441 * </ul>
2442 *
2443 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2444 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2445 * otherwise.
2446 */
2447 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002448 if (phoneAccountHandle == null) {
2449 return false;
2450 }
2451
Tyler Gunnf5035432017-01-09 09:43:12 -08002452 ITelecomService service = getTelecomService();
2453 if (service != null) {
2454 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002455 return service.isIncomingCallPermitted(phoneAccountHandle,
2456 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002457 } catch (RemoteException e) {
2458 Log.e(TAG, "Error isIncomingCallPermitted", e);
2459 }
2460 }
2461 return false;
2462 }
2463
2464 /**
2465 * Determines whether Telecom would permit an outgoing call to be placed via the
2466 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2467 * <p>
2468 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2469 * in the following situations:
2470 * <ul>
2471 * <li>{@link PhoneAccount} does not have property
2472 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2473 * {@link ConnectionService}), and the active, held or ringing call limit has
2474 * been reached.</li>
2475 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2476 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2477 * another {@link ConnectionService}.</li>
2478 * <li>There is an ongoing emergency call.</li>
2479 * </ul>
2480 *
2481 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2482 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2483 * otherwise.
2484 */
2485 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2486 ITelecomService service = getTelecomService();
2487 if (service != null) {
2488 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002489 return service.isOutgoingCallPermitted(phoneAccountHandle,
2490 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002491 } catch (RemoteException e) {
2492 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2493 }
2494 }
2495 return false;
2496 }
2497
Sanket Padawea8eddd42017-11-03 11:07:35 -07002498 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002499 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2500 * {@link PhoneAccountHandle} it defines.
2501 * <p>
2502 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2503 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2504 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2505 * is referred to as the source of the handover, and the video calling app is referred to as the
2506 * destination.
2507 * <p>
2508 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2509 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2510 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2511 * device.
2512 * <p>
2513 * For a full discussion of the handover process and the APIs involved, see
2514 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2515 * <p>
2516 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2517 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002518 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2519 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2520 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2521 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2522 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2523 * <p>
2524 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2525 * associated with the {@link PhoneAccountHandle} destAcct and call
2526 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2527 * <p>
2528 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2529 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2530 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2531 * user.
2532 * <p>
2533 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2534 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2535 *
2536 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2537 * {@link ConnectionService}.
2538 * @param videoState Video state after the handover.
2539 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2540 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002541 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2542 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002543 ITelecomService service = getTelecomService();
2544 if (service != null) {
2545 try {
2546 service.acceptHandover(srcAddr, videoState, destAcct);
2547 } catch (RemoteException e) {
2548 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002549 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002550 }
2551 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002552
Tyler Gunn5bd90852018-09-21 09:37:07 -07002553 /**
2554 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2555 * call, as identified by the dialed number, or because a call was identified by the network
2556 * as an emergency call.
2557 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2558 * @hide
2559 */
2560 @SystemApi
2561 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2562 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002563 ITelecomService service = getTelecomService();
2564 if (service != null) {
2565 try {
2566 return service.isInEmergencyCall();
2567 } catch (RemoteException e) {
2568 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2569 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002570 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002571 }
2572 return false;
2573 }
2574
Tyler Gunnc37445c2018-09-28 16:16:20 -07002575 /**
2576 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2577 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002578 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002579 * @hide
2580 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002581 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002582 ITelecomService service = getTelecomService();
2583 if (service != null) {
2584 try {
2585 service.handleCallIntent(intent, callingPackageProxy);
2586 } catch (RemoteException e) {
2587 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002588 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002589 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002590 }
2591
Shuo Qian4d065262020-10-20 11:04:28 -07002592 private boolean isSystemProcess() {
2593 return Process.myUid() == Process.SYSTEM_UID;
2594 }
2595
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002596 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002597 if (mTelecomServiceOverride != null) {
2598 return mTelecomServiceOverride;
2599 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002600 if (sTelecomService == null) {
2601 ITelecomService temp = ITelecomService.Stub.asInterface(
2602 ServiceManager.getService(Context.TELECOM_SERVICE));
2603 synchronized (CACHE_LOCK) {
2604 if (sTelecomService == null && temp != null) {
2605 try {
2606 sTelecomService = temp;
2607 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2608 } catch (Exception e) {
2609 sTelecomService = null;
2610 }
2611 }
2612 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002613 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002614 return sTelecomService;
2615 }
2616
2617 private static class DeathRecipient implements IBinder.DeathRecipient {
2618 @Override
2619 public void binderDied() {
2620 resetServiceCache();
2621 }
2622 }
2623
2624 private static void resetServiceCache() {
2625 synchronized (CACHE_LOCK) {
2626 if (sTelecomService != null) {
2627 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2628 sTelecomService = null;
2629 }
2630 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002631 }
Evan Charlton235c1592014-09-05 15:41:23 +00002632}