1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * 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
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * 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.
13  */
14 
15 package android.telecom;
16 
17 import static android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE;
18 import static android.content.Intent.LOCAL_FLAG_FROM_SYSTEM;
19 
20 import android.Manifest;
21 import android.annotation.CallbackExecutor;
22 import android.annotation.FlaggedApi;
23 import android.annotation.IntDef;
24 import android.annotation.NonNull;
25 import android.annotation.Nullable;
26 import android.annotation.RequiresFeature;
27 import android.annotation.RequiresPermission;
28 import android.annotation.SuppressAutoDoc;
29 import android.annotation.SuppressLint;
30 import android.annotation.SystemApi;
31 import android.annotation.SystemService;
32 import android.compat.annotation.ChangeId;
33 import android.compat.annotation.EnabledSince;
34 import android.compat.annotation.UnsupportedAppUsage;
35 import android.content.ComponentName;
36 import android.content.Context;
37 import android.content.Intent;
38 import android.content.pm.PackageManager;
39 import android.net.Uri;
40 import android.os.Build;
41 import android.os.Bundle;
42 import android.os.IBinder;
43 import android.os.OutcomeReceiver;
44 import android.os.Process;
45 import android.os.RemoteException;
46 import android.os.ServiceManager;
47 import android.os.UserHandle;
48 import android.telephony.Annotation.CallState;
49 import android.telephony.SubscriptionManager;
50 import android.telephony.TelephonyManager;
51 import android.text.TextUtils;
52 import android.util.Log;
53 
54 import com.android.internal.annotations.GuardedBy;
55 import com.android.internal.telecom.ClientTransactionalServiceRepository;
56 import com.android.internal.telecom.ClientTransactionalServiceWrapper;
57 import com.android.internal.telecom.ITelecomService;
58 import com.android.server.telecom.flags.Flags;
59 
60 import java.lang.annotation.Retention;
61 import java.lang.annotation.RetentionPolicy;
62 import java.util.ArrayList;
63 import java.util.Collections;
64 import java.util.List;
65 import java.util.Objects;
66 import java.util.concurrent.Executor;
67 
68 /**
69  * Provides access to information about active calls and registration/call-management functionality.
70  * Apps can use methods in this class to determine the current call state.
71  * <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.
79  */
80 @SuppressAutoDoc
81 @SystemService(Context.TELECOM_SERVICE)
82 @RequiresFeature(PackageManager.FEATURE_TELECOM)
83 public class TelecomManager {
84 
85     /**
86      * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
87      * 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
90      * 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
93      * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
94      * ask the connection service for more information about the call prior to showing any UI.
95      *
96      * @deprecated Use {@link #addNewIncomingCall} instead.
97      */
98     public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
99 
100     /**
101      * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
102      * sim-initiated MO call for carrier testing.
103      * @deprecated Use {@link #addNewUnknownCall} instead.
104      * @hide
105      */
106     public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
107 
108     /**
109      * 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.
119      */
120     public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
121             "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
122 
123     /**
124      * 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     /**
130      * The {@link android.content.Intent} action used to show the call settings page.
131      */
132     public static final String ACTION_SHOW_CALL_SETTINGS =
133             "android.telecom.action.SHOW_CALL_SETTINGS";
134 
135     /**
136      * 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     /**
142      * 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 =
146             "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
147 
148     /**
149      * {@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()}).
156      */
157     public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
158             "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
159 
160     /**
161      * {@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()}).
168      */
169     public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
170             "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
171 
172     /**
173      * 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>
184      * <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.
188      */
189     public static final String ACTION_CHANGE_DEFAULT_DIALER =
190             "android.telecom.action.CHANGE_DEFAULT_DIALER";
191 
192     /**
193      * 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     /**
203      * 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     /**
209      * Broadcast intent action indicating that the current default call screening app has changed.
210      * <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.
217      */
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.
224      * <p>
225      * Note: This extra is NOT used and will be deprecated in the future.
226      */
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      * Optional extra to indicate a call should not be added to the call log.
232      *
233      * @hide
234      */
235     public static final String EXTRA_DO_NOT_LOG_CALL =
236             "android.telecom.extra.DO_NOT_LOG_CALL";
237 
238     /**
239      * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
240      * indicate whether an app is the default call screening app.
241      * <p>
242      * Note: This extra is NOT used and will be deprecated in the future.
243      */
244     public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
245             "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
246 
247     /**
248      * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
249      * determines whether the speakerphone should be automatically turned on for an outgoing call.
250      */
251     public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
252             "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
253 
254     /**
255      * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
256      * determines the desired video state for an outgoing call.
257      * Valid options:
258      * {@link VideoProfile#STATE_AUDIO_ONLY},
259      * {@link VideoProfile#STATE_BIDIRECTIONAL},
260      * {@link VideoProfile#STATE_RX_ENABLED},
261      * {@link VideoProfile#STATE_TX_ENABLED}.
262      */
263     public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
264             "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
265 
266     /**
267      * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
268      * integer that determines the requested video state for an incoming call.
269      * Valid options:
270      * {@link VideoProfile#STATE_AUDIO_ONLY},
271      * {@link VideoProfile#STATE_BIDIRECTIONAL},
272      * {@link VideoProfile#STATE_RX_ENABLED},
273      * {@link VideoProfile#STATE_TX_ENABLED}.
274      */
275     public static final String EXTRA_INCOMING_VIDEO_STATE =
276             "android.telecom.extra.INCOMING_VIDEO_STATE";
277 
278     /**
279      * The extra used with an {@link android.content.Intent#ACTION_CALL} and
280      * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
281      * {@link PhoneAccountHandle} to use when making the call.
282      * <p class="note">
283      * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
284      */
285     public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
286             "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
287 
288     /**
289      * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
290      * subject which will be associated with an outgoing call.  Should only be specified if the
291      * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}
292      * or {@link PhoneAccount#CAPABILITY_CALL_COMPOSER}.
293      */
294     public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
295 
296     // Values for EXTRA_PRIORITY
297     /**
298      * Indicates the call composer call priority is normal.
299      *
300      * Reference: RCC.20 Section 2.4.4.2
301      */
302     public static final int PRIORITY_NORMAL = 0;
303 
304     /**
305      * Indicates the call composer call priority is urgent.
306      *
307      * Reference: RCC.20 Section 2.4.4.2
308      */
309     public static final int PRIORITY_URGENT = 1;
310 
311     /**
312      * Extra for the call composer call priority, either {@link #PRIORITY_NORMAL} or
313      * {@link #PRIORITY_URGENT}.
314      *
315      * Reference: RCC.20 Section 2.4.4.2
316      */
317     public static final String EXTRA_PRIORITY = "android.telecom.extra.PRIORITY";
318 
319     /**
320      * Extra for the call composer call location, an {@link android.location.Location} parcelable
321      * class to represent the geolocation as a latitude and longitude pair.
322      *
323      * Reference: RCC.20 Section 2.4.3.2
324      */
325     public static final String EXTRA_LOCATION = "android.telecom.extra.LOCATION";
326 
327     /**
328      * A boolean extra set on incoming calls to indicate that the call has a picture specified.
329      * Given that image download could take a (short) time, the EXTRA is set immediately upon
330      * adding the call to the Dialer app, this allows the Dialer app to reserve space for an image
331      * if one is expected. The EXTRA may be unset if the image download ends up failing for some
332      * reason.
333      */
334     public static final String EXTRA_HAS_PICTURE = "android.telecom.extra.HAS_PICTURE";
335 
336     /**
337      * A {@link Uri} representing the picture that was downloaded when a call is received or
338      * uploaded when a call is placed.
339      *
340      * This is a content URI within the call log provider which can be used to open a file
341      * descriptor. This could be set a short time after a call is added to the Dialer app if the
342      * download/upload is delayed for some reason. The Dialer app will receive a callback via
343      * {@link Call.Callback#onDetailsChanged} when this value has changed.
344      *
345      * Reference: RCC.20 Section 2.4.3.2
346      */
347     public static final String EXTRA_PICTURE_URI = "android.telecom.extra.PICTURE_URI";
348 
349     /**
350      * A ParcelUuid used as a token to represent a picture that was uploaded prior to the call
351      * being placed. The value of this extra should be set using the {@link android.os.ParcelUuid}
352      * obtained from the callback in {@link TelephonyManager#uploadCallComposerPicture}.
353      */
354     public static final String EXTRA_OUTGOING_PICTURE = "android.telecom.extra.OUTGOING_PICTURE";
355 
356     /**
357      * The extra used by a {@link ConnectionService} to provide the handle of the caller that
358      * has initiated a new incoming call.
359      */
360     public static final String EXTRA_INCOMING_CALL_ADDRESS =
361             "android.telecom.extra.INCOMING_CALL_ADDRESS";
362 
363     /**
364      * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
365      * metadata about the call. This {@link Bundle} will be returned to the
366      * {@link ConnectionService}.
367      */
368     public static final String EXTRA_INCOMING_CALL_EXTRAS =
369             "android.telecom.extra.INCOMING_CALL_EXTRAS";
370 
371     /**
372      * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} used to indicate
373      * that a call has an in-band ringtone associated with it.  This is used when the device is
374      * acting as an HFP headset and the Bluetooth stack has received an in-band ringtone from the
375      * the HFP host which must be played instead of any local ringtone the device would otherwise
376      * have generated.
377      *
378      * @hide
379      */
380     @SystemApi
381     public static final String EXTRA_CALL_HAS_IN_BAND_RINGTONE =
382             "android.telecom.extra.CALL_HAS_IN_BAND_RINGTONE";
383 
384     /**
385      * Optional extra for {@link android.content.Intent#ACTION_CALL} and
386      * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
387      * which contains metadata about the call. This {@link Bundle} will be saved into
388      * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
389      */
390     public static final String EXTRA_OUTGOING_CALL_EXTRAS =
391             "android.telecom.extra.OUTGOING_CALL_EXTRAS";
392 
393     /**
394      * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
395      * whether the user's dial intent is emergency; this is required to specify when the dialed
396      * number is ambiguous, identified as both emergency number and any other non-emergency number;
397      * e.g. in some situation, 611 could be both an emergency number in a country and a
398      * non-emergency number of a carrier's customer service hotline.
399      *
400      * @hide
401      */
402     @SystemApi
403     public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
404             "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
405 
406     /**
407      * A mandatory extra containing a {@link Uri} to be passed in when calling
408      * {@link #addNewUnknownCall(PhoneAccountHandle, Bundle)}. The {@link Uri} value indicates
409      * the remote handle of the new call.
410      * @hide
411      */
412     @SystemApi
413     public static final String EXTRA_UNKNOWN_CALL_HANDLE =
414             "android.telecom.extra.UNKNOWN_CALL_HANDLE";
415 
416     /**
417      * Optional extra for incoming and outgoing calls containing a long which specifies the time the
418      * call was created. This value is in milliseconds since boot.
419      * @hide
420      */
421     public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
422             "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
423 
424     /**
425      * Extra URI that is used by a dialer to query the {@link android.provider.CallLog} content
426      * provider and associate a missed call notification with a call log entry.
427      */
428     @FlaggedApi(Flags.FLAG_ADD_CALL_URI_FOR_MISSED_CALLS)
429     public static final String EXTRA_CALL_LOG_URI =
430             "android.telecom.extra.CALL_LOG_URI";
431 
432     /**
433      * Optional extra for incoming containing a long which specifies the time the
434      * call was answered by user. This value is in milliseconds.
435      * @hide
436      */
437     public static final String EXTRA_CALL_ANSWERED_TIME_MILLIS =
438             "android.telecom.extra.CALL_ANSWERED_TIME_MILLIS";
439 
440 
441     /**
442      * Optional extra for incoming and outgoing calls containing a long which specifies the Epoch
443      * time the call was created.
444      * @hide
445      */
446     public static final String EXTRA_CALL_CREATED_EPOCH_TIME_MILLIS =
447             "android.telecom.extra.CALL_CREATED_EPOCH_TIME_MILLIS";
448 
449     /**
450      * Optional extra for incoming and outgoing calls containing a long which specifies the time
451      * telecom began routing the call. This value is in milliseconds since boot.
452      * @hide
453      */
454     public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
455             "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
456 
457     /**
458      * Optional extra for incoming and outgoing calls containing a long which specifies the time
459      * telecom finished routing the call. This value is in milliseconds since boot.
460      * @hide
461      */
462     public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
463             "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
464 
465     /**
466      * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
467      * containing the disconnect code.
468      */
469     public static final String EXTRA_CALL_DISCONNECT_CAUSE =
470             "android.telecom.extra.CALL_DISCONNECT_CAUSE";
471 
472     /**
473      * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
474      * containing the disconnect message.
475      */
476     public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
477             "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
478 
479     /**
480      * A string value for {@link #EXTRA_CALL_DISCONNECT_MESSAGE}, indicates the call was dropped by
481      * lower layers
482      * @hide
483      */
484     public static final String CALL_AUTO_DISCONNECT_MESSAGE_STRING =
485             "Call dropped by lower layers";
486 
487     /**
488      * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
489      * containing the component name of the associated connection service.
490      * @hide
491      */
492     @SystemApi
493     public static final String EXTRA_CONNECTION_SERVICE =
494             "android.telecom.extra.CONNECTION_SERVICE";
495 
496     /**
497      * Optional extra for communicating the call technology used by a {@link ConnectionService}
498      * to Telecom. Valid values are:
499      * <ul>
500      *     <li>{@link TelephonyManager#PHONE_TYPE_CDMA}</li>
501      *     <li>{@link TelephonyManager#PHONE_TYPE_GSM}</li>
502      *     <li>{@link TelephonyManager#PHONE_TYPE_IMS}</li>
503      *     <li>{@link TelephonyManager#PHONE_TYPE_THIRD_PARTY}</li>
504      *     <li>{@link TelephonyManager#PHONE_TYPE_SIP}</li>
505      * </ul>
506      * @hide
507      */
508     @SystemApi
509     public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
510             "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
511 
512     /**
513      * Optional extra for communicating the call network technology used by a
514      * {@link android.telecom.Connection} to Telecom and InCallUI.
515      *
516      * {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
517      */
518     public static final String EXTRA_CALL_NETWORK_TYPE =
519             "android.telecom.extra.CALL_NETWORK_TYPE";
520 
521     /**
522      * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
523      * package name of the app specifying an alternative gateway for the call.
524      * The value is a string.
525      *
526      * (The following comment corresponds to the all GATEWAY_* extras)
527      * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
528      * alternative address to dial which is different from the one specified and displayed to
529      * the user. This alternative address is referred to as the gateway address.
530      */
531     public static final String GATEWAY_PROVIDER_PACKAGE =
532             "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
533 
534     /**
535      * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
536      * original address to dial for the call. This is used when an alternative gateway address is
537      * provided to recall the original address.
538      * The value is a {@link android.net.Uri}.
539      *
540      * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
541      */
542     public static final String GATEWAY_ORIGINAL_ADDRESS =
543             "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
544 
545     /**
546      * The number which the party on the other side of the line will see (and use to return the
547      * call).
548      * <p>
549      * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
550      * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
551      * user's expected caller ID.
552      */
553     public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
554 
555     /**
556      * The number of milliseconds that Telecom should wait after disconnecting a call via the
557      * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
558      * to make a new one.
559      * @hide
560      */
561     public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
562             "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
563 
564     /**
565      * Boolean extra specified to indicate that the intention of adding a call is to handover an
566      * existing call from the user's device to a different {@link PhoneAccount}.
567      * <p>
568      * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
569      * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
570      * existing call from the user's device to a different {@link PhoneAccount}.  This occurs on
571      * the receiving side of a handover.
572      * <p>
573      * Used when Telecom calls
574      * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
575      * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
576      * a handover to this {@link ConnectionService} from an ongoing call on the user's device.  This
577      * occurs on the initiating side of a handover.
578      * <p>
579      * The phone number of the call used by Telecom to determine which call should be handed over.
580      * @hide
581      * @deprecated Use the public handover APIs.  See
582      * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
583      */
584     @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
585     public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
586 
587     /**
588      * When {@code true} indicates that a request to create a new connection is for the purpose of
589      * a handover.  Note: This is used with the
590      * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
591      * internal communication mechanism with the {@link android.telecom.ConnectionService}.  It is
592      * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
593      * @hide
594      */
595     public static final String EXTRA_IS_HANDOVER_CONNECTION =
596             "android.telecom.extra.IS_HANDOVER_CONNECTION";
597 
598     /**
599      * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
600      * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
601      * the handover is from.
602      * @hide
603      */
604     public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
605             "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
606 
607     /**
608      * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
609      * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
610      * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
611      * {@link Connection} will be.
612      * @hide
613      */
614     public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
615 
616     /**
617      * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
618      * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
619      * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
620      */
621     public static final String EXTRA_START_CALL_WITH_RTT =
622             "android.telecom.extra.START_CALL_WITH_RTT";
623 
624     /**
625      * Start an activity indicating that the completion of an outgoing call or an incoming call
626      * which was not blocked by the {@link CallScreeningService}, and which was NOT terminated
627      * while the call was in {@link Call#STATE_AUDIO_PROCESSING}.
628      *
629      * The {@link Uri} extra {@link #EXTRA_HANDLE} will contain the uri handle(phone number) for the
630      * call which completed.
631      *
632      * The integer extra {@link #EXTRA_DISCONNECT_CAUSE} will indicate the reason for the call
633      * disconnection. See {@link #EXTRA_DISCONNECT_CAUSE} for more information.
634      *
635      * The integer extra {@link #EXTRA_CALL_DURATION} will indicate the duration of the call. See
636      * {@link #EXTRA_CALL_DURATION} for more information.
637      */
638     public static final String ACTION_POST_CALL = "android.telecom.action.POST_CALL";
639 
640     /**
641      * A {@link Uri} extra, which when set on the {@link #ACTION_POST_CALL} intent, indicates the
642      * uri handle(phone number) of the completed call.
643      */
644     public static final String EXTRA_HANDLE = "android.telecom.extra.HANDLE";
645 
646     /**
647      * A integer value provided for completed calls to indicate the reason for the call
648      * disconnection.
649      * <p>
650      * Allowed values:
651      * <ul>
652      * <li>{@link DisconnectCause#UNKNOWN}</li>
653      * <li>{@link DisconnectCause#LOCAL}</li>
654      * <li>{@link DisconnectCause#REMOTE}</li>
655      * <li>{@link DisconnectCause#REJECTED}</li>
656      * <li>{@link DisconnectCause#MISSED}</li>
657      * </ul>
658      * </p>
659      */
660     public static final String EXTRA_DISCONNECT_CAUSE = "android.telecom.extra.DISCONNECT_CAUSE";
661 
662     /**
663      * A integer value provided for completed calls to indicate the duration of the call.
664      * <p>
665      * Allowed values:
666      * <ul>
667      * <li>{@link #DURATION_VERY_SHORT}</li>
668      * <li>{@link #DURATION_SHORT}</li>
669      * <li>{@link #DURATION_MEDIUM}</li>
670      * <li>{@link #DURATION_LONG}</li>
671      * </ul>
672      * </p>
673      */
674     public static final String EXTRA_CALL_DURATION = "android.telecom.extra.CALL_DURATION";
675 
676     /**
677      * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
678      * call was < 3 seconds.
679      */
680     public static final int DURATION_VERY_SHORT = 0;
681 
682     /**
683      * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
684      * call was >= 3 seconds and < 60 seconds.
685      */
686     public static final int DURATION_SHORT = 1;
687 
688     /**
689      * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
690      * call was >= 60 seconds and < 120 seconds.
691      */
692     public static final int DURATION_MEDIUM = 2;
693 
694     /**
695      * A integer value for {@link #EXTRA_CALL_DURATION}, indicates the duration of the completed
696      * call was >= 120 seconds.
697      */
698     public static final int DURATION_LONG = 3;
699 
700     /**
701      * The threshold between {@link #DURATION_VERY_SHORT} calls and {@link #DURATION_SHORT} calls in
702      * milliseconds.
703      * @hide
704      */
705     public static final long VERY_SHORT_CALL_TIME_MS = 3000;
706 
707     /**
708      * The threshold between {@link #DURATION_SHORT} calls and {@link #DURATION_MEDIUM} calls in
709      * milliseconds.
710      * @hide
711      */
712     public static final long SHORT_CALL_TIME_MS = 60000;
713 
714     /**
715      * The threshold between {@link #DURATION_MEDIUM} calls and {@link #DURATION_LONG} calls in
716      * milliseconds.
717      * @hide
718      */
719     public static final long MEDIUM_CALL_TIME_MS = 120000;
720 
721     /**
722      * A boolean meta-data value indicating whether an {@link InCallService} implements an
723      * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
724      * would also like to replace the in-call interface should set this meta-data to {@code true} in
725      * the manifest registration of their {@link InCallService}.
726      */
727     public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
728 
729     /**
730      * A boolean meta-data value indicating whether an {@link InCallService} implements an
731      * in-call user interface to be used while the device is in car-mode (see
732      * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
733      */
734     public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
735             "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
736 
737     /**
738      * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
739      * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
740      * override the system provided ringing should set this meta-data to {@code true} in the
741      * manifest registration of their {@link InCallService}.
742      * <p>
743      * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
744      * all incoming calls.
745      */
746     public static final String METADATA_IN_CALL_SERVICE_RINGING =
747             "android.telecom.IN_CALL_SERVICE_RINGING";
748 
749     /**
750      * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
751      * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property.  An external
752      * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
753      * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
754      * informed of external calls should set this meta-data to {@code true} in the manifest
755      * registration of their {@link InCallService}.  By default, the {@link InCallService} will NOT
756      * be informed of external calls.
757      */
758     public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
759             "android.telecom.INCLUDE_EXTERNAL_CALLS";
760 
761     /**
762      * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
763      * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property.  A self-managed
764      * call is one which originates from a self-managed {@link ConnectionService} which has chosen
765      * to implement its own call user interface.  An {@link InCallService} implementation which
766      * would like to be informed of external calls should set this meta-data to {@code true} in the
767      * manifest registration of their {@link InCallService}.  By default, the {@link InCallService}
768      * will NOT be informed about self-managed calls.
769      * <p>
770      * An {@link InCallService} which receives self-managed calls is free to view and control the
771      * state of calls in the self-managed {@link ConnectionService}.  An example use-case is
772      * exposing these calls to an automotive device via its companion app.
773      * <p>
774      * See also {@link Connection#PROPERTY_SELF_MANAGED}.
775      */
776     public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
777             "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
778 
779     /**
780      * The dual tone multi-frequency signaling character sent to indicate the dialing system should
781      * pause for a predefined period.
782      */
783     public static final char DTMF_CHARACTER_PAUSE = ',';
784 
785     /**
786      * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
787      * wait for user confirmation before proceeding.
788      */
789     public static final char DTMF_CHARACTER_WAIT = ';';
790 
791     /**
792      * @hide
793      */
794     @IntDef(prefix = { "TTY_MODE_" },
795             value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
796     @Retention(RetentionPolicy.SOURCE)
797     public @interface TtyMode {}
798 
799     /**
800      * TTY (teletypewriter) mode is off.
801      *
802      * @hide
803      */
804     @SystemApi
805     public static final int TTY_MODE_OFF = 0;
806 
807     /**
808      * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
809      * will communicate with the remote party by sending and receiving text messages.
810      *
811      * @hide
812      */
813     @SystemApi
814     public static final int TTY_MODE_FULL = 1;
815 
816     /**
817      * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
818      * speaker is on. The user will communicate with the remote party by sending text messages and
819      * hearing an audible reply.
820      *
821      * @hide
822      */
823     @SystemApi
824     public static final int TTY_MODE_HCO = 2;
825 
826     /**
827      * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
828      * microphone is still on. User will communicate with the remote party by speaking and receiving
829      * text message replies.
830      *
831      * @hide
832      */
833     @SystemApi
834     public static final int TTY_MODE_VCO = 3;
835 
836     /**
837      * Broadcast intent action indicating that the current TTY mode has changed.
838      *
839      * This intent will contain {@link #EXTRA_CURRENT_TTY_MODE} as an intent extra, giving the new
840      * TTY mode.
841      * @hide
842      */
843     @SystemApi
844     public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
845             "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
846 
847     /**
848      * Integer extra key that indicates the current TTY mode.
849      *
850      * Used with {@link #ACTION_CURRENT_TTY_MODE_CHANGED}.
851      *
852      * Valid modes are:
853      * <ul>
854      *     <li>{@link #TTY_MODE_OFF}</li>
855      *     <li>{@link #TTY_MODE_FULL}</li>
856      *     <li>{@link #TTY_MODE_HCO}</li>
857      *     <li>{@link #TTY_MODE_VCO}</li>
858      * </ul>
859      *
860      * This TTY mode is distinct from the one sent via {@link #ACTION_TTY_PREFERRED_MODE_CHANGED},
861      * since the current TTY mode will always be {@link #TTY_MODE_OFF}unless a TTY terminal is
862      * plugged into the device.
863      * @hide
864      */
865     @SystemApi
866     public static final String EXTRA_CURRENT_TTY_MODE =
867             "android.telecom.extra.CURRENT_TTY_MODE";
868 
869     /**
870      * Broadcast intent action indicating that the TTY preferred operating mode has changed.
871      *
872      * This intent will contain {@link #EXTRA_TTY_PREFERRED_MODE} as an intent extra, giving the new
873      * preferred TTY mode.
874      * @hide
875      */
876     @SystemApi
877     public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
878             "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
879 
880     /**
881      * Integer extra key that indicates the preferred TTY mode.
882      *
883      * Used with {@link #ACTION_TTY_PREFERRED_MODE_CHANGED}.
884      *
885      * Valid modes are:
886      * <ul>
887      *     <li>{@link #TTY_MODE_OFF}</li>
888      *     <li>{@link #TTY_MODE_FULL}</li>
889      *     <li>{@link #TTY_MODE_HCO}</li>
890      *     <li>{@link #TTY_MODE_VCO}</li>
891      * </ul>
892      * @hide
893      */
894     @SystemApi
895     public static final String EXTRA_TTY_PREFERRED_MODE =
896             "android.telecom.extra.TTY_PREFERRED_MODE";
897 
898     /**
899      * Broadcast intent action for letting custom component know to show the missed call
900      * notification. If no custom component exists then this is sent to the default dialer which
901      * should post a missed-call notification.
902      */
903     public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
904             "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
905 
906     /**
907      * The number of calls associated with the notification. If the number is zero then the missed
908      * call notification should be dismissed.
909      */
910     public static final String EXTRA_NOTIFICATION_COUNT =
911             "android.telecom.extra.NOTIFICATION_COUNT";
912 
913     /**
914      * The number associated with the missed calls. This number is only relevant
915      * when EXTRA_NOTIFICATION_COUNT is 1.
916      */
917     public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
918             "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
919 
920     /**
921      * Included in the extras of the {@link #ACTION_SHOW_MISSED_CALLS_NOTIFICATION}, provides a
922      * pending intent which can be used to clear the missed calls notification and mark unread
923      * missed call log entries as read.
924      * @hide
925      * @deprecated Use {@link #cancelMissedCallsNotification()} instead.
926      */
927     @Deprecated
928     @SystemApi
929     public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
930             "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
931 
932     /**
933      * The intent to call back a missed call.
934      * @hide
935      */
936     @SystemApi
937     public static final String EXTRA_CALL_BACK_INTENT =
938             "android.telecom.extra.CALL_BACK_INTENT";
939 
940     /**
941      * The dialer activity responsible for placing emergency calls from, for example, a locked
942      * keyguard.
943      * @hide
944      */
945     public static final ComponentName EMERGENCY_DIALER_COMPONENT =
946             ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
947 
948     /**
949      * The boolean indicated by this extra controls whether or not a call is eligible to undergo
950      * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
951      * <p>
952      * The call initiator can use this extra to indicate that a call used assisted dialing to help
953      * place the call.  This is most commonly used by a Dialer app which provides the ability to
954      * automatically add dialing prefixes when placing international calls.
955      * <p>
956      * Setting this extra on the outgoing call extras will cause the
957      * {@link Connection#PROPERTY_ASSISTED_DIALING} property and
958      * {@link Call.Details#PROPERTY_ASSISTED_DIALING} property to be set on the
959      * {@link Connection}/{@link Call} in question.  When the call is logged to the call log, the
960      * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
961      * indicate that assisted dialing was used for the call.
962      */
963     public static final String EXTRA_USE_ASSISTED_DIALING =
964             "android.telecom.extra.USE_ASSISTED_DIALING";
965 
966     /**
967      * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
968      * the source where user initiated this call. This data is used in metrics.
969      * Valid sources are:
970      * {@link TelecomManager#CALL_SOURCE_UNSPECIFIED},
971      * {@link TelecomManager#CALL_SOURCE_EMERGENCY_DIALPAD},
972      * {@link TelecomManager#CALL_SOURCE_EMERGENCY_SHORTCUT}.
973      *
974      * Intended for use with the platform emergency dialer only.
975      * @hide
976      */
977     @SystemApi
978     public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
979 
980     /**
981      * Intent action to trigger "switch to managed profile" dialog for call in SystemUI
982      *
983      * @hide
984      */
985     public static final String ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG =
986             "android.telecom.action.SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG";
987 
988     /**
989      * Extra specifying the managed profile user id.
990      * This is used with {@link TelecomManager#ACTION_SHOW_SWITCH_TO_WORK_PROFILE_FOR_CALL_DIALOG}
991      *
992      * @hide
993      */
994     public static final String EXTRA_MANAGED_PROFILE_USER_ID =
995             "android.telecom.extra.MANAGED_PROFILE_USER_ID";
996 
997     /**
998      * Indicating the call is initiated via emergency dialer's shortcut button.
999      *
1000      * @hide
1001      */
1002     @SystemApi
1003     public static final int CALL_SOURCE_EMERGENCY_SHORTCUT = 2;
1004 
1005     /**
1006      * Indicating the call is initiated via emergency dialer's dialpad.
1007      *
1008      * @hide
1009      */
1010     @SystemApi
1011     public static final int CALL_SOURCE_EMERGENCY_DIALPAD = 1;
1012 
1013     /**
1014      * Indicating the call source is not specified.
1015      *
1016      * @hide
1017      */
1018     @SystemApi
1019     public static final int CALL_SOURCE_UNSPECIFIED = 0;
1020 
1021     /**
1022      * The following 4 constants define how properties such as phone numbers and names are
1023      * displayed to the user.
1024      */
1025 
1026     /**
1027      * Indicates that the address or number of a call is allowed to be displayed for caller ID.
1028      */
1029     public static final int PRESENTATION_ALLOWED = 1;
1030 
1031     /**
1032      * Indicates that the address or number of a call is blocked by the other party.
1033      */
1034     public static final int PRESENTATION_RESTRICTED = 2;
1035 
1036     /**
1037      * Indicates that the address or number of a call is not specified or known by the carrier.
1038      */
1039     public static final int PRESENTATION_UNKNOWN = 3;
1040 
1041     /**
1042      * Indicates that the address or number of a call belongs to a pay phone.
1043      */
1044     public static final int PRESENTATION_PAYPHONE = 4;
1045 
1046     /**
1047      * Indicates that the address or number of a call is unavailable.
1048      */
1049     public static final int PRESENTATION_UNAVAILABLE = 5;
1050 
1051 
1052     /**
1053      * Controls audio route for video calls.
1054      * 0 - Use the default audio routing strategy.
1055      * 1 - Disable the speaker. Route the audio to Headset or Bluetooth
1056      *     or Earpiece, based on the default audio routing strategy.
1057      * @hide
1058      */
1059     public static final String PROPERTY_VIDEOCALL_AUDIO_OUTPUT = "persist.radio.call.audio.output";
1060 
1061     /*
1062      * Values for the adb property "persist.radio.call.audio.output"
1063      */
1064     /** @hide */
1065     public static final int AUDIO_OUTPUT_ENABLE_SPEAKER = 0;
1066     /** @hide */
1067     public static final int AUDIO_OUTPUT_DISABLE_SPEAKER = 1;
1068     /** @hide */
1069     public static final int AUDIO_OUTPUT_DEFAULT = AUDIO_OUTPUT_ENABLE_SPEAKER;
1070 
1071     /** @hide */
1072     @Retention(RetentionPolicy.SOURCE)
1073     @IntDef(
1074             prefix = { "PRESENTATION_" },
1075             value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
1076             PRESENTATION_PAYPHONE, PRESENTATION_UNAVAILABLE})
1077     public @interface Presentation {}
1078 
1079 
1080     /**
1081      * Enable READ_PHONE_STATE protection on APIs querying and notifying call state, such as
1082      * {@code TelecomManager#getCallState}, {@link TelephonyManager#getCallStateForSubscription()},
1083      * and {@link android.telephony.TelephonyCallback.CallStateListener}.
1084      * @hide
1085      */
1086     @ChangeId
1087     @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1088     // this magic number is a bug ID
1089     public static final long ENABLE_GET_CALL_STATE_PERMISSION_PROTECTION = 157233955L;
1090 
1091     /**
1092      * Enable READ_PHONE_NUMBERS or READ_PRIVILEGED_PHONE_STATE protections on
1093      * {@link TelecomManager#getPhoneAccount(PhoneAccountHandle)}.
1094      * @hide
1095      */
1096     @ChangeId
1097     @EnabledSince(targetSdkVersion = Build.VERSION_CODES.S)
1098     // bug ID
1099     public static final long ENABLE_GET_PHONE_ACCOUNT_PERMISSION_PROTECTION = 183407956L;
1100 
1101     private static final String TAG = "TelecomManager";
1102 
1103 
1104     /** Cached service handles, cleared by resetServiceCache() at death */
1105     private static final Object CACHE_LOCK = new Object();
1106 
1107     @GuardedBy("CACHE_LOCK")
1108     private static ITelecomService sTelecomService;
1109     @GuardedBy("CACHE_LOCK")
1110     private static final DeathRecipient SERVICE_DEATH = new DeathRecipient();
1111 
1112     private final Context mContext;
1113 
1114     private final ITelecomService mTelecomServiceOverride;
1115 
1116     /** @hide **/
1117     private final ClientTransactionalServiceRepository mTransactionalServiceRepository =
1118             new ClientTransactionalServiceRepository();
1119     /** @hide **/
1120     public static final int TELECOM_TRANSACTION_SUCCESS = 0;
1121     /** @hide **/
1122     public static final String TRANSACTION_CALL_ID_KEY = "TelecomCallId";
1123 
1124     /**
1125      * @hide
1126      */
1127     @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
from(Context context)1128     public static TelecomManager from(Context context) {
1129         return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
1130     }
1131 
1132     /**
1133      * @hide
1134      */
TelecomManager(Context context)1135     public TelecomManager(Context context) {
1136         this(context, null);
1137     }
1138 
1139     /**
1140      * @hide
1141      */
TelecomManager(Context context, ITelecomService telecomServiceImpl)1142     public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
1143         Context appContext = context.getApplicationContext();
1144         if (appContext != null && Objects.equals(context.getAttributionTag(),
1145                 appContext.getAttributionTag())) {
1146             mContext = appContext;
1147         } else {
1148             mContext = context;
1149         }
1150         mTelecomServiceOverride = telecomServiceImpl;
1151     }
1152 
1153     /**
1154      * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
1155      * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
1156      * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
1157      * account returned depends on the following priorities:
1158      * <ul>
1159      * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
1160      * be returned.
1161      * </li>
1162      * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
1163      * will be returned.
1164      * </li>
1165      * </ul>
1166      * <p>
1167      * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
1168      *
1169      * @param uriScheme The URI scheme.
1170      * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
1171      */
1172     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
getDefaultOutgoingPhoneAccount(String uriScheme)1173     public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
1174         ITelecomService service = getTelecomService();
1175         if (service != null) {
1176             try {
1177                 return service.getDefaultOutgoingPhoneAccount(uriScheme,
1178                         mContext.getOpPackageName(), mContext.getAttributionTag());
1179             } catch (RemoteException e) {
1180                 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
1181             }
1182         }
1183         return null;
1184     }
1185 
1186     /**
1187      * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
1188      * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
1189      * calling {@link #getCallCapablePhoneAccounts()}
1190      * <p>
1191      * Apps must be prepared for this method to return {@code null}, indicating that there currently
1192      * exists no user-chosen default {@code PhoneAccount}.
1193      * <p>
1194      * The default dialer has access to use this method.
1195      *
1196      * @return The user outgoing phone account selected by the user, or {@code null} if there is no
1197      * user selected outgoing {@link PhoneAccountHandle}.
1198      */
1199     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
getUserSelectedOutgoingPhoneAccount()1200     public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
1201         ITelecomService service = getTelecomService();
1202         if (service != null) {
1203             try {
1204                 return service.getUserSelectedOutgoingPhoneAccount(
1205                         mContext.getOpPackageName());
1206             } catch (RemoteException e) {
1207                 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
1208             }
1209         }
1210         return null;
1211     }
1212 
1213     /**
1214      * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
1215      *
1216      * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
1217      *                      outgoing voice calls, or {@code null} if no default is specified (the
1218      *                      user will be asked each time a call is placed in this case).
1219      * @hide
1220      */
1221     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
1222     @SystemApi
setUserSelectedOutgoingPhoneAccount(@ullable PhoneAccountHandle accountHandle)1223     public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
1224         ITelecomService service = getTelecomService();
1225         if (service != null) {
1226             try {
1227                 service.setUserSelectedOutgoingPhoneAccount(accountHandle);
1228             } catch (RemoteException e) {
1229                 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
1230             }
1231         }
1232     }
1233 
1234     /**
1235      * Returns the current SIM call manager. Apps must be prepared for this method to return
1236      * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
1237      * for the default voice subscription.
1238      *
1239      * @return The phone account handle of the current sim call manager for the default voice
1240      * subscription.
1241      * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
1242      */
getSimCallManager()1243     public PhoneAccountHandle getSimCallManager() {
1244         ITelecomService service = getTelecomService();
1245         if (service != null) {
1246             try {
1247                 return service.getSimCallManager(
1248                         SubscriptionManager.getDefaultSubscriptionId(), mContext.getPackageName());
1249             } catch (RemoteException e) {
1250                 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
1251             }
1252         }
1253         return null;
1254     }
1255 
1256     /**
1257      * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
1258      * prepared for this method to return {@code null}, indicating that there currently exists no
1259      * SIM call manager {@link PhoneAccount} for the subscription specified.
1260      *
1261      * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
1262      *                       queried for.
1263      * @return The phone account handle of the current sim call manager.
1264      * @see SubscriptionManager#getActiveSubscriptionInfoList()
1265      */
getSimCallManagerForSubscription(int subscriptionId)1266     public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
1267         ITelecomService service = getTelecomService();
1268         if (service != null) {
1269             try {
1270                 return service.getSimCallManager(subscriptionId, mContext.getPackageName());
1271             } catch (RemoteException e) {
1272                 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
1273             }
1274         }
1275         return null;
1276     }
1277 
1278     /**
1279      * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
1280      * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
1281      * must be prepared for this method to return {@code null}, indicating that there currently
1282      * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
1283      *
1284      * @return The phone account handle of the current sim call manager.
1285      *
1286      * @hide
1287      * @deprecated Use {@link #getSimCallManager()}.
1288      */
1289     @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
getSimCallManager(int userId)1290     public PhoneAccountHandle getSimCallManager(int userId) {
1291         ITelecomService service = getTelecomService();
1292         if (service != null) {
1293             try {
1294                 return service.getSimCallManagerForUser(userId, mContext.getPackageName());
1295             } catch (RemoteException e) {
1296                 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
1297             }
1298         }
1299         return null;
1300     }
1301 
1302     /**
1303      * Returns the current connection manager. Apps must be prepared for this method to return
1304      * {@code null}, indicating that there currently exists no Connection Manager
1305      * {@link PhoneAccount} for the default voice subscription.
1306      *
1307      * @return The phone account handle of the current connection manager.
1308      * @hide
1309      */
1310     @SystemApi
getConnectionManager()1311     public PhoneAccountHandle getConnectionManager() {
1312         return getSimCallManager();
1313     }
1314 
1315     /**
1316      * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
1317      * calls which support the specified URI scheme.
1318      * <P>
1319      * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
1320      * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}).  Invoking with
1321      * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
1322      * such as {@code sip:example@sipexample.com}).
1323      *
1324      * @param uriScheme The URI scheme.
1325      * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
1326      * @hide
1327      */
1328     @SystemApi
1329     @RequiresPermission(anyOf = {
1330             READ_PRIVILEGED_PHONE_STATE,
1331             android.Manifest.permission.READ_PHONE_STATE
1332     })
getPhoneAccountsSupportingScheme(String uriScheme)1333     public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
1334         ITelecomService service = getTelecomService();
1335         if (service != null) {
1336             try {
1337                 return service.getPhoneAccountsSupportingScheme(uriScheme,
1338                         mContext.getOpPackageName()).getList();
1339             } catch (RemoteException e) {
1340                 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
1341             }
1342         }
1343         return new ArrayList<>();
1344     }
1345 
1346 
1347     /**
1348      * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1349      * calls. The returned list includes only those accounts which have been explicitly enabled
1350      * by the user.
1351      *
1352      * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1353      * @return A list of {@code PhoneAccountHandle} objects.
1354      */
1355     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
getCallCapablePhoneAccounts()1356     public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
1357         return getCallCapablePhoneAccounts(false);
1358     }
1359 
1360     /**
1361      * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
1362      * calls. The returned list includes those accounts which have been explicitly enabled.
1363      * In contrast to {@link #getCallCapablePhoneAccounts}, this also includes accounts from
1364      * the calling user's {@link android.os.UserManager#getUserProfiles} profile group.
1365      *
1366      * @see #EXTRA_PHONE_ACCOUNT_HANDLE
1367      * @return A list of {@code PhoneAccountHandle} objects.
1368      *
1369      * @throws IllegalStateException if telecom service is null.
1370      */
1371     @FlaggedApi(com.android.internal.telephony.flags.Flags.FLAG_WORK_PROFILE_API_SPLIT)
1372     @RequiresPermission(allOf = {android.Manifest.permission.READ_PHONE_STATE,
1373             android.Manifest.permission.INTERACT_ACROSS_PROFILES})
getCallCapablePhoneAccountsAcrossProfiles()1374     public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccountsAcrossProfiles() {
1375         return getCallCapablePhoneAccountsAcrossProfiles(false);
1376     }
1377 
1378 
1379     /**
1380      * Returns a list of {@link PhoneAccountHandle}s for all self-managed
1381      * {@link ConnectionService}s owned by the calling {@link UserHandle}.
1382      * <p>
1383      * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1384      * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1385      * <p>
1386      * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
1387      * is the default dialer app.
1388      * <p>
1389      * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1390      * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
1391      *
1392      * @return A list of {@code PhoneAccountHandle} objects.
1393      */
1394     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
getSelfManagedPhoneAccounts()1395     public @NonNull List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
1396         ITelecomService service = getTelecomService();
1397         if (service != null) {
1398             try {
1399                 return service.getSelfManagedPhoneAccounts(mContext.getOpPackageName(),
1400                         mContext.getAttributionTag()).getList();
1401             } catch (RemoteException e) {
1402                 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
1403             }
1404         }
1405         return new ArrayList<>();
1406     }
1407 
1408     /**
1409      * Returns a list of {@link PhoneAccountHandle}s owned by the calling self-managed
1410      * {@link ConnectionService}.
1411      * <p>
1412      * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1413      * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1414      * <p>
1415      * Requires permission {@link android.Manifest.permission#MANAGE_OWN_CALLS}
1416      * <p>
1417      * A {@link SecurityException} will be thrown if a caller lacks the
1418      * {@link android.Manifest.permission#MANAGE_OWN_CALLS} permission.
1419      *
1420      * @return A list of {@code PhoneAccountHandle} objects.
1421      */
1422     @RequiresPermission(Manifest.permission.MANAGE_OWN_CALLS)
getOwnSelfManagedPhoneAccounts()1423     public @NonNull List<PhoneAccountHandle> getOwnSelfManagedPhoneAccounts() {
1424         ITelecomService service = getTelecomService();
1425         if (service != null) {
1426             try {
1427                 return service.getOwnSelfManagedPhoneAccounts(mContext.getOpPackageName(),
1428                         mContext.getAttributionTag()).getList();
1429             } catch (RemoteException e) {
1430                 throw e.rethrowFromSystemServer();
1431             }
1432         }
1433         throw new IllegalStateException("Telecom is not available");
1434     }
1435 
1436     /**
1437      * This API will return all {@link PhoneAccount}s the caller registered via
1438      * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}.  If a {@link PhoneAccount} appears
1439      * to be missing from the list, Telecom has either unregistered the {@link PhoneAccount} (for
1440      * cleanup purposes) or the caller registered the {@link PhoneAccount} under a different user
1441      * and does not have the  {@link android.Manifest.permission#INTERACT_ACROSS_USERS} permission.
1442      * <b>Note:</b> This API will only return {@link PhoneAccount}s registered by the same app.  For
1443      * system Dialers that need all the {@link PhoneAccount}s registered by every application, see
1444      * {@link TelecomManager#getAllPhoneAccounts()}.
1445      *
1446      * @return all the {@link PhoneAccount}s registered by the caller.
1447      */
1448     @SuppressLint("RequiresPermission")
1449     @FlaggedApi(Flags.FLAG_GET_REGISTERED_PHONE_ACCOUNTS)
getRegisteredPhoneAccounts()1450     public @NonNull List<PhoneAccount> getRegisteredPhoneAccounts() {
1451         ITelecomService service = getTelecomService();
1452         if (service != null) {
1453             try {
1454                 return service.getRegisteredPhoneAccounts(
1455                         mContext.getOpPackageName(),
1456                         mContext.getAttributionTag()).getList();
1457             } catch (RemoteException e) {
1458                 throw e.rethrowFromSystemServer();
1459             }
1460         }
1461         throw new IllegalStateException("Telecom is not available");
1462     }
1463 
1464     /**
1465      * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1466      * by the user.
1467      *
1468      * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
1469      *                                when {@code false}, only enabled phone accounts will be
1470      *                                included.
1471      * @return A list of {@code PhoneAccountHandle} objects.
1472      * @hide
1473      */
1474     @SystemApi
1475     @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
getCallCapablePhoneAccounts( boolean includeDisabledAccounts)1476     public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1477             boolean includeDisabledAccounts) {
1478         ITelecomService service = getTelecomService();
1479         if (service != null) {
1480             try {
1481                 return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
1482                         mContext.getOpPackageName(), mContext.getAttributionTag(), false).getList();
1483             } catch (RemoteException e) {
1484                 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts("
1485                         + includeDisabledAccounts + ")", e);
1486             }
1487         }
1488         return new ArrayList<>();
1489     }
1490 
1491     /**
1492      * Returns a list of {@link PhoneAccountHandle}s visible to current user including those which
1493      * have not been enabled by the user.
1494      *
1495      * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
1496      *                                when {@code false}, only enabled phone accounts will be
1497      *                                included.
1498      * @return A list of {@code PhoneAccountHandle} objects.
1499      *
1500      * @throws IllegalStateException if telecom service is null.
1501      * @hide
1502      */
1503     @SystemApi
1504     @FlaggedApi(com.android.internal.telephony.flags.Flags.FLAG_WORK_PROFILE_API_SPLIT)
1505     @RequiresPermission(allOf = {android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
1506             android.Manifest.permission.INTERACT_ACROSS_PROFILES})
getCallCapablePhoneAccountsAcrossProfiles( boolean includeDisabledAccounts)1507     public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccountsAcrossProfiles(
1508             boolean includeDisabledAccounts) {
1509         ITelecomService service = getTelecomService();
1510         if (service == null) {
1511             throw new IllegalStateException("telecom service is null.");
1512         }
1513 
1514         try {
1515             return service.getCallCapablePhoneAccounts(includeDisabledAccounts,
1516                     mContext.getOpPackageName(), mContext.getAttributionTag(), true).getList();
1517         } catch (RemoteException e) {
1518             throw e.rethrowFromSystemServer();
1519         }
1520     }
1521 
1522     /**
1523      *  Returns a list of all {@link PhoneAccount}s registered for the calling package.
1524      *
1525      * @deprecated Use {@link #getSelfManagedPhoneAccounts()} instead to get only self-managed
1526      * {@link PhoneAccountHandle} for the calling package.
1527      * @return A list of {@code PhoneAccountHandle} objects.
1528      * @hide
1529      */
1530     @SystemApi
1531     @SuppressLint("RequiresPermission")
1532     @Deprecated
getPhoneAccountsForPackage()1533     public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
1534         ITelecomService service = getTelecomService();
1535         if (service != null) {
1536             try {
1537                 return service.getPhoneAccountsForPackage(mContext.getPackageName()).getList();
1538             } catch (RemoteException e) {
1539                 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
1540             }
1541         }
1542         return null;
1543     }
1544 
1545     /**
1546      * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1547      * resources which can be used in a user interface.
1548      *
1549      * Requires Permission:
1550      * {@link android.Manifest.permission#READ_PHONE_NUMBERS} for applications targeting API
1551      * level 31+.
1552      * @param account The {@link PhoneAccountHandle}.
1553      * @return The {@link PhoneAccount} object.
1554      */
getPhoneAccount(PhoneAccountHandle account)1555     public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
1556         ITelecomService service = getTelecomService();
1557         if (service != null) {
1558             try {
1559                 return service.getPhoneAccount(account, mContext.getPackageName());
1560             } catch (RemoteException e) {
1561                 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
1562             }
1563         }
1564         return null;
1565     }
1566 
1567     /**
1568      * Returns a count of all {@link PhoneAccount}s.
1569      *
1570      * @return The count of {@link PhoneAccount}s.
1571      * @hide
1572      */
1573     @SystemApi
getAllPhoneAccountsCount()1574     public int getAllPhoneAccountsCount() {
1575         ITelecomService service = getTelecomService();
1576         if (service != null) {
1577             try {
1578                 return service.getAllPhoneAccountsCount();
1579             } catch (RemoteException e) {
1580                 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
1581             }
1582         }
1583         return 0;
1584     }
1585 
1586     /**
1587      * Returns a list of all {@link PhoneAccount}s.
1588      *
1589      * @return All {@link PhoneAccount}s.
1590      * @hide
1591      */
1592     @SystemApi
getAllPhoneAccounts()1593     public List<PhoneAccount> getAllPhoneAccounts() {
1594         ITelecomService service = getTelecomService();
1595         if (service != null) {
1596             try {
1597                 return service.getAllPhoneAccounts().getList();
1598             } catch (RemoteException e) {
1599                 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
1600             }
1601         }
1602         return Collections.EMPTY_LIST;
1603     }
1604 
1605     /**
1606      * Returns a list of all {@link PhoneAccountHandle}s.
1607      *
1608      * @return All {@link PhoneAccountHandle}s.
1609      * @hide
1610      */
1611     @SystemApi
getAllPhoneAccountHandles()1612     public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
1613         ITelecomService service = getTelecomService();
1614         if (service != null) {
1615             try {
1616                 return service.getAllPhoneAccountHandles().getList();
1617             } catch (RemoteException e) {
1618                 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
1619             }
1620         }
1621         return Collections.EMPTY_LIST;
1622     }
1623 
1624     /**
1625      * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1626      * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1627      * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
1628      * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1629      * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1630      * the phone app settings before the account is usable.
1631      * <p>
1632      * Note: Each package is limited to 10 {@link PhoneAccount} registrations.
1633      * <p>
1634      * A {@link SecurityException} will be thrown if an app tries to register a
1635      * {@link PhoneAccountHandle} where the package name specified within
1636      * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
1637      * <p>
1638      * A {@link IllegalArgumentException} will be thrown if an app tries to register a
1639      * {@link PhoneAccount} when the upper bound limit, 10, has already been reached.
1640      *
1641      * @param account The complete {@link PhoneAccount}.
1642      * @throws UnsupportedOperationException if the caller cannot modify phone state and the device
1643      * does not have the Telecom feature.
1644      * @throws SecurityException if:
1645      * <ol>
1646      *     <li>the caller cannot modify phone state and the phone account doesn't belong to the
1647      *     calling user.</li>
1648      *     <li>the caller is registering a self-managed phone and either they are not allowed to
1649      *     manage their own calls or if the account is call capable, a connection manager, or a
1650      *     sim account.</li>
1651      *     <li>the caller is registering a sim account without the ability to do so.</li>
1652      *     <li>the caller is registering a multi-user phone account but isn't a system app.</li>
1653      *     <li>the account can make SIM-based voice calls but the caller cannot register sim
1654      *     accounts or isn't a sim call manager.</li>
1655      *     <li>the account defines the EXTRA_SKIP_CALL_FILTERING extra but the caller isn't
1656      *     able to modify the phone state.</li>
1657      *     <li>the caller is registering an account for a different user but isn't able to
1658      *     interact across users.</li>
1659      *     <li>if simultaneous calling is available and the phone account package name doesn't
1660      *     correspond to the simultaneous calling accounts associated with this phone account.</li>
1661      * </ol>
1662      */
registerPhoneAccount(PhoneAccount account)1663     public void registerPhoneAccount(PhoneAccount account) {
1664         ITelecomService service = getTelecomService();
1665         if (service != null) {
1666             try {
1667                 service.registerPhoneAccount(account, mContext.getPackageName());
1668             } catch (RemoteException e) {
1669                 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
1670             }
1671         }
1672     }
1673 
1674     /**
1675      * Remove a {@link PhoneAccount} registration from the system.
1676      *
1677      * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
1678      */
unregisterPhoneAccount(PhoneAccountHandle accountHandle)1679     public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
1680         ITelecomService service = getTelecomService();
1681         if (service != null) {
1682             try {
1683                 service.unregisterPhoneAccount(accountHandle, mContext.getPackageName());
1684             } catch (RemoteException e) {
1685                 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
1686             }
1687         }
1688     }
1689 
1690     /**
1691      * Remove all Accounts that belong to the calling package from the system.
1692      * @hide
1693      */
1694     @SystemApi
1695     @SuppressLint("RequiresPermission")
clearPhoneAccounts()1696     public void clearPhoneAccounts() {
1697         clearAccounts();
1698     }
1699     /**
1700      * Remove all Accounts that belong to the calling package from the system.
1701      * @deprecated Use {@link #clearPhoneAccounts()} instead.
1702      * @hide
1703      */
1704     @SystemApi
1705     @SuppressLint("RequiresPermission")
clearAccounts()1706     public void clearAccounts() {
1707         ITelecomService service = getTelecomService();
1708         if (service != null) {
1709             try {
1710                 service.clearAccounts(mContext.getPackageName());
1711             } catch (RemoteException e) {
1712                 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
1713             }
1714         }
1715     }
1716 
1717     /**
1718      * Remove all Accounts that belong to the specified package from the system.
1719      * @hide
1720      */
clearAccountsForPackage(String packageName)1721     public void clearAccountsForPackage(String packageName) {
1722         ITelecomService service = getTelecomService();
1723         if (service != null) {
1724             try {
1725                 if (!TextUtils.isEmpty(packageName)) {
1726                     service.clearAccounts(packageName);
1727                 }
1728             } catch (RemoteException e) {
1729                 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
1730             }
1731         }
1732     }
1733 
1734 
1735     /**
1736      * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1737      *         the default dialer's package name instead.
1738      * @hide
1739      */
1740     @SystemApi
1741     @SuppressLint("RequiresPermission")
getDefaultPhoneApp()1742     public ComponentName getDefaultPhoneApp() {
1743         ITelecomService service = getTelecomService();
1744         if (service != null) {
1745             try {
1746                 return service.getDefaultPhoneApp();
1747             } catch (RemoteException e) {
1748                 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
1749             }
1750         }
1751         return null;
1752     }
1753 
1754     /**
1755      * Used to determine the currently selected default dialer package.
1756      *
1757      * @return package name for the default dialer package or null if no package has been
1758      *         selected as the default dialer.
1759      */
getDefaultDialerPackage()1760     public String getDefaultDialerPackage() {
1761         ITelecomService service = getTelecomService();
1762         if (service != null) {
1763             try {
1764                 return service.getDefaultDialerPackage(mContext.getPackageName());
1765             } catch (RemoteException e) {
1766                 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
1767             }
1768         }
1769         return null;
1770     }
1771 
1772     /**
1773      * Used to determine the currently selected default dialer package for a specific user.
1774      *
1775      * @param userHandle the user id to query the default dialer package for.
1776      * @return package name for the default dialer package or null if no package has been
1777      *         selected as the default dialer.
1778      * @hide
1779      */
1780     @SystemApi
1781     @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
getDefaultDialerPackage(@onNull UserHandle userHandle)1782     public @Nullable String getDefaultDialerPackage(@NonNull UserHandle userHandle) {
1783         ITelecomService service = getTelecomService();
1784         if (service != null) {
1785             try {
1786                 return service.getDefaultDialerPackageForUser(
1787                         userHandle.getIdentifier());
1788             } catch (RemoteException e) {
1789                 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
1790             }
1791         }
1792         return null;
1793     }
1794 
1795     /**
1796      * Used to set the default dialer package.
1797      *
1798      * @param packageName to set the default dialer to, or {@code null} if the system provided
1799      *                    dialer should be used instead.
1800      *
1801      * @result {@code true} if the default dialer was successfully changed, {@code false} if
1802      *         the specified package does not correspond to an installed dialer, or is already
1803      *         the default dialer.
1804      *
1805      * @hide
1806      * @deprecated Use
1807      * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1808      * Executor, java.util.function.Consumer)} instead.
1809      * @removed
1810      */
1811     @SystemApi
1812     @Deprecated
1813     @RequiresPermission(allOf = {
1814             android.Manifest.permission.MODIFY_PHONE_STATE,
1815             android.Manifest.permission.WRITE_SECURE_SETTINGS})
setDefaultDialer(@ullable String packageName)1816     public boolean setDefaultDialer(@Nullable String packageName) {
1817         ITelecomService service = getTelecomService();
1818         if (service != null) {
1819             try {
1820                 return service.setDefaultDialer(packageName);
1821             } catch (RemoteException e) {
1822                 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
1823             }
1824         }
1825         return false;
1826     }
1827 
1828     /**
1829      * Determines the package name of the system-provided default phone app.
1830      *
1831      * @return package name for the system dialer package or {@code null} if no system dialer is
1832      *         preloaded.
1833      */
getSystemDialerPackage()1834     public @Nullable String getSystemDialerPackage() {
1835         ITelecomService service = getTelecomService();
1836         if (service != null) {
1837             try {
1838                 return service.getSystemDialerPackage(mContext.getPackageName());
1839             } catch (RemoteException e) {
1840                 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
1841             }
1842         }
1843         return null;
1844     }
1845 
1846     /**
1847      * Return whether a given phone number is the configured voicemail number for a
1848      * particular phone account.
1849      *
1850      * @param accountHandle The handle for the account to check the voicemail number against
1851      * @param number The number to look up.
1852      */
1853     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
isVoiceMailNumber(PhoneAccountHandle accountHandle, String number)1854     public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
1855         ITelecomService service = getTelecomService();
1856         if (service != null) {
1857             try {
1858                 return service.isVoiceMailNumber(accountHandle, number,
1859                         mContext.getOpPackageName(), mContext.getAttributionTag());
1860             } catch (RemoteException e) {
1861                 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
1862             }
1863         }
1864         return false;
1865     }
1866 
1867     /**
1868      * Return the voicemail number for a given phone account.
1869      *
1870      * @param accountHandle The handle for the phone account.
1871      * @return The voicemail number for the phone account, and {@code null} if one has not been
1872      *         configured.
1873      */
1874     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
getVoiceMailNumber(PhoneAccountHandle accountHandle)1875     public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
1876         ITelecomService service = getTelecomService();
1877         if (service != null) {
1878             try {
1879                 return service.getVoiceMailNumber(accountHandle,
1880                         mContext.getOpPackageName(), mContext.getAttributionTag());
1881             } catch (RemoteException e) {
1882                 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
1883             }
1884         }
1885         return null;
1886     }
1887 
1888     /**
1889      * Return the line 1 phone number for given phone account.
1890      *
1891      * <p>Requires Permission:
1892      *     {@link android.Manifest.permission#READ_SMS READ_SMS},
1893      *     {@link android.Manifest.permission#READ_PHONE_NUMBERS READ_PHONE_NUMBERS},
1894      *     or that the caller is the default SMS app for any API level.
1895      *     {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1896      *     for apps targeting SDK API level 29 and below.
1897      *
1898      * @param accountHandle The handle for the account retrieve a number for.
1899      * @return A string representation of the line 1 phone number.
1900      * @deprecated use {@link SubscriptionManager#getPhoneNumber(int)} instead, which takes a
1901      *             Telephony Subscription ID that can be retrieved with the {@code accountHandle}
1902      *             from {@link TelephonyManager#getSubscriptionId(PhoneAccountHandle)}.
1903      */
1904     @Deprecated
1905     @SuppressAutoDoc // Blocked by b/72967236 - no support for carrier privileges or default SMS app
1906     @RequiresPermission(anyOf = {
1907             android.Manifest.permission.READ_PHONE_STATE,
1908             android.Manifest.permission.READ_SMS,
1909             android.Manifest.permission.READ_PHONE_NUMBERS
1910             }, conditional = true)
getLine1Number(PhoneAccountHandle accountHandle)1911     public String getLine1Number(PhoneAccountHandle accountHandle) {
1912         ITelecomService service = getTelecomService();
1913         if (service != null) {
1914             try {
1915                 return service.getLine1Number(accountHandle,
1916                         mContext.getOpPackageName(), mContext.getAttributionTag());
1917             } catch (RemoteException e) {
1918                 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
1919             }
1920         }
1921         return null;
1922     }
1923 
1924     /**
1925      * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
1926      * states) originating from either a manager or self-managed {@link ConnectionService}.
1927      *
1928      * @return {@code true} if there is an ongoing call in either a managed or self-managed
1929      *      {@link ConnectionService}, {@code false} otherwise.
1930      */
1931     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
isInCall()1932     public boolean isInCall() {
1933         ITelecomService service = getTelecomService();
1934         if (service != null) {
1935             try {
1936                 return service.isInCall(mContext.getOpPackageName(),
1937                         mContext.getAttributionTag());
1938             } catch (RemoteException e) {
1939                 Log.e(TAG, "RemoteException calling isInCall().", e);
1940             }
1941         }
1942         return false;
1943     }
1944 
1945     /**
1946      * Returns whether the caller has {@link android.Manifest.permission#MANAGE_ONGOING_CALLS}
1947      * permission. The permission can be obtained by associating with a physical wearable device
1948      * via the {@link android.companion.CompanionDeviceManager} API as a companion app. If the
1949      * caller app has the permission, it has {@link InCallService} access to manage ongoing calls.
1950      *
1951      * @return {@code true} if the caller has {@link InCallService} access for
1952      *      companion app; {@code false} otherwise.
1953      */
hasManageOngoingCallsPermission()1954     public boolean hasManageOngoingCallsPermission() {
1955         ITelecomService service = getTelecomService();
1956         if (service != null) {
1957             try {
1958                 return service.hasManageOngoingCallsPermission(
1959                         mContext.getOpPackageName());
1960             } catch (RemoteException e) {
1961                 Log.e(TAG, "RemoteException calling hasManageOngoingCallsPermission().", e);
1962                 if (!isSystemProcess()) {
1963                     e.rethrowAsRuntimeException();
1964                 }
1965             }
1966         }
1967         return false;
1968     }
1969 
1970     /**
1971      * Returns whether there is an ongoing call originating from a managed
1972      * {@link ConnectionService}.  An ongoing call can be in dialing, ringing, active or holding
1973      * states.
1974      * <p>
1975      * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1976      * instead.
1977      *
1978      * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1979      *      {@code false} otherwise.
1980      */
1981     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
isInManagedCall()1982     public boolean isInManagedCall() {
1983         ITelecomService service = getTelecomService();
1984         if (service != null) {
1985             try {
1986                 return service.isInManagedCall(mContext.getOpPackageName(),
1987                         mContext.getAttributionTag());
1988             } catch (RemoteException e) {
1989                 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
1990             }
1991         }
1992         return false;
1993     }
1994 
1995     /**
1996      * Returns one of the following constants that represents the current state of Telecom:
1997      *
1998      * {@link TelephonyManager#CALL_STATE_RINGING}
1999      * {@link TelephonyManager#CALL_STATE_OFFHOOK}
2000      * {@link TelephonyManager#CALL_STATE_IDLE}
2001      *
2002      * Takes into consideration both managed and self-managed calls.
2003      * <p>
2004      * Requires Permission:
2005      * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE} for applications
2006      * targeting API level 31+.
2007      *
2008      * @hide
2009      */
2010     @RequiresPermission(anyOf = {READ_PRIVILEGED_PHONE_STATE,
2011             android.Manifest.permission.READ_PHONE_STATE}, conditional = true)
2012     @SystemApi
getCallState()2013     public @CallState int getCallState() {
2014         ITelecomService service = getTelecomService();
2015         if (service != null) {
2016             try {
2017                 return service.getCallStateUsingPackage(mContext.getOpPackageName(),
2018                         mContext.getAttributionTag());
2019             } catch (RemoteException e) {
2020                 Log.d(TAG, "RemoteException calling getCallState().", e);
2021             }
2022         }
2023         return TelephonyManager.CALL_STATE_IDLE;
2024     }
2025 
2026     /**
2027      * Returns whether there currently exists is a ringing incoming-call.
2028      *
2029      * @return {@code true} if there is a managed or self-managed ringing call.
2030      * @hide
2031      */
2032     @SystemApi
2033     @RequiresPermission(anyOf = {
2034             READ_PRIVILEGED_PHONE_STATE,
2035             android.Manifest.permission.READ_PHONE_STATE
2036     })
isRinging()2037     public boolean isRinging() {
2038         ITelecomService service = getTelecomService();
2039         if (service != null) {
2040             try {
2041                 return service.isRinging(mContext.getOpPackageName());
2042             } catch (RemoteException e) {
2043                 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
2044             }
2045         }
2046         return false;
2047     }
2048 
2049     /**
2050      * Ends the foreground call on the device.
2051      * <p>
2052      * If there is a ringing call, calling this method rejects the ringing call.  Otherwise the
2053      * foreground call is ended.
2054      * <p>
2055      * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
2056      * if an attempt is made to end an emergency call.
2057      *
2058      * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
2059      * otherwise.
2060      * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
2061      * instead.  Apps performing call screening should use the {@link CallScreeningService} API
2062      * instead.
2063      */
2064     @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
2065     @Deprecated
endCall()2066     public boolean endCall() {
2067         ITelecomService service = getTelecomService();
2068         if (service != null) {
2069             try {
2070                 return service.endCall(mContext.getPackageName());
2071             } catch (RemoteException e) {
2072                 Log.e(TAG, "Error calling ITelecomService#endCall", e);
2073             }
2074         }
2075         return false;
2076     }
2077 
2078     /**
2079      * If there is a ringing incoming call, this method accepts the call on behalf of the user.
2080      *
2081      * If the incoming call is a video call, the call will be answered with the same video state as
2082      * the incoming call requests.  This means, for example, that an incoming call requesting
2083      * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
2084      *
2085      * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
2086      * instead.
2087      */
2088     //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
2089     // this method (clockwork & gearhead).
2090     @RequiresPermission(anyOf =
2091             {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
2092     @Deprecated
acceptRingingCall()2093     public void acceptRingingCall() {
2094         ITelecomService service = getTelecomService();
2095         if (service != null) {
2096             try {
2097                 service.acceptRingingCall(mContext.getPackageName());
2098             } catch (RemoteException e) {
2099                 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
2100             }
2101         }
2102     }
2103 
2104     /**
2105      * If there is a ringing incoming call, this method accepts the call on behalf of the user,
2106      * with the specified video state.
2107      *
2108      * @param videoState The desired video state to answer the call with.
2109      * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
2110      * instead.
2111      */
2112     @RequiresPermission(anyOf =
2113             {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
2114     @Deprecated
acceptRingingCall(int videoState)2115     public void acceptRingingCall(int videoState) {
2116         ITelecomService service = getTelecomService();
2117         if (service != null) {
2118             try {
2119                 service.acceptRingingCallWithVideoState(
2120                         mContext.getPackageName(), videoState);
2121             } catch (RemoteException e) {
2122                 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
2123             }
2124         }
2125     }
2126 
2127     /**
2128      * Silences the ringer if a ringing call exists.
2129      * <p>
2130      * This method can only be relied upon to stop the ringtone for a call if the ringtone has
2131      * already started playing.  It is intended to handle use-cases such as silencing a ringing call
2132      * when the user presses the volume button during ringing.
2133      * <p>
2134      * If this method is called prior to when the ringtone begins playing, the ringtone will not be
2135      * silenced.  As such it is not intended as a means to avoid playing of a ringtone.
2136      * <p>
2137      * A dialer app which wants to have more control over ringtone playing should declare
2138      * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
2139      * {@link InCallService} implementation to indicate that the app wants to be responsible for
2140      * playing the ringtone for all incoming calls.
2141      * <p>
2142      * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
2143      * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
2144      */
2145     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
silenceRinger()2146     public void silenceRinger() {
2147         ITelecomService service = getTelecomService();
2148         if (service != null) {
2149             try {
2150                 service.silenceRinger(mContext.getOpPackageName());
2151             } catch (RemoteException e) {
2152                 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
2153             }
2154         }
2155     }
2156 
2157     /**
2158      * Returns whether TTY is supported on this device.
2159      */
2160     @RequiresPermission(anyOf = {
2161             READ_PRIVILEGED_PHONE_STATE,
2162             android.Manifest.permission.READ_PHONE_STATE
2163     })
isTtySupported()2164     public boolean isTtySupported() {
2165         ITelecomService service = getTelecomService();
2166         if (service != null) {
2167             try {
2168                 return service.isTtySupported(mContext.getOpPackageName(),
2169                         mContext.getAttributionTag());
2170             } catch (RemoteException e) {
2171                 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
2172             }
2173         }
2174         return false;
2175     }
2176 
2177     /**
2178      * Returns the current TTY mode of the device. For TTY to be on the user must enable it in
2179      * settings and have a wired headset plugged in.
2180      * Valid modes are:
2181      * - {@link TelecomManager#TTY_MODE_OFF}
2182      * - {@link TelecomManager#TTY_MODE_FULL}
2183      * - {@link TelecomManager#TTY_MODE_HCO}
2184      * - {@link TelecomManager#TTY_MODE_VCO}
2185      * @hide
2186      */
2187     @SystemApi
2188     @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
getCurrentTtyMode()2189     public @TtyMode int getCurrentTtyMode() {
2190         ITelecomService service = getTelecomService();
2191         if (service != null) {
2192             try {
2193                 return service.getCurrentTtyMode(mContext.getOpPackageName(),
2194                         mContext.getAttributionTag());
2195             } catch (RemoteException e) {
2196                 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
2197             }
2198         }
2199         return TTY_MODE_OFF;
2200     }
2201 
2202     /**
2203      * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
2204      * has an incoming call. For managed {@link ConnectionService}s, the specified
2205      * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2206      * the user must have enabled the corresponding {@link PhoneAccount}.  This can be checked using
2207      * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2208      * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2209      * <p>
2210      * Specify the address associated with the incoming call using
2211      * {@link #EXTRA_INCOMING_CALL_ADDRESS}.  If an incoming call is from an anonymous source, omit
2212      * this extra and ensure you specify a valid number presentation via
2213      * {@link Connection#setAddress(Uri, int)} on the {@link Connection} instance you return in
2214      * your
2215      * {@link ConnectionService#onCreateIncomingConnection(PhoneAccountHandle, ConnectionRequest)}
2216      * implementation.
2217      * <p>
2218      * The incoming call you are adding is assumed to have a video state of
2219      * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2220      * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2221      * <p>
2222      * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2223      * associated with the {@link PhoneAccountHandle} and request additional information about the
2224      * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
2225      * call UI.
2226      * <p>
2227      * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2228      * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2229      * the associated {@link PhoneAccount} is not currently enabled by the user.
2230      * <p>
2231      * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2232      * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
2233      * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2234      * <p>
2235      * <p>
2236      * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2237      * the call is added to Telecom in order for the notification to be non-dismissible.
2238      * @param phoneAccount A {@link PhoneAccountHandle} registered with
2239      *            {@link #registerPhoneAccount}.
2240      * @param extras A bundle that will be passed through to
2241      *            {@link ConnectionService#onCreateIncomingConnection}.
2242      */
addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras)2243     public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
2244         ITelecomService service = getTelecomService();
2245         if (service != null) {
2246             try {
2247                 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
2248                         mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
2249                                 Build.VERSION_CODES.O_MR1) {
2250                     Log.e("TAG", "addNewIncomingCall failed. Use public api " +
2251                             "acceptHandover for API > O-MR1");
2252                     return;
2253                 }
2254                 service.addNewIncomingCall(phoneAccount, extras == null ? new Bundle() : extras,
2255                         mContext.getPackageName());
2256             } catch (RemoteException e) {
2257                 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
2258             }
2259         }
2260     }
2261 
2262     /**
2263      * Registers a new incoming conference. A {@link ConnectionService} should invoke this method
2264      * when it has an incoming conference. An incoming {@link Conference} is an adhoc conference
2265      * call initiated on another device which the user is being invited to join in. For managed
2266      * {@link ConnectionService}s, the specified {@link PhoneAccountHandle} must have been
2267      * registered with {@link #registerPhoneAccount} and the user must have enabled the
2268      * corresponding {@link PhoneAccount}.  This can be checked using
2269      * {@link #getPhoneAccount(PhoneAccountHandle)}. Self-managed {@link ConnectionService}s must
2270      * have {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
2271      * <p>
2272      * The incoming conference you are adding is assumed to have a video state of
2273      * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
2274      * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
2275      * <p>
2276      * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2277      * associated with the {@link PhoneAccountHandle} and request additional information about the
2278      * call (See
2279      * {@link ConnectionService#onCreateIncomingConference(PhoneAccountHandle, ConnectionRequest)})
2280      * before starting the incoming call UI.
2281      * <p>
2282      * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2283      * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
2284      * the associated {@link PhoneAccount} is not currently enabled by the user.
2285      *
2286      * @param phoneAccount A {@link PhoneAccountHandle} registered with
2287      *            {@link #registerPhoneAccount}.
2288      * @param extras A bundle that will be passed through to
2289      *            {@link ConnectionService#onCreateIncomingConference}.
2290      */
addNewIncomingConference(@onNull PhoneAccountHandle phoneAccount, @NonNull Bundle extras)2291     public void addNewIncomingConference(@NonNull PhoneAccountHandle phoneAccount,
2292             @NonNull Bundle extras) {
2293         ITelecomService service = getTelecomService();
2294         if (service != null) {
2295             try {
2296                 service.addNewIncomingConference(
2297                         phoneAccount, extras == null ? new Bundle() : extras,
2298                         mContext.getPackageName());
2299             } catch (RemoteException e) {
2300                 Log.e(TAG, "RemoteException adding a new incoming conference: " + phoneAccount, e);
2301             }
2302         }
2303     }
2304 
2305     /**
2306      * Registers a new unknown call with Telecom. This can only be called by the system Telephony
2307      * service. This is invoked when Telephony detects a new unknown connection that was neither
2308      * a new incoming call, nor an user-initiated outgoing call.
2309      *
2310      * @param phoneAccount A {@link PhoneAccountHandle} registered with
2311      *            {@link #registerPhoneAccount}.
2312      * @param extras A bundle that will be passed through to
2313      *            {@link ConnectionService#onCreateIncomingConnection}.
2314      * @hide
2315      */
2316     @SystemApi
addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras)2317     public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
2318         ITelecomService service = getTelecomService();
2319         if (service != null) {
2320             try {
2321                 service.addNewUnknownCall(
2322                         phoneAccount, extras == null ? new Bundle() : extras);
2323             } catch (RemoteException e) {
2324                 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
2325             }
2326         }
2327     }
2328 
2329     /**
2330      * Processes the specified dial string as an MMI code.
2331      * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2332      * Some of these sequences launch special behavior through handled by Telephony.
2333      * This method uses the default subscription.
2334      * <p>
2335      * Requires that the method-caller be set as the system dialer app.
2336      * </p>
2337      *
2338      * @param dialString The digits to dial.
2339      * @return True if the digits were processed as an MMI code, false otherwise.
2340      */
2341     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
handleMmi(String dialString)2342     public boolean handleMmi(String dialString) {
2343         ITelecomService service = getTelecomService();
2344         if (service != null) {
2345             try {
2346                 return service.handlePinMmi(dialString, mContext.getOpPackageName());
2347             } catch (RemoteException e) {
2348                 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2349             }
2350         }
2351         return false;
2352     }
2353 
2354     /**
2355      * Processes the specified dial string as an MMI code.
2356      * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
2357      * Some of these sequences launch special behavior through handled by Telephony.
2358      * <p>
2359      * Requires that the method-caller be set as the system dialer app.
2360      * </p>
2361      *
2362      * @param accountHandle The handle for the account the MMI code should apply to.
2363      * @param dialString The digits to dial.
2364      * @return True if the digits were processed as an MMI code, false otherwise.
2365      */
2366     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
handleMmi(String dialString, PhoneAccountHandle accountHandle)2367     public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
2368         ITelecomService service = getTelecomService();
2369         if (service != null) {
2370             try {
2371                 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
2372                         mContext.getOpPackageName());
2373             } catch (RemoteException e) {
2374                 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
2375             }
2376         }
2377         return false;
2378     }
2379 
2380     /**
2381      * Returns a URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2382      * for ADN content retrieval.
2383      * @param accountHandle The handle for the account to derive an adn query URI for or
2384      * {@code null} to return a URI which will use the default account.
2385      * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
2386      * for the the content retrieve.
2387      */
2388     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle)2389     public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
2390         ITelecomService service = getTelecomService();
2391         if (service != null && accountHandle != null) {
2392             try {
2393                 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
2394             } catch (RemoteException e) {
2395                 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
2396             }
2397         }
2398         return Uri.parse("content://icc/adn");
2399     }
2400 
2401     /**
2402      * Removes the missed-call notification if one is present and marks missed calls in the call
2403      * log as read.
2404      * <p>
2405      * Requires that the method-caller be set as the default dialer app.
2406      * </p>
2407      */
2408     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
cancelMissedCallsNotification()2409     public void cancelMissedCallsNotification() {
2410         ITelecomService service = getTelecomService();
2411         if (service != null) {
2412             try {
2413                 service.cancelMissedCallsNotification(mContext.getOpPackageName());
2414             } catch (RemoteException e) {
2415                 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
2416             }
2417         }
2418     }
2419 
2420     /**
2421      * Brings the in-call screen to the foreground if there is an ongoing call. If there is
2422      * currently no ongoing call, then this method does nothing.
2423      * <p>
2424      * Requires that the method-caller be set as the system dialer app or have the
2425      * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
2426      * </p>
2427      *
2428      * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
2429      */
2430     @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
showInCallScreen(boolean showDialpad)2431     public void showInCallScreen(boolean showDialpad) {
2432         ITelecomService service = getTelecomService();
2433         if (service != null) {
2434             try {
2435                 service.showInCallScreen(showDialpad, mContext.getOpPackageName(),
2436                         mContext.getAttributionTag());
2437             } catch (RemoteException e) {
2438                 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
2439             }
2440         }
2441     }
2442 
2443     /**
2444      * Places a new outgoing call to the provided address using the system telecom service with
2445      * the specified extras.
2446      *
2447      * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
2448      * except that the outgoing call will always be sent via the system telecom service. If
2449      * method-caller is either the user selected default dialer app or preloaded system dialer
2450      * app, then emergency calls will also be allowed.
2451      *
2452      * Placing a call via a managed {@link ConnectionService} requires permission:
2453      * {@link android.Manifest.permission#CALL_PHONE}
2454      *
2455      * Usage example:
2456      * <pre>
2457      * Uri uri = Uri.fromParts("tel", "12345", null);
2458      * Bundle extras = new Bundle();
2459      * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
2460      * telecomManager.placeCall(uri, extras);
2461      * </pre>
2462      *
2463      * The following keys are supported in the supplied extras.
2464      * <ul>
2465      *   <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
2466      *   <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2467      *   <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2468      *   <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2469      * </ul>
2470      * <p>
2471      * An app which implements the self-managed {@link ConnectionService} API uses
2472      * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call.  A self-managed
2473      * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
2474      * associated {@link android.telecom.PhoneAccountHandle}.
2475      *
2476      * Self-managed {@link ConnectionService}s require permission
2477      * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2478      *
2479      * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
2480      * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
2481      * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
2482      * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
2483      * capability, depending on external factors, such as network conditions and Modem/SIM status.
2484      * </p>
2485      * <p>
2486      * <p>
2487      * <b>Note</b>: {@link android.app.Notification.CallStyle} notifications should be posted after
2488      * the call is placed in order for the notification to be non-dismissible.
2489      * <p><b>Note</b>: Call Forwarding MMI codes can only be dialed by applications that are
2490      * configured as the user defined default dialer or system dialer role. If a call containing a
2491      * call forwarding MMI code is placed by an application that is not in one of these roles, the
2492      * dialer will be launched with a UI showing the MMI code already populated so that the user can
2493      * confirm the action before the call is placed.
2494      * @param address The address to make the call to.
2495      * @param extras Bundle of extras to use with the call.
2496      */
2497     @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
2498             android.Manifest.permission.MANAGE_OWN_CALLS})
placeCall(Uri address, Bundle extras)2499     public void placeCall(Uri address, Bundle extras) {
2500         ITelecomService service = getTelecomService();
2501         if (service != null) {
2502             if (address == null) {
2503                 Log.w(TAG, "Cannot place call to empty address.");
2504             }
2505             try {
2506                 service.placeCall(address, extras == null ? new Bundle() : extras,
2507                         mContext.getOpPackageName(), mContext.getAttributionTag());
2508             } catch (RemoteException e) {
2509                 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2510             }
2511         }
2512     }
2513 
2514 
2515     /**
2516      * Place a new adhoc conference call with the provided participants using the system telecom
2517      * service. This method doesn't support placing of emergency calls.
2518      *
2519      * An adhoc conference call is established by providing a list of addresses to
2520      * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
2521      * {@link ConnectionService} is responsible for connecting all indicated participants
2522      * to a conference simultaneously.
2523      * This is in contrast to conferences formed by merging calls together (e.g. using
2524      * {@link android.telecom.Call#mergeConference()}).
2525      *
2526      * The following keys are supported in the supplied extras.
2527      * <ul>
2528      *   <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
2529      *   <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
2530      *   <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
2531      * </ul>
2532      *
2533      * @param participants List of participants to start conference with
2534      * @param extras Bundle of extras to use with the call
2535      */
2536     @RequiresPermission(android.Manifest.permission.CALL_PHONE)
startConference(@onNull List<Uri> participants, @NonNull Bundle extras)2537     public void startConference(@NonNull List<Uri> participants,
2538             @NonNull Bundle extras) {
2539         ITelecomService service = getTelecomService();
2540         if (service != null) {
2541             try {
2542                 service.startConference(participants, extras,
2543                         mContext.getOpPackageName());
2544             } catch (RemoteException e) {
2545                 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
2546             }
2547         }
2548     }
2549 
2550     /**
2551      * Enables and disables specified phone account.
2552      *
2553      * @param handle Handle to the phone account.
2554      * @param isEnabled Enable state of the phone account.
2555      * @hide
2556      */
2557     @SystemApi
2558     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled)2559     public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
2560         ITelecomService service = getTelecomService();
2561         if (service != null) {
2562             try {
2563                 service.enablePhoneAccount(handle, isEnabled);
2564             } catch (RemoteException e) {
2565                 Log.e(TAG, "Error enablePhoneAbbount", e);
2566             }
2567         }
2568     }
2569 
2570     /**
2571      * Dumps telecom analytics for uploading.
2572      *
2573      * @return
2574      * @hide
2575      */
2576     @SystemApi
2577     @RequiresPermission(Manifest.permission.DUMP)
dumpAnalytics()2578     public TelecomAnalytics dumpAnalytics() {
2579         ITelecomService service = getTelecomService();
2580         TelecomAnalytics result = null;
2581         if (service != null) {
2582             try {
2583                 result = service.dumpCallAnalytics();
2584             } catch (RemoteException e) {
2585                 Log.e(TAG, "Error dumping call analytics", e);
2586             }
2587         }
2588         return result;
2589     }
2590 
2591     /**
2592      * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2593      * launch the activity to manage blocked numbers.
2594      * <p> The activity will display the UI to manage blocked numbers only if
2595      * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
2596      * {@code true} for the current user.
2597      */
createManageBlockedNumbersIntent()2598     public Intent createManageBlockedNumbersIntent() {
2599         ITelecomService service = getTelecomService();
2600         Intent result = null;
2601         if (service != null) {
2602             try {
2603                 result = service.createManageBlockedNumbersIntent(mContext.getPackageName());
2604                 if (result != null) {
2605                     result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2606                             mContext.getAttributionSource());
2607                 }
2608             } catch (RemoteException e) {
2609                 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
2610             }
2611         }
2612         return result;
2613     }
2614 
2615 
2616     /**
2617      * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
2618      * launch the activity for emergency dialer.
2619      *
2620      * @param number Optional number to call in emergency dialer
2621      * @hide
2622      */
2623     @SystemApi
2624     @NonNull
createLaunchEmergencyDialerIntent(@ullable String number)2625     public Intent createLaunchEmergencyDialerIntent(@Nullable String number) {
2626         ITelecomService service = getTelecomService();
2627         if (service != null) {
2628             try {
2629                 Intent result = service.createLaunchEmergencyDialerIntent(number);
2630                 if (result != null) {
2631                     result.prepareToEnterProcess(LOCAL_FLAG_FROM_SYSTEM,
2632                             mContext.getAttributionSource());
2633                 }
2634                 return result;
2635             } catch (RemoteException e) {
2636                 Log.e(TAG, "Error createLaunchEmergencyDialerIntent", e);
2637             }
2638         } else {
2639             Log.w(TAG, "createLaunchEmergencyDialerIntent - Telecom service not available.");
2640         }
2641 
2642         // Telecom service knows the package name of the expected emergency dialer package; if it
2643         // is not available, then fallback to not targeting a specific package.
2644         Intent intent = new Intent(Intent.ACTION_DIAL_EMERGENCY);
2645         if (!TextUtils.isEmpty(number) && TextUtils.isDigitsOnly(number)) {
2646             intent.setData(Uri.fromParts(PhoneAccount.SCHEME_TEL, number, null));
2647         }
2648         return intent;
2649     }
2650 
2651     /**
2652      * Determines whether Telecom would permit an incoming call to be added via the
2653      * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
2654      * {@link PhoneAccountHandle}.
2655      * <p>
2656      * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
2657      * in the following situations:
2658      * <ul>
2659      *     <li>{@link PhoneAccount} does not have property
2660      *     {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2661      *     {@link ConnectionService}), and the active or held call limit has
2662      *     been reached.</li>
2663      *     <li>There is an ongoing emergency call.</li>
2664      * </ul>
2665      *
2666      * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2667      * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
2668      *      otherwise.
2669      */
isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle)2670     public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2671         if (phoneAccountHandle == null) {
2672             return false;
2673         }
2674 
2675         ITelecomService service = getTelecomService();
2676         if (service != null) {
2677             try {
2678                 return service.isIncomingCallPermitted(phoneAccountHandle,
2679                         mContext.getOpPackageName());
2680             } catch (RemoteException e) {
2681                 Log.e(TAG, "Error isIncomingCallPermitted", e);
2682             }
2683         }
2684         return false;
2685     }
2686 
2687     /**
2688      * Determines whether Telecom would permit an outgoing call to be placed via the
2689      * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2690      * <p>
2691      * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2692      * in the following situations:
2693      * <ul>
2694      *     <li>{@link PhoneAccount} does not have property
2695      *     {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2696      *     {@link ConnectionService}), and the active, held or ringing call limit has
2697      *     been reached.</li>
2698      *     <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2699      *     (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2700      *     another {@link ConnectionService}.</li>
2701      *     <li>There is an ongoing emergency call.</li>
2702      * </ul>
2703      *
2704      * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2705      * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2706      *      otherwise.
2707      */
isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle)2708     public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2709         ITelecomService service = getTelecomService();
2710         if (service != null) {
2711             try {
2712                 return service.isOutgoingCallPermitted(phoneAccountHandle,
2713                         mContext.getOpPackageName());
2714             } catch (RemoteException e) {
2715                 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2716             }
2717         }
2718         return false;
2719     }
2720 
2721     /**
2722      * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2723      * {@link PhoneAccountHandle} it defines.
2724      * <p>
2725      * A call handover is the process where an ongoing call is transferred from one app (i.e.
2726      * {@link ConnectionService} to another app.  The user could, for example, choose to continue a
2727      * mobile network call in a video calling app.  The mobile network call via the Telephony stack
2728      * is referred to as the source of the handover, and the video calling app is referred to as the
2729      * destination.
2730      * <p>
2731      * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2732      * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2733      * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2734      * device.
2735      * <p>
2736      * For a full discussion of the handover process and the APIs involved, see
2737      * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2738      * <p>
2739      * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2740      * accept the handover of an ongoing call to another {@link ConnectionService} identified by
2741      * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2742      * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2743      * the user must have enabled the corresponding {@link PhoneAccount}.  This can be checked using
2744      * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2745      * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2746      * <p>
2747      * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2748      * associated with the {@link PhoneAccountHandle} destAcct and call
2749      * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2750      * <p>
2751      * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2752      * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2753      * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2754      * user.
2755      * <p>
2756      * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2757      * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2758      *
2759      * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2760      *                {@link ConnectionService}.
2761      * @param videoState Video state after the handover.
2762      * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2763      */
acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState, PhoneAccountHandle destAcct)2764     public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2765             PhoneAccountHandle destAcct) {
2766         ITelecomService service = getTelecomService();
2767         if (service != null) {
2768             try {
2769                 service.acceptHandover(srcAddr, videoState, destAcct, mContext.getPackageName());
2770             } catch (RemoteException e) {
2771                 Log.e(TAG, "RemoteException acceptHandover: " + e);
2772             }
2773         }
2774     }
2775 
2776     /**
2777      * Determines if there is an ongoing emergency call.  This can be either an outgoing emergency
2778      * call, as identified by the dialed number, or because a call was identified by the network
2779      * as an emergency call.
2780      * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2781      * @hide
2782      */
2783     @SystemApi
2784     @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
isInEmergencyCall()2785     public boolean isInEmergencyCall() {
2786         ITelecomService service = getTelecomService();
2787         if (service != null) {
2788             try {
2789                 return service.isInEmergencyCall();
2790             } catch (RemoteException e) {
2791                 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2792                 return false;
2793             }
2794         }
2795         return false;
2796     }
2797 
2798     /**
2799      * Determines whether there are any ongoing {@link PhoneAccount#CAPABILITY_SELF_MANAGED}
2800      * calls for a given {@code packageName} and {@code userHandle}. If UserHandle.ALL or a user
2801      * that isn't the calling user is passed in, the caller will need to have granted the ability
2802      * to interact across users.
2803      *
2804      * @param packageName the package name of the app to check calls for.
2805      * @param userHandle the user handle to check calls for.
2806      * @return {@code true} if there are ongoing calls, {@code false} otherwise.
2807      * @throws SecurityException if the userHandle is not the calling user and the caller does not
2808      * grant the ability to interact across users.
2809      * @hide
2810      */
2811     @SystemApi
2812     @FlaggedApi(Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
2813     @RequiresPermission(allOf = {Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
2814             Manifest.permission.INTERACT_ACROSS_USERS}, conditional = true)
isInSelfManagedCall(@onNull String packageName, @NonNull UserHandle userHandle)2815     public boolean isInSelfManagedCall(@NonNull String packageName,
2816             @NonNull UserHandle userHandle) {
2817         ITelecomService service = getTelecomService();
2818         if (service != null) {
2819             try {
2820                 return service.isInSelfManagedCall(packageName, userHandle,
2821                         mContext.getOpPackageName());
2822             } catch (RemoteException e) {
2823                 Log.e(TAG, "RemoteException isInSelfManagedCall: " + e);
2824                 e.rethrowFromSystemServer();
2825                 return false;
2826             }
2827         } else {
2828             throw new IllegalStateException("Telecom service is not present");
2829         }
2830     }
2831 
2832     /**
2833      * Add a call to the Android system service Telecom. This allows the system to start tracking an
2834      * incoming or outgoing call with the specified {@link CallAttributes}.  Once a call is added,
2835      * a {@link android.app.Notification.CallStyle} notification should be posted and when the
2836      * call is ready to be disconnected, use {@link CallControl#disconnect(DisconnectCause,
2837      * Executor, OutcomeReceiver)} which is provided by the
2838      * {@code pendingControl#onResult(CallControl)}.
2839      * <p>
2840      * <p>
2841      * <p>
2842      * <b>Call Lifecycle</b>: Your app is given foreground execution priority as long as you have a
2843      * valid call and are posting a {@link android.app.Notification.CallStyle} notification.
2844      * When your application is given foreground execution priority, your app is treated as a
2845      * foreground service. Foreground execution priority will prevent the
2846      * {@link android.app.ActivityManager} from killing your application when it is placed the
2847      * background. Foreground execution priority is removed from your app when all of your app's
2848      * calls terminate or your app no longer posts a valid notification.
2849      * <p>
2850      * <p>
2851      * <p>
2852      * <b>Note</b>: Only packages that register with
2853      * {@link PhoneAccount#CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS}
2854      * can utilize this API. {@link PhoneAccount}s that set the capabilities
2855      * {@link PhoneAccount#CAPABILITY_SIM_SUBSCRIPTION},
2856      * {@link PhoneAccount#CAPABILITY_CALL_PROVIDER},
2857      * {@link PhoneAccount#CAPABILITY_CONNECTION_MANAGER}
2858      * are not supported and will cause an exception to be thrown.
2859      * <p>
2860      * <p>
2861      * <p>
2862      * <b>Usage example:</b>
2863      * <pre>
2864      *  // Its up to your app on how you want to wrap the objects. One such implementation can be:
2865      *  class MyVoipCall {
2866      *    ...
2867      *      public CallControlCallEventCallback handshakes = new  CallControlCallback() {
2868      *                         ...
2869      *                        }
2870      *
2871      *      public CallEventCallback events = new CallEventCallback() {
2872      *                         ...
2873      *                        }
2874      *
2875      *      public MyVoipCall(String id){
2876      *          ...
2877      *      }
2878      *  }
2879      *
2880      * MyVoipCall myFirstOutgoingCall = new MyVoipCall("1");
2881      *
2882      * telecomManager.addCall(callAttributes,
2883      *                        Runnable::run,
2884      *                        new OutcomeReceiver() {
2885      *                              public void onResult(CallControl callControl) {
2886      *                                 // The call has been added successfully. For demonstration
2887      *                                 // purposes, the call is disconnected immediately ...
2888      *                                 callControl.disconnect(
2889      *                                                 new DisconnectCause(DisconnectCause.LOCAL) )
2890      *                              }
2891      *                           },
2892      *                           myFirstOutgoingCall.handshakes,
2893      *                           myFirstOutgoingCall.events);
2894      * </pre>
2895      *
2896      * @param callAttributes attributes of the new call (incoming or outgoing, address, etc.)
2897      * @param executor       execution context to run {@link CallControlCallback} updates on
2898      * @param pendingControl Receives the result of addCall transaction. Upon success, a
2899      *                       CallControl object is provided which can be used to do things like
2900      *                       disconnect the call that was added.
2901      * @param handshakes     callback that receives <b>actionable</b> updates that originate from
2902      *                       Telecom.
2903      * @param events         callback that receives <b>non</b>-actionable updates that originate
2904      *                       from Telecom.
2905      */
2906     @RequiresPermission(android.Manifest.permission.MANAGE_OWN_CALLS)
2907     @SuppressLint("SamShouldBeLast")
addCall(@onNull CallAttributes callAttributes, @NonNull @CallbackExecutor Executor executor, @NonNull OutcomeReceiver<CallControl, CallException> pendingControl, @NonNull CallControlCallback handshakes, @NonNull CallEventCallback events)2908     public void addCall(@NonNull CallAttributes callAttributes,
2909             @NonNull @CallbackExecutor Executor executor,
2910             @NonNull OutcomeReceiver<CallControl, CallException> pendingControl,
2911             @NonNull CallControlCallback handshakes,
2912             @NonNull CallEventCallback events) {
2913         Objects.requireNonNull(callAttributes);
2914         Objects.requireNonNull(executor);
2915         Objects.requireNonNull(pendingControl);
2916         Objects.requireNonNull(handshakes);
2917         Objects.requireNonNull(events);
2918 
2919         ITelecomService service = getTelecomService();
2920         if (service != null) {
2921             try {
2922                 // create or add the new call to a service wrapper w/ the same phoneAccountHandle
2923                 ClientTransactionalServiceWrapper transactionalServiceWrapper =
2924                         mTransactionalServiceRepository.addNewCallForTransactionalServiceWrapper(
2925                                 callAttributes.getPhoneAccountHandle());
2926 
2927                 // couple all the args passed by the client
2928                 String newCallId = transactionalServiceWrapper.trackCall(callAttributes, executor,
2929                         pendingControl, handshakes, events);
2930 
2931                 // send args to server to process new call
2932                 service.addCall(callAttributes, transactionalServiceWrapper.getCallEventCallback(),
2933                         newCallId, mContext.getOpPackageName());
2934             } catch (RemoteException e) {
2935                 Log.e(TAG, "RemoteException addCall: " + e);
2936                 e.rethrowFromSystemServer();
2937             }
2938         } else {
2939             throw new IllegalStateException("Telecom service is not present");
2940         }
2941     }
2942 
2943     /**
2944      * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2945      * @param intent The {@link Intent#ACTION_CALL} intent to handle.
2946      * @param callingPackageProxy The original package that called this before it was trampolined.
2947      * @hide
2948      */
handleCallIntent(Intent intent, String callingPackageProxy)2949     public void handleCallIntent(Intent intent, String callingPackageProxy) {
2950         ITelecomService service = getTelecomService();
2951         if (service != null) {
2952             try {
2953                 service.handleCallIntent(intent, callingPackageProxy);
2954             } catch (RemoteException e) {
2955                 Log.e(TAG, "RemoteException handleCallIntent: " + e);
2956             }
2957         }
2958     }
2959 
isSystemProcess()2960     private boolean isSystemProcess() {
2961         return Process.myUid() == Process.SYSTEM_UID;
2962     }
2963 
getTelecomService()2964     private ITelecomService getTelecomService() {
2965         if (mTelecomServiceOverride != null) {
2966             return mTelecomServiceOverride;
2967         }
2968         if (sTelecomService == null) {
2969             ITelecomService temp = ITelecomService.Stub.asInterface(
2970                     ServiceManager.getService(Context.TELECOM_SERVICE));
2971             synchronized (CACHE_LOCK) {
2972                 if (sTelecomService == null && temp != null) {
2973                     try {
2974                         sTelecomService = temp;
2975                         sTelecomService.asBinder().linkToDeath(SERVICE_DEATH, 0);
2976                     } catch (Exception e) {
2977                         sTelecomService = null;
2978                     }
2979                 }
2980             }
2981         }
2982         return sTelecomService;
2983     }
2984 
2985     private static class DeathRecipient implements IBinder.DeathRecipient {
2986         @Override
binderDied()2987         public void binderDied() {
2988             resetServiceCache();
2989         }
2990     }
2991 
resetServiceCache()2992     private static void resetServiceCache() {
2993         synchronized (CACHE_LOCK) {
2994             if (sTelecomService != null) {
2995                 sTelecomService.asBinder().unlinkToDeath(SERVICE_DEATH, 0);
2996                 sTelecomService = null;
2997             }
2998         }
2999     }
3000 }
3001