blob: e000265f0a2c61936a7c2a30958818980fb7c524 [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
Hall Liu4a9fde12020-01-16 17:38:46 -0800990
991 /*
992 * Values for the adb property "persist.radio.videocall.audio.output"
993 */
994 /** @hide */
995 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
996 /** @hide */
997 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
998 /** @hide */
999 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1000
Tyler Gunn00d737b2019-10-31 13:04:37 -07001001 /** @hide */
1002 @Retention(RetentionPolicy.SOURCE)
1003 @IntDef(
1004 prefix = { "PRESENTATION_" },
1005 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
1006 PRESENTATION_PAYPHONE})
1007 public @interface Presentation {}
1008
Brad Ebingera8366ae2021-03-23 21:01:51 +00001009
1010 /**
1011 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1012 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1013 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001014 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001015 */
1016 @ChangeId
1017 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1018 // this magic number is a bug ID
1019 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1020
Grace Jiab13eb2c2021-04-21 14:13:26 -07001021 /**
1022 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1023 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1024 * @hide
1025 */
1026 @ChangeId
1027 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1028 // bug ID
1029 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1030
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001031 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001032
Kevin Jeon767cda32020-11-17 01:40:16 +00001033
1034 /** Cached service handles, cleared by resetServiceCache() at death */
1035 private static final Object CACHE_LOCK = new Object();
1036
1037 @GuardedBy("CACHE_LOCK")
1038 private static ITelecomService sTelecomService;
1039 @GuardedBy("CACHE_LOCK")
1040 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1041
Yorke Leeb4ce1432014-06-09 13:53:23 -07001042 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001043
Hall Liue1bc2ec2015-10-09 15:58:37 -07001044 private final ITelecomService mTelecomServiceOverride;
1045
Santos Cordon6c7a3882014-06-25 15:30:08 -07001046 /**
1047 * @hide
1048 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001049 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001050 public static TelecomManager from(Context context) {
1051 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001052 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001053
1054 /**
1055 * @hide
1056 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001057 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001058 this(context, null);
1059 }
1060
1061 /**
1062 * @hide
1063 */
1064 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001065 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001066 if (appContext != null && Objects.equals(context.getAttributionTag(),
1067 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001068 mContext = appContext;
1069 } else {
1070 mContext = context;
1071 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001072 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001073 }
1074
1075 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001076 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1077 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1078 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1079 * account returned depends on the following priorities:
1080 * <ul>
1081 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1082 * be returned.
1083 * </li>
1084 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1085 * will be returned.
1086 * </li>
1087 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001088 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001089 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1090 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001091 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001092 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001093 */
Yorke Leec61d13662015-09-21 17:25:25 -07001094 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001095 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001096 ITelecomService service = getTelecomService();
1097 if (service != null) {
1098 try {
1099 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001100 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001101 } catch (RemoteException e) {
1102 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001103 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001104 }
1105 return null;
1106 }
1107
1108 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001109 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1110 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001111 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001112 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001113 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1114 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001115 * <p>
1116 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001117 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001118 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1119 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001120 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001121 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001122 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001123 ITelecomService service = getTelecomService();
1124 if (service != null) {
1125 try {
1126 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001127 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001128 } catch (RemoteException e) {
1129 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001130 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001131 }
1132 return null;
1133 }
1134
1135 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001136 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1137 *
1138 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001139 * outgoing voice calls, or {@code null} if no default is specified (the
1140 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001141 * @hide
1142 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001143 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1144 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001145 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001146 ITelecomService service = getTelecomService();
1147 if (service != null) {
1148 try {
1149 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1150 } catch (RemoteException e) {
1151 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001152 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001153 }
1154 }
1155
1156 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001157 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001158 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1159 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001160 *
Brad Ebingere7833312019-05-07 10:55:55 -07001161 * @return The phone account handle of the current sim call manager for the default voice
1162 * subscription.
1163 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001164 */
1165 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001166 ITelecomService service = getTelecomService();
1167 if (service != null) {
1168 try {
1169 return service.getSimCallManager(
Brad Ebingere7833312019-05-07 10:55:55 -07001170 SubscriptionManager.getDefaultSubscriptionId());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001171 } catch (RemoteException e) {
1172 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001173 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001174 }
1175 return null;
1176 }
1177
1178 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001179 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1180 * prepared for this method to return {@code null}, indicating that there currently exists no
1181 * SIM call manager {@link PhoneAccount} for the subscription specified.
1182 *
1183 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1184 * queried for.
1185 * @return The phone account handle of the current sim call manager.
1186 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001187 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001188 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001189 ITelecomService service = getTelecomService();
1190 if (service != null) {
1191 try {
1192 return service.getSimCallManager(subscriptionId);
1193 } catch (RemoteException e) {
1194 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001195 }
Brad Ebingere7833312019-05-07 10:55:55 -07001196 }
1197 return null;
1198 }
1199
1200 /**
1201 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1202 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1203 * must be prepared for this method to return {@code null}, indicating that there currently
1204 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001205 *
1206 * @return The phone account handle of the current sim call manager.
1207 *
1208 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001209 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001210 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001211 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001212 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001213 ITelecomService service = getTelecomService();
1214 if (service != null) {
1215 try {
1216 return service.getSimCallManagerForUser(userId);
1217 } catch (RemoteException e) {
1218 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001219 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001220 }
1221 return null;
1222 }
1223
1224 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001225 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001226 * {@code null}, indicating that there currently exists no Connection Manager
1227 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001228 *
1229 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001230 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001231 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001232 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001233 public PhoneAccountHandle getConnectionManager() {
1234 return getSimCallManager();
1235 }
1236
1237 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001238 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1239 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001240 * <P>
1241 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1242 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1243 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1244 * such as {@code sip:example@sipexample.com}).
1245 *
1246 * @param uriScheme The URI scheme.
1247 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001248 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001249 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001250 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001251 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001252 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001253 android.Manifest.permission.READ_PHONE_STATE
1254 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001255 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001256 ITelecomService service = getTelecomService();
1257 if (service != null) {
1258 try {
1259 return service.getPhoneAccountsSupportingScheme(uriScheme,
Svet Ganov16a16892015-04-16 10:32:04 -07001260 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001261 } catch (RemoteException e) {
1262 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001263 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001264 }
1265 return new ArrayList<>();
1266 }
1267
Nancy Chen513c8922014-09-17 14:47:20 -07001268
1269 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001270 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1271 * calls. The returned list includes only those accounts which have been explicitly enabled
1272 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001273 *
1274 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1275 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001276 */
Yorke Leec61d13662015-09-21 17:25:25 -07001277 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001278 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001279 return getCallCapablePhoneAccounts(false);
1280 }
1281
1282 /**
Tyler Gunn89317072017-04-07 14:57:37 -07001283 * Returns a list of {@link PhoneAccountHandle}s for self-managed {@link ConnectionService}s.
1284 * <p>
1285 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1286 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1287 * <p>
1288 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
1289 * is the default dialer app.
1290 * <p>
1291 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1292 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
1293 *
1294 * @return A list of {@code PhoneAccountHandle} objects.
1295 */
1296 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1297 public List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001298 ITelecomService service = getTelecomService();
1299 if (service != null) {
1300 try {
1301 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001302 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001303 } catch (RemoteException e) {
1304 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001305 }
Tyler Gunn89317072017-04-07 14:57:37 -07001306 }
1307 return new ArrayList<>();
1308 }
1309
1310 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001311 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1312 * by the user.
1313 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001314 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001315 * when {@code false}, only enabled phone accounts will be
1316 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001317 * @return A list of {@code PhoneAccountHandle} objects.
1318 * @hide
1319 */
Hall Liub2306242019-11-15 17:13:05 -08001320 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001321 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1322 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1323 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001324 ITelecomService service = getTelecomService();
1325 if (service != null) {
1326 try {
1327 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001328 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001329 } catch (RemoteException e) {
1330 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1331 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001332 }
Nancy Chen513c8922014-09-17 14:47:20 -07001333 }
1334 return new ArrayList<>();
1335 }
1336
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001337 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001338 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1339 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001340 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1341 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001342 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001343 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001344 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001345 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001346 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001347 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001348 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001349 ITelecomService service = getTelecomService();
1350 if (service != null) {
1351 try {
1352 return service.getPhoneAccountsForPackage(mContext.getPackageName());
1353 } catch (RemoteException e) {
1354 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001355 }
Nancy Chen513c8922014-09-17 14:47:20 -07001356 }
1357 return null;
1358 }
1359
1360 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001361 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1362 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001363 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001364 * Requires Permission:
1365 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1366 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001367 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001368 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001369 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001370 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001371 ITelecomService service = getTelecomService();
1372 if (service != null) {
1373 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001374 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001375 } catch (RemoteException e) {
1376 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001377 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001378 }
1379 return null;
1380 }
1381
1382 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001383 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001384 *
Nancy Chen210ef032014-09-15 17:58:42 -07001385 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001386 * @hide
1387 */
1388 @SystemApi
1389 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001390 ITelecomService service = getTelecomService();
1391 if (service != null) {
1392 try {
1393 return service.getAllPhoneAccountsCount();
1394 } catch (RemoteException e) {
1395 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001396 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001397 }
1398 return 0;
1399 }
1400
1401 /**
1402 * Returns a list of all {@link PhoneAccount}s.
1403 *
1404 * @return All {@link PhoneAccount}s.
1405 * @hide
1406 */
1407 @SystemApi
1408 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001409 ITelecomService service = getTelecomService();
1410 if (service != null) {
1411 try {
1412 return service.getAllPhoneAccounts();
1413 } catch (RemoteException e) {
1414 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001415 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001416 }
1417 return Collections.EMPTY_LIST;
1418 }
1419
1420 /**
1421 * Returns a list of all {@link PhoneAccountHandle}s.
1422 *
1423 * @return All {@link PhoneAccountHandle}s.
1424 * @hide
1425 */
1426 @SystemApi
1427 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001428 ITelecomService service = getTelecomService();
1429 if (service != null) {
1430 try {
1431 return service.getAllPhoneAccountHandles();
1432 } catch (RemoteException e) {
1433 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001434 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001435 }
1436 return Collections.EMPTY_LIST;
1437 }
1438
1439 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001440 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1441 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1442 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001443 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1444 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1445 * the phone app settings before the account is usable.
1446 * <p>
1447 * A {@link SecurityException} will be thrown if an app tries to register a
1448 * {@link PhoneAccountHandle} where the package name specified within
1449 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001450 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001451 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001452 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001453 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001454 ITelecomService service = getTelecomService();
1455 if (service != null) {
1456 try {
1457 service.registerPhoneAccount(account);
1458 } catch (RemoteException e) {
1459 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001460 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001461 }
1462 }
1463
1464 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001465 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001466 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001467 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001468 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001469 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001470 ITelecomService service = getTelecomService();
1471 if (service != null) {
1472 try {
1473 service.unregisterPhoneAccount(accountHandle);
1474 } catch (RemoteException e) {
1475 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001476 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001477 }
1478 }
1479
1480 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001481 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001482 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001483 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001484 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001485 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001486 public void clearPhoneAccounts() {
1487 clearAccounts();
1488 }
1489 /**
1490 * Remove all Accounts that belong to the calling package from the system.
1491 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1492 * @hide
1493 */
1494 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001495 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001496 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001497 ITelecomService service = getTelecomService();
1498 if (service != null) {
1499 try {
1500 service.clearAccounts(mContext.getPackageName());
1501 } catch (RemoteException e) {
1502 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001503 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001504 }
1505 }
1506
1507 /**
Anthony Lee67279262014-10-27 11:28:40 -07001508 * Remove all Accounts that belong to the specified package from the system.
1509 * @hide
1510 */
1511 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001512 ITelecomService service = getTelecomService();
1513 if (service != null) {
1514 try {
1515 if (!TextUtils.isEmpty(packageName)) {
1516 service.clearAccounts(packageName);
1517 }
1518 } catch (RemoteException e) {
1519 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001520 }
Anthony Lee67279262014-10-27 11:28:40 -07001521 }
1522 }
1523
Yorke Lee1011f482015-04-23 15:58:27 -07001524
Anthony Lee67279262014-10-27 11:28:40 -07001525 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001526 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1527 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001528 * @hide
1529 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001530 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001531 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001532 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001533 ITelecomService service = getTelecomService();
1534 if (service != null) {
1535 try {
1536 return service.getDefaultPhoneApp();
1537 } catch (RemoteException e) {
1538 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001539 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001540 }
1541 return null;
1542 }
1543
Santos Cordon9eb45932014-06-27 12:28:43 -07001544 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001545 * Used to determine the currently selected default dialer package.
1546 *
1547 * @return package name for the default dialer package or null if no package has been
1548 * selected as the default dialer.
1549 */
1550 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001551 ITelecomService service = getTelecomService();
1552 if (service != null) {
1553 try {
1554 return service.getDefaultDialerPackage();
1555 } catch (RemoteException e) {
1556 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001557 }
Yorke Lee1011f482015-04-23 15:58:27 -07001558 }
1559 return null;
1560 }
1561
1562 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001563 * Used to determine the currently selected default dialer package for a specific user.
1564 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001565 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001566 * @return package name for the default dialer package or null if no package has been
1567 * selected as the default dialer.
1568 * @hide
1569 */
1570 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001571 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001572 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001573 ITelecomService service = getTelecomService();
1574 if (service != null) {
1575 try {
1576 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001577 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001578 } catch (RemoteException e) {
1579 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001580 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001581 }
1582 return null;
1583 }
1584
1585 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001586 * Used to set the default dialer package.
1587 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001588 * @param packageName to set the default dialer to, or {@code null} if the system provided
1589 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001590 *
1591 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1592 * the specified package does not correspond to an installed dialer, or is already
1593 * the default dialer.
1594 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001595 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001596 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001597 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1598 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001599 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001600 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001601 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001602 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001603 @RequiresPermission(allOf = {
1604 android.Manifest.permission.MODIFY_PHONE_STATE,
1605 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001606 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001607 ITelecomService service = getTelecomService();
1608 if (service != null) {
1609 try {
1610 return service.setDefaultDialer(packageName);
1611 } catch (RemoteException e) {
1612 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001613 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001614 }
1615 return false;
1616 }
1617
1618 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001619 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001620 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001621 * @return package name for the system dialer package or {@code null} if no system dialer is
1622 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001623 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001624 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001625 ITelecomService service = getTelecomService();
1626 if (service != null) {
1627 try {
1628 return service.getSystemDialerPackage();
1629 } catch (RemoteException e) {
1630 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001631 }
Yorke Lee1011f482015-04-23 15:58:27 -07001632 }
1633 return null;
1634 }
1635
1636 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001637 * Return whether a given phone number is the configured voicemail number for a
1638 * particular phone account.
1639 *
1640 * @param accountHandle The handle for the account to check the voicemail number against
1641 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001642 */
Yorke Leec61d13662015-09-21 17:25:25 -07001643 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001644 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001645 ITelecomService service = getTelecomService();
1646 if (service != null) {
1647 try {
1648 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001649 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001650 } catch (RemoteException e) {
1651 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001652 }
Nancy Chen443e5012014-10-15 15:48:21 -07001653 }
1654 return false;
1655 }
1656
1657 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001658 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001659 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001660 * @param accountHandle The handle for the phone account.
1661 * @return The voicemail number for the phone account, and {@code null} if one has not been
1662 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001663 */
Yorke Leec61d13662015-09-21 17:25:25 -07001664 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001665 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001666 ITelecomService service = getTelecomService();
1667 if (service != null) {
1668 try {
1669 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001670 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001671 } catch (RemoteException e) {
1672 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001673 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001674 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001675 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001676 }
1677
1678 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001679 * Return the line 1 phone number for given phone account.
1680 *
Michael Groover08490f12020-03-24 14:08:14 -07001681 * <p>Requires Permission:
1682 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1683 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1684 * or that the caller is the default SMS app for any API level.
1685 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1686 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001687 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001688 * @param accountHandle The handle for the account retrieve a number for.
1689 * @return A string representation of the line 1 phone number.
Nancy Chen5cf27842015-01-24 23:30:27 -08001690 */
Michael Groover08490f12020-03-24 14:08:14 -07001691 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1692 @RequiresPermission(anyOf = {
1693 android.Manifest.permission.READ_PHONE_STATE,
1694 android.Manifest.permission.READ_SMS,
1695 android.Manifest.permission.READ_PHONE_NUMBERS
1696 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001697 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001698 ITelecomService service = getTelecomService();
1699 if (service != null) {
1700 try {
1701 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001702 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001703 } catch (RemoteException e) {
1704 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001705 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001706 }
1707 return null;
1708 }
1709
1710 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001711 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001712 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001713 *
1714 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1715 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001716 */
Yorke Leec61d13662015-09-21 17:25:25 -07001717 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001718 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001719 ITelecomService service = getTelecomService();
1720 if (service != null) {
1721 try {
1722 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001723 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001724 } catch (RemoteException e) {
1725 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001726 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001727 }
1728 return false;
1729 }
1730
1731 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001732 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1733 * permission. The permission can be obtained by associating with a physical wearable device
1734 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1735 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001736 *
1737 * @return {@code true} if the caller has {@link InCallService} access for
1738 * companion app; {@code false} otherwise.
1739 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001740 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001741 ITelecomService service = getTelecomService();
1742 if (service != null) {
1743 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001744 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001745 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001746 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001747 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001748 if (!isSystemProcess()) {
1749 e.rethrowAsRuntimeException();
1750 }
Shuo Qian4d065262020-10-20 11:04:28 -07001751 }
1752 }
1753 return false;
1754 }
1755
1756 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001757 * Returns whether there is an ongoing call originating from a managed
1758 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1759 * states.
1760 * <p>
1761 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1762 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001763 *
1764 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1765 * {@code false} otherwise.
1766 */
1767 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1768 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001769 ITelecomService service = getTelecomService();
1770 if (service != null) {
1771 try {
1772 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001773 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001774 } catch (RemoteException e) {
1775 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001776 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001777 }
1778 return false;
1779 }
1780
1781 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001782 * Returns one of the following constants that represents the current state of Telecom:
1783 *
1784 * {@link TelephonyManager#CALL_STATE_RINGING}
1785 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1786 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001787 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001788 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001789 * <p>
1790 * Requires Permission:
1791 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1792 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001793 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001794 * @hide
1795 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001796 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1797 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001798 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001799 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001800 ITelecomService service = getTelecomService();
1801 if (service != null) {
1802 try {
Brad Ebingera8366ae2021-03-23 21:01:51 +00001803 return service.getCallStateUsingPackage(mContext.getPackageName(),
1804 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001805 } catch (RemoteException e) {
1806 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001807 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001808 }
1809 return TelephonyManager.CALL_STATE_IDLE;
1810 }
1811
1812 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001813 * Returns whether there currently exists is a ringing incoming-call.
1814 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001815 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001816 * @hide
1817 */
1818 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001819 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001820 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001821 android.Manifest.permission.READ_PHONE_STATE
1822 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001823 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001824 ITelecomService service = getTelecomService();
1825 if (service != null) {
1826 try {
1827 return service.isRinging(mContext.getOpPackageName());
1828 } catch (RemoteException e) {
1829 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001830 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001831 }
1832 return false;
1833 }
1834
1835 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001836 * Ends the foreground call on the device.
1837 * <p>
1838 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1839 * foreground call is ended.
1840 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001841 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1842 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001843 *
1844 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1845 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001846 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1847 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1848 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001849 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001850 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001851 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001852 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001853 ITelecomService service = getTelecomService();
1854 if (service != null) {
1855 try {
1856 return service.endCall(mContext.getPackageName());
1857 } catch (RemoteException e) {
1858 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001859 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001860 }
1861 return false;
1862 }
1863
1864 /**
1865 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001866 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001867 * If the incoming call is a video call, the call will be answered with the same video state as
1868 * the incoming call requests. This means, for example, that an incoming call requesting
1869 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001870 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001871 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1872 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001873 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001874 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1875 // this method (clockwork & gearhead).
1876 @RequiresPermission(anyOf =
1877 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001878 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001879 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001880 ITelecomService service = getTelecomService();
1881 if (service != null) {
1882 try {
1883 service.acceptRingingCall(mContext.getPackageName());
1884 } catch (RemoteException e) {
1885 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001886 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001887 }
1888 }
1889
1890 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001891 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1892 * with the specified video state.
1893 *
1894 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001895 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1896 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001897 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001898 @RequiresPermission(anyOf =
1899 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001900 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07001901 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001902 ITelecomService service = getTelecomService();
1903 if (service != null) {
1904 try {
1905 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001906 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001907 } catch (RemoteException e) {
1908 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001909 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07001910 }
1911 }
1912
1913 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001914 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07001915 * <p>
1916 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
1917 * already started playing. It is intended to handle use-cases such as silencing a ringing call
1918 * when the user presses the volume button during ringing.
1919 * <p>
1920 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
1921 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
1922 * <p>
1923 * A dialer app which wants to have more control over ringtone playing should declare
1924 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
1925 * {@link InCallService} implementation to indicate that the app wants to be responsible for
1926 * playing the ringtone for all incoming calls.
1927 * <p>
1928 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
1929 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07001930 */
Yorke Leec61d13662015-09-21 17:25:25 -07001931 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07001932 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001933 ITelecomService service = getTelecomService();
1934 if (service != null) {
1935 try {
1936 service.silenceRinger(mContext.getOpPackageName());
1937 } catch (RemoteException e) {
1938 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001939 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001940 }
1941 }
1942
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001943 /**
1944 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001945 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001946 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001947 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001948 android.Manifest.permission.READ_PHONE_STATE
1949 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001950 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001951 ITelecomService service = getTelecomService();
1952 if (service != null) {
1953 try {
1954 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001955 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001956 } catch (RemoteException e) {
1957 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001958 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001959 }
1960 return false;
1961 }
1962
1963 /**
1964 * 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 -07001965 * settings and have a wired headset plugged in.
1966 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001967 * - {@link TelecomManager#TTY_MODE_OFF}
1968 * - {@link TelecomManager#TTY_MODE_FULL}
1969 * - {@link TelecomManager#TTY_MODE_HCO}
1970 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001971 * @hide
1972 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001973 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001974 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001975 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001976 ITelecomService service = getTelecomService();
1977 if (service != null) {
1978 try {
1979 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001980 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001981 } catch (RemoteException e) {
1982 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001983 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001984 }
Evan Charlton10197192014-07-19 15:00:29 -07001985 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001986 }
1987
Santos Cordon96efb482014-07-19 14:57:05 -07001988 /**
1989 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08001990 * has an incoming call. For managed {@link ConnectionService}s, the specified
1991 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
1992 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
1993 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
1994 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
1995 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07001996 * The incoming call you are adding is assumed to have a video state of
1997 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
1998 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
1999 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002000 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2001 * associated with the {@link PhoneAccountHandle} and request additional information about the
2002 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002003 * call UI.
2004 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002005 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2006 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2007 * the associated {@link PhoneAccount} is not currently enabled by the user.
2008 * <p>
2009 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2010 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2011 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2012 *
Santos Cordon96efb482014-07-19 14:57:05 -07002013 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2014 * {@link #registerPhoneAccount}.
2015 * @param extras A bundle that will be passed through to
2016 * {@link ConnectionService#onCreateIncomingConnection}.
2017 */
2018 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002019 ITelecomService service = getTelecomService();
2020 if (service != null) {
2021 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002022 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2023 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2024 Build.VERSION_CODES.O_MR1) {
2025 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2026 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002027 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002028 }
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002029 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras);
2030 } catch (RemoteException e) {
2031 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002032 }
Santos Cordon96efb482014-07-19 14:57:05 -07002033 }
2034 }
2035
Nancy Chen0eb1e402014-08-21 22:52:29 -07002036 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302037 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002038 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2039 * call initiated on another device which the user is being invited to join in. For managed
2040 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2041 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2042 * corresponding {@link PhoneAccount}. This can be checked using
2043 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2044 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302045 * <p>
2046 * The incoming conference you are adding is assumed to have a video state of
2047 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2048 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2049 * <p>
2050 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2051 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002052 * call (See
2053 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2054 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302055 * <p>
2056 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2057 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2058 * the associated {@link PhoneAccount} is not currently enabled by the user.
2059 *
2060 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2061 * {@link #registerPhoneAccount}.
2062 * @param extras A bundle that will be passed through to
2063 * {@link ConnectionService#onCreateIncomingConference}.
2064 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302065 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2066 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002067 ITelecomService service = getTelecomService();
2068 if (service != null) {
2069 try {
2070 service.addNewIncomingConference(
Ravi Paluri80aa2142019-12-02 11:57:37 +05302071 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002072 } catch (RemoteException e) {
2073 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302074 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302075 }
2076 }
2077
2078 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002079 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2080 * service. This is invoked when Telephony detects a new unknown connection that was neither
2081 * a new incoming call, nor an user-initiated outgoing call.
2082 *
2083 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2084 * {@link #registerPhoneAccount}.
2085 * @param extras A bundle that will be passed through to
2086 * {@link ConnectionService#onCreateIncomingConnection}.
2087 * @hide
2088 */
2089 @SystemApi
2090 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002091 ITelecomService service = getTelecomService();
2092 if (service != null) {
2093 try {
2094 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002095 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002096 } catch (RemoteException e) {
2097 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002098 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002099 }
2100 }
2101
2102 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002103 * Processes the specified dial string as an MMI code.
2104 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2105 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002106 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002107 * <p>
2108 * Requires that the method-caller be set as the system dialer app.
2109 * </p>
2110 *
2111 * @param dialString The digits to dial.
2112 * @return True if the digits were processed as an MMI code, false otherwise.
2113 */
Yorke Leec61d13662015-09-21 17:25:25 -07002114 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002115 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002116 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002117 if (service != null) {
2118 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002119 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002120 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002121 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002122 }
2123 }
2124 return false;
2125 }
2126
2127 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002128 * Processes the specified dial string as an MMI code.
2129 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2130 * Some of these sequences launch special behavior through handled by Telephony.
2131 * <p>
2132 * Requires that the method-caller be set as the system dialer app.
2133 * </p>
2134 *
2135 * @param accountHandle The handle for the account the MMI code should apply to.
2136 * @param dialString The digits to dial.
2137 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002138 */
Yorke Leec61d13662015-09-21 17:25:25 -07002139 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002140 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002141 ITelecomService service = getTelecomService();
2142 if (service != null) {
2143 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002144 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2145 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002146 } catch (RemoteException e) {
2147 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2148 }
2149 }
2150 return false;
2151 }
2152
2153 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002154 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2155 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002156 * @param accountHandle The handle for the account to derive an adn query URI for or
2157 * {@code null} to return a URI which will use the default account.
2158 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2159 * for the the content retrieve.
2160 */
Yorke Leec61d13662015-09-21 17:25:25 -07002161 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002162 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2163 ITelecomService service = getTelecomService();
2164 if (service != null && accountHandle != null) {
2165 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002166 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002167 } catch (RemoteException e) {
2168 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2169 }
2170 }
2171 return Uri.parse("content://icc/adn");
2172 }
2173
2174 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002175 * Removes the missed-call notification if one is present.
2176 * <p>
2177 * Requires that the method-caller be set as the system dialer app.
2178 * </p>
2179 */
Yorke Leec61d13662015-09-21 17:25:25 -07002180 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002181 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002182 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002183 if (service != null) {
2184 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002185 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002186 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002187 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002188 }
2189 }
2190 }
2191
2192 /**
2193 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2194 * currently no ongoing call, then this method does nothing.
2195 * <p>
2196 * Requires that the method-caller be set as the system dialer app or have the
2197 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2198 * </p>
2199 *
2200 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2201 */
Yorke Leec61d13662015-09-21 17:25:25 -07002202 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002203 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002204 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002205 if (service != null) {
2206 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002207 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002208 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002209 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002210 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002211 }
2212 }
2213 }
2214
Yorke Lee3e56ba12015-04-23 12:32:36 -07002215 /**
2216 * Places a new outgoing call to the provided address using the system telecom service with
2217 * the specified extras.
2218 *
2219 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2220 * except that the outgoing call will always be sent via the system telecom service. If
2221 * method-caller is either the user selected default dialer app or preloaded system dialer
2222 * app, then emergency calls will also be allowed.
2223 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002224 * Placing a call via a managed {@link ConnectionService} requires permission:
2225 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002226 *
2227 * Usage example:
2228 * <pre>
2229 * Uri uri = Uri.fromParts("tel", "12345", null);
2230 * Bundle extras = new Bundle();
2231 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2232 * telecomManager.placeCall(uri, extras);
2233 * </pre>
2234 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002235 * The following keys are supported in the supplied extras.
2236 * <ul>
2237 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2238 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2239 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2240 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2241 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002242 * <p>
2243 * An app which implements the self-managed {@link ConnectionService} API uses
2244 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2245 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2246 * associated {@link android.telecom.PhoneAccountHandle}.
2247 *
2248 * Self-managed {@link ConnectionService}s require permission
2249 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002250 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002251 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2252 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2253 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2254 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2255 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2256 * </p>
2257 *
Yorke Lee3e56ba12015-04-23 12:32:36 -07002258 * @param address The address to make the call to.
2259 * @param extras Bundle of extras to use with the call.
2260 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002261 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2262 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002263 public void placeCall(Uri address, Bundle extras) {
2264 ITelecomService service = getTelecomService();
2265 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002266 if (address == null) {
2267 Log.w(TAG, "Cannot place call to empty address.");
2268 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002269 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002270 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002271 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002272 } catch (RemoteException e) {
2273 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2274 }
2275 }
2276 }
2277
Ravi Paluri80aa2142019-12-02 11:57:37 +05302278
2279 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002280 * Place a new adhoc conference call with the provided participants using the system telecom
2281 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302282 *
2283 * An adhoc conference call is established by providing a list of addresses to
2284 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2285 * {@link ConnectionService} is responsible for connecting all indicated participants
2286 * to a conference simultaneously.
2287 * This is in contrast to conferences formed by merging calls together (e.g. using
2288 * {@link android.telecom.Call#mergeConference()}).
2289 *
2290 * The following keys are supported in the supplied extras.
2291 * <ul>
2292 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2293 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2294 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2295 * </ul>
2296 *
2297 * @param participants List of participants to start conference with
2298 * @param extras Bundle of extras to use with the call
2299 */
2300 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2301 public void startConference(@NonNull List<Uri> participants,
2302 @NonNull Bundle extras) {
2303 ITelecomService service = getTelecomService();
2304 if (service != null) {
2305 try {
2306 service.startConference(participants, extras,
2307 mContext.getOpPackageName());
2308 } catch (RemoteException e) {
2309 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2310 }
2311 }
2312 }
2313
Santos Cordon91371dc02015-05-08 13:52:09 -07002314 /**
2315 * Enables and disables specified phone account.
2316 *
2317 * @param handle Handle to the phone account.
2318 * @param isEnabled Enable state of the phone account.
2319 * @hide
2320 */
2321 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002322 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002323 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2324 ITelecomService service = getTelecomService();
2325 if (service != null) {
2326 try {
2327 service.enablePhoneAccount(handle, isEnabled);
2328 } catch (RemoteException e) {
2329 Log.e(TAG, "Error enablePhoneAbbount", e);
2330 }
2331 }
2332 }
2333
Hall Liu0464b9b2016-01-12 15:32:58 -08002334 /**
2335 * Dumps telecom analytics for uploading.
2336 *
2337 * @return
2338 * @hide
2339 */
2340 @SystemApi
2341 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002342 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002343 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002344 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002345 if (service != null) {
2346 try {
2347 result = service.dumpCallAnalytics();
2348 } catch (RemoteException e) {
2349 Log.e(TAG, "Error dumping call analytics", e);
2350 }
2351 }
2352 return result;
2353 }
2354
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002355 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002356 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2357 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002358 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002359 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2360 * {@code true} for the current user.
2361 */
2362 public Intent createManageBlockedNumbersIntent() {
2363 ITelecomService service = getTelecomService();
2364 Intent result = null;
2365 if (service != null) {
2366 try {
2367 result = service.createManageBlockedNumbersIntent();
2368 } catch (RemoteException e) {
2369 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2370 }
2371 }
2372 return result;
2373 }
2374
Fan Zhang5431ef52019-10-14 13:43:46 -07002375
2376 /**
2377 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2378 * launch the activity for emergency dialer.
2379 *
2380 * @param number Optional number to call in emergency dialer
2381 * @hide
2382 */
2383 @SystemApi
2384 @NonNull
2385 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2386 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002387 if (service != null) {
2388 try {
Tyler Gunn753aa102020-04-23 10:16:26 -07002389 return service.createLaunchEmergencyDialerIntent(number);
Fan Zhang5431ef52019-10-14 13:43:46 -07002390 } catch (RemoteException e) {
2391 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2392 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002393 } else {
2394 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002395 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002396
2397 // Telecom service knows the package name of the expected emergency dialer package; if it
2398 // is not available, then fallback to not targeting a specific package.
2399 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2400 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2401 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2402 }
2403 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002404 }
2405
Tyler Gunnf5035432017-01-09 09:43:12 -08002406 /**
2407 * Determines whether Telecom would permit an incoming call to be added via the
2408 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2409 * {@link PhoneAccountHandle}.
2410 * <p>
2411 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2412 * in the following situations:
2413 * <ul>
2414 * <li>{@link PhoneAccount} does not have property
2415 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2416 * {@link ConnectionService}), and the active or held call limit has
2417 * been reached.</li>
2418 * <li>There is an ongoing emergency call.</li>
2419 * </ul>
2420 *
2421 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2422 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2423 * otherwise.
2424 */
2425 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002426 if (phoneAccountHandle == null) {
2427 return false;
2428 }
2429
Tyler Gunnf5035432017-01-09 09:43:12 -08002430 ITelecomService service = getTelecomService();
2431 if (service != null) {
2432 try {
2433 return service.isIncomingCallPermitted(phoneAccountHandle);
2434 } catch (RemoteException e) {
2435 Log.e(TAG, "Error isIncomingCallPermitted", e);
2436 }
2437 }
2438 return false;
2439 }
2440
2441 /**
2442 * Determines whether Telecom would permit an outgoing call to be placed via the
2443 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2444 * <p>
2445 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2446 * in the following situations:
2447 * <ul>
2448 * <li>{@link PhoneAccount} does not have property
2449 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2450 * {@link ConnectionService}), and the active, held or ringing call limit has
2451 * been reached.</li>
2452 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2453 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2454 * another {@link ConnectionService}.</li>
2455 * <li>There is an ongoing emergency call.</li>
2456 * </ul>
2457 *
2458 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2459 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2460 * otherwise.
2461 */
2462 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2463 ITelecomService service = getTelecomService();
2464 if (service != null) {
2465 try {
2466 return service.isOutgoingCallPermitted(phoneAccountHandle);
2467 } catch (RemoteException e) {
2468 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2469 }
2470 }
2471 return false;
2472 }
2473
Sanket Padawea8eddd42017-11-03 11:07:35 -07002474 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002475 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2476 * {@link PhoneAccountHandle} it defines.
2477 * <p>
2478 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2479 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2480 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2481 * is referred to as the source of the handover, and the video calling app is referred to as the
2482 * destination.
2483 * <p>
2484 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2485 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2486 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2487 * device.
2488 * <p>
2489 * For a full discussion of the handover process and the APIs involved, see
2490 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2491 * <p>
2492 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2493 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002494 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2495 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2496 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2497 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2498 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2499 * <p>
2500 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2501 * associated with the {@link PhoneAccountHandle} destAcct and call
2502 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2503 * <p>
2504 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2505 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2506 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2507 * user.
2508 * <p>
2509 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2510 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2511 *
2512 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2513 * {@link ConnectionService}.
2514 * @param videoState Video state after the handover.
2515 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2516 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002517 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2518 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002519 ITelecomService service = getTelecomService();
2520 if (service != null) {
2521 try {
2522 service.acceptHandover(srcAddr, videoState, destAcct);
2523 } catch (RemoteException e) {
2524 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002525 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002526 }
2527 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002528
Tyler Gunn5bd90852018-09-21 09:37:07 -07002529 /**
2530 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2531 * call, as identified by the dialed number, or because a call was identified by the network
2532 * as an emergency call.
2533 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2534 * @hide
2535 */
2536 @SystemApi
2537 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2538 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002539 ITelecomService service = getTelecomService();
2540 if (service != null) {
2541 try {
2542 return service.isInEmergencyCall();
2543 } catch (RemoteException e) {
2544 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2545 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002546 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002547 }
2548 return false;
2549 }
2550
Tyler Gunnc37445c2018-09-28 16:16:20 -07002551 /**
2552 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2553 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002554 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002555 * @hide
2556 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002557 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002558 ITelecomService service = getTelecomService();
2559 if (service != null) {
2560 try {
2561 service.handleCallIntent(intent, callingPackageProxy);
2562 } catch (RemoteException e) {
2563 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002564 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002565 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002566 }
2567
Shuo Qian4d065262020-10-20 11:04:28 -07002568 private boolean isSystemProcess() {
2569 return Process.myUid() == Process.SYSTEM_UID;
2570 }
2571
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002572 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002573 if (mTelecomServiceOverride != null) {
2574 return mTelecomServiceOverride;
2575 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002576 if (sTelecomService == null) {
2577 ITelecomService temp = ITelecomService.Stub.asInterface(
2578 ServiceManager.getService(Context.TELECOM_SERVICE));
2579 synchronized (CACHE_LOCK) {
2580 if (sTelecomService == null && temp != null) {
2581 try {
2582 sTelecomService = temp;
2583 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2584 } catch (Exception e) {
2585 sTelecomService = null;
2586 }
2587 }
2588 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002589 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002590 return sTelecomService;
2591 }
2592
2593 private static class DeathRecipient implements IBinder.DeathRecipient {
2594 @Override
2595 public void binderDied() {
2596 resetServiceCache();
2597 }
2598 }
2599
2600 private static void resetServiceCache() {
2601 synchronized (CACHE_LOCK) {
2602 if (sTelecomService != null) {
2603 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2604 sTelecomService = null;
2605 }
2606 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002607 }
Evan Charlton235c1592014-09-05 15:41:23 +00002608}