blob: 20862c525b5533f2b526b4dec302cc21f6fb9a8f [file] [log] [blame]
Yorke Leeb4ce1432014-06-09 13:53:23 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
Santos Cordon9eb45932014-06-27 12:28:43 -07004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5 * in compliance with the License. You may obtain a copy of the License at
Yorke Leeb4ce1432014-06-09 13:53:23 -07006 *
Santos Cordon9eb45932014-06-27 12:28:43 -07007 * http://www.apache.org/licenses/LICENSE-2.0
Yorke Leeb4ce1432014-06-09 13:53:23 -07008 *
Santos Cordon9eb45932014-06-27 12:28:43 -07009 * Unless required by applicable law or agreed to in writing, software distributed under the License
10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11 * or implied. See the License for the specific language governing permissions and limitations under
12 * the License.
Yorke Leeb4ce1432014-06-09 13:53:23 -070013 */
14
Tyler Gunnef9f6f92014-09-12 22:16:17 -070015package android.telecom;
Yorke Leeb4ce1432014-06-09 13:53:23 -070016
Tyler Gunn5567d742019-10-31 13:04:37 -070017import static android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE;
18
Hall Liu0464b9b2016-01-12 15:32:58 -080019import android.Manifest;
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080020import android.annotation.IntDef;
Hall Liub2306242019-11-15 17:13:05 -080021import android.annotation.NonNull;
Slava Shklyaeve65e4012019-03-04 16:02:34 +000022import android.annotation.Nullable;
Yorke Leec61d1362015-09-21 17:25:25 -070023import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060024import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060025import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070026import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060027import android.annotation.SystemService;
Tyler Gunn6c14a6992019-02-04 15:12:06 -080028import android.annotation.TestApi;
Mathew Inwood42346d12018-08-01 11:33:05 +010029import android.annotation.UnsupportedAppUsage;
Santos Cordon6c7a3882014-06-25 15:30:08 -070030import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070031import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070032import android.content.Intent;
Nancy Chenb2299c12014-10-29 18:22:11 -070033import android.net.Uri;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -080034import android.os.Build;
Santos Cordon96efb482014-07-19 14:57:05 -070035import android.os.Bundle;
Santos Cordon6c7a3882014-06-25 15:30:08 -070036import android.os.RemoteException;
37import android.os.ServiceManager;
Tyler Gunn7e45b722018-12-04 12:56:45 -080038import android.os.UserHandle;
Chen Xu7631ff72019-09-26 16:11:59 -070039import android.telephony.Annotation.CallState;
Brad Ebingere7833312019-05-07 10:55:55 -070040import android.telephony.SubscriptionManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070041import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070042import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070043import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070044
Tyler Gunnef9f6f92014-09-12 22:16:17 -070045import com.android.internal.telecom.ITelecomService;
Yorke Leeb4ce1432014-06-09 13:53:23 -070046
Tyler Gunn6e3ecc42018-11-12 11:30:56 -080047import java.lang.annotation.Retention;
48import java.lang.annotation.RetentionPolicy;
Jay Shrauner7746a942014-08-26 12:15:15 -070049import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070050import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070051import java.util.List;
Tyler Gunn7e45b722018-12-04 12:56:45 -080052import java.util.concurrent.Executor;
Ihab Awad807fe0a2014-07-09 12:30:52 -070053
Yorke Leeb4ce1432014-06-09 13:53:23 -070054/**
Santos Cordond9e614f2014-10-28 13:10:36 -070055 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080056 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070057 * <p>
58 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
59 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
60 * <p>
61 * Note that access to some telecom information is permission-protected. Your app cannot access the
62 * protected information or gain access to protected functionality unless it has the appropriate
63 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
64 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070065 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060066@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060067@SystemService(Context.TELECOM_SERVICE)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070068public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070069
Evan Charlton10197192014-07-19 15:00:29 -070070 /**
Santos Cordon96efb482014-07-19 14:57:05 -070071 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070072 * UI by notifying the Telecom system that an incoming call exists for a specific call service
73 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
74 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070075 * ultimately use to control and get information about the call.
76 * <p>
77 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070078 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070079 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080080 *
81 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070082 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070083 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070084
85 /**
Yorke Leec3cf9822014-10-02 09:38:39 -070086 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
87 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080088 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -070089 * @hide
90 */
91 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
92
93 /**
Santos Cordon895d4b82015-06-25 16:41:48 -070094 * An {@link android.content.Intent} action sent by the telecom framework to start a
95 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
96 * and each app that registers a {@link PhoneAccount} should provide one if desired.
97 * <p>
98 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
99 * app's settings menu. For each entry, the settings app will add a click action. When
100 * triggered, the click-action will start this intent along with the extra
101 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
102 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
103 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -0700104 */
Santos Cordon895d4b82015-06-25 16:41:48 -0700105 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
106 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -0700107
108 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -0800109 * The {@link android.content.Intent} action used to show the call accessibility settings page.
110 */
111 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
112 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
113
114 /**
Yorke Lee3818a892014-07-21 15:57:17 -0700115 * The {@link android.content.Intent} action used to show the call settings page.
116 */
117 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700118 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a892014-07-21 15:57:17 -0700119
120 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800121 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
122 */
123 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
124 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
125
126 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700127 * The {@link android.content.Intent} action used to show the settings page used to configure
128 * {@link PhoneAccount} preferences.
129 */
130 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700131 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700132
133 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700134 * {@link android.content.Intent} action used indicate that a new phone account was just
135 * registered.
136 * <p>
137 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
138 * to indicate which {@link PhoneAccount} was registered.
139 * <p>
140 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800141 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800142 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
143 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
144
145 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700146 * {@link android.content.Intent} action used indicate that a phone account was just
147 * unregistered.
148 * <p>
149 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
150 * to indicate which {@link PhoneAccount} was unregistered.
151 * <p>
152 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700153 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700154 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
155 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
156
157 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700158 * Activity action: Shows a dialog asking the user whether or not they want to replace the
159 * current default Dialer with the one specified in
160 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
161 *
162 * Usage example:
163 * <pre>
164 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
165 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
166 * getActivity().getPackageName());
167 * startActivity(intent);
168 * </pre>
Hai Zhang929085f2019-05-03 15:31:43 +0800169 * <p>
170 * This is no longer supported since Q, please use
171 * {@link android.app.role.RoleManager#createRequestRoleIntent(String)} with
172 * {@link android.app.role.RoleManager#ROLE_DIALER} instead.
Yorke Lee1011f482015-04-23 15:58:27 -0700173 */
174 public static final String ACTION_CHANGE_DEFAULT_DIALER =
175 "android.telecom.action.CHANGE_DEFAULT_DIALER";
176
177 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700178 * Broadcast intent action indicating that the current default dialer has changed.
179 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
180 * name of the package that the default dialer was changed to.
181 *
182 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
183 */
184 public static final String ACTION_DEFAULT_DIALER_CHANGED =
185 "android.telecom.action.DEFAULT_DIALER_CHANGED";
186
187 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700188 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
189 */
190 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
191 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
192
193 /**
tonyzhuff60f5e2018-10-01 19:14:59 +0800194 * Broadcast intent action indicating that the current default call screening app has changed.
195 *
196 * The string extra {@link #EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME} will contain the
197 * name of the Component of the previous or the new call screening app.
198 *
199 * The boolean extra {@link #EXTRA_IS_DEFAULT_CALL_SCREENING_APP} will indicate the component
200 * name in the String extra {@link #EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME} is default
201 * call screening app or not.
202 */
203 public static final String ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED =
204 "android.telecom.action.DEFAULT_CALL_SCREENING_APP_CHANGED";
205
206 /**
207 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
208 * indicate the ComponentName of the call screening app which has changed.
209 */
210 public static final String EXTRA_DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME =
211 "android.telecom.extra.DEFAULT_CALL_SCREENING_APP_COMPONENT_NAME";
212
213 /**
214 * Extra value used with {@link #ACTION_DEFAULT_CALL_SCREENING_APP_CHANGED} broadcast to
215 * indicate whether an app is the default call screening app.
216 */
217 public static final String EXTRA_IS_DEFAULT_CALL_SCREENING_APP =
218 "android.telecom.extra.IS_DEFAULT_CALL_SCREENING_APP";
219
220 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700221 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
222 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700223 */
224 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700225 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700226
227 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700228 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
229 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700230 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700231 * {@link VideoProfile#STATE_AUDIO_ONLY},
232 * {@link VideoProfile#STATE_BIDIRECTIONAL},
233 * {@link VideoProfile#STATE_RX_ENABLED},
234 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700235 */
236 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700237 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700238
239 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700240 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
241 * integer that determines the requested video state for an incoming call.
242 * Valid options:
243 * {@link VideoProfile#STATE_AUDIO_ONLY},
244 * {@link VideoProfile#STATE_BIDIRECTIONAL},
245 * {@link VideoProfile#STATE_RX_ENABLED},
246 * {@link VideoProfile#STATE_TX_ENABLED}.
247 */
248 public static final String EXTRA_INCOMING_VIDEO_STATE =
249 "android.telecom.extra.INCOMING_VIDEO_STATE";
250
251 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700252 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
253 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
254 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700255 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700256 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700257 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700258 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700259 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700260
261 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700262 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
263 * subject which will be associated with an outgoing call. Should only be specified if the
264 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}.
265 */
266 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
267
268 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700269 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
270 * has initiated a new incoming call.
271 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700272 public static final String EXTRA_INCOMING_CALL_ADDRESS =
273 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700274
275 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700276 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
277 * metadata about the call. This {@link Bundle} will be returned to the
278 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700279 */
280 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700281 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700282
283 /**
Joseph Pirozzo40ea5ee2018-01-02 16:15:23 -0800284 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a boolean to indicate that the
285 * call has an externally generated ringer. Used by the HfpClientConnectionService when In Band
286 * Ringtone is enabled to prevent two ringers from being generated.
287 * @hide
288 */
289 public static final String EXTRA_CALL_EXTERNAL_RINGER =
290 "android.telecom.extra.CALL_EXTERNAL_RINGER";
291
292 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700293 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
294 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
295 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700296 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700297 */
298 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700299 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700300
301 /**
sqian6d9e7452019-02-08 21:42:15 -0800302 * An optional boolean extra on {@link android.content.Intent#ACTION_CALL_EMERGENCY} to tell
303 * whether the user's dial intent is emergency; this is required to specify when the dialed
304 * number is ambiguous, identified as both emergency number and any other non-emergency number;
305 * e.g. in some situation, 611 could be both an emergency number in a country and a
306 * non-emergency number of a carrier's customer service hotline.
307 *
308 * @hide
309 */
310 @SystemApi
311 public static final String EXTRA_IS_USER_INTENT_EMERGENCY_CALL =
312 "android.telecom.extra.IS_USER_INTENT_EMERGENCY_CALL";
313
314 /**
Yorke Leec3cf9822014-10-02 09:38:39 -0700315 * @hide
316 */
317 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
318 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
319
320 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700321 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
322 * call was created. This value is in milliseconds since boot.
323 * @hide
324 */
325 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
326 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
327
328 /**
329 * Optional extra for incoming and outgoing calls containing a long which specifies the time
330 * telecom began routing the call. This value is in milliseconds since boot.
331 * @hide
332 */
333 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
334 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
335
336 /**
337 * Optional extra for incoming and outgoing calls containing a long which specifies the time
338 * telecom finished routing the call. This value is in milliseconds since boot.
339 * @hide
340 */
341 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
342 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
343
344 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700345 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
346 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700347 */
348 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700349 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700350
351 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700352 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
353 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700354 */
355 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700356 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700357
358 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700359 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
360 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800361 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700362 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800363 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700364 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700365 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700366
367 /**
Hall Liu90f62902015-11-19 16:19:24 -0800368 * Optional extra for communicating the call technology used by a
369 * {@link com.android.internal.telephony.Connection} to Telecom
370 * @hide
371 */
372 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
373 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
374
375 /**
Wei Huang7f7f72e2018-05-30 19:21:36 +0800376 * Optional extra for communicating the call network technology used by a
377 * {@link android.telecom.Connection} to Telecom and InCallUI.
378 *
379 * @see {@code NETWORK_TYPE_*} in {@link android.telephony.TelephonyManager}.
380 */
381 public static final String EXTRA_CALL_NETWORK_TYPE =
382 "android.telecom.extra.CALL_NETWORK_TYPE";
383
384 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700385 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
386 * package name of the app specifying an alternative gateway for the call.
387 * The value is a string.
388 *
389 * (The following comment corresponds to the all GATEWAY_* extras)
390 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
391 * alternative address to dial which is different from the one specified and displayed to
392 * the user. This alternative address is referred to as the gateway address.
393 */
394 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700395 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700396
397 /**
398 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
399 * original address to dial for the call. This is used when an alternative gateway address is
400 * provided to recall the original address.
401 * The value is a {@link android.net.Uri}.
402 *
403 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
404 */
405 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700406 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700407
408 /**
Evan Charlton10197192014-07-19 15:00:29 -0700409 * The number which the party on the other side of the line will see (and use to return the
410 * call).
411 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700412 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
413 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
414 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700415 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700416 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700417
418 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800419 * The number of milliseconds that Telecom should wait after disconnecting a call via the
420 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
421 * to make a new one.
422 * @hide
423 */
424 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
425 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
426
427 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700428 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700429 * existing call from the user's device to a different {@link PhoneAccount}.
430 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700431 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
432 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
433 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
434 * the receiving side of a handover.
435 * <p>
436 * Used when Telecom calls
437 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
438 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
439 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
440 * occurs on the initiating side of a handover.
441 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700442 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700443 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800444 * @deprecated Use the public handover APIs. See
445 * {@link Call#handoverTo(PhoneAccountHandle, int, Bundle)} for more information.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700446 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800447 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Tyler Gunn8bf76572017-04-06 15:30:08 -0700448 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
449
450 /**
Tyler Gunn79bc1ec2018-01-22 15:17:54 -0800451 * When {@code true} indicates that a request to create a new connection is for the purpose of
452 * a handover. Note: This is used with the
453 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)} API as part of the
454 * internal communication mechanism with the {@link android.telecom.ConnectionService}. It is
455 * not the same as the legacy {@link #EXTRA_IS_HANDOVER} extra.
456 * @hide
457 */
458 public static final String EXTRA_IS_HANDOVER_CONNECTION =
459 "android.telecom.extra.IS_HANDOVER_CONNECTION";
460
461 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700462 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
463 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
464 * the handover is from.
465 * @hide
466 */
467 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
468 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
469
470 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700471 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
472 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
473 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
474 * {@link Connection} will be.
475 * @hide
476 */
477 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
478
479 /**
Hall Liu95d55872017-01-25 17:12:49 -0800480 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
481 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
482 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
483 */
484 public static final String EXTRA_START_CALL_WITH_RTT =
485 "android.telecom.extra.START_CALL_WITH_RTT";
486
487 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700488 * A boolean meta-data value indicating whether an {@link InCallService} implements an
489 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
490 * would also like to replace the in-call interface should set this meta-data to {@code true} in
491 * the manifest registration of their {@link InCallService}.
492 */
493 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
494
495 /**
Santos Cordon88881552015-12-10 17:29:54 -0800496 * A boolean meta-data value indicating whether an {@link InCallService} implements an
497 * in-call user interface to be used while the device is in car-mode (see
Hector Dearman923382c2018-12-13 16:42:33 +0000498 * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}).
Santos Cordon88881552015-12-10 17:29:54 -0800499 */
500 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
501 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
502
503 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800504 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
505 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
506 * override the system provided ringing should set this meta-data to {@code true} in the
507 * manifest registration of their {@link InCallService}.
Tyler Gunn556d2402019-04-10 08:59:43 -0700508 * <p>
509 * When {@code true}, it is the {@link InCallService}'s responsibility to play a ringtone for
510 * all incoming calls.
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800511 */
512 public static final String METADATA_IN_CALL_SERVICE_RINGING =
513 "android.telecom.IN_CALL_SERVICE_RINGING";
514
515 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700516 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
517 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
518 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
519 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
520 * informed of external calls should set this meta-data to {@code true} in the manifest
521 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
522 * be informed of external calls.
523 */
524 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
525 "android.telecom.INCLUDE_EXTERNAL_CALLS";
526
527 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800528 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
529 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
530 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
531 * to implement its own call user interface. An {@link InCallService} implementation which
532 * would like to be informed of external calls should set this meta-data to {@code true} in the
533 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
534 * will NOT be informed about self-managed calls.
535 * <p>
536 * An {@link InCallService} which receives self-managed calls is free to view and control the
537 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700538 * exposing these calls to an automotive device via its companion app.
539 * <p>
540 * This meta-data can only be set for an {@link InCallService} which also sets
541 * {@link #METADATA_IN_CALL_SERVICE_UI}. Only the default phone/dialer app, or a car-mode
542 * {@link InCallService} can see self-managed calls.
Tyler Gunn24e18332017-02-10 09:42:49 -0800543 * <p>
544 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
545 */
546 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
547 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
548
549 /**
Evan Charlton10197192014-07-19 15:00:29 -0700550 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
551 * pause for a predefined period.
552 */
553 public static final char DTMF_CHARACTER_PAUSE = ',';
554
555 /**
556 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
557 * wait for user confirmation before proceeding.
558 */
559 public static final char DTMF_CHARACTER_WAIT = ';';
560
561 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800562 * @hide
563 */
564 @IntDef(prefix = { "TTY_MODE_" },
565 value = {TTY_MODE_OFF, TTY_MODE_FULL, TTY_MODE_HCO, TTY_MODE_VCO})
566 @Retention(RetentionPolicy.SOURCE)
567 public @interface TtyMode {}
568
569 /**
Evan Charlton10197192014-07-19 15:00:29 -0700570 * TTY (teletypewriter) mode is off.
571 *
572 * @hide
573 */
Tyler Gunn6c14a6992019-02-04 15:12:06 -0800574 @TestApi
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800575 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700576 public static final int TTY_MODE_OFF = 0;
577
578 /**
579 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
580 * will communicate with the remote party by sending and receiving text messages.
581 *
582 * @hide
583 */
Tyler Gunn6c14a6992019-02-04 15:12:06 -0800584 @TestApi
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800585 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700586 public static final int TTY_MODE_FULL = 1;
587
588 /**
589 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
590 * speaker is on. The user will communicate with the remote party by sending text messages and
591 * hearing an audible reply.
592 *
593 * @hide
594 */
Tyler Gunn6c14a6992019-02-04 15:12:06 -0800595 @TestApi
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800596 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700597 public static final int TTY_MODE_HCO = 2;
598
599 /**
600 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
601 * microphone is still on. User will communicate with the remote party by speaking and receiving
602 * text message replies.
603 *
604 * @hide
605 */
Tyler Gunn6c14a6992019-02-04 15:12:06 -0800606 @TestApi
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800607 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700608 public static final int TTY_MODE_VCO = 3;
609
610 /**
611 * Broadcast intent action indicating that the current TTY mode has changed. An intent extra
612 * provides this state as an int.
Evan Charlton10197192014-07-19 15:00:29 -0700613 *
Santos Cordon96efb482014-07-19 14:57:05 -0700614 * @see #EXTRA_CURRENT_TTY_MODE
Evan Charlton10197192014-07-19 15:00:29 -0700615 * @hide
616 */
617 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700618 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700619
620 /**
621 * The lookup key for an int that indicates the current TTY mode.
622 * Valid modes are:
623 * - {@link #TTY_MODE_OFF}
624 * - {@link #TTY_MODE_FULL}
625 * - {@link #TTY_MODE_HCO}
626 * - {@link #TTY_MODE_VCO}
627 *
628 * @hide
629 */
630 public static final String EXTRA_CURRENT_TTY_MODE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700631 "android.telecom.intent.extra.CURRENT_TTY_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700632
633 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700634 * Broadcast intent action indicating that the TTY preferred operating mode has changed. An
635 * intent extra provides the new mode as an int.
Evan Charlton10197192014-07-19 15:00:29 -0700636 *
Santos Cordon96efb482014-07-19 14:57:05 -0700637 * @see #EXTRA_TTY_PREFERRED_MODE
Evan Charlton10197192014-07-19 15:00:29 -0700638 * @hide
639 */
640 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700641 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700642
643 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700644 * The lookup key for an int that indicates preferred TTY mode. Valid modes are: -
645 * {@link #TTY_MODE_OFF} - {@link #TTY_MODE_FULL} - {@link #TTY_MODE_HCO} -
646 * {@link #TTY_MODE_VCO}
Evan Charlton10197192014-07-19 15:00:29 -0700647 *
648 * @hide
649 */
650 public static final String EXTRA_TTY_PREFERRED_MODE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700651 "android.telecom.intent.extra.TTY_PREFERRED";
Evan Charlton10197192014-07-19 15:00:29 -0700652
Nancy Chen9d568c02014-09-08 14:17:59 -0700653 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700654 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800655 * notification. If no custom component exists then this is sent to the default dialer which
656 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700657 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700658 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
659 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
660
661 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800662 * The number of calls associated with the notification. If the number is zero then the missed
663 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700664 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700665 public static final String EXTRA_NOTIFICATION_COUNT =
666 "android.telecom.extra.NOTIFICATION_COUNT";
667
668 /**
669 * The number associated with the missed calls. This number is only relevant
670 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700671 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700672 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
673 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
674
675 /**
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700676 * The intent to clear missed calls.
677 * @hide
678 */
679 @SystemApi
680 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
681 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
682
683 /**
684 * The intent to call back a missed call.
685 * @hide
686 */
687 @SystemApi
688 public static final String EXTRA_CALL_BACK_INTENT =
689 "android.telecom.extra.CALL_BACK_INTENT";
690
691 /**
Charles He858f1322017-11-27 17:11:04 -0800692 * The dialer activity responsible for placing emergency calls from, for example, a locked
693 * keyguard.
694 * @hide
695 */
696 public static final ComponentName EMERGENCY_DIALER_COMPONENT =
697 ComponentName.createRelative("com.android.phone", ".EmergencyDialer");
698
699 /**
Eric Erfanian62706c52017-12-06 16:27:53 -0800700 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
701 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
Tyler Gunn5567d742019-10-31 13:04:37 -0700702 * <p>
703 * The call initiator can use this extra to indicate that a call used assisted dialing to help
704 * place the call. This is most commonly used by a Dialer app which provides the ability to
705 * automatically add dialing prefixes when placing international calls.
706 * <p>
707 * Setting this extra on the outgoing call extras will cause the
708 * {@link Connection#PROPERTY_ASSISTED_DIALING_USED} property and
709 * {@link Call.Details#PROPERTY_ASSISTED_DIALING_USED} property to be set on the
710 * {@link Connection}/{@link Call} in question. When the call is logged to the call log, the
711 * {@link android.provider.CallLog.Calls#FEATURES_ASSISTED_DIALING_USED} call feature is set to
712 * indicate that assisted dialing was used for the call.
Eric Erfanian62706c52017-12-06 16:27:53 -0800713 */
714 public static final String EXTRA_USE_ASSISTED_DIALING =
715 "android.telecom.extra.USE_ASSISTED_DIALING";
716
717 /**
Shaotang Li8cec25c2018-07-19 17:29:39 +0800718 * Optional extra for {@link #placeCall(Uri, Bundle)} containing an integer that specifies
719 * the source where user initiated this call. This data is used in metrics.
720 * Valid source are:
721 * {@link ParcelableCallAnalytics#CALL_SOURCE_UNSPECIFIED},
722 * {@link ParcelableCallAnalytics#CALL_SOURCE_EMERGENCY_DIALPAD},
723 * {@link ParcelableCallAnalytics#CALL_SOURCE_EMERGENCY_SHORTCUT}.
724 *
725 * @hide
726 */
727 public static final String EXTRA_CALL_SOURCE = "android.telecom.extra.CALL_SOURCE";
728
729 /**
Nancy Chen9d568c02014-09-08 14:17:59 -0700730 * The following 4 constants define how properties such as phone numbers and names are
731 * displayed to the user.
732 */
733
Santos Cordoned769ae2015-05-13 18:47:38 -0700734 /**
735 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
Charles He858f1322017-11-27 17:11:04 -0800736 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700737 public static final int PRESENTATION_ALLOWED = 1;
738
Santos Cordoned769ae2015-05-13 18:47:38 -0700739 /**
740 * Indicates that the address or number of a call is blocked by the other party.
741 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700742 public static final int PRESENTATION_RESTRICTED = 2;
743
Santos Cordoned769ae2015-05-13 18:47:38 -0700744 /**
745 * Indicates that the address or number of a call is not specified or known by the carrier.
746 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700747 public static final int PRESENTATION_UNKNOWN = 3;
748
Santos Cordoned769ae2015-05-13 18:47:38 -0700749 /**
750 * Indicates that the address or number of a call belongs to a pay phone.
751 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700752 public static final int PRESENTATION_PAYPHONE = 4;
753
Tyler Gunn5567d742019-10-31 13:04:37 -0700754 /** @hide */
755 @Retention(RetentionPolicy.SOURCE)
756 @IntDef(
757 prefix = { "PRESENTATION_" },
758 value = {PRESENTATION_ALLOWED, PRESENTATION_RESTRICTED, PRESENTATION_UNKNOWN,
759 PRESENTATION_PAYPHONE})
760 public @interface Presentation {}
761
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700762 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -0700763
764 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -0700765
Hall Liue1bc2ec2015-10-09 15:58:37 -0700766 private final ITelecomService mTelecomServiceOverride;
767
Santos Cordon6c7a3882014-06-25 15:30:08 -0700768 /**
769 * @hide
770 */
Chen Xu4c0b06d2018-10-22 16:54:39 +0000771 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P)
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700772 public static TelecomManager from(Context context) {
773 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -0700774 }
Santos Cordon6c7a3882014-06-25 15:30:08 -0700775
776 /**
777 * @hide
778 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700779 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -0700780 this(context, null);
781 }
782
783 /**
784 * @hide
785 */
786 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -0700787 Context appContext = context.getApplicationContext();
788 if (appContext != null) {
789 mContext = appContext;
790 } else {
791 mContext = context;
792 }
Hall Liue1bc2ec2015-10-09 15:58:37 -0700793 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700794 }
795
796 /**
Santos Cordon91371dc2015-05-08 13:52:09 -0700797 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
798 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
799 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
800 * account returned depends on the following priorities:
801 * <ul>
802 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
803 * be returned.
804 * </li>
805 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
806 * will be returned.
807 * </li>
808 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700809 * <p>
Santos Cordon91371dc2015-05-08 13:52:09 -0700810 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
811 *
Yorke Leec61d1362015-09-21 17:25:25 -0700812 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
813 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700814 * @param uriScheme The URI scheme.
Santos Cordon91371dc2015-05-08 13:52:09 -0700815 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700816 */
Yorke Leec61d1362015-09-21 17:25:25 -0700817 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700818 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700819 try {
820 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -0700821 return getTelecomService().getDefaultOutgoingPhoneAccount(uriScheme,
822 mContext.getOpPackageName());
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700823 }
824 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700825 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700826 }
827 return null;
828 }
829
830 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -0700831 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
832 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -0700833 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc2015-05-08 13:52:09 -0700834 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -0700835 * Apps must be prepared for this method to return {@code null}, indicating that there currently
836 * exists no user-chosen default {@code PhoneAccount}.
Tyler Gunn36c50ed2018-11-15 07:29:49 -0800837 * <p>
838 * The default dialer has access to use this method.
Andrew Leed4abbfb2014-09-03 14:58:27 -0700839 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +0000840 * @return The user outgoing phone account selected by the user, or {@code null} if there is no
841 * user selected outgoing {@link PhoneAccountHandle}.
Andrew Leed4abbfb2014-09-03 14:58:27 -0700842 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -0800843 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Slava Shklyaeve65e4012019-03-04 16:02:34 +0000844 public @Nullable PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
Andrew Leed4abbfb2014-09-03 14:58:27 -0700845 try {
846 if (isServiceConnected()) {
Tyler Gunn36c50ed2018-11-15 07:29:49 -0800847 return getTelecomService().getUserSelectedOutgoingPhoneAccount(
848 mContext.getOpPackageName());
Andrew Leed4abbfb2014-09-03 14:58:27 -0700849 }
850 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700851 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -0700852 }
853 return null;
854 }
855
856 /**
Tyler Gunn36c50ed2018-11-15 07:29:49 -0800857 * Sets the user-chosen default {@link PhoneAccountHandle} for making outgoing phone calls.
858 *
859 * @param accountHandle The {@link PhoneAccountHandle} which will be used by default for making
Slava Shklyaeve65e4012019-03-04 16:02:34 +0000860 * outgoing voice calls, or {@code null} if no default is specified (the
861 * user will be asked each time a call is placed in this case).
Andrew Lee59cac3a2014-08-28 16:50:10 -0700862 * @hide
863 */
Tyler Gunn36c50ed2018-11-15 07:29:49 -0800864 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Tyler Gunn6c14a6992019-02-04 15:12:06 -0800865 @TestApi
Tyler Gunn36c50ed2018-11-15 07:29:49 -0800866 @SystemApi
Slava Shklyaeve65e4012019-03-04 16:02:34 +0000867 public void setUserSelectedOutgoingPhoneAccount(@Nullable PhoneAccountHandle accountHandle) {
Andrew Lee59cac3a2014-08-28 16:50:10 -0700868 try {
869 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700870 getTelecomService().setUserSelectedOutgoingPhoneAccount(accountHandle);
Andrew Lee59cac3a2014-08-28 16:50:10 -0700871 }
872 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700873 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -0700874 }
875 }
876
877 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -0700878 * Returns the current SIM call manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -0700879 * {@code null}, indicating that there currently exists no SIM call manager {@link PhoneAccount}
880 * for the default voice subscription.
Santos Cordon91371dc2015-05-08 13:52:09 -0700881 *
Brad Ebingere7833312019-05-07 10:55:55 -0700882 * @return The phone account handle of the current sim call manager for the default voice
883 * subscription.
884 * @see SubscriptionManager#getDefaultVoiceSubscriptionId()
Andrew Lee59cac3a2014-08-28 16:50:10 -0700885 */
886 public PhoneAccountHandle getSimCallManager() {
887 try {
888 if (isServiceConnected()) {
Brad Ebingere7833312019-05-07 10:55:55 -0700889 return getTelecomService().getSimCallManager(
890 SubscriptionManager.getDefaultSubscriptionId());
Andrew Lee59cac3a2014-08-28 16:50:10 -0700891 }
892 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700893 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -0700894 }
895 return null;
896 }
897
898 /**
Brad Ebingere7833312019-05-07 10:55:55 -0700899 * Returns current SIM call manager for the Telephony Subscription ID specified. Apps must be
900 * prepared for this method to return {@code null}, indicating that there currently exists no
901 * SIM call manager {@link PhoneAccount} for the subscription specified.
902 *
903 * @param subscriptionId The Telephony Subscription ID that the SIM call manager should be
904 * queried for.
905 * @return The phone account handle of the current sim call manager.
906 * @see SubscriptionManager#getActiveSubscriptionInfoList()
Brad Ebingere7833312019-05-07 10:55:55 -0700907 */
Tyler Gunn5567d742019-10-31 13:04:37 -0700908 public @Nullable PhoneAccountHandle getSimCallManagerForSubscription(int subscriptionId) {
Brad Ebingere7833312019-05-07 10:55:55 -0700909 try {
910 if (isServiceConnected()) {
911 return getTelecomService().getSimCallManager(subscriptionId);
912 }
913 } catch (RemoteException e) {
914 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
915 }
916 return null;
917 }
918
919 /**
920 * Returns the current SIM call manager for the user-chosen default Telephony Subscription ID
921 * (see {@link SubscriptionManager#getDefaultSubscriptionId()}) and the specified user. Apps
922 * must be prepared for this method to return {@code null}, indicating that there currently
923 * exists no SIM call manager {@link PhoneAccount} for the default voice subscription.
Sailesh Nepalcf855622015-07-28 19:22:14 -0700924 *
925 * @return The phone account handle of the current sim call manager.
926 *
927 * @hide
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800928 * @deprecated Use {@link #getSimCallManager()}.
Sailesh Nepalcf855622015-07-28 19:22:14 -0700929 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -0800930 @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 119305590)
Sailesh Nepalcf855622015-07-28 19:22:14 -0700931 public PhoneAccountHandle getSimCallManager(int userId) {
932 try {
933 if (isServiceConnected()) {
934 return getTelecomService().getSimCallManagerForUser(userId);
935 }
936 } catch (RemoteException e) {
937 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
938 }
939 return null;
940 }
941
942 /**
Evan Charltoneb0a8d52014-09-04 12:03:34 -0700943 * Returns the current connection manager. Apps must be prepared for this method to return
Brad Ebingere7833312019-05-07 10:55:55 -0700944 * {@code null}, indicating that there currently exists no Connection Manager
945 * {@link PhoneAccount} for the default voice subscription.
Evan Charltoneb0a8d52014-09-04 12:03:34 -0700946 *
947 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -0800948 * @hide
Evan Charltoneb0a8d52014-09-04 12:03:34 -0700949 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800950 @SystemApi
Evan Charltoneb0a8d52014-09-04 12:03:34 -0700951 public PhoneAccountHandle getConnectionManager() {
952 return getSimCallManager();
953 }
954
955 /**
Nancy Chen210ef032014-09-15 17:58:42 -0700956 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
957 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700958 * <P>
959 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
960 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
961 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
962 * such as {@code sip:example@sipexample.com}).
963 *
964 * @param uriScheme The URI scheme.
965 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -0800966 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700967 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800968 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -0600969 @RequiresPermission(anyOf = {
Tyler Gunn5567d742019-10-31 13:04:37 -0700970 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -0600971 android.Manifest.permission.READ_PHONE_STATE
972 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700973 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
974 try {
975 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -0700976 return getTelecomService().getPhoneAccountsSupportingScheme(uriScheme,
977 mContext.getOpPackageName());
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700978 }
979 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700980 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700981 }
982 return new ArrayList<>();
983 }
984
Nancy Chen513c8922014-09-17 14:47:20 -0700985
986 /**
Santos Cordon91371dc2015-05-08 13:52:09 -0700987 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
988 * calls. The returned list includes only those accounts which have been explicitly enabled
989 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -0700990 *
Yorke Leec61d1362015-09-21 17:25:25 -0700991 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
992 *
Nancy Chen513c8922014-09-17 14:47:20 -0700993 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
994 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -0700995 */
Yorke Leec61d1362015-09-21 17:25:25 -0700996 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -0700997 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc2015-05-08 13:52:09 -0700998 return getCallCapablePhoneAccounts(false);
999 }
1000
1001 /**
Tyler Gunn89317072017-04-07 14:57:37 -07001002 * Returns a list of {@link PhoneAccountHandle}s for self-managed {@link ConnectionService}s.
1003 * <p>
1004 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
1005 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
1006 * <p>
1007 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
1008 * is the default dialer app.
1009 * <p>
1010 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
1011 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
1012 *
1013 * @return A list of {@code PhoneAccountHandle} objects.
1014 */
1015 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1016 public List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
1017 try {
1018 if (isServiceConnected()) {
1019 return getTelecomService().getSelfManagedPhoneAccounts(mContext.getOpPackageName());
1020 }
1021 } catch (RemoteException e) {
1022 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
1023 }
1024 return new ArrayList<>();
1025 }
1026
1027 /**
Santos Cordon91371dc2015-05-08 13:52:09 -07001028 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
1029 * by the user.
1030 *
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001031 * @param includeDisabledAccounts When {@code true}, disabled phone accounts will be included,
Hall Liub2306242019-11-15 17:13:05 -08001032 * when {@code false}, only enabled phone accounts will be
1033 * included.
Santos Cordon91371dc2015-05-08 13:52:09 -07001034 * @return A list of {@code PhoneAccountHandle} objects.
1035 * @hide
1036 */
Hall Liub2306242019-11-15 17:13:05 -08001037 @SystemApi
1038 @TestApi
1039 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1040 public @NonNull List<PhoneAccountHandle> getCallCapablePhoneAccounts(
1041 boolean includeDisabledAccounts) {
Nancy Chen513c8922014-09-17 14:47:20 -07001042 try {
1043 if (isServiceConnected()) {
Santos Cordon91371dc2015-05-08 13:52:09 -07001044 return getTelecomService().getCallCapablePhoneAccounts(
1045 includeDisabledAccounts, mContext.getOpPackageName());
Nancy Chen513c8922014-09-17 14:47:20 -07001046 }
1047 } catch (RemoteException e) {
Santos Cordon91371dc2015-05-08 13:52:09 -07001048 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts(" +
1049 includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -07001050 }
1051 return new ArrayList<>();
1052 }
1053
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001054 /**
Nancy Chen513c8922014-09-17 14:47:20 -07001055 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
1056 *
1057 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -08001058 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -07001059 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001060 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001061 @SuppressLint("Doclava125")
Nancy Chen513c8922014-09-17 14:47:20 -07001062 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
1063 try {
1064 if (isServiceConnected()) {
1065 return getTelecomService().getPhoneAccountsForPackage(mContext.getPackageName());
1066 }
1067 } catch (RemoteException e) {
1068 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
1069 }
1070 return null;
1071 }
1072
1073 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001074 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
1075 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001076 *
Evan Charlton6eb262c2014-07-19 18:18:19 -07001077 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -07001078 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001079 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001080 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001081 try {
1082 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001083 return getTelecomService().getPhoneAccount(account);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001084 }
1085 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001086 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001087 }
1088 return null;
1089 }
1090
1091 /**
Nancy Chen210ef032014-09-15 17:58:42 -07001092 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001093 *
Nancy Chen210ef032014-09-15 17:58:42 -07001094 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001095 * @hide
1096 */
1097 @SystemApi
1098 public int getAllPhoneAccountsCount() {
1099 try {
1100 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001101 return getTelecomService().getAllPhoneAccountsCount();
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001102 }
1103 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001104 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001105 }
1106 return 0;
1107 }
1108
1109 /**
1110 * Returns a list of all {@link PhoneAccount}s.
1111 *
1112 * @return All {@link PhoneAccount}s.
1113 * @hide
1114 */
1115 @SystemApi
1116 public List<PhoneAccount> getAllPhoneAccounts() {
1117 try {
1118 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001119 return getTelecomService().getAllPhoneAccounts();
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001120 }
1121 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001122 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001123 }
1124 return Collections.EMPTY_LIST;
1125 }
1126
1127 /**
1128 * Returns a list of all {@link PhoneAccountHandle}s.
1129 *
1130 * @return All {@link PhoneAccountHandle}s.
1131 * @hide
1132 */
1133 @SystemApi
1134 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
1135 try {
1136 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001137 return getTelecomService().getAllPhoneAccountHandles();
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001138 }
1139 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001140 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -07001141 }
1142 return Collections.EMPTY_LIST;
1143 }
1144
1145 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -08001146 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
1147 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
1148 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -07001149 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
1150 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
1151 * the phone app settings before the account is usable.
1152 * <p>
1153 * A {@link SecurityException} will be thrown if an app tries to register a
1154 * {@link PhoneAccountHandle} where the package name specified within
1155 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001156 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001157 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001158 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001159 public void registerPhoneAccount(PhoneAccount account) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001160 try {
1161 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001162 getTelecomService().registerPhoneAccount(account);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001163 }
1164 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001165 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001166 }
1167 }
1168
1169 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -07001170 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001171 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001172 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001173 */
Evan Charlton8c8a0622014-07-20 12:31:00 -07001174 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001175 try {
1176 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001177 getTelecomService().unregisterPhoneAccount(accountHandle);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001178 }
1179 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001180 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001181 }
1182 }
1183
1184 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001185 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -08001186 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -07001187 */
Evan Charlton0e094d92014-11-08 15:49:16 -08001188 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001189 @SuppressLint("Doclava125")
Yorke Lee06044272015-04-14 15:16:59 -07001190 public void clearPhoneAccounts() {
1191 clearAccounts();
1192 }
1193 /**
1194 * Remove all Accounts that belong to the calling package from the system.
1195 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1196 * @hide
1197 */
1198 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001199 @SuppressLint("Doclava125")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001200 public void clearAccounts() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001201 try {
1202 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001203 getTelecomService().clearAccounts(mContext.getPackageName());
Ihab Awad807fe0a2014-07-09 12:30:52 -07001204 }
1205 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001206 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001207 }
1208 }
1209
1210 /**
Anthony Lee67279262014-10-27 11:28:40 -07001211 * Remove all Accounts that belong to the specified package from the system.
1212 * @hide
1213 */
1214 public void clearAccountsForPackage(String packageName) {
1215 try {
1216 if (isServiceConnected() && !TextUtils.isEmpty(packageName)) {
1217 getTelecomService().clearAccounts(packageName);
1218 }
1219 } catch (RemoteException e) {
Nancy Chen5cf27842015-01-24 23:30:27 -08001220 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001221 }
1222 }
1223
Yorke Lee1011f482015-04-23 15:58:27 -07001224
Anthony Lee67279262014-10-27 11:28:40 -07001225 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001226 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1227 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001228 * @hide
1229 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001230 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001231 @SuppressLint("Doclava125")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001232 public ComponentName getDefaultPhoneApp() {
1233 try {
Santos Cordon9eb45932014-06-27 12:28:43 -07001234 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001235 return getTelecomService().getDefaultPhoneApp();
Santos Cordon9eb45932014-06-27 12:28:43 -07001236 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001237 } catch (RemoteException e) {
1238 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
1239 }
1240 return null;
1241 }
1242
Santos Cordon9eb45932014-06-27 12:28:43 -07001243 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001244 * Used to determine the currently selected default dialer package.
1245 *
1246 * @return package name for the default dialer package or null if no package has been
1247 * selected as the default dialer.
1248 */
1249 public String getDefaultDialerPackage() {
1250 try {
1251 if (isServiceConnected()) {
1252 return getTelecomService().getDefaultDialerPackage();
1253 }
1254 } catch (RemoteException e) {
1255 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
1256 }
1257 return null;
1258 }
1259
1260 /**
Tyler Gunn5567d742019-10-31 13:04:37 -07001261 * Used to determine the currently selected default dialer package for a specific user.
1262 *
1263 * @param userId the user id to query the default dialer package for.
1264 * @return package name for the default dialer package or null if no package has been
1265 * selected as the default dialer.
1266 * @hide
1267 */
1268 @SystemApi
1269 @TestApi
1270 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
1271 public @Nullable String getDefaultDialerPackage(int userId) {
1272 try {
1273 if (isServiceConnected()) {
1274 return getTelecomService().getDefaultDialerPackageForUser(userId);
1275 }
1276 } catch (RemoteException e) {
1277 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
1278 }
1279 return null;
1280 }
1281
1282 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001283 * Used to set the default dialer package.
1284 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001285 * @param packageName to set the default dialer to, or {@code null} if the system provided
1286 * dialer should be used instead.
Yorke Lee107c4ce2015-06-15 12:08:24 -07001287 *
1288 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1289 * the specified package does not correspond to an installed dialer, or is already
1290 * the default dialer.
1291 *
1292 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1293 * Requires permission: {@link android.Manifest.permission#WRITE_SECURE_SETTINGS}
1294 *
1295 * @hide
Tyler Gunn7e45b722018-12-04 12:56:45 -08001296 * @deprecated Use
Hai Zhangf5e8ccd2019-03-06 20:12:24 -08001297 * {@link android.app.role.RoleManager#addRoleHolderAsUser(String, String, int, UserHandle,
1298 * Executor, java.util.function.Consumer)} instead.
Suprabh Shukla169bed72019-05-13 13:54:58 -07001299 * @removed
Yorke Lee107c4ce2015-06-15 12:08:24 -07001300 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001301 @SystemApi
Tyler Gunn7e45b722018-12-04 12:56:45 -08001302 @Deprecated
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001303 @RequiresPermission(allOf = {
1304 android.Manifest.permission.MODIFY_PHONE_STATE,
1305 android.Manifest.permission.WRITE_SECURE_SETTINGS})
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001306 public boolean setDefaultDialer(@Nullable String packageName) {
Yorke Lee107c4ce2015-06-15 12:08:24 -07001307 try {
1308 if (isServiceConnected()) {
1309 return getTelecomService().setDefaultDialer(packageName);
1310 }
1311 } catch (RemoteException e) {
1312 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
1313 }
1314 return false;
1315 }
1316
1317 /**
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001318 * Determines the package name of the system-provided default phone app.
Yorke Lee1011f482015-04-23 15:58:27 -07001319 *
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001320 * @return package name for the system dialer package or {@code null} if no system dialer is
1321 * preloaded.
Yorke Lee1011f482015-04-23 15:58:27 -07001322 */
Slava Shklyaeve65e4012019-03-04 16:02:34 +00001323 public @Nullable String getSystemDialerPackage() {
Yorke Lee1011f482015-04-23 15:58:27 -07001324 try {
1325 if (isServiceConnected()) {
1326 return getTelecomService().getSystemDialerPackage();
1327 }
1328 } catch (RemoteException e) {
1329 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
1330 }
1331 return null;
1332 }
1333
1334 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001335 * Return whether a given phone number is the configured voicemail number for a
1336 * particular phone account.
1337 *
Yorke Leec61d1362015-09-21 17:25:25 -07001338 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1339 *
Nancy Chen443e5012014-10-15 15:48:21 -07001340 * @param accountHandle The handle for the account to check the voicemail number against
1341 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001342 */
Yorke Leec61d1362015-09-21 17:25:25 -07001343 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001344 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
1345 try {
1346 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001347 return getTelecomService().isVoiceMailNumber(accountHandle, number,
1348 mContext.getOpPackageName());
Nancy Chen443e5012014-10-15 15:48:21 -07001349 }
1350 } catch (RemoteException e) {
Nancy Chen5cf27842015-01-24 23:30:27 -08001351 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001352 }
1353 return false;
1354 }
1355
1356 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001357 * Return the voicemail number for a given phone account.
Nancy Chen8c066f72014-12-03 15:18:08 -08001358 *
Yorke Leec61d1362015-09-21 17:25:25 -07001359 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1360 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001361 * @param accountHandle The handle for the phone account.
1362 * @return The voicemail number for the phone account, and {@code null} if one has not been
1363 * configured.
Nancy Chen8c066f72014-12-03 15:18:08 -08001364 */
Yorke Leec61d1362015-09-21 17:25:25 -07001365 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001366 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Nancy Chen8c066f72014-12-03 15:18:08 -08001367 try {
1368 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001369 return getTelecomService().getVoiceMailNumber(accountHandle,
1370 mContext.getOpPackageName());
Nancy Chen8c066f72014-12-03 15:18:08 -08001371 }
1372 } catch (RemoteException e) {
Nancy Chen5cf27842015-01-24 23:30:27 -08001373 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f72014-12-03 15:18:08 -08001374 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001375 return null;
Nancy Chen8c066f72014-12-03 15:18:08 -08001376 }
1377
1378 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001379 * Return the line 1 phone number for given phone account.
1380 *
Yorke Leec61d1362015-09-21 17:25:25 -07001381 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1382 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001383 * @param accountHandle The handle for the account retrieve a number for.
1384 * @return A string representation of the line 1 phone number.
Nancy Chen5cf27842015-01-24 23:30:27 -08001385 */
Yorke Leec61d1362015-09-21 17:25:25 -07001386 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen5cf27842015-01-24 23:30:27 -08001387 public String getLine1Number(PhoneAccountHandle accountHandle) {
1388 try {
1389 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001390 return getTelecomService().getLine1Number(accountHandle,
1391 mContext.getOpPackageName());
Nancy Chen5cf27842015-01-24 23:30:27 -08001392 }
1393 } catch (RemoteException e) {
1394 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
1395 }
1396 return null;
1397 }
1398
1399 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001400 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001401 * states) originating from either a manager or self-managed {@link ConnectionService}.
Nancy Chen0eb1e402014-08-21 22:52:29 -07001402 * <p>
1403 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
Tyler Gunn24e18332017-02-10 09:42:49 -08001404 *
1405 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1406 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001407 */
Yorke Leec61d1362015-09-21 17:25:25 -07001408 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001409 public boolean isInCall() {
Santos Cordon9eb45932014-06-27 12:28:43 -07001410 try {
1411 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001412 return getTelecomService().isInCall(mContext.getOpPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001413 }
1414 } catch (RemoteException e) {
Yorke Lee2ae312e2014-09-12 17:58:48 -07001415 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001416 }
1417 return false;
1418 }
1419
1420 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001421 * Returns whether there is an ongoing call originating from a managed
1422 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1423 * states.
1424 * <p>
1425 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1426 * instead.
1427 * <p>
1428 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1429 *
1430 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1431 * {@code false} otherwise.
1432 */
1433 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1434 public boolean isInManagedCall() {
1435 try {
1436 if (isServiceConnected()) {
1437 return getTelecomService().isInManagedCall(mContext.getOpPackageName());
1438 }
1439 } catch (RemoteException e) {
1440 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
1441 }
1442 return false;
1443 }
1444
1445 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001446 * Returns one of the following constants that represents the current state of Telecom:
1447 *
1448 * {@link TelephonyManager#CALL_STATE_RINGING}
1449 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1450 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001451 *
1452 * Note that this API does not require the
1453 * {@link android.Manifest.permission#READ_PHONE_STATE} permission. This is intentional, to
1454 * preserve the behavior of {@link TelephonyManager#getCallState()}, which also did not require
1455 * the permission.
Tyler Gunn24e18332017-02-10 09:42:49 -08001456 *
1457 * Takes into consideration both managed and self-managed calls.
1458 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001459 * @hide
1460 */
1461 @SystemApi
Chen Xu7631ff72019-09-26 16:11:59 -07001462 public @CallState int getCallState() {
Yorke Lee2ae312e2014-09-12 17:58:48 -07001463 try {
1464 if (isServiceConnected()) {
1465 return getTelecomService().getCallState();
1466 }
1467 } catch (RemoteException e) {
1468 Log.d(TAG, "RemoteException calling getCallState().", e);
1469 }
1470 return TelephonyManager.CALL_STATE_IDLE;
1471 }
1472
1473 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001474 * Returns whether there currently exists is a ringing incoming-call.
1475 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001476 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001477 * @hide
1478 */
1479 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001480 @RequiresPermission(anyOf = {
Tyler Gunn5567d742019-10-31 13:04:37 -07001481 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001482 android.Manifest.permission.READ_PHONE_STATE
1483 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001484 public boolean isRinging() {
1485 try {
1486 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001487 return getTelecomService().isRinging(mContext.getOpPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001488 }
1489 } catch (RemoteException e) {
1490 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
1491 }
1492 return false;
1493 }
1494
1495 /**
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001496 * Ends the foreground call on the device.
1497 * <p>
1498 * If there is a ringing call, calling this method rejects the ringing call. Otherwise the
1499 * foreground call is ended.
1500 * <p>
1501 * Requires permission {@link android.Manifest.permission#ANSWER_PHONE_CALLS}.
Tyler Gunnf18ee4c2019-05-14 11:08:06 -07001502 * <p>
1503 * Note: this method CANNOT be used to end ongoing emergency calls and will return {@code false}
1504 * if an attempt is made to end an emergency call.
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001505 *
1506 * @return {@code true} if there is a call which will be rejected or terminated, {@code false}
1507 * otherwise.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001508 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1509 * instead. Apps performing call screening should use the {@link CallScreeningService} API
1510 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001511 */
Tyler Gunne1aa26c2018-05-02 13:23:48 -07001512 @RequiresPermission(Manifest.permission.ANSWER_PHONE_CALLS)
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001513 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001514 public boolean endCall() {
1515 try {
1516 if (isServiceConnected()) {
Tyler Gunnc8658812018-02-07 16:08:27 -08001517 return getTelecomService().endCall(mContext.getPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001518 }
1519 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001520 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001521 }
1522 return false;
1523 }
1524
1525 /**
1526 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001527 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001528 * If the incoming call is a video call, the call will be answered with the same video state as
1529 * the incoming call requests. This means, for example, that an incoming call requesting
1530 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001531 *
1532 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or
1533 * {@link android.Manifest.permission#ANSWER_PHONE_CALLS}
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001534 *
1535 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1536 * instead.
Santos Cordon9eb45932014-06-27 12:28:43 -07001537 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001538 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1539 // this method (clockwork & gearhead).
1540 @RequiresPermission(anyOf =
1541 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001542 @Deprecated
Santos Cordon9eb45932014-06-27 12:28:43 -07001543 public void acceptRingingCall() {
1544 try {
1545 if (isServiceConnected()) {
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001546 getTelecomService().acceptRingingCall(mContext.getPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001547 }
1548 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001549 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001550 }
1551 }
1552
1553 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001554 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1555 * with the specified video state.
1556 *
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001557 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or
1558 * {@link android.Manifest.permission#ANSWER_PHONE_CALLS}
1559 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001560 * @param videoState The desired video state to answer the call with.
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001561 * @deprecated Companion apps for wearable devices should use the {@link InCallService} API
1562 * instead.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001563 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001564 @RequiresPermission(anyOf =
1565 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn9bd8db42019-01-31 10:54:03 -08001566 @Deprecated
Tyler Gunn6676bb52015-10-23 14:39:49 -07001567 public void acceptRingingCall(int videoState) {
1568 try {
1569 if (isServiceConnected()) {
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001570 getTelecomService().acceptRingingCallWithVideoState(
1571 mContext.getPackageName(), videoState);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001572 }
1573 } catch (RemoteException e) {
1574 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
1575 }
1576 }
1577
1578 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001579 * Silences the ringer if a ringing call exists.
Tyler Gunn556d2402019-04-10 08:59:43 -07001580 * <p>
1581 * This method can only be relied upon to stop the ringtone for a call if the ringtone has
1582 * already started playing. It is intended to handle use-cases such as silencing a ringing call
1583 * when the user presses the volume button during ringing.
1584 * <p>
1585 * If this method is called prior to when the ringtone begins playing, the ringtone will not be
1586 * silenced. As such it is not intended as a means to avoid playing of a ringtone.
1587 * <p>
1588 * A dialer app which wants to have more control over ringtone playing should declare
1589 * {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} in the manifest entry for their
1590 * {@link InCallService} implementation to indicate that the app wants to be responsible for
1591 * playing the ringtone for all incoming calls.
1592 * <p>
1593 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or that the
1594 * app fills the dialer role (see {@link #getDefaultDialerPackage()}).
Santos Cordon9eb45932014-06-27 12:28:43 -07001595 */
Yorke Leec61d1362015-09-21 17:25:25 -07001596 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07001597 public void silenceRinger() {
1598 try {
1599 if (isServiceConnected()) {
Yorke Leef1a349b2015-04-29 16:16:50 -07001600 getTelecomService().silenceRinger(mContext.getOpPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001601 }
1602 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001603 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001604 }
1605 }
1606
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001607 /**
1608 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001609 */
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001610 @RequiresPermission(anyOf = {
Tyler Gunn5567d742019-10-31 13:04:37 -07001611 READ_PRIVILEGED_PHONE_STATE,
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001612 android.Manifest.permission.READ_PHONE_STATE
1613 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001614 public boolean isTtySupported() {
1615 try {
1616 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001617 return getTelecomService().isTtySupported(mContext.getOpPackageName());
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001618 }
1619 } catch (RemoteException e) {
1620 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
1621 }
1622 return false;
1623 }
1624
1625 /**
1626 * Returns the current TTY mode of the device. For TTY to be on the user must enable it in
Santos Cordon96efb482014-07-19 14:57:05 -07001627 * settings and have a wired headset plugged in.
1628 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001629 * - {@link TelecomManager#TTY_MODE_OFF}
1630 * - {@link TelecomManager#TTY_MODE_FULL}
1631 * - {@link TelecomManager#TTY_MODE_HCO}
1632 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001633 * @hide
1634 */
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001635 @SystemApi
Tyler Gunn6c14a6992019-02-04 15:12:06 -08001636 @TestApi
Tyler Gunn5567d742019-10-31 13:04:37 -07001637 @RequiresPermission(READ_PRIVILEGED_PHONE_STATE)
Tyler Gunn6e3ecc42018-11-12 11:30:56 -08001638 public @TtyMode int getCurrentTtyMode() {
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001639 try {
1640 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001641 return getTelecomService().getCurrentTtyMode(mContext.getOpPackageName());
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001642 }
1643 } catch (RemoteException e) {
1644 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
1645 }
Evan Charlton10197192014-07-19 15:00:29 -07001646 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001647 }
1648
Santos Cordon96efb482014-07-19 14:57:05 -07001649 /**
1650 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08001651 * has an incoming call. For managed {@link ConnectionService}s, the specified
1652 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
1653 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
1654 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
1655 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
1656 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07001657 * The incoming call you are adding is assumed to have a video state of
1658 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
1659 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
1660 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08001661 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
1662 * associated with the {@link PhoneAccountHandle} and request additional information about the
1663 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08001664 * call UI.
1665 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08001666 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
1667 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
1668 * the associated {@link PhoneAccount} is not currently enabled by the user.
1669 * <p>
1670 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
1671 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
1672 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
1673 *
Santos Cordon96efb482014-07-19 14:57:05 -07001674 * @param phoneAccount A {@link PhoneAccountHandle} registered with
1675 * {@link #registerPhoneAccount}.
1676 * @param extras A bundle that will be passed through to
1677 * {@link ConnectionService#onCreateIncomingConnection}.
1678 */
1679 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
1680 try {
1681 if (isServiceConnected()) {
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08001682 if (extras != null && extras.getBoolean(EXTRA_IS_HANDOVER) &&
1683 mContext.getApplicationContext().getApplicationInfo().targetSdkVersion >
1684 Build.VERSION_CODES.O_MR1) {
1685 Log.e("TAG", "addNewIncomingCall failed. Use public api " +
1686 "acceptHandover for API > O-MR1");
Tyler Gunn9ae6db82019-02-13 13:51:18 -08001687 return;
Sanket Padawef6a9e5b2018-01-05 14:26:16 -08001688 }
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001689 getTelecomService().addNewIncomingCall(
Santos Cordon96efb482014-07-19 14:57:05 -07001690 phoneAccount, extras == null ? new Bundle() : extras);
1691 }
1692 } catch (RemoteException e) {
1693 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
1694 }
1695 }
1696
Nancy Chen0eb1e402014-08-21 22:52:29 -07001697 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07001698 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
1699 * service. This is invoked when Telephony detects a new unknown connection that was neither
1700 * a new incoming call, nor an user-initiated outgoing call.
1701 *
1702 * @param phoneAccount A {@link PhoneAccountHandle} registered with
1703 * {@link #registerPhoneAccount}.
1704 * @param extras A bundle that will be passed through to
1705 * {@link ConnectionService#onCreateIncomingConnection}.
1706 * @hide
1707 */
1708 @SystemApi
1709 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
1710 try {
1711 if (isServiceConnected()) {
1712 getTelecomService().addNewUnknownCall(
1713 phoneAccount, extras == null ? new Bundle() : extras);
1714 }
1715 } catch (RemoteException e) {
1716 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
1717 }
1718 }
1719
1720 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07001721 * Processes the specified dial string as an MMI code.
1722 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
1723 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07001724 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07001725 * <p>
1726 * Requires that the method-caller be set as the system dialer app.
1727 * </p>
1728 *
Yorke Leec61d1362015-09-21 17:25:25 -07001729 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1730 *
Nancy Chen0eb1e402014-08-21 22:52:29 -07001731 * @param dialString The digits to dial.
1732 * @return True if the digits were processed as an MMI code, false otherwise.
1733 */
Yorke Leec61d1362015-09-21 17:25:25 -07001734 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001735 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001736 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07001737 if (service != null) {
1738 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001739 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07001740 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001741 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07001742 }
1743 }
1744 return false;
1745 }
1746
1747 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07001748 * Processes the specified dial string as an MMI code.
1749 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
1750 * Some of these sequences launch special behavior through handled by Telephony.
1751 * <p>
1752 * Requires that the method-caller be set as the system dialer app.
1753 * </p>
1754 *
Yorke Leec61d1362015-09-21 17:25:25 -07001755 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1756 *
Nancy Chen95e8a672014-10-16 18:38:21 -07001757 * @param accountHandle The handle for the account the MMI code should apply to.
1758 * @param dialString The digits to dial.
1759 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07001760 */
Yorke Leec61d1362015-09-21 17:25:25 -07001761 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07001762 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07001763 ITelecomService service = getTelecomService();
1764 if (service != null) {
1765 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001766 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
1767 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07001768 } catch (RemoteException e) {
1769 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
1770 }
1771 }
1772 return false;
1773 }
1774
1775 /**
Yorke Leec61d1362015-09-21 17:25:25 -07001776 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1777 *
Nancy Chenb2299c12014-10-29 18:22:11 -07001778 * @param accountHandle The handle for the account to derive an adn query URI for or
1779 * {@code null} to return a URI which will use the default account.
1780 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
1781 * for the the content retrieve.
1782 */
Yorke Leec61d1362015-09-21 17:25:25 -07001783 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07001784 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
1785 ITelecomService service = getTelecomService();
1786 if (service != null && accountHandle != null) {
1787 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001788 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07001789 } catch (RemoteException e) {
1790 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
1791 }
1792 }
1793 return Uri.parse("content://icc/adn");
1794 }
1795
1796 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07001797 * Removes the missed-call notification if one is present.
1798 * <p>
1799 * Requires that the method-caller be set as the system dialer app.
1800 * </p>
Yorke Leec61d1362015-09-21 17:25:25 -07001801 *
1802 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
Nancy Chen0eb1e402014-08-21 22:52:29 -07001803 */
Yorke Leec61d1362015-09-21 17:25:25 -07001804 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001805 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001806 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07001807 if (service != null) {
1808 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001809 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07001810 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001811 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07001812 }
1813 }
1814 }
1815
1816 /**
1817 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
1818 * currently no ongoing call, then this method does nothing.
1819 * <p>
1820 * Requires that the method-caller be set as the system dialer app or have the
1821 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
1822 * </p>
1823 *
1824 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
1825 */
Yorke Leec61d1362015-09-21 17:25:25 -07001826 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001827 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001828 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07001829 if (service != null) {
1830 try {
Svet Ganov16a16892015-04-16 10:32:04 -07001831 service.showInCallScreen(showDialpad, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07001832 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001833 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07001834 }
1835 }
1836 }
1837
Yorke Lee3e56ba12015-04-23 12:32:36 -07001838 /**
1839 * Places a new outgoing call to the provided address using the system telecom service with
1840 * the specified extras.
1841 *
1842 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
1843 * except that the outgoing call will always be sent via the system telecom service. If
1844 * method-caller is either the user selected default dialer app or preloaded system dialer
1845 * app, then emergency calls will also be allowed.
1846 *
Tyler Gunnf5035432017-01-09 09:43:12 -08001847 * Placing a call via a managed {@link ConnectionService} requires permission:
1848 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07001849 *
1850 * Usage example:
1851 * <pre>
1852 * Uri uri = Uri.fromParts("tel", "12345", null);
1853 * Bundle extras = new Bundle();
1854 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
1855 * telecomManager.placeCall(uri, extras);
1856 * </pre>
1857 *
Santos Cordon7a060d52015-06-19 14:52:04 -07001858 * The following keys are supported in the supplied extras.
1859 * <ul>
1860 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
1861 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
1862 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
1863 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
1864 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08001865 * <p>
1866 * An app which implements the self-managed {@link ConnectionService} API uses
1867 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
1868 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
1869 * associated {@link android.telecom.PhoneAccountHandle}.
1870 *
1871 * Self-managed {@link ConnectionService}s require permission
1872 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07001873 *
Brad Ebinger3636d742019-05-21 15:28:19 -07001874 * <p class="note"><strong>Note:</strong> If this method is used to place an emergency call, it
1875 * is not guaranteed that the call will be placed on the {@link PhoneAccount} provided in
1876 * the {@link #EXTRA_PHONE_ACCOUNT_HANDLE} extra (if specified) and may be placed on another
1877 * {@link PhoneAccount} with the {@link PhoneAccount#CAPABILITY_PLACE_EMERGENCY_CALLS}
1878 * capability, depending on external factors, such as network conditions and Modem/SIM status.
1879 * </p>
1880 *
Yorke Lee3e56ba12015-04-23 12:32:36 -07001881 * @param address The address to make the call to.
1882 * @param extras Bundle of extras to use with the call.
1883 */
Tyler Gunnf5035432017-01-09 09:43:12 -08001884 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
1885 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07001886 public void placeCall(Uri address, Bundle extras) {
1887 ITelecomService service = getTelecomService();
1888 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07001889 if (address == null) {
1890 Log.w(TAG, "Cannot place call to empty address.");
1891 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07001892 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07001893 service.placeCall(address, extras == null ? new Bundle() : extras,
1894 mContext.getOpPackageName());
Yorke Lee3e56ba12015-04-23 12:32:36 -07001895 } catch (RemoteException e) {
1896 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
1897 }
1898 }
1899 }
1900
Santos Cordon91371dc2015-05-08 13:52:09 -07001901 /**
1902 * Enables and disables specified phone account.
1903 *
1904 * @param handle Handle to the phone account.
1905 * @param isEnabled Enable state of the phone account.
1906 * @hide
1907 */
1908 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001909 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc2015-05-08 13:52:09 -07001910 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
1911 ITelecomService service = getTelecomService();
1912 if (service != null) {
1913 try {
1914 service.enablePhoneAccount(handle, isEnabled);
1915 } catch (RemoteException e) {
1916 Log.e(TAG, "Error enablePhoneAbbount", e);
1917 }
1918 }
1919 }
1920
Hall Liu0464b9b2016-01-12 15:32:58 -08001921 /**
1922 * Dumps telecom analytics for uploading.
1923 *
1924 * @return
1925 * @hide
1926 */
1927 @SystemApi
1928 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07001929 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08001930 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07001931 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08001932 if (service != null) {
1933 try {
1934 result = service.dumpCallAnalytics();
1935 } catch (RemoteException e) {
1936 Log.e(TAG, "Error dumping call analytics", e);
1937 }
1938 }
1939 return result;
1940 }
1941
Abhijith Shastry1908cb842016-02-02 11:10:19 -08001942 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08001943 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
1944 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08001945 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08001946 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
1947 * {@code true} for the current user.
1948 */
1949 public Intent createManageBlockedNumbersIntent() {
1950 ITelecomService service = getTelecomService();
1951 Intent result = null;
1952 if (service != null) {
1953 try {
1954 result = service.createManageBlockedNumbersIntent();
1955 } catch (RemoteException e) {
1956 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
1957 }
1958 }
1959 return result;
1960 }
1961
Tyler Gunnf5035432017-01-09 09:43:12 -08001962 /**
1963 * Determines whether Telecom would permit an incoming call to be added via the
1964 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
1965 * {@link PhoneAccountHandle}.
1966 * <p>
1967 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
1968 * in the following situations:
1969 * <ul>
1970 * <li>{@link PhoneAccount} does not have property
1971 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
1972 * {@link ConnectionService}), and the active or held call limit has
1973 * been reached.</li>
1974 * <li>There is an ongoing emergency call.</li>
1975 * </ul>
1976 *
1977 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
1978 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
1979 * otherwise.
1980 */
1981 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08001982 if (phoneAccountHandle == null) {
1983 return false;
1984 }
1985
Tyler Gunnf5035432017-01-09 09:43:12 -08001986 ITelecomService service = getTelecomService();
1987 if (service != null) {
1988 try {
1989 return service.isIncomingCallPermitted(phoneAccountHandle);
1990 } catch (RemoteException e) {
1991 Log.e(TAG, "Error isIncomingCallPermitted", e);
1992 }
1993 }
1994 return false;
1995 }
1996
1997 /**
1998 * Determines whether Telecom would permit an outgoing call to be placed via the
1999 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
2000 * <p>
2001 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
2002 * in the following situations:
2003 * <ul>
2004 * <li>{@link PhoneAccount} does not have property
2005 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
2006 * {@link ConnectionService}), and the active, held or ringing call limit has
2007 * been reached.</li>
2008 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
2009 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
2010 * another {@link ConnectionService}.</li>
2011 * <li>There is an ongoing emergency call.</li>
2012 * </ul>
2013 *
2014 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
2015 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
2016 * otherwise.
2017 */
2018 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
2019 ITelecomService service = getTelecomService();
2020 if (service != null) {
2021 try {
2022 return service.isOutgoingCallPermitted(phoneAccountHandle);
2023 } catch (RemoteException e) {
2024 Log.e(TAG, "Error isOutgoingCallPermitted", e);
2025 }
2026 }
2027 return false;
2028 }
2029
Sanket Padawea8eddd42017-11-03 11:07:35 -07002030 /**
Tyler Gunn9d127732018-03-02 15:45:51 -08002031 * Called by an app to indicate that it wishes to accept the handover of an ongoing call to a
2032 * {@link PhoneAccountHandle} it defines.
2033 * <p>
2034 * A call handover is the process where an ongoing call is transferred from one app (i.e.
2035 * {@link ConnectionService} to another app. The user could, for example, choose to continue a
2036 * mobile network call in a video calling app. The mobile network call via the Telephony stack
2037 * is referred to as the source of the handover, and the video calling app is referred to as the
2038 * destination.
2039 * <p>
2040 * When considering a handover scenario the <em>initiating</em> device is where a user initiated
2041 * the handover process (e.g. by calling {@link android.telecom.Call#handoverTo(
2042 * PhoneAccountHandle, int, Bundle)}, and the other device is considered the <em>receiving</em>
2043 * device.
2044 * <p>
2045 * For a full discussion of the handover process and the APIs involved, see
2046 * {@link android.telecom.Call#handoverTo(PhoneAccountHandle, int, Bundle)}.
2047 * <p>
2048 * This method is called from the <em>receiving</em> side of a handover to indicate a desire to
2049 * accept the handover of an ongoing call to another {@link ConnectionService} identified by
Sanket Padawea8eddd42017-11-03 11:07:35 -07002050 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
2051 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
2052 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
2053 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
2054 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
2055 * <p>
2056 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
2057 * associated with the {@link PhoneAccountHandle} destAcct and call
2058 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
2059 * <p>
2060 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
2061 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
2062 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
2063 * user.
2064 * <p>
2065 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
2066 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
2067 *
2068 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
2069 * {@link ConnectionService}.
2070 * @param videoState Video state after the handover.
2071 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
2072 */
Tyler Gunn9d127732018-03-02 15:45:51 -08002073 public void acceptHandover(Uri srcAddr, @VideoProfile.VideoState int videoState,
2074 PhoneAccountHandle destAcct) {
Sanket Padawea8eddd42017-11-03 11:07:35 -07002075 try {
2076 if (isServiceConnected()) {
2077 getTelecomService().acceptHandover(srcAddr, videoState, destAcct);
2078 }
2079 } catch (RemoteException e) {
2080 Log.e(TAG, "RemoteException acceptHandover: " + e);
2081 }
2082 }
Tyler Gunnf5035432017-01-09 09:43:12 -08002083
Tyler Gunn5bd90852018-09-21 09:37:07 -07002084 /**
2085 * Determines if there is an ongoing emergency call. This can be either an outgoing emergency
2086 * call, as identified by the dialed number, or because a call was identified by the network
2087 * as an emergency call.
2088 * @return {@code true} if there is an ongoing emergency call, {@code false} otherwise.
2089 * @hide
2090 */
2091 @SystemApi
Tyler Gunn6c14a6992019-02-04 15:12:06 -08002092 @TestApi
Tyler Gunn5bd90852018-09-21 09:37:07 -07002093 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
2094 public boolean isInEmergencyCall() {
2095 try {
2096 if (isServiceConnected()) {
2097 return getTelecomService().isInEmergencyCall();
2098 }
2099 } catch (RemoteException e) {
2100 Log.e(TAG, "RemoteException isInEmergencyCall: " + e);
2101 return false;
2102 }
2103 return false;
2104 }
2105
Tyler Gunnc37445c2018-09-28 16:16:20 -07002106 /**
2107 * Handles {@link Intent#ACTION_CALL} intents trampolined from UserCallActivity.
2108 * @param intent The {@link Intent#ACTION_CALL} intent to handle.
Brad Ebingera9a33e12019-09-27 16:55:35 -07002109 * @param callingPackageProxy The original package that called this before it was trampolined.
Tyler Gunnc37445c2018-09-28 16:16:20 -07002110 * @hide
2111 */
Brad Ebingera9a33e12019-09-27 16:55:35 -07002112 public void handleCallIntent(Intent intent, String callingPackageProxy) {
Tyler Gunnc37445c2018-09-28 16:16:20 -07002113 try {
2114 if (isServiceConnected()) {
Brad Ebingera9a33e12019-09-27 16:55:35 -07002115 getTelecomService().handleCallIntent(intent, callingPackageProxy);
Tyler Gunnc37445c2018-09-28 16:16:20 -07002116 }
2117 } catch (RemoteException e) {
2118 Log.e(TAG, "RemoteException handleCallIntent: " + e);
2119 }
Tyler Gunnc37445c2018-09-28 16:16:20 -07002120 }
2121
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002122 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07002123 if (mTelecomServiceOverride != null) {
2124 return mTelecomServiceOverride;
2125 }
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002126 return ITelecomService.Stub.asInterface(ServiceManager.getService(Context.TELECOM_SERVICE));
Santos Cordon6c7a3882014-06-25 15:30:08 -07002127 }
Santos Cordon9eb45932014-06-27 12:28:43 -07002128
2129 private boolean isServiceConnected() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002130 boolean isConnected = getTelecomService() != null;
Santos Cordon9eb45932014-06-27 12:28:43 -07002131 if (!isConnected) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07002132 Log.w(TAG, "Telecom Service not found.");
Santos Cordon9eb45932014-06-27 12:28:43 -07002133 }
2134 return isConnected;
2135 }
Evan Charlton235c1592014-09-05 15:41:23 +00002136}