blob: 1cc1a115ba83085083c47fb2405dfa816efd6858 [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;
Nan Wuc51fd762022-08-01 21:08:23 +000018import static android.content.Intent.LOCAL_FLAG_FROM_SYSTEM;
Tyler Gunn00d737b2019-10-31 13:04:37 -070019
Hall Liu0464b9b2016-01-12 15:32:58 -080020import android.Manifest;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070021import android.annotation.CallbackExecutor;
Kunduz Baryktabasovae2484c02023-10-02 10:46:49 +000022import android.annotation.FlaggedApi;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080023import android.annotation.IntDef;
Fan Zhang5431ef52019-10-14 13:43:46 -070024import android.annotation.NonNull;
Slava Shklyaeve65e4012019-03-04 16:02:34 +000025import android.annotation.Nullable;
Hui Wangc47df7f2021-12-14 20:37:47 +000026import android.annotation.RequiresFeature;
Yorke Leec61d13662015-09-21 17:25:25 -070027import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060028import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060029import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070030import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060031import android.annotation.SystemService;
Brad Ebingera8366ae2021-03-23 21:01:51 +000032import android.compat.annotation.ChangeId;
33import android.compat.annotation.EnabledSince;
Artur Satayev2ebb31c2020-01-08 12:24:36 +000034import android.compat.annotation.UnsupportedAppUsage;
Santos Cordon6c7a3882014-06-25 15:30:08 -070035import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070036import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070037import android.content.Intent;
Hui Wangc47df7f2021-12-14 20:37:47 +000038import android.content.pm.PackageManager;
Nancy Chenb2299c12014-10-29 18:22:11 -070039import android.net.Uri;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -080040import android.os.Build;
Santos Cordon96efb482014-07-19 14:57:05 -070041import android.os.Bundle;
Kevin Jeon767cda32020-11-17 01:40:16 +000042import android.os.IBinder;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070043import android.os.OutcomeReceiver;
Shuo Qian4d065262020-10-20 11:04:28 -070044import android.os.Process;
Santos Cordon6c7a3882014-06-25 15:30:08 -070045import android.os.RemoteException;
46import android.os.ServiceManager;
Tyler Gunn7e45b722018-12-04 12:56:45 -080047import android.os.UserHandle;
Chen Xuc9d4ee12019-09-26 16:11:59 -070048import android.telephony.Annotation.CallState;
Brad Ebingere7833312019-05-07 10:55:55 -070049import android.telephony.SubscriptionManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070050import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070051import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070052import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070053
Kevin Jeon767cda32020-11-17 01:40:16 +000054import com.android.internal.annotations.GuardedBy;
Thomas Stuart9bfb2432022-09-27 15:02:07 -070055import com.android.internal.telecom.ClientTransactionalServiceRepository;
56import com.android.internal.telecom.ClientTransactionalServiceWrapper;
Tyler Gunnef9f6f92014-09-12 22:16:17 -070057import com.android.internal.telecom.ITelecomService;
Kunduz Baryktabasovae2484c02023-10-02 10:46:49 +000058import com.android.server.telecom.flags.Flags;
Yorke Leeb4ce1432014-06-09 13:53:23 -070059
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080060import java.lang.annotation.Retention;
61import java.lang.annotation.RetentionPolicy;
Jay Shrauner7746a942014-08-26 12:15:15 -070062import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070063import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070064import java.util.List;
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -080065import java.util.Objects;
Tyler Gunn7e45b722018-12-04 12:56:45 -080066import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070067
Yorke Leeb4ce1432014-06-09 13:53:23 -070068/**
Santos Cordond9e614f2014-10-28 13:10:36 -070069 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080070 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070071 * <p>
72 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
73 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
74 * <p>
75 * Note that access to some telecom information is permission-protected. Your app cannot access the
76 * protected information or gain access to protected functionality unless it has the appropriate
77 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
78 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070079 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060080@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060081@SystemService(Context.TELECOM_SERVICE)
Hui Wangc47df7f2021-12-14 20:37:47 +000082@RequiresFeature(PackageManager.FEATURE_TELECOM)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070083public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070084
Evan Charlton10197192014-07-19 15:00:29 -070085 /**
Santos Cordon96efb482014-07-19 14:57:05 -070086 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070087 * UI by notifying the Telecom system that an incoming call exists for a specific call service
88 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
89 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070090 * ultimately use to control and get information about the call.
91 * <p>
92 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070093 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070094 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080095 *
96 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070097 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070098 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070099
100 /**
Yorke Leec3cf9822014-10-02 09:38:39 -0700101 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
102 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -0800103 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -0700104 * @hide
105 */
106 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
107
108 /**
Santos Cordon895d4b82015-06-25 16:41:48 -0700109 * An {@link android.content.Intent} action sent by the telecom framework to start a
110 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
111 * and each app that registers a {@link PhoneAccount} should provide one if desired.
112 * <p>
113 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
114 * app's settings menu. For each entry, the settings app will add a click action. When
115 * triggered, the click-action will start this intent along with the extra
116 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
117 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
118 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700119 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700120 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
121 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700122
123 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800124 * The {@link android.content.Intent} action used to show the call accessibility settings page.
125 */
126 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
127 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
128
129 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700130 * The {@link android.content.Intent} action used to show the call settings page.
131 */
132 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700133 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700134
135 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800136 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
137 */
138 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
139 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
140
141 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700142 * The {@link android.content.Intent} action used to show the settings page used to configure
143 * {@link PhoneAccount} preferences.
144 */
145 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700146 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700147
148 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700149 * {@link android.content.Intent} action used indicate that a new phone account was just
150 * registered.
151 * <p>
152 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
153 * to indicate which {@link PhoneAccount} was registered.
154 * <p>
155 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800156 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800157 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
158 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
159
160 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700161 * {@link android.content.Intent} action used indicate that a phone account was just
162 * unregistered.
163 * <p>
164 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
165 * to indicate which {@link PhoneAccount} was unregistered.
166 * <p>
167 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700168 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700169 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
170 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
171
172 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700173 * Activity action: Shows a dialog asking the user whether or not they want to replace the
174 * current default Dialer with the one specified in
175 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
176 *
177 * Usage example:
178 * <pre>
179 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
180 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
181 * getActivity().getPackageName());
182 * startActivity(intent);
183 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800184 * <p>
185 * This is no longer supported since Q, please use
186 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
187 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700188 */
189 public static final String ACTION_CHANGE_DEFAULT_DIALER =
190 "android.telecom.action.CHANGE_DEFAULT_DIALER";
191
192 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700193 * Broadcast intent action indicating that the current default dialer has changed.
194 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
195 * name of the package that the default dialer was changed to.
196 *
197 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
198 */
199 public static final String ACTION_DEFAULT_DIALER_CHANGED =
200 "android.telecom.action.DEFAULT_DIALER_CHANGED";
201
202 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700203 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
204 */
205 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
206 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
207
208 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800209 * Broadcast intent action indicating that the current default call screening app has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700210 * <p>
211 * Note: This intent is NEVER actually broadcast and will be deprecated in the future.
212 * <p>
213 * An app that want to know if it holds the
214 * {@link android.app.role.RoleManager#ROLE_CALL_SCREENING} role can use
215 * {@link android.app.role.RoleManager#isRoleHeld(String)} to confirm if it holds the role or
216 * not.
tonyzhuff60f5e2018-10-01 19:14:59 +0800217 */
218 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
219 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
220
221 /**
222 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
223 * indicate the ComponentName of the call screening app which has changed.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700224 * <p>
225 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800226 */
227 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
228 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
229
230 /**
231 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
232 * indicate whether an app is the default call screening app.
Tyler Gunn78f77f62020-03-27 12:51:26 -0700233 * <p>
234 * Note: This extra is NOT used and will be deprecated in the future.
tonyzhuff60f5e2018-10-01 19:14:59 +0800235 */
236 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
237 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
238
239 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700240 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
241 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700242 */
243 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700244 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700245
246 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700247 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
248 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700249 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700250 * {@link VideoProfile#STATE_AUDIO_ONLY},
251 * {@link VideoProfile#STATE_BIDIRECTIONAL},
252 * {@link VideoProfile#STATE_RX_ENABLED},
253 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700254 */
255 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700256 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700257
258 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700259 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
260 * integer that determines the requested video state for an incoming call.
261 * Valid options:
262 * {@link VideoProfile#STATE_AUDIO_ONLY},
263 * {@link VideoProfile#STATE_BIDIRECTIONAL},
264 * {@link VideoProfile#STATE_RX_ENABLED},
265 * {@link VideoProfile#STATE_TX_ENABLED}.
266 */
267 public static final String EXTRA_INCOMING_VIDEO_STATE =
268 "android.telecom.extra.INCOMING_VIDEO_STATE";
269
270 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700271 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
272 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
273 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700274 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700275 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700276 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700277 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700278 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700279
280 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700281 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
282 * subject which will be associated with an outgoing call. Should only be specified if the
Shuo Qian3ed38832020-11-30 21:54:36 -0800283 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
284 * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700285 */
286 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
287
Shuo Qian3ed38832020-11-30 21:54:36 -0800288 // Values for EXTRA_PRIORITY
289 /**
290 * Indicates the call composer call priority is normal.
291 *
292 * Reference: RCC.20 Section 2.4.4.2
293 */
294 public static final int PRIORITY_NORMAL = 0;
295
296 /**
297 * Indicates the call composer call priority is urgent.
298 *
299 * Reference: RCC.20 Section 2.4.4.2
300 */
301 public static final int PRIORITY_URGENT = 1;
302
303 /**
304 * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
305 * {@link #PRIORITY_URGENT}.
306 *
307 * Reference: RCC.20 Section 2.4.4.2
308 */
309 public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
310
311 /**
312 * Extra for the call composer call location, an {@link android.location.Location} parcelable
313 * class to represent the geolocation as a latitude and longitude pair.
314 *
315 * Reference: RCC.20 Section 2.4.3.2
316 */
317 public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
318
319 /**
320 * A boolean extra set on incoming calls to indicate that the call has a picture specified.
321 * Given that image download could take a (short) time, the EXTRA is set immediately upon
322 * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
323 * if one is expected. The EXTRA may be unset if the image download ends up failing for some
324 * reason.
325 */
326 public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
327
328 /**
Hall Liu48c3c142021-03-11 16:14:22 -0800329 * A {@link Uri} representing the picture that was downloaded when a call is received or
330 * uploaded when a call is placed.
Hall Liu8fee7ea2021-01-21 16:37:51 -0800331 *
Shuo Qian3ed38832020-11-30 21:54:36 -0800332 * This is a content URI within the call log provider which can be used to open a file
333 * 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 -0800334 * download/upload is delayed for some reason. The Dialer app will receive a callback via
Shuo Qian3ed38832020-11-30 21:54:36 -0800335 * {@link Call.Callback#onDetailsChanged} when this value has changed.
336 *
337 * Reference: RCC.20 Section 2.4.3.2
338 */
Hall Liu8fee7ea2021-01-21 16:37:51 -0800339 public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
Shuo Qian3ed38832020-11-30 21:54:36 -0800340
Shuo Qian3ed38832020-11-30 21:54:36 -0800341 /**
342 * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
Hall Liua749abc2021-01-21 10:05:43 -0800343 * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
344 * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
Shuo Qian3ed38832020-11-30 21:54:36 -0800345 */
346 public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
347
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700348 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700349 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
350 * has initiated a new incoming call.
351 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700352 public static final String EXTRA_INCOMING_CALL_ADDRESS =
353 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700354
355 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700356 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
357 * metadata about the call. This {@link Bundle} will be returned to the
358 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700359 */
360 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700361 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700362
363 /**
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800364 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} used to indicate
365 * that a call has an in-band ringtone associated with it. This is used when the device is
366 * acting as an HFP headset and the Bluetooth stack has received an in-band ringtone from the
367 * the HFP host which must be played instead of any local ringtone the device would otherwise
368 * have generated.
369 *
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800370 * @hide
371 */
Roopa Sattiraju98c76c42022-01-30 13:35:59 -0800372 @SystemApi
373 public static final String EXTRA_CALL_HAS_IN_BAND_RINGTONE =
374 "android.telecom.extra.CALL_HAS_IN_BAND_RINGTONE";
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800375
376 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700377 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
378 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
379 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700380 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700381 */
382 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700383 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700384
385 /**
sqian6d9e7452019-02-08 21:42:15 -0800386 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
387 * whether the user's dial intent is emergency; this is required to specify when the dialed
388 * number is ambiguous, identified as both emergency number and any other non-emergency number;
389 * e.g. in some situation, 611 could be both an emergency number in a country and a
390 * non-emergency number of a carrier's customer service hotline.
391 *
392 * @hide
393 */
394 @SystemApi
395 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
396 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
397
398 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800399 * A mandatory extra containing a {@link Uri} to be passed in when calling
400 * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
401 * the remote handle of the new call.
Yorke Leec3cf9822014-10-02 09:38:39 -0700402 * @hide
403 */
Hall Liu2ef04112020-09-14 18:34:10 -0700404 @SystemApi
Yorke Leec3cf9822014-10-02 09:38:39 -0700405 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
406 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
407
408 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700409 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
410 * call was created. This value is in milliseconds since boot.
Hall Liudbb17f12020-03-10 18:28:58 -0700411 * @hide
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700412 */
413 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
414 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
415
416 /**
Kunduz Baryktabasovae2484c02023-10-02 10:46:49 +0000417 * The extra for call log uri that was used to mark missed calls as read when dialer gets the
418 * notification on reboot.
419 */
420 @FlaggedApi(Flags.FLAG_ADD_CALL_URI_FOR_MISSED_CALLS)
421 public static final String EXTRA_CALL_LOG_URI =
422 "android.telecom.extra.CALL_LOG_URI";
423
424 /**
qing90c40cf2023-02-22 22:46:00 +0000425 * Optional extra for incoming containing a long which specifies the time the
426 * call was answered by user. This value is in milliseconds.
427 * @hide
428 */
429 public static final String EXTRA_CALL_ANSWERED_TIME_MILLIS =
430 "android.telecom.extra.CALL_ANSWERED_TIME_MILLIS";
431
432
433 /**
Jack Yu1e1ff942019-12-23 15:19:56 -0800434 * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
435 * time the call was created.
436 * @hide
437 */
438 public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
439 "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
440
441 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700442 * Optional extra for incoming and outgoing calls containing a long which specifies the time
443 * telecom began routing the call. This value is in milliseconds since boot.
444 * @hide
445 */
446 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
447 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
448
449 /**
450 * Optional extra for incoming and outgoing calls containing a long which specifies the time
451 * telecom finished routing the call. This value is in milliseconds since boot.
452 * @hide
453 */
454 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
455 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
456
457 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700458 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
459 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700460 */
461 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700462 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700463
464 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700465 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
466 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700467 */
468 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700469 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700470
471 /**
radhika0dd90652020-11-04 11:12:51 -0800472 * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
473 * lower layers
474 * @hide
475 */
476 public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
477 "Call dropped by lower layers";
478
479 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700480 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
481 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800482 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700483 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800484 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700485 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700486 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700487
488 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800489 * Optional extra for communicating the call technology used by a {@link ConnectionService}
490 * to Telecom. Valid values are:
491 * <ul>
492 * <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
493 * <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
494 * <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
495 * <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
496 * <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
497 * </ul>
Hall Liu90f62902015-11-19 16:19:24 -0800498 * @hide
499 */
Hall Liu2ef04112020-09-14 18:34:10 -0700500 @SystemApi
Hall Liu90f62902015-11-19 16:19:24 -0800501 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
502 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
503
504 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800505 * Optional extra for communicating the call network technology used by a
506 * {@link android.telecom.Connection} to Telecom and InCallUI.
507 *
Andrew Sapperstein8fe35e52020-04-28 12:29:20 -0700508 * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
Wei Huang7f7f72e2018-05-30 19:21:36 +0800509 */
510 public static final String EXTRA_CALL_NETWORK_TYPE =
511 "android.telecom.extra.CALL_NETWORK_TYPE";
512
513 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700514 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
515 * package name of the app specifying an alternative gateway for the call.
516 * The value is a string.
517 *
518 * (The following comment corresponds to the all GATEWAY_* extras)
519 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
520 * alternative address to dial which is different from the one specified and displayed to
521 * the user. This alternative address is referred to as the gateway address.
522 */
523 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700524 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700525
526 /**
527 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
528 * original address to dial for the call. This is used when an alternative gateway address is
529 * provided to recall the original address.
530 * The value is a {@link android.net.Uri}.
531 *
532 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
533 */
534 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700535 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700536
537 /**
Evan Charlton10197192014-07-19 15:00:29 -0700538 * The number which the party on the other side of the line will see (and use to return the
539 * call).
540 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700541 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
542 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
543 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700544 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700545 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700546
547 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800548 * The number of milliseconds that Telecom should wait after disconnecting a call via the
549 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
550 * to make a new one.
551 * @hide
552 */
553 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
554 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
555
556 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700557 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700558 * existing call from the user's device to a different {@link PhoneAccount}.
559 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700560 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
561 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
562 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
563 * the receiving side of a handover.
564 * <p>
565 * Used when Telecom calls
566 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
567 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
568 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
569 * occurs on the initiating side of a handover.
570 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700571 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700572 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800573 * @deprecated Use the public handover APIs. See
574 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700575 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800576 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700577 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
578
579 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800580 * When {@code true} indicates that a request to create a new connection is for the purpose of
581 * a handover. Note: This is used with the
582 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
583 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
584 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
585 * @hide
586 */
587 public static final String EXTRA_IS_HANDOVER_CONNECTION =
588 "android.telecom.extra.IS_HANDOVER_CONNECTION";
589
590 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700591 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
592 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
593 * the handover is from.
594 * @hide
595 */
596 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
597 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
598
599 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700600 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
601 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
602 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
603 * {@link Connection} will be.
604 * @hide
605 */
606 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
607
608 /**
Hall Liu95d55872017-01-25 17:12:49 -0800609 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
610 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
611 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
612 */
613 public static final String EXTRA_START_CALL_WITH_RTT =
614 "android.telecom.extra.START_CALL_WITH_RTT";
615
616 /**
Grace Jia91cec6e2019-12-16 14:23:05 -0800617 * Start an activity indicating that the completion of an outgoing call or an incoming call
618 * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
619 * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
620 *
621 * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
622 * call which completed.
623 *
624 * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
625 * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
626 *
627 * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
628 * {@link #EXTRA_CALL_DURATION} for more information.
629 */
630 public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
631
632 /**
633 * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
634 * uri handle(phone number) of the completed call.
635 */
636 public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
637
638 /**
639 * A integer value provided for completed calls to indicate the reason for the call
640 * disconnection.
641 * <p>
642 * Allowed values:
643 * <ul>
644 * <li>{@link DisconnectCause#UNKNOWN}</li>
645 * <li>{@link DisconnectCause#LOCAL}</li>
646 * <li>{@link DisconnectCause#REMOTE}</li>
647 * <li>{@link DisconnectCause#REJECTED}</li>
648 * <li>{@link DisconnectCause#MISSED}</li>
649 * </ul>
650 * </p>
651 */
652 public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
653
654 /**
655 * A integer value provided for completed calls to indicate the duration of the call.
656 * <p>
657 * Allowed values:
658 * <ul>
659 * <li>{@link #DURATION_VERY_SHORT}</li>
660 * <li>{@link #DURATION_SHORT}</li>
661 * <li>{@link #DURATION_MEDIUM}</li>
662 * <li>{@link #DURATION_LONG}</li>
663 * </ul>
664 * </p>
665 */
666 public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
667
668 /**
669 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
670 * call was < 3 seconds.
671 */
672 public static final int DURATION_VERY_SHORT = 0;
673
674 /**
675 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
676 * call was >= 3 seconds and < 60 seconds.
677 */
678 public static final int DURATION_SHORT = 1;
679
680 /**
681 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
682 * call was >= 60 seconds and < 120 seconds.
683 */
684 public static final int DURATION_MEDIUM = 2;
685
686 /**
687 * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
688 * call was >= 120 seconds.
689 */
690 public static final int DURATION_LONG = 3;
691
692 /**
693 * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
694 * milliseconds.
695 * @hide
696 */
697 public static final long VERY_SHORT_CALL_TIME_MS = 3000;
698
699 /**
700 * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
701 * milliseconds.
702 * @hide
703 */
704 public static final long SHORT_CALL_TIME_MS = 60000;
705
706 /**
707 * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
708 * milliseconds.
709 * @hide
710 */
711 public static final long MEDIUM_CALL_TIME_MS = 120000;
712
713 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700714 * A boolean meta-data value indicating whether an {@link InCallService} implements an
715 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
716 * would also like to replace the in-call interface should set this meta-data to {@code true} in
717 * the manifest registration of their {@link InCallService}.
718 */
719 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
720
721 /**
Santos Cordon88881552015-12-10 17:29:54 -0800722 * A boolean meta-data value indicating whether an {@link InCallService} implements an
723 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000724 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800725 */
726 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
727 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
728
729 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800730 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
731 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
732 * override the system provided ringing should set this meta-data to {@code true} in the
733 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700734 * <p>
735 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
736 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800737 */
738 public static final String METADATA_IN_CALL_SERVICE_RINGING =
739 "android.telecom.IN_CALL_SERVICE_RINGING";
740
741 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700742 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
743 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
744 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
745 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
746 * informed of external calls should set this meta-data to {@code true} in the manifest
747 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
748 * be informed of external calls.
749 */
750 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
751 "android.telecom.INCLUDE_EXTERNAL_CALLS";
752
753 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800754 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
755 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
756 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
757 * to implement its own call user interface. An {@link InCallService} implementation which
758 * would like to be informed of external calls should set this meta-data to {@code true} in the
759 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
760 * will NOT be informed about self-managed calls.
761 * <p>
762 * An {@link InCallService} which receives self-managed calls is free to view and control the
763 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700764 * exposing these calls to an automotive device via its companion app.
765 * <p>
Tyler Gunn24e18332017-02-10 09:42:49 -0800766 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
767 */
768 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
769 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
770
771 /**
Evan Charlton10197192014-07-19 15:00:29 -0700772 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
773 * pause for a predefined period.
774 */
775 public static final char DTMF_CHARACTER_PAUSE = ',';
776
777 /**
778 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
779 * wait for user confirmation before proceeding.
780 */
781 public static final char DTMF_CHARACTER_WAIT = ';';
782
783 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800784 * @hide
785 */
786 @IntDef(prefix = { "TTY_MODE_" },
787 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
788 @Retention(RetentionPolicy.SOURCE)
789 public @interface TtyMode {}
790
791 /**
Evan Charlton10197192014-07-19 15:00:29 -0700792 * TTY (teletypewriter) mode is off.
793 *
794 * @hide
795 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800796 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700797 public static final int TTY_MODE_OFF = 0;
798
799 /**
800 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
801 * will communicate with the remote party by sending and receiving text messages.
802 *
803 * @hide
804 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800805 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700806 public static final int TTY_MODE_FULL = 1;
807
808 /**
809 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
810 * speaker is on. The user will communicate with the remote party by sending text messages and
811 * hearing an audible reply.
812 *
813 * @hide
814 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800815 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700816 public static final int TTY_MODE_HCO = 2;
817
818 /**
819 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
820 * microphone is still on. User will communicate with the remote party by speaking and receiving
821 * text message replies.
822 *
823 * @hide
824 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800825 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700826 public static final int TTY_MODE_VCO = 3;
827
828 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700829 * Broadcast intent action indicating that the current TTY mode has changed.
Evan Charlton10197192014-07-19 15:00:29 -0700830 *
Hall Liu2ef04112020-09-14 18:34:10 -0700831 * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
832 * TTY mode.
Evan Charlton10197192014-07-19 15:00:29 -0700833 * @hide
834 */
Hall Liu2ef04112020-09-14 18:34:10 -0700835 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700836 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700837 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700838
839 /**
Hall Liu2ef04112020-09-14 18:34:10 -0700840 * Integer extra key that indicates the current TTY mode.
841 *
842 * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
843 *
844 * Valid modes are:
845 * <ul>
846 * <li>{@link #TTY_MODE_OFF}</li>
847 * <li>{@link #TTY_MODE_FULL}</li>
848 * <li>{@link #TTY_MODE_HCO}</li>
849 * <li>{@link #TTY_MODE_VCO}</li>
850 * </ul>
851 *
852 * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
853 * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
854 * plugged into the device.
855 * @hide
856 */
Hall Liu2ef04112020-09-14 18:34:10 -0700857 @SystemApi
858 public static final String EXTRA_CURRENT_TTY_MODE =
859 "android.telecom.extra.CURRENT_TTY_MODE";
860
861 /**
862 * Broadcast intent action indicating that the TTY preferred operating mode has changed.
863 *
864 * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
865 * preferred TTY mode.
866 * @hide
867 */
Hall Liu2ef04112020-09-14 18:34:10 -0700868 @SystemApi
869 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
870 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
871
872 /**
873 * Integer extra key that indicates the preferred TTY mode.
874 *
875 * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
876 *
Evan Charlton10197192014-07-19 15:00:29 -0700877 * Valid modes are:
Hall Liuba820bd2020-01-22 17:17:13 -0800878 * <ul>
879 * <li>{@link #TTY_MODE_OFF}</li>
880 * <li>{@link #TTY_MODE_FULL}</li>
881 * <li>{@link #TTY_MODE_HCO}</li>
882 * <li>{@link #TTY_MODE_VCO}</li>
883 * </ul>
Evan Charlton10197192014-07-19 15:00:29 -0700884 * @hide
885 */
Hall Liu2ef04112020-09-14 18:34:10 -0700886 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700887 public static final String EXTRA_TTY_PREFERRED_MODE =
Hall Liuba820bd2020-01-22 17:17:13 -0800888 "android.telecom.extra.TTY_PREFERRED_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700889
Nancy Chen9d568c02014-09-08 14:17:59 -0700890 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700891 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800892 * notification. If no custom component exists then this is sent to the default dialer which
893 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700894 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700895 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
896 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
897
898 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800899 * The number of calls associated with the notification. If the number is zero then the missed
900 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700901 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700902 public static final String EXTRA_NOTIFICATION_COUNT =
903 "android.telecom.extra.NOTIFICATION_COUNT";
904
905 /**
906 * The number associated with the missed calls. This number is only relevant
907 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700908 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700909 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
910 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
911
912 /**
Tyler Gunna2879412023-02-28 23:41:53 +0000913 * Included in the extras of the {@link #ACTION_SHOW_MISSED_CALLS_NOTIFICATION}, provides a
914 * pending intent which can be used to clear the missed calls notification and mark unread
915 * missed call log entries as read.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700916 * @hide
Tyler Gunna2879412023-02-28 23:41:53 +0000917 * @deprecated Use {@link #cancelMissedCallsNotification()} instead.
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700918 */
Tyler Gunna2879412023-02-28 23:41:53 +0000919 @Deprecated
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700920 @SystemApi
921 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
922 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
923
924 /**
925 * The intent to call back a missed call.
926 * @hide
927 */
928 @SystemApi
929 public static final String EXTRA_CALL_BACK_INTENT =
930 "android.telecom.extra.CALL_BACK_INTENT";
931
932 /**
Charles He858f1322017-11-27 17:11:04 -0800933 * The dialer activity responsible for placing emergency calls from, for example, a locked
934 * keyguard.
935 * @hide
936 */
937 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
938 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
939
940 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800941 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
942 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn00d737b2019-10-31 13:04:37 -0700943 * <p>
944 * The call initiator can use this extra to indicate that a call used assisted dialing to help
945 * place the call. This is most commonly used by a Dialer app which provides the ability to
946 * automatically add dialing prefixes when placing international calls.
947 * <p>
948 * Setting this extra on the outgoing call extras will cause the
Tyler Gunn754493b2020-01-27 10:30:51 -0800949 * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
950 * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
Tyler Gunn00d737b2019-10-31 13:04:37 -0700951 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
952 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
953 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800954 */
955 public static final String EXTRA_USE_ASSISTED_DIALING =
956 "android.telecom.extra.USE_ASSISTED_DIALING";
957
958 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800959 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
960 * the source where user initiated this call. This data is used in metrics.
Hall Liuba820bd2020-01-22 17:17:13 -0800961 * Valid sources are:
962 * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
963 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
964 * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800965 *
Hall Liu2ef04112020-09-14 18:34:10 -0700966 * Intended for use with the platform emergency dialer only.
Shaotang Li8cec25c2018-07-19 17:29:39 +0800967 * @hide
968 */
Hall Liu2ef04112020-09-14 18:34:10 -0700969 @SystemApi
Shaotang Li8cec25c2018-07-19 17:29:39 +0800970 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
971
972 /**
Ayush Sharma527b5072023-01-06 10:14:43 +0000973 * Intent action to trigger "switch to managed profile" dialog for call in SystemUI
974 *
975 * @hide
976 */
977 public static final String ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG =
978 "android.telecom.action.SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG";
979
980 /**
981 * Extra specifying the managed profile user id.
982 * This is used with {@link TelecomManager#ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG}
983 *
984 * @hide
985 */
986 public static final String EXTRA_MANAGED_PROFILE_USER_ID =
987 "android.telecom.extra.MANAGED_PROFILE_USER_ID";
988
989 /**
Hall Liuba820bd2020-01-22 17:17:13 -0800990 * Indicating the call is initiated via emergency dialer's shortcut button.
991 *
992 * @hide
993 */
Hall Liu2ef04112020-09-14 18:34:10 -0700994 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -0800995 public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
996
997 /**
998 * Indicating the call is initiated via emergency dialer's dialpad.
999 *
1000 * @hide
1001 */
Hall Liu2ef04112020-09-14 18:34:10 -07001002 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -08001003 public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
1004
1005 /**
1006 * Indicating the call source is not specified.
1007 *
1008 * @hide
1009 */
Hall Liu2ef04112020-09-14 18:34:10 -07001010 @SystemApi
Hall Liuba820bd2020-01-22 17:17:13 -08001011 public static final int CALL_SOURCE_UNSPECIFIED = 0;
1012
1013 /**
Nancy Chen9d568c02014-09-08 14:17:59 -07001014 * The following 4 constants define how properties such as phone numbers and names are
1015 * displayed to the user.
1016 */
1017
Santos Cordoned769ae2015-05-13 18:47:38 -07001018 /**
1019 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -08001020 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001021 public static final int PRESENTATION_ALLOWED = 1;
1022
Santos Cordoned769ae2015-05-13 18:47:38 -07001023 /**
1024 * Indicates that the address or number of a call is blocked by the other party.
1025 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001026 public static final int PRESENTATION_RESTRICTED = 2;
1027
Santos Cordoned769ae2015-05-13 18:47:38 -07001028 /**
1029 * Indicates that the address or number of a call is not specified or known by the carrier.
1030 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001031 public static final int PRESENTATION_UNKNOWN = 3;
1032
Santos Cordoned769ae2015-05-13 18:47:38 -07001033 /**
1034 * Indicates that the address or number of a call belongs to a pay phone.
1035 */
Nancy Chen9d568c02014-09-08 14:17:59 -07001036 public static final int PRESENTATION_PAYPHONE = 4;
1037
Grace Jiacc16b042021-08-09 09:06:11 -07001038 /**
1039 * Indicates that the address or number of a call is unavailable.
1040 */
1041 public static final int PRESENTATION_UNAVAILABLE = 5;
1042
Hall Liu4a9fde12020-01-16 17:38:46 -08001043
1044 /*
1045 * Values for the adb property "persist.radio.videocall.audio.output"
1046 */
1047 /** @hide */
1048 public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1049 /** @hide */
1050 public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1051 /** @hide */
1052 public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1053
Tyler Gunn00d737b2019-10-31 13:04:37 -07001054 /** @hide */
1055 @Retention(RetentionPolicy.SOURCE)
1056 @IntDef(
1057 prefix = { "PRESENTATION_" },
1058 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
Grace Jiacc16b042021-08-09 09:06:11 -07001059 PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
Tyler Gunn00d737b2019-10-31 13:04:37 -07001060 public @interface Presentation {}
1061
Brad Ebingera8366ae2021-03-23 21:01:51 +00001062
1063 /**
1064 * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1065 * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1066 * and {@link android.telephony.TelephonyCallback.CallStateListener}.
Brad Ebingerd0812632021-04-17 16:11:42 -07001067 * @hide
Brad Ebingera8366ae2021-03-23 21:01:51 +00001068 */
1069 @ChangeId
1070 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1071 // this magic number is a bug ID
1072 public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1073
Grace Jiab13eb2c2021-04-21 14:13:26 -07001074 /**
1075 * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1076 * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1077 * @hide
1078 */
1079 @ChangeId
1080 @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1081 // bug ID
1082 public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1083
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001084 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -07001085
Kevin Jeon767cda32020-11-17 01:40:16 +00001086
1087 /** Cached service handles, cleared by resetServiceCache() at death */
1088 private static final Object CACHE_LOCK = new Object();
1089
1090 @GuardedBy("CACHE_LOCK")
1091 private static ITelecomService sTelecomService;
1092 @GuardedBy("CACHE_LOCK")
1093 private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1094
Yorke Leeb4ce1432014-06-09 13:53:23 -07001095 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -07001096
Hall Liue1bc2ec2015-10-09 15:58:37 -07001097 private final ITelecomService mTelecomServiceOverride;
1098
Thomas Stuart9bfb2432022-09-27 15:02:07 -07001099 /** @hide **/
1100 private final ClientTransactionalServiceRepository mTransactionalServiceRepository =
1101 new ClientTransactionalServiceRepository();
1102 /** @hide **/
1103 public static final int TELECOM_TRANSACTION_SUCCESS = 0;
1104 /** @hide **/
1105 public static final String TRANSACTION_CALL_ID_KEY = "TelecomCallId";
1106
Santos Cordon6c7a3882014-06-25 15:30:08 -07001107 /**
1108 * @hide
1109 */
Chen Xu4c0b06d2018-10-22 16:54:39 +00001110 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001111 public static TelecomManager from(Context context) {
1112 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -07001113 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001114
1115 /**
1116 * @hide
1117 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001118 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001119 this(context, null);
1120 }
1121
1122 /**
1123 * @hide
1124 */
1125 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001126 Context appContext = context.getApplicationContext();
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001127 if (appContext != null && Objects.equals(context.getAttributionTag(),
1128 appContext.getAttributionTag())) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001129 mContext = appContext;
1130 } else {
1131 mContext = context;
1132 }
Hall Liue1bc2ec2015-10-09 15:58:37 -07001133 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -07001134 }
1135
1136 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001137 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1138 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1139 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1140 * account returned depends on the following priorities:
1141 * <ul>
1142 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1143 * be returned.
1144 * </li>
1145 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1146 * will be returned.
1147 * </li>
1148 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001149 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -07001150 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1151 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001152 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -07001153 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001154 */
Yorke Leec61d13662015-09-21 17:25:25 -07001155 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001156 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001157 ITelecomService service = getTelecomService();
1158 if (service != null) {
1159 try {
1160 return service.getDefaultOutgoingPhoneAccount(uriScheme,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001161 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001162 } catch (RemoteException e) {
1163 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001164 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001165 }
1166 return null;
1167 }
1168
1169 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -07001170 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1171 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -07001172 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -07001173 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -07001174 * Apps must be prepared for this method to return {@code null}, indicating that there currently
1175 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001176 * <p>
1177 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001178 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001179 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1180 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -07001181 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001182 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001183 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001184 ITelecomService service = getTelecomService();
1185 if (service != null) {
1186 try {
1187 return service.getUserSelectedOutgoingPhoneAccount(
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001188 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001189 } catch (RemoteException e) {
1190 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -07001191 }
Andrew Leed4abbfb2014-09-03 14:58:27 -07001192 }
1193 return null;
1194 }
1195
1196 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001197 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1198 *
1199 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001200 * outgoing voice calls, or {@code null} if no default is specified (the
1201 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -07001202 * @hide
1203 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -08001204 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1205 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001206 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001207 ITelecomService service = getTelecomService();
1208 if (service != null) {
1209 try {
1210 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1211 } catch (RemoteException e) {
1212 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001213 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001214 }
1215 }
1216
1217 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -07001218 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001219 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1220 * for the default voice subscription.
Santos Cordon91371dc02015-05-08 13:52:09 -07001221 *
Brad Ebingere7833312019-05-07 10:55:55 -07001222 * @return The phone account handle of the current sim call manager for the default voice
1223 * subscription.
1224 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -07001225 */
1226 public PhoneAccountHandle getSimCallManager() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001227 ITelecomService service = getTelecomService();
1228 if (service != null) {
1229 try {
1230 return service.getSimCallManager(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001231 SubscriptionManager.getDefaultSubscriptionId(), mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001232 } catch (RemoteException e) {
1233 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -07001234 }
Andrew Lee59cac3a2014-08-28 16:50:10 -07001235 }
1236 return null;
1237 }
1238
1239 /**
Brad Ebingere7833312019-05-07 10:55:55 -07001240 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1241 * prepared for this method to return {@code null}, indicating that there currently exists no
1242 * SIM call manager {@link PhoneAccount} for the subscription specified.
1243 *
1244 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1245 * queried for.
1246 * @return The phone account handle of the current sim call manager.
1247 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -07001248 */
Tyler Gunn00d737b2019-10-31 13:04:37 -07001249 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001250 ITelecomService service = getTelecomService();
1251 if (service != null) {
1252 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001253 return service.getSimCallManager(subscriptionId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001254 } catch (RemoteException e) {
1255 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Brad Ebingere7833312019-05-07 10:55:55 -07001256 }
Brad Ebingere7833312019-05-07 10:55:55 -07001257 }
1258 return null;
1259 }
1260
1261 /**
1262 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1263 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1264 * must be prepared for this method to return {@code null}, indicating that there currently
1265 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001266 *
1267 * @return The phone account handle of the current sim call manager.
1268 *
1269 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001270 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -07001271 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001272 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -07001273 public PhoneAccountHandle getSimCallManager(int userId) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001274 ITelecomService service = getTelecomService();
1275 if (service != null) {
1276 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001277 return service.getSimCallManagerForUser(userId, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001278 } catch (RemoteException e) {
1279 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
Sailesh Nepalcf855622015-07-28 19:22:14 -07001280 }
Sailesh Nepalcf855622015-07-28 19:22:14 -07001281 }
1282 return null;
1283 }
1284
1285 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001286 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -07001287 * {@code null}, indicating that there currently exists no Connection Manager
1288 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001289 *
1290 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -08001291 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001292 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001293 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -07001294 public PhoneAccountHandle getConnectionManager() {
1295 return getSimCallManager();
1296 }
1297
1298 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001299 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1300 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001301 * <P>
1302 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1303 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
1304 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1305 * such as {@code sip:example@sipexample.com}).
1306 *
1307 * @param uriScheme The URI scheme.
1308 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -08001309 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001310 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001311 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001312 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001313 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001314 android.Manifest.permission.READ_PHONE_STATE
1315 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001316 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001317 ITelecomService service = getTelecomService();
1318 if (service != null) {
1319 try {
1320 return service.getPhoneAccountsSupportingScheme(uriScheme,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001321 mContext.getOpPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001322 } catch (RemoteException e) {
1323 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001324 }
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001325 }
1326 return new ArrayList<>();
1327 }
1328
Nancy Chen513c8922014-09-17 14:47:20 -07001329
1330 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001331 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1332 * calls. The returned list includes only those accounts which have been explicitly enabled
1333 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -07001334 *
1335 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1336 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -07001337 */
Yorke Leec61d13662015-09-21 17:25:25 -07001338 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -07001339 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001340 return getCallCapablePhoneAccounts(false);
1341 }
1342
1343 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001344 * Returns a list of {@link PhoneAccountHandle}s for all self-managed
1345 * {@link ConnectionService}s owned by the calling {@link UserHandle}.
Tyler Gunn89317072017-04-07 14:57:37 -07001346 * <p>
1347 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1348 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1349 * <p>
1350 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
Thomas Stuart510f49a2022-01-28 23:06:57 +00001351 * is the default dialer app.
Tyler Gunn89317072017-04-07 14:57:37 -07001352 * <p>
Thomas Stuart510f49a2022-01-28 23:06:57 +00001353 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1354 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
Tyler Gunn89317072017-04-07 14:57:37 -07001355 *
1356 * @return A list of {@code PhoneAccountHandle} objects.
1357 */
Thomas Stuart510f49a2022-01-28 23:06:57 +00001358 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1359 public @NonNull List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001360 ITelecomService service = getTelecomService();
1361 if (service != null) {
1362 try {
1363 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001364 mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001365 } catch (RemoteException e) {
1366 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
Tyler Gunn89317072017-04-07 14:57:37 -07001367 }
Tyler Gunn89317072017-04-07 14:57:37 -07001368 }
1369 return new ArrayList<>();
1370 }
1371
1372 /**
Thomas Stuart510f49a2022-01-28 23:06:57 +00001373 * Returns a list of {@link PhoneAccountHandle}s owned by the calling self-managed
1374 * {@link ConnectionService}.
1375 * <p>
1376 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1377 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1378 * <p>
1379 * Requires permission {@link android.Manifest.permission#MANAGE_OWN_CALLS}
1380 * <p>
1381 * A {@link SecurityException} will be thrown if a caller lacks the
1382 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission.
1383 *
1384 * @return A list of {@code PhoneAccountHandle} objects.
1385 */
1386 @RequiresPermission(Manifest.permission.MANAGE_OWN_CALLS)
1387 public @NonNull List<PhoneAccountHandle> getOwnSelfManagedPhoneAccounts() {
1388 ITelecomService service = getTelecomService();
1389 if (service != null) {
1390 try {
1391 return service.getOwnSelfManagedPhoneAccounts(mContext.getOpPackageName(),
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001392 mContext.getAttributionTag()).getList();
Thomas Stuart510f49a2022-01-28 23:06:57 +00001393 } catch (RemoteException e) {
1394 throw e.rethrowFromSystemServer();
1395 }
1396 }
1397 throw new IllegalStateException("Telecom is not available");
1398 }
1399
1400 /**
Santos Cordon91371dc02015-05-08 13:52:09 -07001401 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1402 * by the user.
1403 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001404 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001405 * when {@code false}, only enabled phone accounts will be
1406 * included.
Santos Cordon91371dc02015-05-08 13:52:09 -07001407 * @return A list of {@code PhoneAccountHandle} objects.
1408 * @hide
1409 */
Hall Liub2306242019-11-15 17:13:05 -08001410 @SystemApi
Hall Liub2306242019-11-15 17:13:05 -08001411 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1412 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1413 boolean includeDisabledAccounts) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001414 ITelecomService service = getTelecomService();
1415 if (service != null) {
1416 try {
1417 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001418 mContext.getOpPackageName(), mContext.getAttributionTag()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001419 } catch (RemoteException e) {
1420 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1421 + includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001422 }
Nancy Chen513c8922014-09-17 14:47:20 -07001423 }
1424 return new ArrayList<>();
1425 }
1426
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001427 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001428 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1429 *
Grace Jia0128b3c2020-06-23 12:53:17 -07001430 * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1431 * {@link PhoneAccountHandle} for the calling package.
Nancy Chen513c8922014-09-17 14:47:20 -07001432 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001433 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001434 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001435 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001436 @SuppressLint("RequiresPermission")
Grace Jia0128b3c2020-06-23 12:53:17 -07001437 @Deprecated
Nancy Chen513c8922014-09-17 14:47:20 -07001438 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001439 ITelecomService service = getTelecomService();
1440 if (service != null) {
1441 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001442 return service.getPhoneAccountsForPackage(mContext.getPackageName()).getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001443 } catch (RemoteException e) {
1444 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001445 }
Nancy Chen513c8922014-09-17 14:47:20 -07001446 }
1447 return null;
1448 }
1449
1450 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001451 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1452 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001453 *
Grace Jiab13eb2c2021-04-21 14:13:26 -07001454 * Requires Permission:
1455 * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1456 * level 31+.
Evan Charlton6eb262c2014-07-19 18:18:19 -07001457 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001458 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001459 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001460 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001461 ITelecomService service = getTelecomService();
1462 if (service != null) {
1463 try {
Grace Jiab13eb2c2021-04-21 14:13:26 -07001464 return service.getPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001465 } catch (RemoteException e) {
1466 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001467 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001468 }
1469 return null;
1470 }
1471
1472 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001473 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001474 *
Nancy Chen210ef032014-09-15 17:58:42 -07001475 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001476 * @hide
1477 */
1478 @SystemApi
1479 public int getAllPhoneAccountsCount() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001480 ITelecomService service = getTelecomService();
1481 if (service != null) {
1482 try {
1483 return service.getAllPhoneAccountsCount();
1484 } catch (RemoteException e) {
1485 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001486 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001487 }
1488 return 0;
1489 }
1490
1491 /**
1492 * Returns a list of all {@link PhoneAccount}s.
1493 *
1494 * @return All {@link PhoneAccount}s.
1495 * @hide
1496 */
1497 @SystemApi
1498 public List<PhoneAccount> getAllPhoneAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001499 ITelecomService service = getTelecomService();
1500 if (service != null) {
1501 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001502 return service.getAllPhoneAccounts().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001503 } catch (RemoteException e) {
1504 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001505 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001506 }
1507 return Collections.EMPTY_LIST;
1508 }
1509
1510 /**
1511 * Returns a list of all {@link PhoneAccountHandle}s.
1512 *
1513 * @return All {@link PhoneAccountHandle}s.
1514 * @hide
1515 */
1516 @SystemApi
1517 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001518 ITelecomService service = getTelecomService();
1519 if (service != null) {
1520 try {
Thomas Stuart81fe8f32022-06-23 14:27:43 -07001521 return service.getAllPhoneAccountHandles().getList();
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001522 } catch (RemoteException e) {
1523 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001524 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001525 }
1526 return Collections.EMPTY_LIST;
1527 }
1528
1529 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001530 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1531 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1532 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001533 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1534 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1535 * the phone app settings before the account is usable.
1536 * <p>
Thomas Stuarte0416212022-01-31 20:31:42 +00001537 * Note: Each package is limited to 10 {@link PhoneAccount} registrations.
1538 * <p>
Santos Cordond9e614f2014-10-28 13:10:36 -07001539 * A {@link SecurityException} will be thrown if an app tries to register a
1540 * {@link PhoneAccountHandle} where the package name specified within
1541 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Thomas Stuarte0416212022-01-31 20:31:42 +00001542 * <p>
1543 * A {@link IllegalArgumentException} will be thrown if an app tries to register a
1544 * {@link PhoneAccount} when the upper bound limit, 10, has already been reached.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001545 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001546 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001547 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001548 public void registerPhoneAccount(PhoneAccount account) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001549 ITelecomService service = getTelecomService();
1550 if (service != null) {
1551 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001552 service.registerPhoneAccount(account, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001553 } catch (RemoteException e) {
1554 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001555 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001556 }
1557 }
1558
1559 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001560 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001561 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001562 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001563 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001564 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001565 ITelecomService service = getTelecomService();
1566 if (service != null) {
1567 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001568 service.unregisterPhoneAccount(accountHandle, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001569 } catch (RemoteException e) {
1570 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001571 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001572 }
1573 }
1574
1575 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001576 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001577 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001578 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001579 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001580 @SuppressLint("RequiresPermission")
Yorke Lee06044272015-04-14 15:16:59 -07001581 public void clearPhoneAccounts() {
1582 clearAccounts();
1583 }
1584 /**
1585 * Remove all Accounts that belong to the calling package from the system.
1586 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1587 * @hide
1588 */
1589 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001590 @SuppressLint("RequiresPermission")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001591 public void clearAccounts() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001592 ITelecomService service = getTelecomService();
1593 if (service != null) {
1594 try {
1595 service.clearAccounts(mContext.getPackageName());
1596 } catch (RemoteException e) {
1597 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001598 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001599 }
1600 }
1601
1602 /**
Anthony Lee67279262014-10-27 11:28:40 -07001603 * Remove all Accounts that belong to the specified package from the system.
1604 * @hide
1605 */
1606 public void clearAccountsForPackage(String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001607 ITelecomService service = getTelecomService();
1608 if (service != null) {
1609 try {
1610 if (!TextUtils.isEmpty(packageName)) {
1611 service.clearAccounts(packageName);
1612 }
1613 } catch (RemoteException e) {
1614 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001615 }
Anthony Lee67279262014-10-27 11:28:40 -07001616 }
1617 }
1618
Yorke Lee1011f482015-04-23 15:58:27 -07001619
Anthony Lee67279262014-10-27 11:28:40 -07001620 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001621 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1622 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001623 * @hide
1624 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001625 @SystemApi
Aurimas Liutikas1394a012020-11-12 18:26:09 -08001626 @SuppressLint("RequiresPermission")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001627 public ComponentName getDefaultPhoneApp() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001628 ITelecomService service = getTelecomService();
1629 if (service != null) {
1630 try {
1631 return service.getDefaultPhoneApp();
1632 } catch (RemoteException e) {
1633 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001634 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001635 }
1636 return null;
1637 }
1638
Santos Cordon9eb45932014-06-27 12:28:43 -07001639 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001640 * Used to determine the currently selected default dialer package.
1641 *
1642 * @return package name for the default dialer package or null if no package has been
1643 * selected as the default dialer.
1644 */
1645 public String getDefaultDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001646 ITelecomService service = getTelecomService();
1647 if (service != null) {
1648 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001649 return service.getDefaultDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001650 } catch (RemoteException e) {
1651 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001652 }
Yorke Lee1011f482015-04-23 15:58:27 -07001653 }
1654 return null;
1655 }
1656
1657 /**
Tyler Gunn00d737b2019-10-31 13:04:37 -07001658 * Used to determine the currently selected default dialer package for a specific user.
1659 *
Tyler Gunn754493b2020-01-27 10:30:51 -08001660 * @param userHandle the user id to query the default dialer package for.
Tyler Gunn00d737b2019-10-31 13:04:37 -07001661 * @return package name for the default dialer package or null if no package has been
1662 * selected as the default dialer.
1663 * @hide
1664 */
1665 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07001666 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn754493b2020-01-27 10:30:51 -08001667 public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001668 ITelecomService service = getTelecomService();
1669 if (service != null) {
1670 try {
1671 return service.getDefaultDialerPackageForUser(
Tyler Gunn754493b2020-01-27 10:30:51 -08001672 userHandle.getIdentifier());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001673 } catch (RemoteException e) {
1674 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
Tyler Gunn00d737b2019-10-31 13:04:37 -07001675 }
Tyler Gunn00d737b2019-10-31 13:04:37 -07001676 }
1677 return null;
1678 }
1679
1680 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001681 * Used to set the default dialer package.
1682 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001683 * @param packageName to set the default dialer to, or {@code null} if the system provided
1684 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001685 *
1686 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1687 * the specified package does not correspond to an installed dialer, or is already
1688 * the default dialer.
1689 *
Yorke Lee107c4ce2015-06-15 12:08:24 -07001690 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001691 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001692 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1693 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001694 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001695 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001696 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001697 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001698 @RequiresPermission(allOf = {
1699 android.Manifest.permission.MODIFY_PHONE_STATE,
1700 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001701 public boolean setDefaultDialer(@Nullable String packageName) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001702 ITelecomService service = getTelecomService();
1703 if (service != null) {
1704 try {
1705 return service.setDefaultDialer(packageName);
1706 } catch (RemoteException e) {
1707 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
Yorke Lee107c4ce2015-06-15 12:08:24 -07001708 }
Yorke Lee107c4ce2015-06-15 12:08:24 -07001709 }
1710 return false;
1711 }
1712
1713 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001714 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001715 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001716 * @return package name for the system dialer package or {@code null} if no system dialer is
1717 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001718 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001719 public @Nullable String getSystemDialerPackage() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001720 ITelecomService service = getTelecomService();
1721 if (service != null) {
1722 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00001723 return service.getSystemDialerPackage(mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001724 } catch (RemoteException e) {
1725 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
Yorke Lee1011f482015-04-23 15:58:27 -07001726 }
Yorke Lee1011f482015-04-23 15:58:27 -07001727 }
1728 return null;
1729 }
1730
1731 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001732 * Return whether a given phone number is the configured voicemail number for a
1733 * particular phone account.
1734 *
1735 * @param accountHandle The handle for the account to check the voicemail number against
1736 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001737 */
Yorke Leec61d13662015-09-21 17:25:25 -07001738 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001739 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001740 ITelecomService service = getTelecomService();
1741 if (service != null) {
1742 try {
1743 return service.isVoiceMailNumber(accountHandle, number,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001744 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001745 } catch (RemoteException e) {
1746 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001747 }
Nancy Chen443e5012014-10-15 15:48:21 -07001748 }
1749 return false;
1750 }
1751
1752 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001753 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001754 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001755 * @param accountHandle The handle for the phone account.
1756 * @return The voicemail number for the phone account, and {@code null} if one has not been
1757 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001758 */
Yorke Leec61d13662015-09-21 17:25:25 -07001759 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001760 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001761 ITelecomService service = getTelecomService();
1762 if (service != null) {
1763 try {
1764 return service.getVoiceMailNumber(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001765 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001766 } catch (RemoteException e) {
1767 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001768 }
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001769 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001770 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001771 }
1772
1773 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001774 * Return the line 1 phone number for given phone account.
1775 *
Michael Groover08490f12020-03-24 14:08:14 -07001776 * <p>Requires Permission:
1777 * {@link android.Manifest.permission#READ_SMS READ_SMS},
1778 * {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1779 * or that the caller is the default SMS app for any API level.
1780 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1781 * for apps targeting SDK API level 29 and below.
Yorke Leec61d13662015-09-21 17:25:25 -07001782 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001783 * @param accountHandle The handle for the account retrieve a number for.
1784 * @return A string representation of the line 1 phone number.
Meng Wang8665b512021-11-18 15:13:43 -08001785 * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1786 * Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1787 * from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
Nancy Chen5cf27842015-01-24 23:30:27 -08001788 */
Meng Wang8665b512021-11-18 15:13:43 -08001789 @Deprecated
Michael Groover08490f12020-03-24 14:08:14 -07001790 @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1791 @RequiresPermission(anyOf = {
1792 android.Manifest.permission.READ_PHONE_STATE,
1793 android.Manifest.permission.READ_SMS,
1794 android.Manifest.permission.READ_PHONE_NUMBERS
1795 }, conditional = true)
Nancy Chen5cf27842015-01-24 23:30:27 -08001796 public String getLine1Number(PhoneAccountHandle accountHandle) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001797 ITelecomService service = getTelecomService();
1798 if (service != null) {
1799 try {
1800 return service.getLine1Number(accountHandle,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001801 mContext.getOpPackageName(), mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001802 } catch (RemoteException e) {
1803 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
Nancy Chen5cf27842015-01-24 23:30:27 -08001804 }
Nancy Chen5cf27842015-01-24 23:30:27 -08001805 }
1806 return null;
1807 }
1808
1809 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001810 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001811 * states) originating from either a manager or self-managed {@link ConnectionService}.
Tyler Gunn24e18332017-02-10 09:42:49 -08001812 *
1813 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1814 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001815 */
Yorke Leec61d13662015-09-21 17:25:25 -07001816 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001817 public boolean isInCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001818 ITelecomService service = getTelecomService();
1819 if (service != null) {
1820 try {
1821 return service.isInCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001822 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001823 } catch (RemoteException e) {
1824 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001825 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001826 }
1827 return false;
1828 }
1829
1830 /**
Shuo Qian93273fd2021-02-10 15:12:09 -08001831 * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1832 * permission. The permission can be obtained by associating with a physical wearable device
1833 * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1834 * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
Shuo Qian4d065262020-10-20 11:04:28 -07001835 *
1836 * @return {@code true} if the caller has {@link InCallService} access for
1837 * companion app; {@code false} otherwise.
1838 */
Shuo Qian93273fd2021-02-10 15:12:09 -08001839 public boolean hasManageOngoingCallsPermission() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001840 ITelecomService service = getTelecomService();
1841 if (service != null) {
1842 try {
Shuo Qian93273fd2021-02-10 15:12:09 -08001843 return service.hasManageOngoingCallsPermission(
Shuo Qian4d065262020-10-20 11:04:28 -07001844 mContext.getOpPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001845 } catch (RemoteException e) {
Shuo Qian93273fd2021-02-10 15:12:09 -08001846 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001847 if (!isSystemProcess()) {
1848 e.rethrowAsRuntimeException();
1849 }
Shuo Qian4d065262020-10-20 11:04:28 -07001850 }
1851 }
1852 return false;
1853 }
1854
1855 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001856 * Returns whether there is an ongoing call originating from a managed
1857 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1858 * states.
1859 * <p>
1860 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1861 * instead.
Tyler Gunn24e18332017-02-10 09:42:49 -08001862 *
1863 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1864 * {@code false} otherwise.
1865 */
1866 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1867 public boolean isInManagedCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001868 ITelecomService service = getTelecomService();
1869 if (service != null) {
1870 try {
1871 return service.isInManagedCall(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08001872 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001873 } catch (RemoteException e) {
1874 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
Tyler Gunn24e18332017-02-10 09:42:49 -08001875 }
Tyler Gunn24e18332017-02-10 09:42:49 -08001876 }
1877 return false;
1878 }
1879
1880 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001881 * Returns one of the following constants that represents the current state of Telecom:
1882 *
1883 * {@link TelephonyManager#CALL_STATE_RINGING}
1884 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1885 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001886 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001887 * Takes into consideration both managed and self-managed calls.
Brad Ebingera8366ae2021-03-23 21:01:51 +00001888 * <p>
1889 * Requires Permission:
1890 * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
1891 * targeting API level 31+.
Tyler Gunn24e18332017-02-10 09:42:49 -08001892 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001893 * @hide
1894 */
Brad Ebingera8366ae2021-03-23 21:01:51 +00001895 @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
1896 android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
Yorke Lee2ae312e2014-09-12 17:58:48 -07001897 @SystemApi
Chen Xuc9d4ee12019-09-26 16:11:59 -07001898 public @CallState int getCallState() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001899 ITelecomService service = getTelecomService();
1900 if (service != null) {
1901 try {
Thomas Stuartde1f1f22022-11-16 22:17:42 +00001902 return service.getCallStateUsingPackage(mContext.getOpPackageName(),
Brad Ebingera8366ae2021-03-23 21:01:51 +00001903 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001904 } catch (RemoteException e) {
1905 Log.d(TAG, "RemoteException calling getCallState().", e);
Yorke Lee2ae312e2014-09-12 17:58:48 -07001906 }
Yorke Lee2ae312e2014-09-12 17:58:48 -07001907 }
1908 return TelephonyManager.CALL_STATE_IDLE;
1909 }
1910
1911 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001912 * Returns whether there currently exists is a ringing incoming-call.
1913 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001914 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001915 * @hide
1916 */
1917 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001918 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07001919 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001920 android.Manifest.permission.READ_PHONE_STATE
1921 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001922 public boolean isRinging() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001923 ITelecomService service = getTelecomService();
1924 if (service != null) {
1925 try {
1926 return service.isRinging(mContext.getOpPackageName());
1927 } catch (RemoteException e) {
1928 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001929 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001930 }
1931 return false;
1932 }
1933
1934 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001935 * Ends the foreground call on the device.
1936 * <p>
1937 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1938 * foreground call is ended.
1939 * <p>
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001940 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1941 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001942 *
1943 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1944 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001945 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1946 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1947 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001948 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001949 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001950 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001951 public boolean endCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001952 ITelecomService service = getTelecomService();
1953 if (service != null) {
1954 try {
1955 return service.endCall(mContext.getPackageName());
1956 } catch (RemoteException e) {
1957 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001958 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001959 }
1960 return false;
1961 }
1962
1963 /**
1964 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001965 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001966 * If the incoming call is a video call, the call will be answered with the same video state as
1967 * the incoming call requests. This means, for example, that an incoming call requesting
1968 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001969 *
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001970 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1971 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001972 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001973 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1974 // this method (clockwork & gearhead).
1975 @RequiresPermission(anyOf =
1976 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001977 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001978 public void acceptRingingCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00001979 ITelecomService service = getTelecomService();
1980 if (service != null) {
1981 try {
1982 service.acceptRingingCall(mContext.getPackageName());
1983 } catch (RemoteException e) {
1984 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001985 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001986 }
1987 }
1988
1989 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001990 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1991 * with the specified video state.
1992 *
1993 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001994 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1995 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001996 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001997 @RequiresPermission(anyOf =
1998 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001999 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07002000 public void acceptRingingCall(int videoState) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002001 ITelecomService service = getTelecomService();
2002 if (service != null) {
2003 try {
2004 service.acceptRingingCallWithVideoState(
Eugene Suslacae3d3e2017-01-31 11:08:11 -08002005 mContext.getPackageName(), videoState);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002006 } catch (RemoteException e) {
2007 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
Tyler Gunn6676bb52015-10-23 14:39:49 -07002008 }
Tyler Gunn6676bb52015-10-23 14:39:49 -07002009 }
2010 }
2011
2012 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07002013 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07002014 * <p>
2015 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
2016 * already started playing. It is intended to handle use-cases such as silencing a ringing call
2017 * when the user presses the volume button during ringing.
2018 * <p>
2019 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
2020 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
2021 * <p>
2022 * A dialer app which wants to have more control over ringtone playing should declare
2023 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
2024 * {@link InCallService} implementation to indicate that the app wants to be responsible for
2025 * playing the ringtone for all incoming calls.
2026 * <p>
2027 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
2028 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07002029 */
Yorke Leec61d13662015-09-21 17:25:25 -07002030 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07002031 public void silenceRinger() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002032 ITelecomService service = getTelecomService();
2033 if (service != null) {
2034 try {
2035 service.silenceRinger(mContext.getOpPackageName());
2036 } catch (RemoteException e) {
2037 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07002038 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002039 }
2040 }
2041
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002042 /**
2043 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002044 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002045 @RequiresPermission(anyOf = {
Tyler Gunn00d737b2019-10-31 13:04:37 -07002046 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002047 android.Manifest.permission.READ_PHONE_STATE
2048 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002049 public boolean isTtySupported() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002050 ITelecomService service = getTelecomService();
2051 if (service != null) {
2052 try {
2053 return service.isTtySupported(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002054 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002055 } catch (RemoteException e) {
2056 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002057 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002058 }
2059 return false;
2060 }
2061
2062 /**
2063 * 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 -07002064 * settings and have a wired headset plugged in.
2065 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002066 * - {@link TelecomManager#TTY_MODE_OFF}
2067 * - {@link TelecomManager#TTY_MODE_FULL}
2068 * - {@link TelecomManager#TTY_MODE_HCO}
2069 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002070 * @hide
2071 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002072 @SystemApi
Tyler Gunn00d737b2019-10-31 13:04:37 -07002073 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08002074 public @TtyMode int getCurrentTtyMode() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002075 ITelecomService service = getTelecomService();
2076 if (service != null) {
2077 try {
2078 return service.getCurrentTtyMode(mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002079 mContext.getAttributionTag());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002080 } catch (RemoteException e) {
2081 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002082 }
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002083 }
Evan Charlton10197192014-07-19 15:00:29 -07002084 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07002085 }
2086
Santos Cordon96efb482014-07-19 14:57:05 -07002087 /**
2088 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08002089 * has an incoming call. For managed {@link ConnectionService}s, the specified
2090 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2091 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2092 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2093 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2094 * <p>
Tyler Gunnd8778662023-02-10 17:13:11 +00002095 * Specify the address associated with the incoming call using
2096 * {@link #EXTRA_INCOMING_CALL_ADDRESS}. If an incoming call is from an anonymous source, omit
2097 * this extra and ensure you specify a valid number presentation via
2098 * {@link Connection#setAddress(Uri, int)} on the {@link Connection} instance you return in
2099 * your
2100 * {@link ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)}
2101 * implementation.
2102 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07002103 * The incoming call you are adding is assumed to have a video state of
2104 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2105 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2106 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002107 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2108 * associated with the {@link PhoneAccountHandle} and request additional information about the
2109 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08002110 * call UI.
2111 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08002112 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2113 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2114 * the associated {@link PhoneAccount} is not currently enabled by the user.
2115 * <p>
2116 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2117 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2118 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002119 * <p>
2120 * <p>
2121 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2122 * the call is added to Telecom in order for the notification to be non-dismissible.
Santos Cordon96efb482014-07-19 14:57:05 -07002123 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2124 * {@link #registerPhoneAccount}.
2125 * @param extras A bundle that will be passed through to
2126 * {@link ConnectionService#onCreateIncomingConnection}.
2127 */
2128 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002129 ITelecomService service = getTelecomService();
2130 if (service != null) {
2131 try {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002132 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2133 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2134 Build.VERSION_CODES.O_MR1) {
2135 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2136 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08002137 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08002138 }
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002139 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras,
2140 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002141 } catch (RemoteException e) {
2142 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
Santos Cordon96efb482014-07-19 14:57:05 -07002143 }
Santos Cordon96efb482014-07-19 14:57:05 -07002144 }
2145 }
2146
Nancy Chen0eb1e402014-08-21 22:52:29 -07002147 /**
Ravi Paluri80aa2142019-12-02 11:57:37 +05302148 * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
Grace Jia8587ee52020-07-10 15:42:32 -07002149 * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2150 * call initiated on another device which the user is being invited to join in. For managed
2151 * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2152 * registered with {@link #registerPhoneAccount} and the user must have enabled the
2153 * corresponding {@link PhoneAccount}. This can be checked using
2154 * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2155 * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302156 * <p>
2157 * The incoming conference you are adding is assumed to have a video state of
2158 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2159 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2160 * <p>
2161 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2162 * associated with the {@link PhoneAccountHandle} and request additional information about the
Grace Jia8587ee52020-07-10 15:42:32 -07002163 * call (See
2164 * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2165 * before starting the incoming call UI.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302166 * <p>
2167 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2168 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2169 * the associated {@link PhoneAccount} is not currently enabled by the user.
2170 *
2171 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2172 * {@link #registerPhoneAccount}.
2173 * @param extras A bundle that will be passed through to
2174 * {@link ConnectionService#onCreateIncomingConference}.
2175 */
Ravi Paluri80aa2142019-12-02 11:57:37 +05302176 public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2177 @NonNull Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002178 ITelecomService service = getTelecomService();
2179 if (service != null) {
2180 try {
2181 service.addNewIncomingConference(
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002182 phoneAccount, extras == null ? new Bundle() : extras,
2183 mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002184 } catch (RemoteException e) {
2185 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
Ravi Paluri80aa2142019-12-02 11:57:37 +05302186 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05302187 }
2188 }
2189
2190 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07002191 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2192 * service. This is invoked when Telephony detects a new unknown connection that was neither
2193 * a new incoming call, nor an user-initiated outgoing call.
2194 *
2195 * @param phoneAccount A {@link PhoneAccountHandle} registered with
2196 * {@link #registerPhoneAccount}.
2197 * @param extras A bundle that will be passed through to
2198 * {@link ConnectionService#onCreateIncomingConnection}.
2199 * @hide
2200 */
2201 @SystemApi
2202 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002203 ITelecomService service = getTelecomService();
2204 if (service != null) {
2205 try {
2206 service.addNewUnknownCall(
Yorke Leec3cf9822014-10-02 09:38:39 -07002207 phoneAccount, extras == null ? new Bundle() : extras);
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002208 } catch (RemoteException e) {
2209 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
Yorke Leec3cf9822014-10-02 09:38:39 -07002210 }
Yorke Leec3cf9822014-10-02 09:38:39 -07002211 }
2212 }
2213
2214 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07002215 * Processes the specified dial string as an MMI code.
2216 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2217 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07002218 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002219 * <p>
2220 * Requires that the method-caller be set as the system dialer app.
2221 * </p>
2222 *
2223 * @param dialString The digits to dial.
2224 * @return True if the digits were processed as an MMI code, false otherwise.
2225 */
Yorke Leec61d13662015-09-21 17:25:25 -07002226 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002227 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002228 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002229 if (service != null) {
2230 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002231 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002232 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002233 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002234 }
2235 }
2236 return false;
2237 }
2238
2239 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07002240 * Processes the specified dial string as an MMI code.
2241 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2242 * Some of these sequences launch special behavior through handled by Telephony.
2243 * <p>
2244 * Requires that the method-caller be set as the system dialer app.
2245 * </p>
2246 *
2247 * @param accountHandle The handle for the account the MMI code should apply to.
2248 * @param dialString The digits to dial.
2249 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07002250 */
Yorke Leec61d13662015-09-21 17:25:25 -07002251 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07002252 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07002253 ITelecomService service = getTelecomService();
2254 if (service != null) {
2255 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002256 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2257 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07002258 } catch (RemoteException e) {
2259 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2260 }
2261 }
2262 return false;
2263 }
2264
2265 /**
Tyler Gunn1a4f0402020-11-06 09:48:16 -08002266 * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2267 * for ADN content retrieval.
Nancy Chenb2299c12014-10-29 18:22:11 -07002268 * @param accountHandle The handle for the account to derive an adn query URI for or
2269 * {@code null} to return a URI which will use the default account.
2270 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2271 * for the the content retrieve.
2272 */
Yorke Leec61d13662015-09-21 17:25:25 -07002273 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07002274 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2275 ITelecomService service = getTelecomService();
2276 if (service != null && accountHandle != null) {
2277 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002278 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07002279 } catch (RemoteException e) {
2280 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2281 }
2282 }
2283 return Uri.parse("content://icc/adn");
2284 }
2285
2286 /**
Tyler Gunna2879412023-02-28 23:41:53 +00002287 * Removes the missed-call notification if one is present and marks missed calls in the call
2288 * log as read.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002289 * <p>
Tyler Gunna2879412023-02-28 23:41:53 +00002290 * Requires that the method-caller be set as the default dialer app.
Nancy Chen0eb1e402014-08-21 22:52:29 -07002291 * </p>
2292 */
Yorke Leec61d13662015-09-21 17:25:25 -07002293 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002294 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002295 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002296 if (service != null) {
2297 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07002298 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002299 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002300 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002301 }
2302 }
2303 }
2304
2305 /**
2306 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2307 * currently no ongoing call, then this method does nothing.
2308 * <p>
2309 * Requires that the method-caller be set as the system dialer app or have the
2310 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2311 * </p>
2312 *
2313 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2314 */
Yorke Leec61d13662015-09-21 17:25:25 -07002315 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07002316 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002317 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07002318 if (service != null) {
2319 try {
Philip P. Moltmann00cf9fb2020-01-06 16:41:38 -08002320 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002321 mContext.getAttributionTag());
Nancy Chen0eb1e402014-08-21 22:52:29 -07002322 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002323 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07002324 }
2325 }
2326 }
2327
Yorke Lee3e56ba12015-04-23 12:32:36 -07002328 /**
2329 * Places a new outgoing call to the provided address using the system telecom service with
2330 * the specified extras.
2331 *
2332 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2333 * except that the outgoing call will always be sent via the system telecom service. If
2334 * method-caller is either the user selected default dialer app or preloaded system dialer
2335 * app, then emergency calls will also be allowed.
2336 *
Tyler Gunnf5035432017-01-09 09:43:12 -08002337 * Placing a call via a managed {@link ConnectionService} requires permission:
2338 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07002339 *
2340 * Usage example:
2341 * <pre>
2342 * Uri uri = Uri.fromParts("tel", "12345", null);
2343 * Bundle extras = new Bundle();
2344 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2345 * telecomManager.placeCall(uri, extras);
2346 * </pre>
2347 *
Santos Cordon7a060d52015-06-19 14:52:04 -07002348 * The following keys are supported in the supplied extras.
2349 * <ul>
2350 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2351 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2352 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2353 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2354 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08002355 * <p>
2356 * An app which implements the self-managed {@link ConnectionService} API uses
2357 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
2358 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2359 * associated {@link android.telecom.PhoneAccountHandle}.
2360 *
2361 * Self-managed {@link ConnectionService}s require permission
2362 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07002363 *
Brad Ebinger3636d742019-05-21 15:28:19 -07002364 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2365 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2366 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2367 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2368 * capability, depending on external factors, such as network conditions and Modem/SIM status.
2369 * </p>
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002370 * <p>
2371 * <p>
2372 * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2373 * the call is placed in order for the notification to be non-dismissible.
Yorke Lee3e56ba12015-04-23 12:32:36 -07002374 * @param address The address to make the call to.
2375 * @param extras Bundle of extras to use with the call.
2376 */
Tyler Gunnf5035432017-01-09 09:43:12 -08002377 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2378 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07002379 public void placeCall(Uri address, Bundle extras) {
2380 ITelecomService service = getTelecomService();
2381 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002382 if (address == null) {
2383 Log.w(TAG, "Cannot place call to empty address.");
2384 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07002385 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07002386 service.placeCall(address, extras == null ? new Bundle() : extras,
Philip P. Moltmann12ac3f42020-03-05 15:01:29 -08002387 mContext.getOpPackageName(), mContext.getAttributionTag());
Yorke Lee3e56ba12015-04-23 12:32:36 -07002388 } catch (RemoteException e) {
2389 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2390 }
2391 }
2392 }
2393
Ravi Paluri80aa2142019-12-02 11:57:37 +05302394
2395 /**
Grace Jia8587ee52020-07-10 15:42:32 -07002396 * Place a new adhoc conference call with the provided participants using the system telecom
2397 * service. This method doesn't support placing of emergency calls.
Ravi Paluri80aa2142019-12-02 11:57:37 +05302398 *
2399 * An adhoc conference call is established by providing a list of addresses to
2400 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2401 * {@link ConnectionService} is responsible for connecting all indicated participants
2402 * to a conference simultaneously.
2403 * This is in contrast to conferences formed by merging calls together (e.g. using
2404 * {@link android.telecom.Call#mergeConference()}).
2405 *
2406 * The following keys are supported in the supplied extras.
2407 * <ul>
2408 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2409 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2410 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2411 * </ul>
2412 *
2413 * @param participants List of participants to start conference with
2414 * @param extras Bundle of extras to use with the call
2415 */
2416 @RequiresPermission(android.Manifest.permission.CALL_PHONE)
2417 public void startConference(@NonNull List<Uri> participants,
2418 @NonNull Bundle extras) {
2419 ITelecomService service = getTelecomService();
2420 if (service != null) {
2421 try {
2422 service.startConference(participants, extras,
2423 mContext.getOpPackageName());
2424 } catch (RemoteException e) {
2425 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2426 }
2427 }
2428 }
2429
Santos Cordon91371dc02015-05-08 13:52:09 -07002430 /**
2431 * Enables and disables specified phone account.
2432 *
2433 * @param handle Handle to the phone account.
2434 * @param isEnabled Enable state of the phone account.
2435 * @hide
2436 */
2437 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06002438 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07002439 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2440 ITelecomService service = getTelecomService();
2441 if (service != null) {
2442 try {
2443 service.enablePhoneAccount(handle, isEnabled);
2444 } catch (RemoteException e) {
2445 Log.e(TAG, "Error enablePhoneAbbount", e);
2446 }
2447 }
2448 }
2449
Hall Liu0464b9b2016-01-12 15:32:58 -08002450 /**
2451 * Dumps telecom analytics for uploading.
2452 *
2453 * @return
2454 * @hide
2455 */
2456 @SystemApi
2457 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07002458 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08002459 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07002460 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08002461 if (service != null) {
2462 try {
2463 result = service.dumpCallAnalytics();
2464 } catch (RemoteException e) {
2465 Log.e(TAG, "Error dumping call analytics", e);
2466 }
2467 }
2468 return result;
2469 }
2470
Abhijith Shastry1908cb842016-02-02 11:10:19 -08002471 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002472 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2473 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08002474 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002475 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2476 * {@code true} for the current user.
2477 */
2478 public Intent createManageBlockedNumbersIntent() {
2479 ITelecomService service = getTelecomService();
2480 Intent result = null;
2481 if (service != null) {
2482 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002483 result = service.createManageBlockedNumbersIntent(mContext.getPackageName());
Nan Wuc51fd762022-08-01 21:08:23 +00002484 if (result != null) {
2485 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2486 mContext.getAttributionSource());
2487 }
Abhijith Shastrya26fe992016-02-29 11:40:24 -08002488 } catch (RemoteException e) {
2489 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2490 }
2491 }
2492 return result;
2493 }
2494
Fan Zhang5431ef52019-10-14 13:43:46 -07002495
2496 /**
2497 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2498 * launch the activity for emergency dialer.
2499 *
2500 * @param number Optional number to call in emergency dialer
2501 * @hide
2502 */
2503 @SystemApi
2504 @NonNull
2505 public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2506 ITelecomService service = getTelecomService();
Fan Zhang5431ef52019-10-14 13:43:46 -07002507 if (service != null) {
2508 try {
Nan Wuc51fd762022-08-01 21:08:23 +00002509 Intent result = service.createLaunchEmergencyDialerIntent(number);
2510 if (result != null) {
2511 result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2512 mContext.getAttributionSource());
2513 }
2514 return result;
Fan Zhang5431ef52019-10-14 13:43:46 -07002515 } catch (RemoteException e) {
2516 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2517 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002518 } else {
2519 Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
Fan Zhang5431ef52019-10-14 13:43:46 -07002520 }
Tyler Gunn753aa102020-04-23 10:16:26 -07002521
2522 // Telecom service knows the package name of the expected emergency dialer package; if it
2523 // is not available, then fallback to not targeting a specific package.
2524 Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2525 if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2526 intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2527 }
2528 return intent;
Fan Zhang5431ef52019-10-14 13:43:46 -07002529 }
2530
Tyler Gunnf5035432017-01-09 09:43:12 -08002531 /**
2532 * Determines whether Telecom would permit an incoming call to be added via the
2533 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2534 * {@link PhoneAccountHandle}.
2535 * <p>
2536 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2537 * in the following situations:
2538 * <ul>
2539 * <li>{@link PhoneAccount} does not have property
2540 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2541 * {@link ConnectionService}), and the active or held call limit has
2542 * been reached.</li>
2543 * <li>There is an ongoing emergency call.</li>
2544 * </ul>
2545 *
2546 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2547 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2548 * otherwise.
2549 */
2550 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08002551 if (phoneAccountHandle == null) {
2552 return false;
2553 }
2554
Tyler Gunnf5035432017-01-09 09:43:12 -08002555 ITelecomService service = getTelecomService();
2556 if (service != null) {
2557 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002558 return service.isIncomingCallPermitted(phoneAccountHandle,
2559 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002560 } catch (RemoteException e) {
2561 Log.e(TAG, "Error isIncomingCallPermitted", e);
2562 }
2563 }
2564 return false;
2565 }
2566
2567 /**
2568 * Determines whether Telecom would permit an outgoing call to be placed via the
2569 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2570 * <p>
2571 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2572 * in the following situations:
2573 * <ul>
2574 * <li>{@link PhoneAccount} does not have property
2575 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2576 * {@link ConnectionService}), and the active, held or ringing call limit has
2577 * been reached.</li>
2578 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2579 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2580 * another {@link ConnectionService}.</li>
2581 * <li>There is an ongoing emergency call.</li>
2582 * </ul>
2583 *
2584 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2585 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2586 * otherwise.
2587 */
2588 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2589 ITelecomService service = getTelecomService();
2590 if (service != null) {
2591 try {
Shuo Qian911d4642021-07-13 17:39:12 -07002592 return service.isOutgoingCallPermitted(phoneAccountHandle,
2593 mContext.getOpPackageName());
Tyler Gunnf5035432017-01-09 09:43:12 -08002594 } catch (RemoteException e) {
2595 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2596 }
2597 }
2598 return false;
2599 }
2600
Sanket Padawea8eddd42017-11-03 11:07:35 -07002601 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002602 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2603 * {@link PhoneAccountHandle} it defines.
2604 * <p>
2605 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2606 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2607 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2608 * is referred to as the source of the handover, and the video calling app is referred to as the
2609 * destination.
2610 * <p>
2611 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2612 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2613 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2614 * device.
2615 * <p>
2616 * For a full discussion of the handover process and the APIs involved, see
2617 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2618 * <p>
2619 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2620 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002621 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2622 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2623 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2624 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2625 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2626 * <p>
2627 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2628 * associated with the {@link PhoneAccountHandle} destAcct and call
2629 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2630 * <p>
2631 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2632 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2633 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2634 * user.
2635 * <p>
2636 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2637 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2638 *
2639 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2640 * {@link ConnectionService}.
2641 * @param videoState Video state after the handover.
2642 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2643 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002644 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2645 PhoneAccountHandle destAcct) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002646 ITelecomService service = getTelecomService();
2647 if (service != null) {
2648 try {
Thomas Stuartbc724ef2022-01-27 21:16:11 +00002649 service.acceptHandover(srcAddr, videoState, destAcct, mContext.getPackageName());
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002650 } catch (RemoteException e) {
2651 Log.e(TAG, "RemoteException acceptHandover: " + e);
Sanket Padawea8eddd42017-11-03 11:07:35 -07002652 }
Sanket Padawea8eddd42017-11-03 11:07:35 -07002653 }
2654 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002655
Tyler Gunn5bd90852018-09-21 09:37:07 -07002656 /**
2657 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2658 * call, as identified by the dialed number, or because a call was identified by the network
2659 * as an emergency call.
2660 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2661 * @hide
2662 */
2663 @SystemApi
2664 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2665 public boolean isInEmergencyCall() {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002666 ITelecomService service = getTelecomService();
2667 if (service != null) {
2668 try {
2669 return service.isInEmergencyCall();
2670 } catch (RemoteException e) {
2671 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2672 return false;
Tyler Gunn5bd90852018-09-21 09:37:07 -07002673 }
Tyler Gunn5bd90852018-09-21 09:37:07 -07002674 }
2675 return false;
2676 }
2677
Tyler Gunnc37445c2018-09-28 16:16:20 -07002678 /**
Tyler Gunn27bf4342022-03-25 14:17:52 -07002679 * Determines whether there are any ongoing {@link PhoneAccount#CAPABILITY_SELF_MANAGED}
2680 * calls for a given {@code packageName} and {@code userHandle}.
2681 *
2682 * @param packageName the package name of the app to check calls for.
2683 * @param userHandle the user handle on which to check for calls.
2684 * @return {@code true} if there are ongoing calls, {@code false} otherwise.
2685 * @hide
2686 */
2687 @RequiresPermission(android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE)
2688 public boolean isInSelfManagedCall(@NonNull String packageName,
2689 @NonNull UserHandle userHandle) {
2690 ITelecomService service = getTelecomService();
2691 if (service != null) {
2692 try {
2693 return service.isInSelfManagedCall(packageName, userHandle,
2694 mContext.getOpPackageName());
2695 } catch (RemoteException e) {
2696 Log.e(TAG, "RemoteException isInSelfManagedCall: " + e);
2697 e.rethrowFromSystemServer();
2698 return false;
2699 }
2700 } else {
2701 throw new IllegalStateException("Telecom service is not present");
2702 }
2703 }
2704
2705 /**
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002706 * Add a call to the Android system service Telecom. This allows the system to start tracking an
Thomas Stuart4cf5a752023-06-13 15:10:21 -07002707 * incoming or outgoing call with the specified {@link CallAttributes}. Once a call is added,
2708 * a {@link android.app.Notification.CallStyle} notification should be posted and when the
2709 * call is ready to be disconnected, use {@link CallControl#disconnect(DisconnectCause,
2710 * Executor, OutcomeReceiver)} which is provided by the
2711 * {@code pendingControl#onResult(CallControl)}.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002712 * <p>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002713 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002714 * <p>
2715 * <b>Call Lifecycle</b>: Your app is given foreground execution priority as long as you have a
2716 * valid call and are posting a {@link android.app.Notification.CallStyle} notification.
2717 * When your application is given foreground execution priority, your app is treated as a
2718 * foreground service. Foreground execution priority will prevent the
2719 * {@link android.app.ActivityManager} from killing your application when it is placed the
2720 * background. Foreground execution priority is removed from your app when all of your app's
2721 * calls terminate or your app no longer posts a valid notification.
2722 * <p>
2723 * <p>
2724 * <p>
2725 * <b>Note</b>: Only packages that register with
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002726 * {@link PhoneAccount#CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS}
2727 * can utilize this API. {@link PhoneAccount}s that set the capabilities
2728 * {@link PhoneAccount#CAPABILITY_SIM_SUBSCRIPTION},
2729 * {@link PhoneAccount#CAPABILITY_CALL_PROVIDER},
2730 * {@link PhoneAccount#CAPABILITY_CONNECTION_MANAGER}
2731 * are not supported and will cause an exception to be thrown.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002732 * <p>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002733 * <p>
2734 * <p>
2735 * <b>Usage example:</b>
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002736 * <pre>
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002737 * // Its up to your app on how you want to wrap the objects. One such implementation can be:
2738 * class MyVoipCall {
2739 * ...
2740 * public CallControlCallEventCallback handshakes = new CallControlCallback() {
2741 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002742 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002743 *
2744 * public CallEventCallback events = new CallEventCallback() {
2745 * ...
Thomas Stuart6e418b32023-02-06 08:22:08 -08002746 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002747 *
2748 * public MyVoipCall(String id){
2749 * ...
2750 * }
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002751 * }
2752 *
Thomas Stuart6e418b32023-02-06 08:22:08 -08002753 * MyVoipCall myFirstOutgoingCall = new MyVoipCall("1");
2754 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002755 * telecomManager.addCall(callAttributes,
2756 * Runnable::run,
2757 * new OutcomeReceiver() {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002758 * public void onResult(CallControl callControl) {
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002759 * // The call has been added successfully. For demonstration
2760 * // purposes, the call is disconnected immediately ...
2761 * callControl.disconnect(
2762 * new DisconnectCause(DisconnectCause.LOCAL) )
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002763 * }
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002764 * },
2765 * myFirstOutgoingCall.handshakes,
2766 * myFirstOutgoingCall.events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002767 * </pre>
2768 *
Thomas Stuart69bbffa2023-03-24 16:50:05 -07002769 * @param callAttributes attributes of the new call (incoming or outgoing, address, etc.)
2770 * @param executor execution context to run {@link CallControlCallback} updates on
2771 * @param pendingControl Receives the result of addCall transaction. Upon success, a
2772 * CallControl object is provided which can be used to do things like
2773 * disconnect the call that was added.
2774 * @param handshakes callback that receives <b>actionable</b> updates that originate from
2775 * Telecom.
2776 * @param events callback that receives <b>non</b>-actionable updates that originate
2777 * from Telecom.
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002778 */
2779 @RequiresPermission(android.Manifest.permission.MANAGE_OWN_CALLS)
2780 @SuppressLint("SamShouldBeLast")
2781 public void addCall(@NonNull CallAttributes callAttributes,
2782 @NonNull @CallbackExecutor Executor executor,
2783 @NonNull OutcomeReceiver<CallControl, CallException> pendingControl,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002784 @NonNull CallControlCallback handshakes,
2785 @NonNull CallEventCallback events) {
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002786 Objects.requireNonNull(callAttributes);
2787 Objects.requireNonNull(executor);
2788 Objects.requireNonNull(pendingControl);
Thomas Stuart6e418b32023-02-06 08:22:08 -08002789 Objects.requireNonNull(handshakes);
2790 Objects.requireNonNull(events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002791
2792 ITelecomService service = getTelecomService();
2793 if (service != null) {
2794 try {
2795 // create or add the new call to a service wrapper w/ the same phoneAccountHandle
2796 ClientTransactionalServiceWrapper transactionalServiceWrapper =
2797 mTransactionalServiceRepository.addNewCallForTransactionalServiceWrapper(
2798 callAttributes.getPhoneAccountHandle());
2799
2800 // couple all the args passed by the client
2801 String newCallId = transactionalServiceWrapper.trackCall(callAttributes, executor,
Thomas Stuart6e418b32023-02-06 08:22:08 -08002802 pendingControl, handshakes, events);
Thomas Stuart9bfb2432022-09-27 15:02:07 -07002803
2804 // send args to server to process new call
2805 service.addCall(callAttributes, transactionalServiceWrapper.getCallEventCallback(),
2806 newCallId, mContext.getOpPackageName());
2807 } catch (RemoteException e) {
2808 Log.e(TAG, "RemoteException addCall: " + e);
2809 e.rethrowFromSystemServer();
2810 }
2811 } else {
2812 throw new IllegalStateException("Telecom service is not present");
2813 }
2814 }
2815
2816 /**
Tyler Gunnc37445c2018-09-28 16:16:20 -07002817 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2818 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002819 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002820 * @hide
2821 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002822 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Kevin Jeoneddcb1b2020-11-11 00:07:39 +00002823 ITelecomService service = getTelecomService();
2824 if (service != null) {
2825 try {
2826 service.handleCallIntent(intent, callingPackageProxy);
2827 } catch (RemoteException e) {
2828 Log.e(TAG, "RemoteException handleCallIntent: " + e);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002829 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002830 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002831 }
2832
Shuo Qian4d065262020-10-20 11:04:28 -07002833 private boolean isSystemProcess() {
2834 return Process.myUid() == Process.SYSTEM_UID;
2835 }
2836
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002837 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002838 if (mTelecomServiceOverride != null) {
2839 return mTelecomServiceOverride;
2840 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002841 if (sTelecomService == null) {
2842 ITelecomService temp = ITelecomService.Stub.asInterface(
2843 ServiceManager.getService(Context.TELECOM_SERVICE));
2844 synchronized (CACHE_LOCK) {
2845 if (sTelecomService == null && temp != null) {
2846 try {
2847 sTelecomService = temp;
2848 sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2849 } catch (Exception e) {
2850 sTelecomService = null;
2851 }
2852 }
2853 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002854 }
Kevin Jeon767cda32020-11-17 01:40:16 +00002855 return sTelecomService;
2856 }
2857
2858 private static class DeathRecipient implements IBinder.DeathRecipient {
2859 @Override
2860 public void binderDied() {
2861 resetServiceCache();
2862 }
2863 }
2864
2865 private static void resetServiceCache() {
2866 synchronized (CACHE_LOCK) {
2867 if (sTelecomService != null) {
2868 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2869 sTelecomService = null;
2870 }
2871 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002872 }
Evan Charlton235c1592014-09-05 15:41:23 +00002873}