blob: c9cf2ff28828b5c202145038766a596e342aeaae [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;
Yorke Leec61d13662015-09-21 17:25:25 -070023import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060024import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060025import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070026import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060027import android.annotation.SystemService;
Brad Ebingera8366ae2021-03-23 21:01:51 +000028import android.compat.annotation.ChangeId;
29import android.compat.annotation.EnabledSince;
Artur Satayev2ebb31c2020-01-08 12:24:36 +000030import android.compat.annotation.UnsupportedAppUsage;
Santos Cordon6c7a3882014-06-25 15:30:08 -070031import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070032import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070033import android.content.Intent;
Nancy Chenb2299c12014-10-29 18:22:11 -070034import android.net.Uri;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -080035import android.os.Build;
Santos Cordon96efb482014-07-19 14:57:05 -070036import android.os.Bundle;
Kevin Jeon767cda32020-11-17 01:40:16 +000037import android.os.IBinder;
Shuo Qian4d065262020-10-20 11:04:28 -070038import android.os.Process;
Santos Cordon6c7a3882014-06-25 15:30:08 -070039import android.os.RemoteException;
40import android.os.ServiceManager;
Tyler Gunn7e45b722018-12-04 12:56:45 -080041import android.os.UserHandle;
Chen Xuc9d4ee12019-09-26 16:11:59 -070042import android.telephony.Annotation.CallState;
Brad Ebingere7833312019-05-07 10:55:55 -070043import android.telephony.SubscriptionManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070044import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070045import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070046import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070047
Kevin Jeon767cda32020-11-17 01:40:16 +000048import com.android.internal.annotations.GuardedBy;
Tyler Gunnef9f6f92014-09-12 22:16:17 -070049import com.android.internal.telecom.ITelecomService;
Yorke Leeb4ce1432014-06-09 13:53:23 -070050
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080051import java.lang.annotation.Retention;
52import java.lang.annotation.RetentionPolicy;
Jay Shrauner7746a942014-08-26 12:15:15 -070053import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070054import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070055import java.util.List;
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -080056import java.util.Objects;
Tyler Gunn7e45b722018-12-04 12:56:45 -080057import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070058
Yorke Leeb4ce1432014-06-09 13:53:23 -070059/**
Santos Cordond9e614f2014-10-28 13:10:36 -070060 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080061 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070062 * <p>
63 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
64 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
65 * <p>
66 * Note that access to some telecom information is permission-protected. Your app cannot access the
67 * protected information or gain access to protected functionality unless it has the appropriate
68 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
69 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070070 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060071@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060072@SystemService(Context.TELECOM_SERVICE)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070073public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070074
Evan Charlton10197192014-07-19 15:00:29 -070075 /**
Santos Cordon96efb482014-07-19 14:57:05 -070076 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070077 * UI by notifying the Telecom system that an incoming call exists for a specific call service
78 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
79 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070080 * ultimately use to control and get information about the call.
81 * <p>
82 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070083 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070084 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080085 *
86 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070087 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070088 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070089
90 /**
Yorke Leec3cf9822014-10-02 09:38:39 -070091 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
92 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080093 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -070094 * @hide
95 */
96 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
97
98 /**
Santos Cordon895d4b82015-06-25 16:41:48 -070099 * An {@link android.content.Intent} action sent by the telecom framework to start a
100 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
101 * and each app that registers a {@link PhoneAccount} should provide one if desired.
102 * <p>
103 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
104 * app's settings menu. For each entry, the settings app will add a click action. When
105 * triggered, the click-action will start this intent along with the extra
106 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
107 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
108 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700109 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700110 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
111 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700112
113 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800114 * The {@link android.content.Intent} action used to show the call accessibility settings page.
115 */
116 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
117 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
118
119 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700120 * The {@link android.content.Intent} action used to show the call settings page.
121 */
122 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700123 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700124
125 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800126 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
127 */
128 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
129 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
130
131 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700132 * The {@link android.content.Intent} action used to show the settings page used to configure
133 * {@link PhoneAccount} preferences.
134 */
135 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700136 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700137
138 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700139 * {@link android.content.Intent} action used indicate that a new phone account was just
140 * registered.
141 * <p>
142 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
143 * to indicate which {@link PhoneAccount} was registered.
144 * <p>
145 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800146 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800147 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
148 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
149
150 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700151 * {@link android.content.Intent} action used indicate that a phone account was just
152 * unregistered.
153 * <p>
154 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
155 * to indicate which {@link PhoneAccount} was unregistered.
156 * <p>
157 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700158 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700159 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
160 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
161
162 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700163 * Activity action: Shows a dialog asking the user whether or not they want to replace the
164 * current default Dialer with the one specified in
165 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
166 *
167 * Usage example:
168 * <pre>
169 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
170 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
171 * getActivity().getPackageName());
172 * startActivity(intent);
173 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800174 * <p>
175 * This is no longer supported since Q, please use
176 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
177 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700178 */
179 public static final String ACTION_CHANGE_DEFAULT_DIALER =
180 "android.telecom.action.CHANGE_DEFAULT_DIALER";
181
182 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700183 * Broadcast intent action indicating that the current default dialer has changed.
184 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
185 * name of the package that the default dialer was changed to.
186 *
187 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
188 */
189 public static final String ACTION_DEFAULT_DIALER_CHANGED =
190 "android.telecom.action.DEFAULT_DIALER_CHANGED";
191
192 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700193 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
194 */
195 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
196 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
197
198 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800199 * Broadcast intent action indicating that the current default call screening app has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700200 * <p>
201 * Note: This intent is NEVER actually broadcast and will be deprecated in the future.
202 * <p>
203 * An app that want to know if it holds the
204 * {@link android.app.role.RoleManager#ROLE_CALL_SCREENING} role can use
205 * {@link android.app.role.RoleManager#isRoleHeld(String)} to confirm if it holds the role or
206 * not.
tonyzhuff60f5e2018-10-01 19:14:59 +0800207 */
208 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
209 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
210
211 /**
212 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
213 * indicate the ComponentName of the call screening app which has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700214 * <p>
215 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800216 */
217 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
218 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
219
220 /**
221 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
222 * indicate whether an app is the default call screening app.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700223 * <p>
224 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800225 */
226 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
227 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
228
229 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700230 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
231 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700232 */
233 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700234 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700235
236 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700237 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
238 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700239 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700240 * {@link VideoProfile#STATE_AUDIO_ONLY},
241 * {@link VideoProfile#STATE_BIDIRECTIONAL},
242 * {@link VideoProfile#STATE_RX_ENABLED},
243 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700244 */
245 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700246 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700247
248 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700249 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
250 * integer that determines the requested video state for an incoming call.
251 * Valid options:
252 * {@link VideoProfile#STATE_AUDIO_ONLY},
253 * {@link VideoProfile#STATE_BIDIRECTIONAL},
254 * {@link VideoProfile#STATE_RX_ENABLED},
255 * {@link VideoProfile#STATE_TX_ENABLED}.
256 */
257 public static final String EXTRA_INCOMING_VIDEO_STATE =
258 "android.telecom.extra.INCOMING_VIDEO_STATE";
259
260 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700261 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
262 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
263 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700264 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700265 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700266 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700267 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700268 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700269
270 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700271 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
272 * subject which will be associated with an outgoing call. Should only be specified if the
Shuo Qian3ed38832020-11-30 21:54:36 -0800273 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
274 * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700275 */
276 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
277
Shuo Qian3ed38832020-11-30 21:54:36 -0800278 // Values for EXTRA_PRIORITY
279 /**
280 * Indicates the call composer call priority is normal.
281 *
282 * Reference: RCC.20 Section 2.4.4.2
283 */
284 public static final int PRIORITY_NORMAL = 0;
285
286 /**
287 * Indicates the call composer call priority is urgent.
288 *
289 * Reference: RCC.20 Section 2.4.4.2
290 */
291 public static final int PRIORITY_URGENT = 1;
292
293 /**
294 * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
295 * {@link #PRIORITY_URGENT}.
296 *
297 * Reference: RCC.20 Section 2.4.4.2
298 */
299 public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
300
301 /**
302 * Extra for the call composer call location, an {@link android.location.Location} parcelable
303 * class to represent the geolocation as a latitude and longitude pair.
304 *
305 * Reference: RCC.20 Section 2.4.3.2
306 */
307 public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
308
309 /**
310 * A boolean extra set on incoming calls to indicate that the call has a picture specified.
311 * Given that image download could take a (short) time, the EXTRA is set immediately upon
312 * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
313 * if one is expected. The EXTRA may be unset if the image download ends up failing for some
314 * reason.
315 */
316 public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
317
318 /**
Hall Liu48c3c142021-03-11 16:14:22 -0800319 * A {@link Uri} representing the picture that was downloaded when a call is received or
320 * uploaded when a call is placed.
Hall Liu8fee7ea2021-01-21 16:37:51 -0800321 *
Shuo Qian3ed38832020-11-30 21:54:36 -0800322 * This is a content URI within the call log provider which can be used to open a file
323 * 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 -0800324 * download/upload is delayed for some reason. The Dialer app will receive a callback via
Shuo Qian3ed38832020-11-30 21:54:36 -0800325 * {@link Call.Callback#onDetailsChanged} when this value has changed.
326 *
327 * Reference: RCC.20 Section 2.4.3.2
328 */
Hall Liu8fee7ea2021-01-21 16:37:51 -0800329 public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
Shuo Qian3ed38832020-11-30 21:54:36 -0800330
Shuo Qian3ed38832020-11-30 21:54:36 -0800331 /**
332 * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
Hall Liua749abc2021-01-21 10:05:43 -0800333 * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
334 * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
Shuo Qian3ed38832020-11-30 21:54:36 -0800335 */
336 public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
337
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700338 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700339 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
340 * has initiated a new incoming call.
341 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700342 public static final String EXTRA_INCOMING_CALL_ADDRESS =
343 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700344
345 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700346 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
347 * metadata about the call. This {@link Bundle} will be returned to the
348 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700349 */
350 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700351 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700352
353 /**
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800354 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a boolean to indicate that the
355 * call has an externally generated ringer. Used by the HfpClientConnectionService when In Band
356 * Ringtone is enabled to prevent two ringers from being generated.
357 * @hide
358 */
359 public static final String EXTRA_CALL_EXTERNAL_RINGER =
360 "android.telecom.extra.CALL_EXTERNAL_RINGER";
361
362 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700363 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
364 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
365 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700366 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700367 */
368 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700369 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700370
371 /**
sqian6d9e7452019-02-08 21:42:15 -0800372 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
373 * whether the user's dial intent is emergency; this is required to specify when the dialed
374 * number is ambiguous, identified as both emergency number and any other non-emergency number;
375 * e.g. in some situation, 611 could be both an emergency number in a country and a
376 * non-emergency number of a carrier's customer service hotline.
377 *
378 * @hide
379 */
380 @SystemApi
381 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
382 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
383
384 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800385 * A mandatory extra containing a {@link Uri} to be passed in when calling
386 * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
387 * the remote handle of the new call.
Yorke Leec3cf9822014-10-02 09:38:39 -0700388 * @hide
389 */
Hall Liu2ef04112020-09-14 18:34:10 -0700390 @SystemApi
Yorke Leec3cf9822014-10-02 09:38:39 -0700391 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
392 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
393
394 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700395 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
396 * call was created. This value is in milliseconds since boot.
Hall Liudbb17f12020-03-10 18:28:58 -0700397 * @hide
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700398 */
399 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
400 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
401
402 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800403 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
404 * time the call was created.
405 * @hide
406 */
407 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
408 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
409
410 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700411 * Optional extra for incoming and outgoing calls containing a long which specifies the time
412 * telecom began routing the call. This value is in milliseconds since boot.
413 * @hide
414 */
415 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
416 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
417
418 /**
419 * Optional extra for incoming and outgoing calls containing a long which specifies the time
420 * telecom finished routing the call. This value is in milliseconds since boot.
421 * @hide
422 */
423 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
424 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
425
426 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700427 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
428 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700429 */
430 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700431 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700432
433 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700434 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
435 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700436 */
437 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700438 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700439
440 /**
radhika0dd90652020-11-04 11:12:51 -0800441 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
442 * lower layers
443 * @hide
444 */
445 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
446 "Call dropped by lower layers";
447
448 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700449 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
450 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800451 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700452 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800453 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700454 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700455 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700456
457 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800458 * Optional extra for communicating the call technology used by a {@link ConnectionService}
459 * to Telecom. Valid values are:
460 * <ul>
461 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
462 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
463 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
464 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
465 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
466 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800467 * @hide
468 */
Hall Liu2ef04112020-09-14 18:34:10 -0700469 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800470 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
471 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
472
473 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800474 * Optional extra for communicating the call network technology used by a
475 * {@link android.telecom.Connection} to Telecom and InCallUI.
476 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700477 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800478 */
479 public static final String EXTRA_CALL_NETWORK_TYPE =
480 "android.telecom.extra.CALL_NETWORK_TYPE";
481
482 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700483 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
484 * package name of the app specifying an alternative gateway for the call.
485 * The value is a string.
486 *
487 * (The following comment corresponds to the all GATEWAY_* extras)
488 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
489 * alternative address to dial which is different from the one specified and displayed to
490 * the user. This alternative address is referred to as the gateway address.
491 */
492 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700493 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700494
495 /**
496 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
497 * original address to dial for the call. This is used when an alternative gateway address is
498 * provided to recall the original address.
499 * The value is a {@link android.net.Uri}.
500 *
501 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
502 */
503 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700504 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700505
506 /**
Evan Charlton10197192014-07-19 15:00:29 -0700507 * The number which the party on the other side of the line will see (and use to return the
508 * call).
509 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700510 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
511 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
512 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700513 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700514 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700515
516 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800517 * The number of milliseconds that Telecom should wait after disconnecting a call via the
518 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
519 * to make a new one.
520 * @hide
521 */
522 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
523 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
524
525 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700526 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700527 * existing call from the user's device to a different {@link PhoneAccount}.
528 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700529 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
530 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
531 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
532 * the receiving side of a handover.
533 * <p>
534 * Used when Telecom calls
535 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
536 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
537 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
538 * occurs on the initiating side of a handover.
539 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700540 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700541 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800542 * @deprecated Use the public handover APIs. See
543 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700544 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800545 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700546 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
547
548 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800549 * When {@code true} indicates that a request to create a new connection is for the purpose of
550 * a handover. Note: This is used with the
551 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
552 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
553 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
554 * @hide
555 */
556 public static final String EXTRA_IS_HANDOVER_CONNECTION =
557 "android.telecom.extra.IS_HANDOVER_CONNECTION";
558
559 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700560 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
561 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
562 * the handover is from.
563 * @hide
564 */
565 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
566 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
567
568 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700569 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
570 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
571 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
572 * {@link Connection} will be.
573 * @hide
574 */
575 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
576
577 /**
Hall Liu95d55872017-01-25 17:12:49 -0800578 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
579 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
580 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
581 */
582 public static final String EXTRA_START_CALL_WITH_RTT =
583 "android.telecom.extra.START_CALL_WITH_RTT";
584
585 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800586 * Start an activity indicating that the completion of an outgoing call or an incoming call
587 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
588 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
589 *
590 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
591 * call which completed.
592 *
593 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
594 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
595 *
596 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
597 * {@link #EXTRA_CALL_DURATION} for more information.
598 */
599 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
600
601 /**
602 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
603 * uri handle(phone number) of the completed call.
604 */
605 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
606
607 /**
608 * A integer value provided for completed calls to indicate the reason for the call
609 * disconnection.
610 * <p>
611 * Allowed values:
612 * <ul>
613 * <li>{@link DisconnectCause#UNKNOWN}</li>
614 * <li>{@link DisconnectCause#LOCAL}</li>
615 * <li>{@link DisconnectCause#REMOTE}</li>
616 * <li>{@link DisconnectCause#REJECTED}</li>
617 * <li>{@link DisconnectCause#MISSED}</li>
618 * </ul>
619 * </p>
620 */
621 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
622
623 /**
624 * A integer value provided for completed calls to indicate the duration of the call.
625 * <p>
626 * Allowed values:
627 * <ul>
628 * <li>{@link #DURATION_VERY_SHORT}</li>
629 * <li>{@link #DURATION_SHORT}</li>
630 * <li>{@link #DURATION_MEDIUM}</li>
631 * <li>{@link #DURATION_LONG}</li>
632 * </ul>
633 * </p>
634 */
635 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
636
637 /**
638 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
639 * call was < 3 seconds.
640 */
641 public static final int DURATION_VERY_SHORT = 0;
642
643 /**
644 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
645 * call was >= 3 seconds and < 60 seconds.
646 */
647 public static final int DURATION_SHORT = 1;
648
649 /**
650 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
651 * call was >= 60 seconds and < 120 seconds.
652 */
653 public static final int DURATION_MEDIUM = 2;
654
655 /**
656 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
657 * call was >= 120 seconds.
658 */
659 public static final int DURATION_LONG = 3;
660
661 /**
662 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
663 * milliseconds.
664 * @hide
665 */
666 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
667
668 /**
669 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
670 * milliseconds.
671 * @hide
672 */
673 public static final long SHORT_CALL_TIME_MS = 60000;
674
675 /**
676 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
677 * milliseconds.
678 * @hide
679 */
680 public static final long MEDIUM_CALL_TIME_MS = 120000;
681
682 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700683 * A boolean meta-data value indicating whether an {@link InCallService} implements an
684 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
685 * would also like to replace the in-call interface should set this meta-data to {@code true} in
686 * the manifest registration of their {@link InCallService}.
687 */
688 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
689
690 /**
Santos Cordon88881552015-12-10 17:29:54 -0800691 * A boolean meta-data value indicating whether an {@link InCallService} implements an
692 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000693 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800694 */
695 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
696 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
697
698 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800699 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
700 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
701 * override the system provided ringing should set this meta-data to {@code true} in the
702 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700703 * <p>
704 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
705 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800706 */
707 public static final String METADATA_IN_CALL_SERVICE_RINGING =
708 "android.telecom.IN_CALL_SERVICE_RINGING";
709
710 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700711 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
712 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
713 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
714 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
715 * informed of external calls should set this meta-data to {@code true} in the manifest
716 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
717 * be informed of external calls.
718 */
719 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
720 "android.telecom.INCLUDE_EXTERNAL_CALLS";
721
722 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800723 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
724 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
725 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
726 * to implement its own call user interface. An {@link InCallService} implementation which
727 * would like to be informed of external calls should set this meta-data to {@code true} in the
728 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
729 * will NOT be informed about self-managed calls.
730 * <p>
731 * An {@link InCallService} which receives self-managed calls is free to view and control the
732 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700733 * exposing these calls to an automotive device via its companion app.
734 * <p>
735 * This meta-data can only be set for an {@link InCallService} which also sets
736 * {@link #METADATA_IN_CALL_SERVICE_UI}. Only the default phone/dialer app, or a car-mode
737 * {@link InCallService} can see self-managed calls.
Tyler Gunn24e18332017-02-10 09:42:49 -0800738 * <p>
739 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
740 */
741 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
742 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
743
744 /**
Evan Charlton10197192014-07-19 15:00:29 -0700745 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
746 * pause for a predefined period.
747 */
748 public static final char DTMF_CHARACTER_PAUSE = ',';
749
750 /**
751 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
752 * wait for user confirmation before proceeding.
753 */
754 public static final char DTMF_CHARACTER_WAIT = ';';
755
756 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800757 * @hide
758 */
759 @IntDef(prefix = { "TTY_MODE_" },
760 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
761 @Retention(RetentionPolicy.SOURCE)
762 public @interface TtyMode {}
763
764 /**
Evan Charlton10197192014-07-19 15:00:29 -0700765 * TTY (teletypewriter) mode is off.
766 *
767 * @hide
768 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800769 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700770 public static final int TTY_MODE_OFF = 0;
771
772 /**
773 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
774 * will communicate with the remote party by sending and receiving text messages.
775 *
776 * @hide
777 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800778 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700779 public static final int TTY_MODE_FULL = 1;
780
781 /**
782 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
783 * speaker is on. The user will communicate with the remote party by sending text messages and
784 * hearing an audible reply.
785 *
786 * @hide
787 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800788 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700789 public static final int TTY_MODE_HCO = 2;
790
791 /**
792 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
793 * microphone is still on. User will communicate with the remote party by speaking and receiving
794 * text message replies.
795 *
796 * @hide
797 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800798 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700799 public static final int TTY_MODE_VCO = 3;
800
801 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700802 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700803 *
Hall Liu2ef04112020-09-14 18:34:10 -0700804 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
805 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700806 * @hide
807 */
Hall Liu2ef04112020-09-14 18:34:10 -0700808 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700809 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700810 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700811
812 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700813 * Integer extra key that indicates the current TTY mode.
814 *
815 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
816 *
817 * Valid modes are:
818 * <ul>
819 * <li>{@link #TTY_MODE_OFF}</li>
820 * <li>{@link #TTY_MODE_FULL}</li>
821 * <li>{@link #TTY_MODE_HCO}</li>
822 * <li>{@link #TTY_MODE_VCO}</li>
823 * </ul>
824 *
825 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
826 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
827 * plugged into the device.
828 * @hide
829 */
Hall Liu2ef04112020-09-14 18:34:10 -0700830 @SystemApi
831 public static final String EXTRA_CURRENT_TTY_MODE =
832 "android.telecom.extra.CURRENT_TTY_MODE";
833
834 /**
835 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
836 *
837 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
838 * preferred TTY mode.
839 * @hide
840 */
Hall Liu2ef04112020-09-14 18:34:10 -0700841 @SystemApi
842 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
843 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
844
845 /**
846 * Integer extra key that indicates the preferred TTY mode.
847 *
848 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
849 *
Evan Charlton10197192014-07-19 15:00:29 -0700850 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800851 * <ul>
852 * <li>{@link #TTY_MODE_OFF}</li>
853 * <li>{@link #TTY_MODE_FULL}</li>
854 * <li>{@link #TTY_MODE_HCO}</li>
855 * <li>{@link #TTY_MODE_VCO}</li>
856 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700857 * @hide
858 */
Hall Liu2ef04112020-09-14 18:34:10 -0700859 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700860 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800861 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700862
Nancy Chen9d568c02014-09-08 14:17:59 -0700863 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700864 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800865 * notification. If no custom component exists then this is sent to the default dialer which
866 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700867 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700868 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
869 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
870
871 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800872 * The number of calls associated with the notification. If the number is zero then the missed
873 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700874 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700875 public static final String EXTRA_NOTIFICATION_COUNT =
876 "android.telecom.extra.NOTIFICATION_COUNT";
877
878 /**
879 * The number associated with the missed calls. This number is only relevant
880 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700881 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700882 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
883 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
884
885 /**
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700886 * The intent to clear missed calls.
887 * @hide
888 */
889 @SystemApi
890 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
891 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
892
893 /**
894 * The intent to call back a missed call.
895 * @hide
896 */
897 @SystemApi
898 public static final String EXTRA_CALL_BACK_INTENT =
899 "android.telecom.extra.CALL_BACK_INTENT";
900
901 /**
Charles He858f1322017-11-27 17:11:04 -0800902 * The dialer activity responsible for placing emergency calls from, for example, a locked
903 * keyguard.
904 * @hide
905 */
906 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
907 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
908
909 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800910 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
911 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700912 * <p>
913 * The call initiator can use this extra to indicate that a call used assisted dialing to help
914 * place the call. This is most commonly used by a Dialer app which provides the ability to
915 * automatically add dialing prefixes when placing international calls.
916 * <p>
917 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800918 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
919 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700920 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
921 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
922 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800923 */
924 public static final String EXTRA_USE_ASSISTED_DIALING =
925 "android.telecom.extra.USE_ASSISTED_DIALING";
926
927 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800928 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
929 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800930 * Valid sources are:
931 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
932 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
933 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800934 *
Hall Liu2ef04112020-09-14 18:34:10 -0700935 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800936 * @hide
937 */
Hall Liu2ef04112020-09-14 18:34:10 -0700938 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800939 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
940
941 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800942 * Indicating the call is initiated via emergency dialer's shortcut button.
943 *
944 * @hide
945 */
Hall Liu2ef04112020-09-14 18:34:10 -0700946 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800947 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
948
949 /**
950 * Indicating the call is initiated via emergency dialer's dialpad.
951 *
952 * @hide
953 */
Hall Liu2ef04112020-09-14 18:34:10 -0700954 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800955 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
956
957 /**
958 * Indicating the call source is not specified.
959 *
960 * @hide
961 */
Hall Liu2ef04112020-09-14 18:34:10 -0700962 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800963 public static final int CALL_SOURCE_UNSPECIFIED = 0;
964
965 /**
Nancy Chen9d568c02014-09-08 14:17:59 -0700966 * The following 4 constants define how properties such as phone numbers and names are
967 * displayed to the user.
968 */
969
Santos Cordoned769ae2015-05-13 18:47:38 -0700970 /**
971 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -0800972 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700973 public static final int PRESENTATION_ALLOWED = 1;
974
Santos Cordoned769ae2015-05-13 18:47:38 -0700975 /**
976 * Indicates that the address or number of a call is blocked by the other party.
977 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700978 public static final int PRESENTATION_RESTRICTED = 2;
979
Santos Cordoned769ae2015-05-13 18:47:38 -0700980 /**
981 * Indicates that the address or number of a call is not specified or known by the carrier.
982 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700983 public static final int PRESENTATION_UNKNOWN = 3;
984
Santos Cordoned769ae2015-05-13 18:47:38 -0700985 /**
986 * Indicates that the address or number of a call belongs to a pay phone.
987 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700988 public static final int PRESENTATION_PAYPHONE = 4;
989
Grace Jiacc16b042021-08-09 09:06:11 -0700990 /**
991 * Indicates that the address or number of a call is unavailable.
992 */
993 public static final int PRESENTATION_UNAVAILABLE = 5;
994
Hall Liu4a9fde12020-01-16 17:38:46 -0800995
996 /*
997 * Values for the adb property "persist.radio.videocall.audio.output"
998 */
999 /** @hide */
1000 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1001 /** @hide */
1002 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1003 /** @hide */
1004 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1005
Tyler Gunn00d737b2019-10-31 13:04:37 -07001006 /** @hide */
1007 @Retention(RetentionPolicy.SOURCE)
1008 @IntDef(
1009 prefix = { "PRESENTATION_" },
1010 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001011 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001012 public @interface Presentation {}
1013
Brad Ebingera8366ae2021-03-23 21:01:51 +00001014
1015 /**
1016 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1017 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1018 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001019 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001020 */
1021 @ChangeId
1022 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1023 // this magic number is a bug ID
1024 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1025
Grace Jia3ad3cb72021-04-21 14:13:26 -07001026 /**
1027 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1028 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1029 * @hide
1030 */
1031 @ChangeId
1032 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1033 // bug ID
1034 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1035
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001036 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001037
Kevin Jeon767cda32020-11-17 01:40:16 +00001038
1039 /** Cached service handles, cleared by resetServiceCache() at death */
1040 private static final Object CACHE_LOCK = new Object();
1041
1042 @GuardedBy("CACHE_LOCK")
1043 private static ITelecomService sTelecomService;
1044 @GuardedBy("CACHE_LOCK")
1045 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1046
Yorke Leeb4ce1432014-06-09 13:53:23 -07001047 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001048
Hall Liue1bc2ec2015-10-09 15:58:37 -07001049 private final ITelecomService mTelecomServiceOverride;
1050
Santos Cordon6c7a3882014-06-25 15:30:08 -07001051 /**
1052 * @hide
1053 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001054 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001055 public static TelecomManager from(Context context) {
1056 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001057 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001058
1059 /**
1060 * @hide
1061 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001062 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001063 this(context, null);
1064 }
1065
1066 /**
1067 * @hide
1068 */
1069 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001070 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001071 if (appContext != null && Objects.equals(context.getAttributionTag(),
1072 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001073 mContext = appContext;
1074 } else {
1075 mContext = context;
1076 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001077 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001078 }
1079
1080 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001081 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1082 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1083 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1084 * account returned depends on the following priorities:
1085 * <ul>
1086 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1087 * be returned.
1088 * </li>
1089 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1090 * will be returned.
1091 * </li>
1092 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001093 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001094 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1095 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001096 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001097 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001098 */
Yorke Leec61d13662015-09-21 17:25:25 -07001099 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001100 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001101 ITelecomService service = getTelecomService();
1102 if (service != null) {
1103 try {
1104 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001105 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001106 } catch (RemoteException e) {
1107 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001108 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001109 }
1110 return null;
1111 }
1112
1113 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001114 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1115 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001116 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001117 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001118 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1119 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001120 * <p>
1121 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001122 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001123 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1124 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001125 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001126 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001127 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001128 ITelecomService service = getTelecomService();
1129 if (service != null) {
1130 try {
1131 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001132 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001133 } catch (RemoteException e) {
1134 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001135 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001136 }
1137 return null;
1138 }
1139
1140 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001141 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1142 *
1143 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001144 * outgoing voice calls, or {@code null} if no default is specified (the
1145 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001146 * @hide
1147 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001148 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1149 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001150 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001151 ITelecomService service = getTelecomService();
1152 if (service != null) {
1153 try {
1154 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1155 } catch (RemoteException e) {
1156 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001157 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001158 }
1159 }
1160
1161 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001162 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001163 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1164 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001165 *
Brad Ebingere7833312019-05-07 10:55:55 -07001166 * @return The phone account handle of the current sim call manager for the default voice
1167 * subscription.
1168 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001169 */
1170 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001171 ITelecomService service = getTelecomService();
1172 if (service != null) {
1173 try {
1174 return service.getSimCallManager(
Brad Ebingere7833312019-05-07 10:55:55 -07001175 SubscriptionManager.getDefaultSubscriptionId());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001176 } catch (RemoteException e) {
1177 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001178 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001179 }
1180 return null;
1181 }
1182
1183 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001184 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1185 * prepared for this method to return {@code null}, indicating that there currently exists no
1186 * SIM call manager {@link PhoneAccount} for the subscription specified.
1187 *
1188 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1189 * queried for.
1190 * @return The phone account handle of the current sim call manager.
1191 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001192 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001193 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001194 ITelecomService service = getTelecomService();
1195 if (service != null) {
1196 try {
1197 return service.getSimCallManager(subscriptionId);
1198 } catch (RemoteException e) {
1199 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001200 }
Brad Ebingere7833312019-05-07 10:55:55 -07001201 }
1202 return null;
1203 }
1204
1205 /**
1206 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1207 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1208 * must be prepared for this method to return {@code null}, indicating that there currently
1209 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001210 *
1211 * @return The phone account handle of the current sim call manager.
1212 *
1213 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001214 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001215 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001216 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001217 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001218 ITelecomService service = getTelecomService();
1219 if (service != null) {
1220 try {
1221 return service.getSimCallManagerForUser(userId);
1222 } catch (RemoteException e) {
1223 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001224 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001225 }
1226 return null;
1227 }
1228
1229 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001230 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001231 * {@code null}, indicating that there currently exists no Connection Manager
1232 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001233 *
1234 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001235 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001236 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001237 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001238 public PhoneAccountHandle getConnectionManager() {
1239 return getSimCallManager();
1240 }
1241
1242 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001243 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1244 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001245 * <P>
1246 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1247 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1248 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1249 * such as {@code sip:example@sipexample.com}).
1250 *
1251 * @param uriScheme The URI scheme.
1252 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001253 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001254 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001255 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001256 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001257 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001258 android.Manifest.permission.READ_PHONE_STATE
1259 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001260 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001261 ITelecomService service = getTelecomService();
1262 if (service != null) {
1263 try {
1264 return service.getPhoneAccountsSupportingScheme(uriScheme,
Svet Ganov16a16892015-04-16 10:32:04 -07001265 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001266 } catch (RemoteException e) {
1267 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001268 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001269 }
1270 return new ArrayList<>();
1271 }
1272
Nancy Chen513c8922014-09-17 14:47:20 -07001273
1274 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001275 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1276 * calls. The returned list includes only those accounts which have been explicitly enabled
1277 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001278 *
1279 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1280 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001281 */
Yorke Leec61d13662015-09-21 17:25:25 -07001282 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001283 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001284 return getCallCapablePhoneAccounts(false);
1285 }
1286
1287 /**
Tyler Gunn89317072017-04-07 14:57:37 -07001288 * Returns a list of {@link PhoneAccountHandle}s for self-managed {@link ConnectionService}s.
1289 * <p>
1290 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1291 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1292 * <p>
1293 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
1294 * is the default dialer app.
1295 * <p>
1296 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1297 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
1298 *
1299 * @return A list of {@code PhoneAccountHandle} objects.
1300 */
1301 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1302 public List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001303 ITelecomService service = getTelecomService();
1304 if (service != null) {
1305 try {
1306 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001307 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001308 } catch (RemoteException e) {
1309 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001310 }
Tyler Gunn89317072017-04-07 14:57:37 -07001311 }
1312 return new ArrayList<>();
1313 }
1314
1315 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001316 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1317 * by the user.
1318 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001319 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001320 * when {@code false}, only enabled phone accounts will be
1321 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001322 * @return A list of {@code PhoneAccountHandle} objects.
1323 * @hide
1324 */
Hall Liub2306242019-11-15 17:13:05 -08001325 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001326 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1327 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1328 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001329 ITelecomService service = getTelecomService();
1330 if (service != null) {
1331 try {
1332 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001333 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001334 } catch (RemoteException e) {
1335 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1336 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001337 }
Nancy Chen513c8922014-09-17 14:47:20 -07001338 }
1339 return new ArrayList<>();
1340 }
1341
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001342 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001343 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1344 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001345 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1346 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001347 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001348 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001349 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001350 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001351 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001352 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001353 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001354 ITelecomService service = getTelecomService();
1355 if (service != null) {
1356 try {
1357 return service.getPhoneAccountsForPackage(mContext.getPackageName());
1358 } catch (RemoteException e) {
1359 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001360 }
Nancy Chen513c8922014-09-17 14:47:20 -07001361 }
1362 return null;
1363 }
1364
1365 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001366 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1367 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001368 *
Grace Jia3ad3cb72021-04-21 14:13:26 -07001369 * Requires Permission:
1370 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1371 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001372 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001373 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001374 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001375 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001376 ITelecomService service = getTelecomService();
1377 if (service != null) {
1378 try {
Grace Jia3ad3cb72021-04-21 14:13:26 -07001379 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001380 } catch (RemoteException e) {
1381 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001382 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001383 }
1384 return null;
1385 }
1386
1387 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001388 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001389 *
Nancy Chen210ef032014-09-15 17:58:42 -07001390 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001391 * @hide
1392 */
1393 @SystemApi
1394 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001395 ITelecomService service = getTelecomService();
1396 if (service != null) {
1397 try {
1398 return service.getAllPhoneAccountsCount();
1399 } catch (RemoteException e) {
1400 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001401 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001402 }
1403 return 0;
1404 }
1405
1406 /**
1407 * Returns a list of all {@link PhoneAccount}s.
1408 *
1409 * @return All {@link PhoneAccount}s.
1410 * @hide
1411 */
1412 @SystemApi
1413 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001414 ITelecomService service = getTelecomService();
1415 if (service != null) {
1416 try {
1417 return service.getAllPhoneAccounts();
1418 } catch (RemoteException e) {
1419 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001420 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001421 }
1422 return Collections.EMPTY_LIST;
1423 }
1424
1425 /**
1426 * Returns a list of all {@link PhoneAccountHandle}s.
1427 *
1428 * @return All {@link PhoneAccountHandle}s.
1429 * @hide
1430 */
1431 @SystemApi
1432 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001433 ITelecomService service = getTelecomService();
1434 if (service != null) {
1435 try {
1436 return service.getAllPhoneAccountHandles();
1437 } catch (RemoteException e) {
1438 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001439 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001440 }
1441 return Collections.EMPTY_LIST;
1442 }
1443
1444 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001445 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1446 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1447 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001448 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1449 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1450 * the phone app settings before the account is usable.
1451 * <p>
1452 * A {@link SecurityException} will be thrown if an app tries to register a
1453 * {@link PhoneAccountHandle} where the package name specified within
1454 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001455 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001456 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001457 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001458 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001459 ITelecomService service = getTelecomService();
1460 if (service != null) {
1461 try {
1462 service.registerPhoneAccount(account);
1463 } catch (RemoteException e) {
1464 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001465 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001466 }
1467 }
1468
1469 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001470 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001471 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001472 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001473 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001474 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001475 ITelecomService service = getTelecomService();
1476 if (service != null) {
1477 try {
1478 service.unregisterPhoneAccount(accountHandle);
1479 } catch (RemoteException e) {
1480 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001481 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001482 }
1483 }
1484
1485 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001486 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001487 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001488 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001489 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001490 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001491 public void clearPhoneAccounts() {
1492 clearAccounts();
1493 }
1494 /**
1495 * Remove all Accounts that belong to the calling package from the system.
1496 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1497 * @hide
1498 */
1499 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001500 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001501 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001502 ITelecomService service = getTelecomService();
1503 if (service != null) {
1504 try {
1505 service.clearAccounts(mContext.getPackageName());
1506 } catch (RemoteException e) {
1507 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001508 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001509 }
1510 }
1511
1512 /**
Anthony Lee67279262014-10-27 11:28:40 -07001513 * Remove all Accounts that belong to the specified package from the system.
1514 * @hide
1515 */
1516 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001517 ITelecomService service = getTelecomService();
1518 if (service != null) {
1519 try {
1520 if (!TextUtils.isEmpty(packageName)) {
1521 service.clearAccounts(packageName);
1522 }
1523 } catch (RemoteException e) {
1524 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001525 }
Anthony Lee67279262014-10-27 11:28:40 -07001526 }
1527 }
1528
Yorke Lee1011f482015-04-23 15:58:27 -07001529
Anthony Lee67279262014-10-27 11:28:40 -07001530 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001531 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1532 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001533 * @hide
1534 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001535 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001536 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001537 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001538 ITelecomService service = getTelecomService();
1539 if (service != null) {
1540 try {
1541 return service.getDefaultPhoneApp();
1542 } catch (RemoteException e) {
1543 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001544 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001545 }
1546 return null;
1547 }
1548
Santos Cordon9eb45932014-06-27 12:28:43 -07001549 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001550 * Used to determine the currently selected default dialer package.
1551 *
1552 * @return package name for the default dialer package or null if no package has been
1553 * selected as the default dialer.
1554 */
1555 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001556 ITelecomService service = getTelecomService();
1557 if (service != null) {
1558 try {
1559 return service.getDefaultDialerPackage();
1560 } catch (RemoteException e) {
1561 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001562 }
Yorke Lee1011f482015-04-23 15:58:27 -07001563 }
1564 return null;
1565 }
1566
1567 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001568 * Used to determine the currently selected default dialer package for a specific user.
1569 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001570 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001571 * @return package name for the default dialer package or null if no package has been
1572 * selected as the default dialer.
1573 * @hide
1574 */
1575 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001576 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001577 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001578 ITelecomService service = getTelecomService();
1579 if (service != null) {
1580 try {
1581 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001582 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001583 } catch (RemoteException e) {
1584 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001585 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001586 }
1587 return null;
1588 }
1589
1590 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001591 * Used to set the default dialer package.
1592 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001593 * @param packageName to set the default dialer to, or {@code null} if the system provided
1594 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001595 *
1596 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1597 * the specified package does not correspond to an installed dialer, or is already
1598 * the default dialer.
1599 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001600 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001601 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001602 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1603 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001604 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001605 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001606 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001607 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001608 @RequiresPermission(allOf = {
1609 android.Manifest.permission.MODIFY_PHONE_STATE,
1610 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001611 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001612 ITelecomService service = getTelecomService();
1613 if (service != null) {
1614 try {
1615 return service.setDefaultDialer(packageName);
1616 } catch (RemoteException e) {
1617 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001618 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001619 }
1620 return false;
1621 }
1622
1623 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001624 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001625 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001626 * @return package name for the system dialer package or {@code null} if no system dialer is
1627 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001628 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001629 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001630 ITelecomService service = getTelecomService();
1631 if (service != null) {
1632 try {
1633 return service.getSystemDialerPackage();
1634 } catch (RemoteException e) {
1635 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001636 }
Yorke Lee1011f482015-04-23 15:58:27 -07001637 }
1638 return null;
1639 }
1640
1641 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001642 * Return whether a given phone number is the configured voicemail number for a
1643 * particular phone account.
1644 *
1645 * @param accountHandle The handle for the account to check the voicemail number against
1646 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001647 */
Yorke Leec61d13662015-09-21 17:25:25 -07001648 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001649 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001650 ITelecomService service = getTelecomService();
1651 if (service != null) {
1652 try {
1653 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001654 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001655 } catch (RemoteException e) {
1656 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001657 }
Nancy Chen443e5012014-10-15 15:48:21 -07001658 }
1659 return false;
1660 }
1661
1662 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001663 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001664 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001665 * @param accountHandle The handle for the phone account.
1666 * @return The voicemail number for the phone account, and {@code null} if one has not been
1667 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001668 */
Yorke Leec61d13662015-09-21 17:25:25 -07001669 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001670 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001671 ITelecomService service = getTelecomService();
1672 if (service != null) {
1673 try {
1674 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001675 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001676 } catch (RemoteException e) {
1677 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001678 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001679 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001680 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001681 }
1682
1683 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001684 * Return the line 1 phone number for given phone account.
1685 *
Michael Groover08490f12020-03-24 14:08:14 -07001686 * <p>Requires Permission:
1687 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1688 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1689 * or that the caller is the default SMS app for any API level.
1690 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1691 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001692 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001693 * @param accountHandle The handle for the account retrieve a number for.
1694 * @return A string representation of the line 1 phone number.
Nancy Chen5cf27842015-01-24 23:30:27 -08001695 */
Michael Groover08490f12020-03-24 14:08:14 -07001696 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1697 @RequiresPermission(anyOf = {
1698 android.Manifest.permission.READ_PHONE_STATE,
1699 android.Manifest.permission.READ_SMS,
1700 android.Manifest.permission.READ_PHONE_NUMBERS
1701 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001702 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001703 ITelecomService service = getTelecomService();
1704 if (service != null) {
1705 try {
1706 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001707 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001708 } catch (RemoteException e) {
1709 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001710 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001711 }
1712 return null;
1713 }
1714
1715 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001716 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001717 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001718 *
1719 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1720 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001721 */
Yorke Leec61d13662015-09-21 17:25:25 -07001722 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001723 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001724 ITelecomService service = getTelecomService();
1725 if (service != null) {
1726 try {
1727 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001728 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001729 } catch (RemoteException e) {
1730 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001731 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001732 }
1733 return false;
1734 }
1735
1736 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001737 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1738 * permission. The permission can be obtained by associating with a physical wearable device
1739 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1740 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001741 *
1742 * @return {@code true} if the caller has {@link InCallService} access for
1743 * companion app; {@code false} otherwise.
1744 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001745 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001746 ITelecomService service = getTelecomService();
1747 if (service != null) {
1748 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001749 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001750 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001751 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001752 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001753 if (!isSystemProcess()) {
1754 e.rethrowAsRuntimeException();
1755 }
Shuo Qian4d065262020-10-20 11:04:28 -07001756 }
1757 }
1758 return false;
1759 }
1760
1761 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001762 * Returns whether there is an ongoing call originating from a managed
1763 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1764 * states.
1765 * <p>
1766 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1767 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001768 *
1769 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1770 * {@code false} otherwise.
1771 */
1772 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1773 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001774 ITelecomService service = getTelecomService();
1775 if (service != null) {
1776 try {
1777 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001778 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001779 } catch (RemoteException e) {
1780 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001781 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001782 }
1783 return false;
1784 }
1785
1786 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001787 * Returns one of the following constants that represents the current state of Telecom:
1788 *
1789 * {@link TelephonyManager#CALL_STATE_RINGING}
1790 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1791 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001792 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001793 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001794 * <p>
1795 * Requires Permission:
1796 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1797 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001798 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001799 * @hide
1800 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001801 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1802 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001803 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001804 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001805 ITelecomService service = getTelecomService();
1806 if (service != null) {
1807 try {
Brad Ebingera8366ae2021-03-23 21:01:51 +00001808 return service.getCallStateUsingPackage(mContext.getPackageName(),
1809 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001810 } catch (RemoteException e) {
1811 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001812 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001813 }
1814 return TelephonyManager.CALL_STATE_IDLE;
1815 }
1816
1817 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001818 * Returns whether there currently exists is a ringing incoming-call.
1819 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001820 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001821 * @hide
1822 */
1823 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001824 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001825 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001826 android.Manifest.permission.READ_PHONE_STATE
1827 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001828 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001829 ITelecomService service = getTelecomService();
1830 if (service != null) {
1831 try {
1832 return service.isRinging(mContext.getOpPackageName());
1833 } catch (RemoteException e) {
1834 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001835 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001836 }
1837 return false;
1838 }
1839
1840 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001841 * Ends the foreground call on the device.
1842 * <p>
1843 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1844 * foreground call is ended.
1845 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001846 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1847 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001848 *
1849 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1850 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001851 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1852 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1853 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001854 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001855 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001856 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001857 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001858 ITelecomService service = getTelecomService();
1859 if (service != null) {
1860 try {
1861 return service.endCall(mContext.getPackageName());
1862 } catch (RemoteException e) {
1863 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001864 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001865 }
1866 return false;
1867 }
1868
1869 /**
1870 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001871 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001872 * If the incoming call is a video call, the call will be answered with the same video state as
1873 * the incoming call requests. This means, for example, that an incoming call requesting
1874 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001875 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001876 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1877 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001878 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001879 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1880 // this method (clockwork & gearhead).
1881 @RequiresPermission(anyOf =
1882 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001883 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001884 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001885 ITelecomService service = getTelecomService();
1886 if (service != null) {
1887 try {
1888 service.acceptRingingCall(mContext.getPackageName());
1889 } catch (RemoteException e) {
1890 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001891 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001892 }
1893 }
1894
1895 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001896 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1897 * with the specified video state.
1898 *
1899 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001900 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1901 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001902 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001903 @RequiresPermission(anyOf =
1904 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001905 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07001906 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001907 ITelecomService service = getTelecomService();
1908 if (service != null) {
1909 try {
1910 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001911 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001912 } catch (RemoteException e) {
1913 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001914 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07001915 }
1916 }
1917
1918 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001919 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07001920 * <p>
1921 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
1922 * already started playing. It is intended to handle use-cases such as silencing a ringing call
1923 * when the user presses the volume button during ringing.
1924 * <p>
1925 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
1926 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
1927 * <p>
1928 * A dialer app which wants to have more control over ringtone playing should declare
1929 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
1930 * {@link InCallService} implementation to indicate that the app wants to be responsible for
1931 * playing the ringtone for all incoming calls.
1932 * <p>
1933 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
1934 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07001935 */
Yorke Leec61d13662015-09-21 17:25:25 -07001936 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07001937 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001938 ITelecomService service = getTelecomService();
1939 if (service != null) {
1940 try {
1941 service.silenceRinger(mContext.getOpPackageName());
1942 } catch (RemoteException e) {
1943 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001944 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001945 }
1946 }
1947
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001948 /**
1949 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001950 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001951 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001952 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001953 android.Manifest.permission.READ_PHONE_STATE
1954 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001955 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001956 ITelecomService service = getTelecomService();
1957 if (service != null) {
1958 try {
1959 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001960 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001961 } catch (RemoteException e) {
1962 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001963 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001964 }
1965 return false;
1966 }
1967
1968 /**
1969 * 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 -07001970 * settings and have a wired headset plugged in.
1971 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001972 * - {@link TelecomManager#TTY_MODE_OFF}
1973 * - {@link TelecomManager#TTY_MODE_FULL}
1974 * - {@link TelecomManager#TTY_MODE_HCO}
1975 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001976 * @hide
1977 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001978 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001979 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001980 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001981 ITelecomService service = getTelecomService();
1982 if (service != null) {
1983 try {
1984 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001985 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001986 } catch (RemoteException e) {
1987 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001988 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001989 }
Evan Charlton10197192014-07-19 15:00:29 -07001990 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001991 }
1992
Santos Cordon96efb482014-07-19 14:57:05 -07001993 /**
1994 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08001995 * has an incoming call. For managed {@link ConnectionService}s, the specified
1996 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
1997 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
1998 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
1999 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2000 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002001 * The incoming call you are adding is assumed to have a video state of
2002 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2003 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2004 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002005 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2006 * associated with the {@link PhoneAccountHandle} and request additional information about the
2007 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002008 * call UI.
2009 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002010 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2011 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2012 * the associated {@link PhoneAccount} is not currently enabled by the user.
2013 * <p>
2014 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2015 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2016 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2017 *
Santos Cordon96efb482014-07-19 14:57:05 -07002018 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2019 * {@link #registerPhoneAccount}.
2020 * @param extras A bundle that will be passed through to
2021 * {@link ConnectionService#onCreateIncomingConnection}.
2022 */
2023 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002024 ITelecomService service = getTelecomService();
2025 if (service != null) {
2026 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002027 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2028 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2029 Build.VERSION_CODES.O_MR1) {
2030 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2031 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002032 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002033 }
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002034 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras);
2035 } catch (RemoteException e) {
2036 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002037 }
Santos Cordon96efb482014-07-19 14:57:05 -07002038 }
2039 }
2040
Nancy Chen0eb1e402014-08-21 22:52:29 -07002041 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302042 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002043 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2044 * call initiated on another device which the user is being invited to join in. For managed
2045 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2046 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2047 * corresponding {@link PhoneAccount}. This can be checked using
2048 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2049 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302050 * <p>
2051 * The incoming conference you are adding is assumed to have a video state of
2052 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2053 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2054 * <p>
2055 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2056 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002057 * call (See
2058 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2059 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302060 * <p>
2061 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2062 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2063 * the associated {@link PhoneAccount} is not currently enabled by the user.
2064 *
2065 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2066 * {@link #registerPhoneAccount}.
2067 * @param extras A bundle that will be passed through to
2068 * {@link ConnectionService#onCreateIncomingConference}.
2069 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302070 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2071 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002072 ITelecomService service = getTelecomService();
2073 if (service != null) {
2074 try {
2075 service.addNewIncomingConference(
Ravi Paluri80aa2142019-12-02 11:57:37 +05302076 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002077 } catch (RemoteException e) {
2078 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302079 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302080 }
2081 }
2082
2083 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002084 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2085 * service. This is invoked when Telephony detects a new unknown connection that was neither
2086 * a new incoming call, nor an user-initiated outgoing call.
2087 *
2088 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2089 * {@link #registerPhoneAccount}.
2090 * @param extras A bundle that will be passed through to
2091 * {@link ConnectionService#onCreateIncomingConnection}.
2092 * @hide
2093 */
2094 @SystemApi
2095 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002096 ITelecomService service = getTelecomService();
2097 if (service != null) {
2098 try {
2099 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002100 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002101 } catch (RemoteException e) {
2102 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002103 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002104 }
2105 }
2106
2107 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002108 * Processes the specified dial string as an MMI code.
2109 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2110 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002111 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002112 * <p>
2113 * Requires that the method-caller be set as the system dialer app.
2114 * </p>
2115 *
2116 * @param dialString The digits to dial.
2117 * @return True if the digits were processed as an MMI code, false otherwise.
2118 */
Yorke Leec61d13662015-09-21 17:25:25 -07002119 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002120 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002121 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002122 if (service != null) {
2123 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002124 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002125 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002126 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002127 }
2128 }
2129 return false;
2130 }
2131
2132 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002133 * Processes the specified dial string as an MMI code.
2134 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2135 * Some of these sequences launch special behavior through handled by Telephony.
2136 * <p>
2137 * Requires that the method-caller be set as the system dialer app.
2138 * </p>
2139 *
2140 * @param accountHandle The handle for the account the MMI code should apply to.
2141 * @param dialString The digits to dial.
2142 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002143 */
Yorke Leec61d13662015-09-21 17:25:25 -07002144 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002145 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002146 ITelecomService service = getTelecomService();
2147 if (service != null) {
2148 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002149 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2150 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002151 } catch (RemoteException e) {
2152 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2153 }
2154 }
2155 return false;
2156 }
2157
2158 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002159 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2160 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002161 * @param accountHandle The handle for the account to derive an adn query URI for or
2162 * {@code null} to return a URI which will use the default account.
2163 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2164 * for the the content retrieve.
2165 */
Yorke Leec61d13662015-09-21 17:25:25 -07002166 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002167 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2168 ITelecomService service = getTelecomService();
2169 if (service != null && accountHandle != null) {
2170 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002171 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002172 } catch (RemoteException e) {
2173 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2174 }
2175 }
2176 return Uri.parse("content://icc/adn");
2177 }
2178
2179 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002180 * Removes the missed-call notification if one is present.
2181 * <p>
2182 * Requires that the method-caller be set as the system dialer app.
2183 * </p>
2184 */
Yorke Leec61d13662015-09-21 17:25:25 -07002185 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002186 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002187 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002188 if (service != null) {
2189 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002190 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002191 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002192 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002193 }
2194 }
2195 }
2196
2197 /**
2198 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2199 * currently no ongoing call, then this method does nothing.
2200 * <p>
2201 * Requires that the method-caller be set as the system dialer app or have the
2202 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2203 * </p>
2204 *
2205 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2206 */
Yorke Leec61d13662015-09-21 17:25:25 -07002207 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002208 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002209 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002210 if (service != null) {
2211 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002212 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002213 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002214 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002215 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002216 }
2217 }
2218 }
2219
Yorke Lee3e56ba12015-04-23 12:32:36 -07002220 /**
2221 * Places a new outgoing call to the provided address using the system telecom service with
2222 * the specified extras.
2223 *
2224 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2225 * except that the outgoing call will always be sent via the system telecom service. If
2226 * method-caller is either the user selected default dialer app or preloaded system dialer
2227 * app, then emergency calls will also be allowed.
2228 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002229 * Placing a call via a managed {@link ConnectionService} requires permission:
2230 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002231 *
2232 * Usage example:
2233 * <pre>
2234 * Uri uri = Uri.fromParts("tel", "12345", null);
2235 * Bundle extras = new Bundle();
2236 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2237 * telecomManager.placeCall(uri, extras);
2238 * </pre>
2239 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002240 * The following keys are supported in the supplied extras.
2241 * <ul>
2242 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2243 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2244 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2245 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2246 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002247 * <p>
2248 * An app which implements the self-managed {@link ConnectionService} API uses
2249 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2250 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2251 * associated {@link android.telecom.PhoneAccountHandle}.
2252 *
2253 * Self-managed {@link ConnectionService}s require permission
2254 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002255 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002256 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2257 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2258 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2259 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2260 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2261 * </p>
2262 *
Yorke Lee3e56ba12015-04-23 12:32:36 -07002263 * @param address The address to make the call to.
2264 * @param extras Bundle of extras to use with the call.
2265 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002266 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2267 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002268 public void placeCall(Uri address, Bundle extras) {
2269 ITelecomService service = getTelecomService();
2270 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002271 if (address == null) {
2272 Log.w(TAG, "Cannot place call to empty address.");
2273 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002274 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002275 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002276 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002277 } catch (RemoteException e) {
2278 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2279 }
2280 }
2281 }
2282
Ravi Paluri80aa2142019-12-02 11:57:37 +05302283
2284 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002285 * Place a new adhoc conference call with the provided participants using the system telecom
2286 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302287 *
2288 * An adhoc conference call is established by providing a list of addresses to
2289 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2290 * {@link ConnectionService} is responsible for connecting all indicated participants
2291 * to a conference simultaneously.
2292 * This is in contrast to conferences formed by merging calls together (e.g. using
2293 * {@link android.telecom.Call#mergeConference()}).
2294 *
2295 * The following keys are supported in the supplied extras.
2296 * <ul>
2297 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2298 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2299 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2300 * </ul>
2301 *
2302 * @param participants List of participants to start conference with
2303 * @param extras Bundle of extras to use with the call
2304 */
2305 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2306 public void startConference(@NonNull List<Uri> participants,
2307 @NonNull Bundle extras) {
2308 ITelecomService service = getTelecomService();
2309 if (service != null) {
2310 try {
2311 service.startConference(participants, extras,
2312 mContext.getOpPackageName());
2313 } catch (RemoteException e) {
2314 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2315 }
2316 }
2317 }
2318
Santos Cordon91371dc02015-05-08 13:52:09 -07002319 /**
2320 * Enables and disables specified phone account.
2321 *
2322 * @param handle Handle to the phone account.
2323 * @param isEnabled Enable state of the phone account.
2324 * @hide
2325 */
2326 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002327 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002328 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2329 ITelecomService service = getTelecomService();
2330 if (service != null) {
2331 try {
2332 service.enablePhoneAccount(handle, isEnabled);
2333 } catch (RemoteException e) {
2334 Log.e(TAG, "Error enablePhoneAbbount", e);
2335 }
2336 }
2337 }
2338
Hall Liu0464b9b2016-01-12 15:32:58 -08002339 /**
2340 * Dumps telecom analytics for uploading.
2341 *
2342 * @return
2343 * @hide
2344 */
2345 @SystemApi
2346 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002347 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002348 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002349 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002350 if (service != null) {
2351 try {
2352 result = service.dumpCallAnalytics();
2353 } catch (RemoteException e) {
2354 Log.e(TAG, "Error dumping call analytics", e);
2355 }
2356 }
2357 return result;
2358 }
2359
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002360 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002361 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2362 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002363 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002364 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2365 * {@code true} for the current user.
2366 */
2367 public Intent createManageBlockedNumbersIntent() {
2368 ITelecomService service = getTelecomService();
2369 Intent result = null;
2370 if (service != null) {
2371 try {
2372 result = service.createManageBlockedNumbersIntent();
2373 } catch (RemoteException e) {
2374 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2375 }
2376 }
2377 return result;
2378 }
2379
Fan Zhang5431ef52019-10-14 13:43:46 -07002380
2381 /**
2382 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2383 * launch the activity for emergency dialer.
2384 *
2385 * @param number Optional number to call in emergency dialer
2386 * @hide
2387 */
2388 @SystemApi
2389 @NonNull
2390 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2391 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002392 if (service != null) {
2393 try {
Tyler Gunn753aa102020-04-23 10:16:26 -07002394 return service.createLaunchEmergencyDialerIntent(number);
Fan Zhang5431ef52019-10-14 13:43:46 -07002395 } catch (RemoteException e) {
2396 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2397 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002398 } else {
2399 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002400 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002401
2402 // Telecom service knows the package name of the expected emergency dialer package; if it
2403 // is not available, then fallback to not targeting a specific package.
2404 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2405 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2406 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2407 }
2408 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002409 }
2410
Tyler Gunnf5035432017-01-09 09:43:12 -08002411 /**
2412 * Determines whether Telecom would permit an incoming call to be added via the
2413 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2414 * {@link PhoneAccountHandle}.
2415 * <p>
2416 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2417 * in the following situations:
2418 * <ul>
2419 * <li>{@link PhoneAccount} does not have property
2420 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2421 * {@link ConnectionService}), and the active or held call limit has
2422 * been reached.</li>
2423 * <li>There is an ongoing emergency call.</li>
2424 * </ul>
2425 *
2426 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2427 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2428 * otherwise.
2429 */
2430 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002431 if (phoneAccountHandle == null) {
2432 return false;
2433 }
2434
Tyler Gunnf5035432017-01-09 09:43:12 -08002435 ITelecomService service = getTelecomService();
2436 if (service != null) {
2437 try {
2438 return service.isIncomingCallPermitted(phoneAccountHandle);
2439 } catch (RemoteException e) {
2440 Log.e(TAG, "Error isIncomingCallPermitted", e);
2441 }
2442 }
2443 return false;
2444 }
2445
2446 /**
2447 * Determines whether Telecom would permit an outgoing call to be placed via the
2448 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2449 * <p>
2450 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2451 * in the following situations:
2452 * <ul>
2453 * <li>{@link PhoneAccount} does not have property
2454 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2455 * {@link ConnectionService}), and the active, held or ringing call limit has
2456 * been reached.</li>
2457 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2458 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2459 * another {@link ConnectionService}.</li>
2460 * <li>There is an ongoing emergency call.</li>
2461 * </ul>
2462 *
2463 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2464 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2465 * otherwise.
2466 */
2467 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2468 ITelecomService service = getTelecomService();
2469 if (service != null) {
2470 try {
2471 return service.isOutgoingCallPermitted(phoneAccountHandle);
2472 } catch (RemoteException e) {
2473 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2474 }
2475 }
2476 return false;
2477 }
2478
Sanket Padawea8eddd42017-11-03 11:07:35 -07002479 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002480 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2481 * {@link PhoneAccountHandle} it defines.
2482 * <p>
2483 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2484 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2485 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2486 * is referred to as the source of the handover, and the video calling app is referred to as the
2487 * destination.
2488 * <p>
2489 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2490 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2491 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2492 * device.
2493 * <p>
2494 * For a full discussion of the handover process and the APIs involved, see
2495 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2496 * <p>
2497 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2498 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002499 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2500 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2501 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2502 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2503 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2504 * <p>
2505 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2506 * associated with the {@link PhoneAccountHandle} destAcct and call
2507 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2508 * <p>
2509 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2510 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2511 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2512 * user.
2513 * <p>
2514 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2515 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2516 *
2517 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2518 * {@link ConnectionService}.
2519 * @param videoState Video state after the handover.
2520 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2521 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002522 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2523 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002524 ITelecomService service = getTelecomService();
2525 if (service != null) {
2526 try {
2527 service.acceptHandover(srcAddr, videoState, destAcct);
2528 } catch (RemoteException e) {
2529 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002530 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002531 }
2532 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002533
Tyler Gunn5bd90852018-09-21 09:37:07 -07002534 /**
2535 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2536 * call, as identified by the dialed number, or because a call was identified by the network
2537 * as an emergency call.
2538 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2539 * @hide
2540 */
2541 @SystemApi
2542 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2543 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002544 ITelecomService service = getTelecomService();
2545 if (service != null) {
2546 try {
2547 return service.isInEmergencyCall();
2548 } catch (RemoteException e) {
2549 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2550 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002551 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002552 }
2553 return false;
2554 }
2555
Tyler Gunnc37445c2018-09-28 16:16:20 -07002556 /**
2557 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2558 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002559 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002560 * @hide
2561 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002562 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002563 ITelecomService service = getTelecomService();
2564 if (service != null) {
2565 try {
2566 service.handleCallIntent(intent, callingPackageProxy);
2567 } catch (RemoteException e) {
2568 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002569 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002570 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002571 }
2572
Shuo Qian4d065262020-10-20 11:04:28 -07002573 private boolean isSystemProcess() {
2574 return Process.myUid() == Process.SYSTEM_UID;
2575 }
2576
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002577 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002578 if (mTelecomServiceOverride != null) {
2579 return mTelecomServiceOverride;
2580 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002581 if (sTelecomService == null) {
2582 ITelecomService temp = ITelecomService.Stub.asInterface(
2583 ServiceManager.getService(Context.TELECOM_SERVICE));
2584 synchronized (CACHE_LOCK) {
2585 if (sTelecomService == null && temp != null) {
2586 try {
2587 sTelecomService = temp;
2588 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2589 } catch (Exception e) {
2590 sTelecomService = null;
2591 }
2592 }
2593 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002594 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002595 return sTelecomService;
2596 }
2597
2598 private static class DeathRecipient implements IBinder.DeathRecipient {
2599 @Override
2600 public void binderDied() {
2601 resetServiceCache();
2602 }
2603 }
2604
2605 private static void resetServiceCache() {
2606 synchronized (CACHE_LOCK) {
2607 if (sTelecomService != null) {
2608 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2609 sTelecomService = null;
2610 }
2611 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002612 }
Evan Charlton235c1592014-09-05 15:41:23 +00002613}