blob: a9bbd2421d888264d89cde326f86c9d1c3e95735 [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
Hall Liu0464b9b2016-01-12 15:32:58 -080017import android.Manifest;
Yorke Leec61d13662015-09-21 17:25:25 -070018import android.annotation.RequiresPermission;
Jeff Sharkey910e0812017-04-21 16:29:27 -060019import android.annotation.SuppressAutoDoc;
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -060020import android.annotation.SuppressLint;
Santos Cordon6c7a3882014-06-25 15:30:08 -070021import android.annotation.SystemApi;
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060022import android.annotation.SystemService;
Santos Cordon6c7a3882014-06-25 15:30:08 -070023import android.content.ComponentName;
Yorke Leeb4ce1432014-06-09 13:53:23 -070024import android.content.Context;
Yorke Lee3e56ba12015-04-23 12:32:36 -070025import android.content.Intent;
Nancy Chenb2299c12014-10-29 18:22:11 -070026import android.net.Uri;
Santos Cordon96efb482014-07-19 14:57:05 -070027import android.os.Bundle;
Santos Cordon6c7a3882014-06-25 15:30:08 -070028import android.os.RemoteException;
29import android.os.ServiceManager;
Yorke Lee2ae312e2014-09-12 17:58:48 -070030import android.telephony.TelephonyManager;
Anthony Lee67279262014-10-27 11:28:40 -070031import android.text.TextUtils;
Santos Cordon6c7a3882014-06-25 15:30:08 -070032import android.util.Log;
Yorke Leeb4ce1432014-06-09 13:53:23 -070033
Tyler Gunnef9f6f92014-09-12 22:16:17 -070034import com.android.internal.telecom.ITelecomService;
Yorke Leeb4ce1432014-06-09 13:53:23 -070035
Jay Shrauner7746a942014-08-26 12:15:15 -070036import java.util.ArrayList;
Tyler Gunna1ed7d12014-09-08 09:52:22 -070037import java.util.Collections;
Ihab Awad807fe0a2014-07-09 12:30:52 -070038import java.util.List;
39
Yorke Leeb4ce1432014-06-09 13:53:23 -070040/**
Santos Cordond9e614f2014-10-28 13:10:36 -070041 * Provides access to information about active calls and registration/call-management functionality.
Evan Charlton0e094d92014-11-08 15:49:16 -080042 * Apps can use methods in this class to determine the current call state.
Santos Cordond9e614f2014-10-28 13:10:36 -070043 * <p>
44 * Apps do not instantiate this class directly; instead, they retrieve a reference to an instance
45 * through {@link Context#getSystemService Context.getSystemService(Context.TELECOM_SERVICE)}.
46 * <p>
47 * Note that access to some telecom information is permission-protected. Your app cannot access the
48 * protected information or gain access to protected functionality unless it has the appropriate
49 * permissions declared in its manifest file. Where permissions apply, they are noted in the method
50 * descriptions.
Yorke Leeb4ce1432014-06-09 13:53:23 -070051 */
Jeff Sharkey910e0812017-04-21 16:29:27 -060052@SuppressAutoDoc
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -060053@SystemService(Context.TELECOM_SERVICE)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070054public class TelecomManager {
Ihab Awad807fe0a2014-07-09 12:30:52 -070055
Evan Charlton10197192014-07-19 15:00:29 -070056 /**
Santos Cordon96efb482014-07-19 14:57:05 -070057 * Activity action: Starts the UI for handing an incoming call. This intent starts the in-call
Tyler Gunnef9f6f92014-09-12 22:16:17 -070058 * UI by notifying the Telecom system that an incoming call exists for a specific call service
59 * (see {@link android.telecom.ConnectionService}). Telecom reads the Intent extras to find
60 * and bind to the appropriate {@link android.telecom.ConnectionService} which Telecom will
Santos Cordon96efb482014-07-19 14:57:05 -070061 * ultimately use to control and get information about the call.
62 * <p>
63 * Input: get*Extra field {@link #EXTRA_PHONE_ACCOUNT_HANDLE} contains the component name of the
Tyler Gunnef9f6f92014-09-12 22:16:17 -070064 * {@link android.telecom.ConnectionService} that Telecom should bind to. Telecom will then
Evan Charlton10197192014-07-19 15:00:29 -070065 * ask the connection service for more information about the call prior to showing any UI.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080066 *
67 * @deprecated Use {@link #addNewIncomingCall} instead.
Evan Charlton10197192014-07-19 15:00:29 -070068 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -070069 public static final String ACTION_INCOMING_CALL = "android.telecom.action.INCOMING_CALL";
Evan Charlton10197192014-07-19 15:00:29 -070070
71 /**
Yorke Leec3cf9822014-10-02 09:38:39 -070072 * Similar to {@link #ACTION_INCOMING_CALL}, but is used only by Telephony to add a new
73 * sim-initiated MO call for carrier testing.
Brad Ebinger23b1c6d2017-01-12 13:10:40 -080074 * @deprecated Use {@link #addNewUnknownCall} instead.
Yorke Leec3cf9822014-10-02 09:38:39 -070075 * @hide
76 */
77 public static final String ACTION_NEW_UNKNOWN_CALL = "android.telecom.action.NEW_UNKNOWN_CALL";
78
79 /**
Santos Cordon895d4b82015-06-25 16:41:48 -070080 * An {@link android.content.Intent} action sent by the telecom framework to start a
81 * configuration dialog for a registered {@link PhoneAccount}. There is no default dialog
82 * and each app that registers a {@link PhoneAccount} should provide one if desired.
83 * <p>
84 * A user can access the list of enabled {@link android.telecom.PhoneAccount}s through the Phone
85 * app's settings menu. For each entry, the settings app will add a click action. When
86 * triggered, the click-action will start this intent along with the extra
87 * {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to indicate the {@link PhoneAccount} to configure. If the
88 * {@link PhoneAccount} package does not register an {@link android.app.Activity} for this
89 * intent, then it will not be sent.
Evan Charlton10197192014-07-19 15:00:29 -070090 */
Santos Cordon895d4b82015-06-25 16:41:48 -070091 public static final String ACTION_CONFIGURE_PHONE_ACCOUNT =
92 "android.telecom.action.CONFIGURE_PHONE_ACCOUNT";
Evan Charlton10197192014-07-19 15:00:29 -070093
94 /**
Andrew Lee873cfbf2015-02-26 15:22:00 -080095 * The {@link android.content.Intent} action used to show the call accessibility settings page.
96 */
97 public static final String ACTION_SHOW_CALL_ACCESSIBILITY_SETTINGS =
98 "android.telecom.action.SHOW_CALL_ACCESSIBILITY_SETTINGS";
99
100 /**
Yorke Lee3818a8922014-07-21 15:57:17 -0700101 * The {@link android.content.Intent} action used to show the call settings page.
102 */
103 public static final String ACTION_SHOW_CALL_SETTINGS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700104 "android.telecom.action.SHOW_CALL_SETTINGS";
Yorke Lee3818a8922014-07-21 15:57:17 -0700105
106 /**
Andrew Lee866080f2015-02-19 12:05:33 -0800107 * The {@link android.content.Intent} action used to show the respond via SMS settings page.
108 */
109 public static final String ACTION_SHOW_RESPOND_VIA_SMS_SETTINGS =
110 "android.telecom.action.SHOW_RESPOND_VIA_SMS_SETTINGS";
111
112 /**
Evan Charlton6d8604f2014-09-04 12:38:17 -0700113 * The {@link android.content.Intent} action used to show the settings page used to configure
114 * {@link PhoneAccount} preferences.
115 */
116 public static final String ACTION_CHANGE_PHONE_ACCOUNTS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700117 "android.telecom.action.CHANGE_PHONE_ACCOUNTS";
Evan Charlton6d8604f2014-09-04 12:38:17 -0700118
119 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700120 * {@link android.content.Intent} action used indicate that a new phone account was just
121 * registered.
122 * <p>
123 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
124 * to indicate which {@link PhoneAccount} was registered.
125 * <p>
126 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800127 */
Santos Cordonc66f3ba2015-02-27 15:22:07 -0800128 public static final String ACTION_PHONE_ACCOUNT_REGISTERED =
129 "android.telecom.action.PHONE_ACCOUNT_REGISTERED";
130
131 /**
Tyler Gunnd9da6ce2017-04-14 13:43:30 -0700132 * {@link android.content.Intent} action used indicate that a phone account was just
133 * unregistered.
134 * <p>
135 * The Intent {@link Intent#getExtras() extras} will contain {@link #EXTRA_PHONE_ACCOUNT_HANDLE}
136 * to indicate which {@link PhoneAccount} was unregistered.
137 * <p>
138 * Will only be sent to the default dialer app (see {@link #getDefaultDialerPackage()}).
Bryce Lee30b0aa02015-09-23 21:53:53 -0700139 */
Bryce Lee30b0aa02015-09-23 21:53:53 -0700140 public static final String ACTION_PHONE_ACCOUNT_UNREGISTERED =
141 "android.telecom.action.PHONE_ACCOUNT_UNREGISTERED";
142
143 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700144 * Activity action: Shows a dialog asking the user whether or not they want to replace the
145 * current default Dialer with the one specified in
146 * {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME}.
147 *
148 * Usage example:
149 * <pre>
150 * Intent intent = new Intent(TelecomManager.ACTION_CHANGE_DEFAULT_DIALER);
151 * intent.putExtra(TelecomManager.EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME,
152 * getActivity().getPackageName());
153 * startActivity(intent);
154 * </pre>
155 */
156 public static final String ACTION_CHANGE_DEFAULT_DIALER =
157 "android.telecom.action.CHANGE_DEFAULT_DIALER";
158
159 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -0700160 * Broadcast intent action indicating that the current default dialer has changed.
161 * The string extra {@link #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME} will contain the
162 * name of the package that the default dialer was changed to.
163 *
164 * @see #EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME
165 */
166 public static final String ACTION_DEFAULT_DIALER_CHANGED =
167 "android.telecom.action.DEFAULT_DIALER_CHANGED";
168
169 /**
Yorke Lee1011f482015-04-23 15:58:27 -0700170 * Extra value used to provide the package name for {@link #ACTION_CHANGE_DEFAULT_DIALER}.
171 */
172 public static final String EXTRA_CHANGE_DEFAULT_DIALER_PACKAGE_NAME =
173 "android.telecom.extra.CHANGE_DEFAULT_DIALER_PACKAGE_NAME";
174
175 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700176 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a boolean that
177 * determines whether the speakerphone should be automatically turned on for an outgoing call.
Evan Charlton10197192014-07-19 15:00:29 -0700178 */
179 public static final String EXTRA_START_CALL_WITH_SPEAKERPHONE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700180 "android.telecom.extra.START_CALL_WITH_SPEAKERPHONE";
Evan Charlton10197192014-07-19 15:00:29 -0700181
182 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700183 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing an integer that
184 * determines the desired video state for an outgoing call.
Santos Cordon96efb482014-07-19 14:57:05 -0700185 * Valid options:
Yorke Lee32f24732015-05-12 16:18:03 -0700186 * {@link VideoProfile#STATE_AUDIO_ONLY},
187 * {@link VideoProfile#STATE_BIDIRECTIONAL},
188 * {@link VideoProfile#STATE_RX_ENABLED},
189 * {@link VideoProfile#STATE_TX_ENABLED}.
Evan Charlton10197192014-07-19 15:00:29 -0700190 */
191 public static final String EXTRA_START_CALL_WITH_VIDEO_STATE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700192 "android.telecom.extra.START_CALL_WITH_VIDEO_STATE";
Evan Charlton10197192014-07-19 15:00:29 -0700193
194 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700195 * Optional extra for {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} containing an
196 * integer that determines the requested video state for an incoming call.
197 * Valid options:
198 * {@link VideoProfile#STATE_AUDIO_ONLY},
199 * {@link VideoProfile#STATE_BIDIRECTIONAL},
200 * {@link VideoProfile#STATE_RX_ENABLED},
201 * {@link VideoProfile#STATE_TX_ENABLED}.
202 */
203 public static final String EXTRA_INCOMING_VIDEO_STATE =
204 "android.telecom.extra.INCOMING_VIDEO_STATE";
205
206 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700207 * The extra used with an {@link android.content.Intent#ACTION_CALL} and
208 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} to specify a
209 * {@link PhoneAccountHandle} to use when making the call.
Evan Charlton10197192014-07-19 15:00:29 -0700210 * <p class="note">
Santos Cordon96efb482014-07-19 14:57:05 -0700211 * Retrieve with {@link android.content.Intent#getParcelableExtra(String)}.
Evan Charlton10197192014-07-19 15:00:29 -0700212 */
Evan Charlton6eb262c2014-07-19 18:18:19 -0700213 public static final String EXTRA_PHONE_ACCOUNT_HANDLE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700214 "android.telecom.extra.PHONE_ACCOUNT_HANDLE";
Evan Charlton10197192014-07-19 15:00:29 -0700215
216 /**
Tyler Gunn335ff2e2015-07-30 14:18:33 -0700217 * Optional extra for {@link android.content.Intent#ACTION_CALL} containing a string call
218 * subject which will be associated with an outgoing call. Should only be specified if the
219 * {@link PhoneAccount} supports the capability {@link PhoneAccount#CAPABILITY_CALL_SUBJECT}.
220 */
221 public static final String EXTRA_CALL_SUBJECT = "android.telecom.extra.CALL_SUBJECT";
222
223 /**
Yorke Lee04ea7d32015-06-05 15:59:18 -0700224 * The extra used by a {@link ConnectionService} to provide the handle of the caller that
225 * has initiated a new incoming call.
226 */
Yorke Lee02fb5bc2015-06-09 12:27:36 -0700227 public static final String EXTRA_INCOMING_CALL_ADDRESS =
228 "android.telecom.extra.INCOMING_CALL_ADDRESS";
Yorke Lee04ea7d32015-06-05 15:59:18 -0700229
230 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700231 * Optional extra for {@link #ACTION_INCOMING_CALL} containing a {@link Bundle} which contains
232 * metadata about the call. This {@link Bundle} will be returned to the
233 * {@link ConnectionService}.
Evan Charlton10197192014-07-19 15:00:29 -0700234 */
235 public static final String EXTRA_INCOMING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700236 "android.telecom.extra.INCOMING_CALL_EXTRAS";
Evan Charlton10197192014-07-19 15:00:29 -0700237
238 /**
Nancy Chen10798dc2014-08-08 14:00:25 -0700239 * Optional extra for {@link android.content.Intent#ACTION_CALL} and
240 * {@link android.content.Intent#ACTION_DIAL} {@code Intent} containing a {@link Bundle}
241 * which contains metadata about the call. This {@link Bundle} will be saved into
Santos Cordon7a060d52015-06-19 14:52:04 -0700242 * {@code Call.Details} and passed to the {@link ConnectionService} when placing the call.
Nancy Chen10798dc2014-08-08 14:00:25 -0700243 */
244 public static final String EXTRA_OUTGOING_CALL_EXTRAS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700245 "android.telecom.extra.OUTGOING_CALL_EXTRAS";
Nancy Chen10798dc2014-08-08 14:00:25 -0700246
247 /**
Yorke Leec3cf9822014-10-02 09:38:39 -0700248 * @hide
249 */
250 public static final String EXTRA_UNKNOWN_CALL_HANDLE =
251 "android.telecom.extra.UNKNOWN_CALL_HANDLE";
252
253 /**
Sailesh Nepalda6bb382016-04-14 19:51:46 -0700254 * Optional extra for incoming and outgoing calls containing a long which specifies the time the
255 * call was created. This value is in milliseconds since boot.
256 * @hide
257 */
258 public static final String EXTRA_CALL_CREATED_TIME_MILLIS =
259 "android.telecom.extra.CALL_CREATED_TIME_MILLIS";
260
261 /**
262 * Optional extra for incoming and outgoing calls containing a long which specifies the time
263 * telecom began routing the call. This value is in milliseconds since boot.
264 * @hide
265 */
266 public static final String EXTRA_CALL_TELECOM_ROUTING_START_TIME_MILLIS =
267 "android.telecom.extra.CALL_TELECOM_ROUTING_START_TIME_MILLIS";
268
269 /**
270 * Optional extra for incoming and outgoing calls containing a long which specifies the time
271 * telecom finished routing the call. This value is in milliseconds since boot.
272 * @hide
273 */
274 public static final String EXTRA_CALL_TELECOM_ROUTING_END_TIME_MILLIS =
275 "android.telecom.extra.CALL_TELECOM_ROUTING_END_TIME_MILLIS";
276
277 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700278 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
279 * containing the disconnect code.
Evan Charlton10197192014-07-19 15:00:29 -0700280 */
281 public static final String EXTRA_CALL_DISCONNECT_CAUSE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700282 "android.telecom.extra.CALL_DISCONNECT_CAUSE";
Evan Charlton10197192014-07-19 15:00:29 -0700283
284 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700285 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
286 * containing the disconnect message.
Evan Charlton10197192014-07-19 15:00:29 -0700287 */
288 public static final String EXTRA_CALL_DISCONNECT_MESSAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700289 "android.telecom.extra.CALL_DISCONNECT_MESSAGE";
Evan Charlton10197192014-07-19 15:00:29 -0700290
291 /**
Evan Charlton6eb262c2014-07-19 18:18:19 -0700292 * Optional extra for {@link android.telephony.TelephonyManager#ACTION_PHONE_STATE_CHANGED}
293 * containing the component name of the associated connection service.
Evan Charlton0e094d92014-11-08 15:49:16 -0800294 * @hide
Evan Charlton10197192014-07-19 15:00:29 -0700295 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800296 @SystemApi
Evan Charlton10197192014-07-19 15:00:29 -0700297 public static final String EXTRA_CONNECTION_SERVICE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700298 "android.telecom.extra.CONNECTION_SERVICE";
Evan Charlton10197192014-07-19 15:00:29 -0700299
300 /**
Hall Liu90f62902015-11-19 16:19:24 -0800301 * Optional extra for communicating the call technology used by a
302 * {@link com.android.internal.telephony.Connection} to Telecom
303 * @hide
304 */
305 public static final String EXTRA_CALL_TECHNOLOGY_TYPE =
306 "android.telecom.extra.CALL_TECHNOLOGY_TYPE";
307
308 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700309 * An optional {@link android.content.Intent#ACTION_CALL} intent extra denoting the
310 * package name of the app specifying an alternative gateway for the call.
311 * The value is a string.
312 *
313 * (The following comment corresponds to the all GATEWAY_* extras)
314 * An app which sends the {@link android.content.Intent#ACTION_CALL} intent can specify an
315 * alternative address to dial which is different from the one specified and displayed to
316 * the user. This alternative address is referred to as the gateway address.
317 */
318 public static final String GATEWAY_PROVIDER_PACKAGE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700319 "android.telecom.extra.GATEWAY_PROVIDER_PACKAGE";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700320
321 /**
322 * An optional {@link android.content.Intent#ACTION_CALL} intent extra corresponding to the
323 * original address to dial for the call. This is used when an alternative gateway address is
324 * provided to recall the original address.
325 * The value is a {@link android.net.Uri}.
326 *
327 * (See {@link #GATEWAY_PROVIDER_PACKAGE} for details)
328 */
329 public static final String GATEWAY_ORIGINAL_ADDRESS =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700330 "android.telecom.extra.GATEWAY_ORIGINAL_ADDRESS";
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700331
332 /**
Evan Charlton10197192014-07-19 15:00:29 -0700333 * The number which the party on the other side of the line will see (and use to return the
334 * call).
335 * <p>
Santos Cordon96efb482014-07-19 14:57:05 -0700336 * {@link ConnectionService}s which interact with {@link RemoteConnection}s should only populate
337 * this if the {@link android.telephony.TelephonyManager#getLine1Number()} value, as that is the
338 * user's expected caller ID.
Evan Charlton10197192014-07-19 15:00:29 -0700339 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700340 public static final String EXTRA_CALL_BACK_NUMBER = "android.telecom.extra.CALL_BACK_NUMBER";
Evan Charlton10197192014-07-19 15:00:29 -0700341
342 /**
Hall Liu8f613fb2017-02-14 18:11:11 -0800343 * The number of milliseconds that Telecom should wait after disconnecting a call via the
344 * ACTION_NEW_OUTGOING_CALL broadcast, in order to wait for the app which cancelled the call
345 * to make a new one.
346 * @hide
347 */
348 public static final String EXTRA_NEW_OUTGOING_CALL_CANCEL_TIMEOUT =
349 "android.telecom.extra.NEW_OUTGOING_CALL_CANCEL_TIMEOUT";
350
351 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700352 * Boolean extra specified to indicate that the intention of adding a call is to handover an
Tyler Gunn8bf76572017-04-06 15:30:08 -0700353 * existing call from the user's device to a different {@link PhoneAccount}.
354 * <p>
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700355 * Used when calling {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)}
356 * to indicate to Telecom that the purpose of adding a new incoming call is to handover an
357 * existing call from the user's device to a different {@link PhoneAccount}. This occurs on
358 * the receiving side of a handover.
359 * <p>
360 * Used when Telecom calls
361 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
362 * to indicate that the purpose of Telecom requesting a new outgoing connection it to request
363 * a handover to this {@link ConnectionService} from an ongoing call on the user's device. This
364 * occurs on the initiating side of a handover.
365 * <p>
Tyler Gunn727c6bd2017-04-11 09:51:40 -0700366 * The phone number of the call used by Telecom to determine which call should be handed over.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700367 * @hide
368 */
369 public static final String EXTRA_IS_HANDOVER = "android.telecom.extra.IS_HANDOVER";
370
371 /**
Tyler Gunn3af38692017-05-26 13:30:09 -0700372 * Parcelable extra used with {@link #EXTRA_IS_HANDOVER} to indicate the source
373 * {@link PhoneAccountHandle} when initiating a handover which {@link ConnectionService}
374 * the handover is from.
375 * @hide
376 */
377 public static final String EXTRA_HANDOVER_FROM_PHONE_ACCOUNT =
378 "android.telecom.extra.HANDOVER_FROM_PHONE_ACCOUNT";
379
380 /**
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700381 * Extra key specified in the {@link ConnectionRequest#getExtras()} when Telecom calls
382 * {@link ConnectionService#onCreateOutgoingConnection(PhoneAccountHandle, ConnectionRequest)}
383 * to inform the {@link ConnectionService} what the initial {@link CallAudioState} of the
384 * {@link Connection} will be.
385 * @hide
386 */
387 public static final String EXTRA_CALL_AUDIO_STATE = "android.telecom.extra.CALL_AUDIO_STATE";
388
389 /**
Hall Liu95d55872017-01-25 17:12:49 -0800390 * A boolean extra, which when set on the {@link Intent#ACTION_CALL} intent or on the bundle
391 * passed into {@link #placeCall(Uri, Bundle)}, indicates that the call should be initiated with
392 * an RTT session open. See {@link android.telecom.Call.RttCall} for more information on RTT.
393 */
394 public static final String EXTRA_START_CALL_WITH_RTT =
395 "android.telecom.extra.START_CALL_WITH_RTT";
396
397 /**
Santos Cordonf2600eb2015-06-22 15:02:20 -0700398 * A boolean meta-data value indicating whether an {@link InCallService} implements an
399 * in-call user interface. Dialer implementations (see {@link #getDefaultDialerPackage()}) which
400 * would also like to replace the in-call interface should set this meta-data to {@code true} in
401 * the manifest registration of their {@link InCallService}.
402 */
403 public static final String METADATA_IN_CALL_SERVICE_UI = "android.telecom.IN_CALL_SERVICE_UI";
404
405 /**
Santos Cordon88881552015-12-10 17:29:54 -0800406 * A boolean meta-data value indicating whether an {@link InCallService} implements an
407 * in-call user interface to be used while the device is in car-mode (see
408 * {@link android.content.res.Configuration.UI_MODE_TYPE_CAR}).
409 *
410 * @hide
411 */
412 public static final String METADATA_IN_CALL_SERVICE_CAR_MODE_UI =
413 "android.telecom.IN_CALL_SERVICE_CAR_MODE_UI";
414
415 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800416 * A boolean meta-data value indicating whether an {@link InCallService} implements ringing.
417 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would also like to
418 * override the system provided ringing should set this meta-data to {@code true} in the
419 * manifest registration of their {@link InCallService}.
420 */
421 public static final String METADATA_IN_CALL_SERVICE_RINGING =
422 "android.telecom.IN_CALL_SERVICE_RINGING";
423
424 /**
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700425 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
426 * calls which have the {@link Call.Details#PROPERTY_IS_EXTERNAL_CALL} property. An external
427 * call is one which a {@link ConnectionService} knows about, but is not connected to directly.
428 * Dialer implementations (see {@link #getDefaultDialerPackage()}) which would like to be
429 * informed of external calls should set this meta-data to {@code true} in the manifest
430 * registration of their {@link InCallService}. By default, the {@link InCallService} will NOT
431 * be informed of external calls.
432 */
433 public static final String METADATA_INCLUDE_EXTERNAL_CALLS =
434 "android.telecom.INCLUDE_EXTERNAL_CALLS";
435
436 /**
Tyler Gunn24e18332017-02-10 09:42:49 -0800437 * A boolean meta-data value indicating whether an {@link InCallService} wants to be informed of
438 * calls which have the {@link Call.Details#PROPERTY_SELF_MANAGED} property. A self-managed
439 * call is one which originates from a self-managed {@link ConnectionService} which has chosen
440 * to implement its own call user interface. An {@link InCallService} implementation which
441 * would like to be informed of external calls should set this meta-data to {@code true} in the
442 * manifest registration of their {@link InCallService}. By default, the {@link InCallService}
443 * will NOT be informed about self-managed calls.
444 * <p>
445 * An {@link InCallService} which receives self-managed calls is free to view and control the
446 * state of calls in the self-managed {@link ConnectionService}. An example use-case is
Tyler Gunn37653562017-03-13 18:15:15 -0700447 * exposing these calls to an automotive device via its companion app.
448 * <p>
449 * This meta-data can only be set for an {@link InCallService} which also sets
450 * {@link #METADATA_IN_CALL_SERVICE_UI}. Only the default phone/dialer app, or a car-mode
451 * {@link InCallService} can see self-managed calls.
Tyler Gunn24e18332017-02-10 09:42:49 -0800452 * <p>
453 * See also {@link Connection#PROPERTY_SELF_MANAGED}.
454 */
455 public static final String METADATA_INCLUDE_SELF_MANAGED_CALLS =
456 "android.telecom.INCLUDE_SELF_MANAGED_CALLS";
457
458 /**
Evan Charlton10197192014-07-19 15:00:29 -0700459 * The dual tone multi-frequency signaling character sent to indicate the dialing system should
460 * pause for a predefined period.
461 */
462 public static final char DTMF_CHARACTER_PAUSE = ',';
463
464 /**
465 * The dual-tone multi-frequency signaling character sent to indicate the dialing system should
466 * wait for user confirmation before proceeding.
467 */
468 public static final char DTMF_CHARACTER_WAIT = ';';
469
470 /**
471 * TTY (teletypewriter) mode is off.
472 *
473 * @hide
474 */
475 public static final int TTY_MODE_OFF = 0;
476
477 /**
478 * TTY (teletypewriter) mode is on. The speaker is off and the microphone is muted. The user
479 * will communicate with the remote party by sending and receiving text messages.
480 *
481 * @hide
482 */
483 public static final int TTY_MODE_FULL = 1;
484
485 /**
486 * TTY (teletypewriter) mode is in hearing carryover mode (HCO). The microphone is muted but the
487 * speaker is on. The user will communicate with the remote party by sending text messages and
488 * hearing an audible reply.
489 *
490 * @hide
491 */
492 public static final int TTY_MODE_HCO = 2;
493
494 /**
495 * TTY (teletypewriter) mode is in voice carryover mode (VCO). The speaker is off but the
496 * microphone is still on. User will communicate with the remote party by speaking and receiving
497 * text message replies.
498 *
499 * @hide
500 */
501 public static final int TTY_MODE_VCO = 3;
502
503 /**
504 * Broadcast intent action indicating that the current TTY mode has changed. An intent extra
505 * provides this state as an int.
Evan Charlton10197192014-07-19 15:00:29 -0700506 *
Santos Cordon96efb482014-07-19 14:57:05 -0700507 * @see #EXTRA_CURRENT_TTY_MODE
Evan Charlton10197192014-07-19 15:00:29 -0700508 * @hide
509 */
510 public static final String ACTION_CURRENT_TTY_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700511 "android.telecom.action.CURRENT_TTY_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700512
513 /**
514 * The lookup key for an int that indicates the current TTY mode.
515 * Valid modes are:
516 * - {@link #TTY_MODE_OFF}
517 * - {@link #TTY_MODE_FULL}
518 * - {@link #TTY_MODE_HCO}
519 * - {@link #TTY_MODE_VCO}
520 *
521 * @hide
522 */
523 public static final String EXTRA_CURRENT_TTY_MODE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700524 "android.telecom.intent.extra.CURRENT_TTY_MODE";
Evan Charlton10197192014-07-19 15:00:29 -0700525
526 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700527 * Broadcast intent action indicating that the TTY preferred operating mode has changed. An
528 * intent extra provides the new mode as an int.
Evan Charlton10197192014-07-19 15:00:29 -0700529 *
Santos Cordon96efb482014-07-19 14:57:05 -0700530 * @see #EXTRA_TTY_PREFERRED_MODE
Evan Charlton10197192014-07-19 15:00:29 -0700531 * @hide
532 */
533 public static final String ACTION_TTY_PREFERRED_MODE_CHANGED =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700534 "android.telecom.action.TTY_PREFERRED_MODE_CHANGED";
Evan Charlton10197192014-07-19 15:00:29 -0700535
536 /**
Santos Cordon96efb482014-07-19 14:57:05 -0700537 * The lookup key for an int that indicates preferred TTY mode. Valid modes are: -
538 * {@link #TTY_MODE_OFF} - {@link #TTY_MODE_FULL} - {@link #TTY_MODE_HCO} -
539 * {@link #TTY_MODE_VCO}
Evan Charlton10197192014-07-19 15:00:29 -0700540 *
541 * @hide
542 */
543 public static final String EXTRA_TTY_PREFERRED_MODE =
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700544 "android.telecom.intent.extra.TTY_PREFERRED";
Evan Charlton10197192014-07-19 15:00:29 -0700545
Nancy Chen9d568c02014-09-08 14:17:59 -0700546 /**
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700547 * Broadcast intent action for letting custom component know to show the missed call
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800548 * notification. If no custom component exists then this is sent to the default dialer which
549 * should post a missed-call notification.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700550 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700551 public static final String ACTION_SHOW_MISSED_CALLS_NOTIFICATION =
552 "android.telecom.action.SHOW_MISSED_CALLS_NOTIFICATION";
553
554 /**
Sailesh Nepalbe15ad92016-01-21 19:26:20 -0800555 * The number of calls associated with the notification. If the number is zero then the missed
556 * call notification should be dismissed.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700557 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700558 public static final String EXTRA_NOTIFICATION_COUNT =
559 "android.telecom.extra.NOTIFICATION_COUNT";
560
561 /**
562 * The number associated with the missed calls. This number is only relevant
563 * when EXTRA_NOTIFICATION_COUNT is 1.
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700564 */
Bryce Lee5e4dd3e2015-08-03 16:59:10 -0700565 public static final String EXTRA_NOTIFICATION_PHONE_NUMBER =
566 "android.telecom.extra.NOTIFICATION_PHONE_NUMBER";
567
568 /**
Bryce Lee8d41d1d2015-08-10 07:40:42 -0700569 * The intent to clear missed calls.
570 * @hide
571 */
572 @SystemApi
573 public static final String EXTRA_CLEAR_MISSED_CALLS_INTENT =
574 "android.telecom.extra.CLEAR_MISSED_CALLS_INTENT";
575
576 /**
577 * The intent to call back a missed call.
578 * @hide
579 */
580 @SystemApi
581 public static final String EXTRA_CALL_BACK_INTENT =
582 "android.telecom.extra.CALL_BACK_INTENT";
583
584 /**
Eric Erfanianec881872017-12-06 16:27:53 -0800585 * The boolean indicated by this extra controls whether or not a call is eligible to undergo
586 * assisted dialing. This extra is stored under {@link #EXTRA_OUTGOING_CALL_EXTRAS}.
587 * @hide
588 */
589 public static final String EXTRA_USE_ASSISTED_DIALING =
590 "android.telecom.extra.USE_ASSISTED_DIALING";
591
592 /**
Nancy Chen9d568c02014-09-08 14:17:59 -0700593 * The following 4 constants define how properties such as phone numbers and names are
594 * displayed to the user.
595 */
596
Santos Cordoned769ae2015-05-13 18:47:38 -0700597 /**
598 * Indicates that the address or number of a call is allowed to be displayed for caller ID.
599 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700600 public static final int PRESENTATION_ALLOWED = 1;
601
Santos Cordoned769ae2015-05-13 18:47:38 -0700602 /**
603 * Indicates that the address or number of a call is blocked by the other party.
604 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700605 public static final int PRESENTATION_RESTRICTED = 2;
606
Santos Cordoned769ae2015-05-13 18:47:38 -0700607 /**
608 * Indicates that the address or number of a call is not specified or known by the carrier.
609 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700610 public static final int PRESENTATION_UNKNOWN = 3;
611
Santos Cordoned769ae2015-05-13 18:47:38 -0700612 /**
613 * Indicates that the address or number of a call belongs to a pay phone.
614 */
Nancy Chen9d568c02014-09-08 14:17:59 -0700615 public static final int PRESENTATION_PAYPHONE = 4;
616
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700617 private static final String TAG = "TelecomManager";
Yorke Leeb4ce1432014-06-09 13:53:23 -0700618
619 private final Context mContext;
Yorke Leeb4ce1432014-06-09 13:53:23 -0700620
Hall Liue1bc2ec2015-10-09 15:58:37 -0700621 private final ITelecomService mTelecomServiceOverride;
622
Santos Cordon6c7a3882014-06-25 15:30:08 -0700623 /**
624 * @hide
625 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700626 public static TelecomManager from(Context context) {
627 return (TelecomManager) context.getSystemService(Context.TELECOM_SERVICE);
Yorke Leeb4ce1432014-06-09 13:53:23 -0700628 }
Santos Cordon6c7a3882014-06-25 15:30:08 -0700629
630 /**
631 * @hide
632 */
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700633 public TelecomManager(Context context) {
Hall Liue1bc2ec2015-10-09 15:58:37 -0700634 this(context, null);
635 }
636
637 /**
638 * @hide
639 */
640 public TelecomManager(Context context, ITelecomService telecomServiceImpl) {
Ihab Awad807fe0a2014-07-09 12:30:52 -0700641 Context appContext = context.getApplicationContext();
642 if (appContext != null) {
643 mContext = appContext;
644 } else {
645 mContext = context;
646 }
Hall Liue1bc2ec2015-10-09 15:58:37 -0700647 mTelecomServiceOverride = telecomServiceImpl;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700648 }
649
650 /**
Santos Cordon91371dc02015-05-08 13:52:09 -0700651 * Return the {@link PhoneAccount} which will be used to place outgoing calls to addresses with
652 * the specified {@code uriScheme}. This {@link PhoneAccount} will always be a member of the
653 * list which is returned from invoking {@link #getCallCapablePhoneAccounts()}. The specific
654 * account returned depends on the following priorities:
655 * <ul>
656 * <li> If the user-selected default {@link PhoneAccount} supports the specified scheme, it will
657 * be returned.
658 * </li>
659 * <li> If there exists only one {@link PhoneAccount} that supports the specified scheme, it
660 * will be returned.
661 * </li>
662 * </ul>
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700663 * <p>
Santos Cordon91371dc02015-05-08 13:52:09 -0700664 * If no {@link PhoneAccount} fits the criteria above, this method will return {@code null}.
665 *
Yorke Leec61d13662015-09-21 17:25:25 -0700666 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
667 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700668 * @param uriScheme The URI scheme.
Santos Cordon91371dc02015-05-08 13:52:09 -0700669 * @return The {@link PhoneAccountHandle} corresponding to the account to be used.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700670 */
Yorke Leec61d13662015-09-21 17:25:25 -0700671 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700672 public PhoneAccountHandle getDefaultOutgoingPhoneAccount(String uriScheme) {
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700673 try {
674 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -0700675 return getTelecomService().getDefaultOutgoingPhoneAccount(uriScheme,
676 mContext.getOpPackageName());
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700677 }
678 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700679 Log.e(TAG, "Error calling ITelecomService#getDefaultOutgoingPhoneAccount", e);
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700680 }
681 return null;
682 }
683
684 /**
Andrew Leed4abbfb2014-09-03 14:58:27 -0700685 * Return the {@link PhoneAccount} which is the user-chosen default for making outgoing phone
686 * calls. This {@code PhoneAccount} will always be a member of the list which is returned from
Nancy Chen210ef032014-09-15 17:58:42 -0700687 * calling {@link #getCallCapablePhoneAccounts()}
Santos Cordon91371dc02015-05-08 13:52:09 -0700688 * <p>
Andrew Leed4abbfb2014-09-03 14:58:27 -0700689 * Apps must be prepared for this method to return {@code null}, indicating that there currently
690 * exists no user-chosen default {@code PhoneAccount}.
691 *
692 * @return The user outgoing phone account selected by the user.
Jay Shrauner225ccad2015-04-15 15:51:15 -0700693 * @hide
Andrew Leed4abbfb2014-09-03 14:58:27 -0700694 */
695 public PhoneAccountHandle getUserSelectedOutgoingPhoneAccount() {
696 try {
697 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700698 return getTelecomService().getUserSelectedOutgoingPhoneAccount();
Andrew Leed4abbfb2014-09-03 14:58:27 -0700699 }
700 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700701 Log.e(TAG, "Error calling ITelecomService#getUserSelectedOutgoingPhoneAccount", e);
Andrew Leed4abbfb2014-09-03 14:58:27 -0700702 }
703 return null;
704 }
705
706 /**
Santos Cordon91371dc02015-05-08 13:52:09 -0700707 * Sets the user-chosen default for making outgoing phone calls.
Andrew Lee59cac3a2014-08-28 16:50:10 -0700708 * @hide
709 */
Andrew Leed4abbfb2014-09-03 14:58:27 -0700710 public void setUserSelectedOutgoingPhoneAccount(PhoneAccountHandle accountHandle) {
Andrew Lee59cac3a2014-08-28 16:50:10 -0700711 try {
712 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700713 getTelecomService().setUserSelectedOutgoingPhoneAccount(accountHandle);
Andrew Lee59cac3a2014-08-28 16:50:10 -0700714 }
715 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700716 Log.e(TAG, "Error calling ITelecomService#setUserSelectedOutgoingPhoneAccount");
Andrew Lee59cac3a2014-08-28 16:50:10 -0700717 }
718 }
719
720 /**
Andrew Lee59cac3a2014-08-28 16:50:10 -0700721 * Returns the current SIM call manager. Apps must be prepared for this method to return
722 * {@code null}, indicating that there currently exists no user-chosen default
723 * {@code PhoneAccount}.
Santos Cordon91371dc02015-05-08 13:52:09 -0700724 *
Andrew Lee59cac3a2014-08-28 16:50:10 -0700725 * @return The phone account handle of the current sim call manager.
Andrew Lee59cac3a2014-08-28 16:50:10 -0700726 */
727 public PhoneAccountHandle getSimCallManager() {
728 try {
729 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700730 return getTelecomService().getSimCallManager();
Andrew Lee59cac3a2014-08-28 16:50:10 -0700731 }
732 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700733 Log.e(TAG, "Error calling ITelecomService#getSimCallManager");
Andrew Lee59cac3a2014-08-28 16:50:10 -0700734 }
735 return null;
736 }
737
738 /**
Sailesh Nepalcf855622015-07-28 19:22:14 -0700739 * Returns the current SIM call manager for the specified user. Apps must be prepared for this
740 * method to return {@code null}, indicating that there currently exists no user-chosen default
741 * {@code PhoneAccount}.
742 *
743 * @return The phone account handle of the current sim call manager.
744 *
745 * @hide
746 */
747 public PhoneAccountHandle getSimCallManager(int userId) {
748 try {
749 if (isServiceConnected()) {
750 return getTelecomService().getSimCallManagerForUser(userId);
751 }
752 } catch (RemoteException e) {
753 Log.e(TAG, "Error calling ITelecomService#getSimCallManagerForUser");
754 }
755 return null;
756 }
757
758 /**
Evan Charltoneb0a8d562014-09-04 12:03:34 -0700759 * Returns the current connection manager. Apps must be prepared for this method to return
760 * {@code null}, indicating that there currently exists no user-chosen default
761 * {@code PhoneAccount}.
762 *
763 * @return The phone account handle of the current connection manager.
Evan Charlton0e094d92014-11-08 15:49:16 -0800764 * @hide
Evan Charltoneb0a8d562014-09-04 12:03:34 -0700765 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800766 @SystemApi
Evan Charltoneb0a8d562014-09-04 12:03:34 -0700767 public PhoneAccountHandle getConnectionManager() {
768 return getSimCallManager();
769 }
770
771 /**
Nancy Chen210ef032014-09-15 17:58:42 -0700772 * Returns a list of the {@link PhoneAccountHandle}s which can be used to make and receive phone
773 * calls which support the specified URI scheme.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700774 * <P>
775 * For example, invoking with {@code "tel"} will find all {@link PhoneAccountHandle}s which
776 * support telephone calls (e.g. URIs such as {@code tel:555-555-1212}). Invoking with
777 * {@code "sip"} will find all {@link PhoneAccountHandle}s which support SIP calls (e.g. URIs
778 * such as {@code sip:example@sipexample.com}).
779 *
780 * @param uriScheme The URI scheme.
781 * @return A list of {@code PhoneAccountHandle} objects supporting the URI scheme.
Evan Charlton0e094d92014-11-08 15:49:16 -0800782 * @hide
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700783 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800784 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -0600785 @RequiresPermission(anyOf = {
786 android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
787 android.Manifest.permission.READ_PHONE_STATE
788 })
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700789 public List<PhoneAccountHandle> getPhoneAccountsSupportingScheme(String uriScheme) {
790 try {
791 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -0700792 return getTelecomService().getPhoneAccountsSupportingScheme(uriScheme,
793 mContext.getOpPackageName());
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700794 }
795 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700796 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsSupportingScheme", e);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700797 }
798 return new ArrayList<>();
799 }
800
Nancy Chen513c8922014-09-17 14:47:20 -0700801
802 /**
Santos Cordon91371dc02015-05-08 13:52:09 -0700803 * Returns a list of {@link PhoneAccountHandle}s which can be used to make and receive phone
804 * calls. The returned list includes only those accounts which have been explicitly enabled
805 * by the user.
Nancy Chen513c8922014-09-17 14:47:20 -0700806 *
Yorke Leec61d13662015-09-21 17:25:25 -0700807 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
808 *
Nancy Chen513c8922014-09-17 14:47:20 -0700809 * @see #EXTRA_PHONE_ACCOUNT_HANDLE
810 * @return A list of {@code PhoneAccountHandle} objects.
Nancy Chen513c8922014-09-17 14:47:20 -0700811 */
Yorke Leec61d13662015-09-21 17:25:25 -0700812 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen513c8922014-09-17 14:47:20 -0700813 public List<PhoneAccountHandle> getCallCapablePhoneAccounts() {
Santos Cordon91371dc02015-05-08 13:52:09 -0700814 return getCallCapablePhoneAccounts(false);
815 }
816
817 /**
Tyler Gunn89317072017-04-07 14:57:37 -0700818 * Returns a list of {@link PhoneAccountHandle}s for self-managed {@link ConnectionService}s.
819 * <p>
820 * Self-Managed {@link ConnectionService}s have a {@link PhoneAccount} with
821 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED}.
822 * <p>
823 * Requires permission {@link android.Manifest.permission#READ_PHONE_STATE}, or that the caller
824 * is the default dialer app.
825 * <p>
826 * A {@link SecurityException} will be thrown if a called is not the default dialer, or lacks
827 * the {@link android.Manifest.permission#READ_PHONE_STATE} permission.
828 *
829 * @return A list of {@code PhoneAccountHandle} objects.
830 */
831 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
832 public List<PhoneAccountHandle> getSelfManagedPhoneAccounts() {
833 try {
834 if (isServiceConnected()) {
835 return getTelecomService().getSelfManagedPhoneAccounts(mContext.getOpPackageName());
836 }
837 } catch (RemoteException e) {
838 Log.e(TAG, "Error calling ITelecomService#getSelfManagedPhoneAccounts()", e);
839 }
840 return new ArrayList<>();
841 }
842
843 /**
Santos Cordon91371dc02015-05-08 13:52:09 -0700844 * Returns a list of {@link PhoneAccountHandle}s including those which have not been enabled
845 * by the user.
846 *
847 * @return A list of {@code PhoneAccountHandle} objects.
848 * @hide
849 */
850 public List<PhoneAccountHandle> getCallCapablePhoneAccounts(boolean includeDisabledAccounts) {
Nancy Chen513c8922014-09-17 14:47:20 -0700851 try {
852 if (isServiceConnected()) {
Santos Cordon91371dc02015-05-08 13:52:09 -0700853 return getTelecomService().getCallCapablePhoneAccounts(
854 includeDisabledAccounts, mContext.getOpPackageName());
Nancy Chen513c8922014-09-17 14:47:20 -0700855 }
856 } catch (RemoteException e) {
Santos Cordon91371dc02015-05-08 13:52:09 -0700857 Log.e(TAG, "Error calling ITelecomService#getCallCapablePhoneAccounts(" +
858 includeDisabledAccounts + ")", e);
Nancy Chen513c8922014-09-17 14:47:20 -0700859 }
860 return new ArrayList<>();
861 }
862
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700863 /**
Nancy Chen513c8922014-09-17 14:47:20 -0700864 * Returns a list of all {@link PhoneAccount}s registered for the calling package.
865 *
866 * @return A list of {@code PhoneAccountHandle} objects.
Evan Charlton0e094d92014-11-08 15:49:16 -0800867 * @hide
Nancy Chen513c8922014-09-17 14:47:20 -0700868 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800869 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -0600870 @SuppressLint("Doclava125")
Nancy Chen513c8922014-09-17 14:47:20 -0700871 public List<PhoneAccountHandle> getPhoneAccountsForPackage() {
872 try {
873 if (isServiceConnected()) {
874 return getTelecomService().getPhoneAccountsForPackage(mContext.getPackageName());
875 }
876 } catch (RemoteException e) {
877 Log.e(TAG, "Error calling ITelecomService#getPhoneAccountsForPackage", e);
878 }
879 return null;
880 }
881
882 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700883 * Return the {@link PhoneAccount} for a specified {@link PhoneAccountHandle}. Object includes
884 * resources which can be used in a user interface.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700885 *
Evan Charlton6eb262c2014-07-19 18:18:19 -0700886 * @param account The {@link PhoneAccountHandle}.
Evan Charlton8c8a0622014-07-20 12:31:00 -0700887 * @return The {@link PhoneAccount} object.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700888 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700889 public PhoneAccount getPhoneAccount(PhoneAccountHandle account) {
Ihab Awad807fe0a2014-07-09 12:30:52 -0700890 try {
891 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700892 return getTelecomService().getPhoneAccount(account);
Ihab Awad807fe0a2014-07-09 12:30:52 -0700893 }
894 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700895 Log.e(TAG, "Error calling ITelecomService#getPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -0700896 }
897 return null;
898 }
899
900 /**
Nancy Chen210ef032014-09-15 17:58:42 -0700901 * Returns a count of all {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700902 *
Nancy Chen210ef032014-09-15 17:58:42 -0700903 * @return The count of {@link PhoneAccount}s.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700904 * @hide
905 */
906 @SystemApi
907 public int getAllPhoneAccountsCount() {
908 try {
909 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700910 return getTelecomService().getAllPhoneAccountsCount();
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700911 }
912 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700913 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountsCount", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700914 }
915 return 0;
916 }
917
918 /**
919 * Returns a list of all {@link PhoneAccount}s.
920 *
921 * @return All {@link PhoneAccount}s.
922 * @hide
923 */
924 @SystemApi
925 public List<PhoneAccount> getAllPhoneAccounts() {
926 try {
927 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700928 return getTelecomService().getAllPhoneAccounts();
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700929 }
930 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700931 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccounts", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700932 }
933 return Collections.EMPTY_LIST;
934 }
935
936 /**
937 * Returns a list of all {@link PhoneAccountHandle}s.
938 *
939 * @return All {@link PhoneAccountHandle}s.
940 * @hide
941 */
942 @SystemApi
943 public List<PhoneAccountHandle> getAllPhoneAccountHandles() {
944 try {
945 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700946 return getTelecomService().getAllPhoneAccountHandles();
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700947 }
948 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700949 Log.e(TAG, "Error calling ITelecomService#getAllPhoneAccountHandles", e);
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700950 }
951 return Collections.EMPTY_LIST;
952 }
953
954 /**
Brad Ebingerec0d3342016-01-29 15:40:43 -0800955 * Register a {@link PhoneAccount} for use by the system that will be stored in Device Encrypted
956 * storage. When registering {@link PhoneAccount}s, existing registrations will be overwritten
957 * if the {@link PhoneAccountHandle} matches that of a {@link PhoneAccount} which is already
Santos Cordond9e614f2014-10-28 13:10:36 -0700958 * registered. Once registered, the {@link PhoneAccount} is listed to the user as an option
959 * when placing calls. The user may still need to enable the {@link PhoneAccount} within
960 * the phone app settings before the account is usable.
961 * <p>
962 * A {@link SecurityException} will be thrown if an app tries to register a
963 * {@link PhoneAccountHandle} where the package name specified within
964 * {@link PhoneAccountHandle#getComponentName()} does not match the package name of the app.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700965 *
Evan Charlton8c8a0622014-07-20 12:31:00 -0700966 * @param account The complete {@link PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700967 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700968 public void registerPhoneAccount(PhoneAccount account) {
Ihab Awad807fe0a2014-07-09 12:30:52 -0700969 try {
970 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700971 getTelecomService().registerPhoneAccount(account);
Ihab Awad807fe0a2014-07-09 12:30:52 -0700972 }
973 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700974 Log.e(TAG, "Error calling ITelecomService#registerPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -0700975 }
976 }
977
978 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700979 * Remove a {@link PhoneAccount} registration from the system.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700980 *
Evan Charlton8c8a0622014-07-20 12:31:00 -0700981 * @param accountHandle A {@link PhoneAccountHandle} for the {@link PhoneAccount} to unregister.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700982 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700983 public void unregisterPhoneAccount(PhoneAccountHandle accountHandle) {
Ihab Awad807fe0a2014-07-09 12:30:52 -0700984 try {
985 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700986 getTelecomService().unregisterPhoneAccount(accountHandle);
Ihab Awad807fe0a2014-07-09 12:30:52 -0700987 }
988 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -0700989 Log.e(TAG, "Error calling ITelecomService#unregisterPhoneAccount", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -0700990 }
991 }
992
993 /**
Nancy Chen7ab1dc42014-09-09 18:18:26 -0700994 * Remove all Accounts that belong to the calling package from the system.
Evan Charlton0e094d92014-11-08 15:49:16 -0800995 * @hide
Ihab Awad807fe0a2014-07-09 12:30:52 -0700996 */
Evan Charlton0e094d92014-11-08 15:49:16 -0800997 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -0600998 @SuppressLint("Doclava125")
Yorke Lee06044272015-04-14 15:16:59 -0700999 public void clearPhoneAccounts() {
1000 clearAccounts();
1001 }
1002 /**
1003 * Remove all Accounts that belong to the calling package from the system.
1004 * @deprecated Use {@link #clearPhoneAccounts()} instead.
1005 * @hide
1006 */
1007 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001008 @SuppressLint("Doclava125")
Nancy Chen7ab1dc42014-09-09 18:18:26 -07001009 public void clearAccounts() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001010 try {
1011 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001012 getTelecomService().clearAccounts(mContext.getPackageName());
Ihab Awad807fe0a2014-07-09 12:30:52 -07001013 }
1014 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001015 Log.e(TAG, "Error calling ITelecomService#clearAccounts", e);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001016 }
1017 }
1018
1019 /**
Anthony Lee67279262014-10-27 11:28:40 -07001020 * Remove all Accounts that belong to the specified package from the system.
1021 * @hide
1022 */
1023 public void clearAccountsForPackage(String packageName) {
1024 try {
1025 if (isServiceConnected() && !TextUtils.isEmpty(packageName)) {
1026 getTelecomService().clearAccounts(packageName);
1027 }
1028 } catch (RemoteException e) {
Nancy Chen5cf27842015-01-24 23:30:27 -08001029 Log.e(TAG, "Error calling ITelecomService#clearAccountsForPackage", e);
Anthony Lee67279262014-10-27 11:28:40 -07001030 }
1031 }
1032
Yorke Lee1011f482015-04-23 15:58:27 -07001033
Anthony Lee67279262014-10-27 11:28:40 -07001034 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001035 * @deprecated - Use {@link TelecomManager#getDefaultDialerPackage} to directly access
1036 * the default dialer's package name instead.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001037 * @hide
1038 */
Santos Cordon6c7a3882014-06-25 15:30:08 -07001039 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001040 @SuppressLint("Doclava125")
Santos Cordon6c7a3882014-06-25 15:30:08 -07001041 public ComponentName getDefaultPhoneApp() {
1042 try {
Santos Cordon9eb45932014-06-27 12:28:43 -07001043 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001044 return getTelecomService().getDefaultPhoneApp();
Santos Cordon9eb45932014-06-27 12:28:43 -07001045 }
Santos Cordon6c7a3882014-06-25 15:30:08 -07001046 } catch (RemoteException e) {
1047 Log.e(TAG, "RemoteException attempting to get the default phone app.", e);
1048 }
1049 return null;
1050 }
1051
Santos Cordon9eb45932014-06-27 12:28:43 -07001052 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001053 * Used to determine the currently selected default dialer package.
1054 *
1055 * @return package name for the default dialer package or null if no package has been
1056 * selected as the default dialer.
1057 */
1058 public String getDefaultDialerPackage() {
1059 try {
1060 if (isServiceConnected()) {
1061 return getTelecomService().getDefaultDialerPackage();
1062 }
1063 } catch (RemoteException e) {
1064 Log.e(TAG, "RemoteException attempting to get the default dialer package name.", e);
1065 }
1066 return null;
1067 }
1068
1069 /**
Yorke Lee107c4ce2015-06-15 12:08:24 -07001070 * Used to set the default dialer package.
1071 *
1072 * @param packageName to set the default dialer to..
1073 *
1074 * @result {@code true} if the default dialer was successfully changed, {@code false} if
1075 * the specified package does not correspond to an installed dialer, or is already
1076 * the default dialer.
1077 *
1078 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1079 * Requires permission: {@link android.Manifest.permission#WRITE_SECURE_SETTINGS}
1080 *
1081 * @hide
1082 */
1083 public boolean setDefaultDialer(String packageName) {
1084 try {
1085 if (isServiceConnected()) {
1086 return getTelecomService().setDefaultDialer(packageName);
1087 }
1088 } catch (RemoteException e) {
1089 Log.e(TAG, "RemoteException attempting to set the default dialer.", e);
1090 }
1091 return false;
1092 }
1093
1094 /**
Yorke Lee1011f482015-04-23 15:58:27 -07001095 * Used to determine the dialer package that is preloaded on the system partition.
1096 *
1097 * @return package name for the system dialer package or null if no system dialer is preloaded.
1098 * @hide
1099 */
1100 public String getSystemDialerPackage() {
1101 try {
1102 if (isServiceConnected()) {
1103 return getTelecomService().getSystemDialerPackage();
1104 }
1105 } catch (RemoteException e) {
1106 Log.e(TAG, "RemoteException attempting to get the system dialer package name.", e);
1107 }
1108 return null;
1109 }
1110
1111 /**
Nancy Chen443e5012014-10-15 15:48:21 -07001112 * Return whether a given phone number is the configured voicemail number for a
1113 * particular phone account.
1114 *
Yorke Leec61d13662015-09-21 17:25:25 -07001115 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1116 *
Nancy Chen443e5012014-10-15 15:48:21 -07001117 * @param accountHandle The handle for the account to check the voicemail number against
1118 * @param number The number to look up.
Nancy Chen443e5012014-10-15 15:48:21 -07001119 */
Yorke Leec61d13662015-09-21 17:25:25 -07001120 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen443e5012014-10-15 15:48:21 -07001121 public boolean isVoiceMailNumber(PhoneAccountHandle accountHandle, String number) {
1122 try {
1123 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001124 return getTelecomService().isVoiceMailNumber(accountHandle, number,
1125 mContext.getOpPackageName());
Nancy Chen443e5012014-10-15 15:48:21 -07001126 }
1127 } catch (RemoteException e) {
Nancy Chen5cf27842015-01-24 23:30:27 -08001128 Log.e(TAG, "RemoteException calling ITelecomService#isVoiceMailNumber.", e);
Nancy Chen443e5012014-10-15 15:48:21 -07001129 }
1130 return false;
1131 }
1132
1133 /**
Yorke Lee49e2d462015-04-15 16:14:22 -07001134 * Return the voicemail number for a given phone account.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001135 *
Yorke Leec61d13662015-09-21 17:25:25 -07001136 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1137 *
Yorke Lee49e2d462015-04-15 16:14:22 -07001138 * @param accountHandle The handle for the phone account.
1139 * @return The voicemail number for the phone account, and {@code null} if one has not been
1140 * configured.
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001141 */
Yorke Leec61d13662015-09-21 17:25:25 -07001142 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Yorke Lee49e2d462015-04-15 16:14:22 -07001143 public String getVoiceMailNumber(PhoneAccountHandle accountHandle) {
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001144 try {
1145 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001146 return getTelecomService().getVoiceMailNumber(accountHandle,
1147 mContext.getOpPackageName());
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001148 }
1149 } catch (RemoteException e) {
Nancy Chen5cf27842015-01-24 23:30:27 -08001150 Log.e(TAG, "RemoteException calling ITelecomService#hasVoiceMailNumber.", e);
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001151 }
Yorke Lee49e2d462015-04-15 16:14:22 -07001152 return null;
Nancy Chen8c066f7c2014-12-03 15:18:08 -08001153 }
1154
1155 /**
Nancy Chen5cf27842015-01-24 23:30:27 -08001156 * Return the line 1 phone number for given phone account.
1157 *
Yorke Leec61d13662015-09-21 17:25:25 -07001158 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1159 *
Nancy Chen5cf27842015-01-24 23:30:27 -08001160 * @param accountHandle The handle for the account retrieve a number for.
1161 * @return A string representation of the line 1 phone number.
Nancy Chen5cf27842015-01-24 23:30:27 -08001162 */
Yorke Leec61d13662015-09-21 17:25:25 -07001163 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen5cf27842015-01-24 23:30:27 -08001164 public String getLine1Number(PhoneAccountHandle accountHandle) {
1165 try {
1166 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001167 return getTelecomService().getLine1Number(accountHandle,
1168 mContext.getOpPackageName());
Nancy Chen5cf27842015-01-24 23:30:27 -08001169 }
1170 } catch (RemoteException e) {
1171 Log.e(TAG, "RemoteException calling ITelecomService#getLine1Number.", e);
1172 }
1173 return null;
1174 }
1175
1176 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001177 * Returns whether there is an ongoing phone call (can be in dialing, ringing, active or holding
Tyler Gunn24e18332017-02-10 09:42:49 -08001178 * states) originating from either a manager or self-managed {@link ConnectionService}.
Nancy Chen0eb1e402014-08-21 22:52:29 -07001179 * <p>
1180 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
Tyler Gunn24e18332017-02-10 09:42:49 -08001181 *
1182 * @return {@code true} if there is an ongoing call in either a managed or self-managed
1183 * {@link ConnectionService}, {@code false} otherwise.
Santos Cordon9eb45932014-06-27 12:28:43 -07001184 */
Yorke Leec61d13662015-09-21 17:25:25 -07001185 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001186 public boolean isInCall() {
Santos Cordon9eb45932014-06-27 12:28:43 -07001187 try {
1188 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001189 return getTelecomService().isInCall(mContext.getOpPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001190 }
1191 } catch (RemoteException e) {
Yorke Lee2ae312e2014-09-12 17:58:48 -07001192 Log.e(TAG, "RemoteException calling isInCall().", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001193 }
1194 return false;
1195 }
1196
1197 /**
Tyler Gunn24e18332017-02-10 09:42:49 -08001198 * Returns whether there is an ongoing call originating from a managed
1199 * {@link ConnectionService}. An ongoing call can be in dialing, ringing, active or holding
1200 * states.
1201 * <p>
1202 * If you also need to know if there are ongoing self-managed calls, use {@link #isInCall()}
1203 * instead.
1204 * <p>
1205 * Requires permission: {@link android.Manifest.permission#READ_PHONE_STATE}
1206 *
1207 * @return {@code true} if there is an ongoing call in a managed {@link ConnectionService},
1208 * {@code false} otherwise.
1209 */
1210 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
1211 public boolean isInManagedCall() {
1212 try {
1213 if (isServiceConnected()) {
1214 return getTelecomService().isInManagedCall(mContext.getOpPackageName());
1215 }
1216 } catch (RemoteException e) {
1217 Log.e(TAG, "RemoteException calling isInManagedCall().", e);
1218 }
1219 return false;
1220 }
1221
1222 /**
Yorke Lee2ae312e2014-09-12 17:58:48 -07001223 * Returns one of the following constants that represents the current state of Telecom:
1224 *
1225 * {@link TelephonyManager#CALL_STATE_RINGING}
1226 * {@link TelephonyManager#CALL_STATE_OFFHOOK}
1227 * {@link TelephonyManager#CALL_STATE_IDLE}
Yorke Lee7c72c2d2014-10-28 14:12:02 -07001228 *
1229 * Note that this API does not require the
1230 * {@link android.Manifest.permission#READ_PHONE_STATE} permission. This is intentional, to
1231 * preserve the behavior of {@link TelephonyManager#getCallState()}, which also did not require
1232 * the permission.
Tyler Gunn24e18332017-02-10 09:42:49 -08001233 *
1234 * Takes into consideration both managed and self-managed calls.
1235 *
Yorke Lee2ae312e2014-09-12 17:58:48 -07001236 * @hide
1237 */
1238 @SystemApi
1239 public int getCallState() {
1240 try {
1241 if (isServiceConnected()) {
1242 return getTelecomService().getCallState();
1243 }
1244 } catch (RemoteException e) {
1245 Log.d(TAG, "RemoteException calling getCallState().", e);
1246 }
1247 return TelephonyManager.CALL_STATE_IDLE;
1248 }
1249
1250 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001251 * Returns whether there currently exists is a ringing incoming-call.
1252 *
Tyler Gunn24e18332017-02-10 09:42:49 -08001253 * @return {@code true} if there is a managed or self-managed ringing call.
Santos Cordon9eb45932014-06-27 12:28:43 -07001254 * @hide
1255 */
1256 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001257 @RequiresPermission(anyOf = {
1258 android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
1259 android.Manifest.permission.READ_PHONE_STATE
1260 })
Santos Cordon9eb45932014-06-27 12:28:43 -07001261 public boolean isRinging() {
1262 try {
1263 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001264 return getTelecomService().isRinging(mContext.getOpPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001265 }
1266 } catch (RemoteException e) {
1267 Log.e(TAG, "RemoteException attempting to get ringing state of phone app.", e);
1268 }
1269 return false;
1270 }
1271
1272 /**
Santos Cordon96efb482014-07-19 14:57:05 -07001273 * Ends an ongoing call.
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001274 * TODO: L-release - need to convert all invocations of ITelecomService#endCall to use this
Santos Cordon96efb482014-07-19 14:57:05 -07001275 * method (clockwork & gearhead).
Santos Cordon9eb45932014-06-27 12:28:43 -07001276 * @hide
1277 */
1278 @SystemApi
Jeff Sharkeyd86b8fe2017-06-02 17:36:26 -06001279 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07001280 public boolean endCall() {
1281 try {
1282 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001283 return getTelecomService().endCall();
Santos Cordon9eb45932014-06-27 12:28:43 -07001284 }
1285 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001286 Log.e(TAG, "Error calling ITelecomService#endCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001287 }
1288 return false;
1289 }
1290
1291 /**
1292 * If there is a ringing incoming call, this method accepts the call on behalf of the user.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001293 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001294 * If the incoming call is a video call, the call will be answered with the same video state as
1295 * the incoming call requests. This means, for example, that an incoming call requesting
1296 * {@link VideoProfile#STATE_BIDIRECTIONAL} will be answered, accepting that state.
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001297 *
1298 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or
1299 * {@link android.Manifest.permission#ANSWER_PHONE_CALLS}
Santos Cordon9eb45932014-06-27 12:28:43 -07001300 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001301 //TODO: L-release - need to convert all invocation of ITelecmmService#answerRingingCall to use
1302 // this method (clockwork & gearhead).
1303 @RequiresPermission(anyOf =
1304 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Santos Cordon9eb45932014-06-27 12:28:43 -07001305 public void acceptRingingCall() {
1306 try {
1307 if (isServiceConnected()) {
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001308 getTelecomService().acceptRingingCall(mContext.getPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001309 }
1310 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001311 Log.e(TAG, "Error calling ITelecomService#acceptRingingCall", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001312 }
1313 }
1314
1315 /**
Tyler Gunn6676bb52015-10-23 14:39:49 -07001316 * If there is a ringing incoming call, this method accepts the call on behalf of the user,
1317 * with the specified video state.
1318 *
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001319 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE} or
1320 * {@link android.Manifest.permission#ANSWER_PHONE_CALLS}
1321 *
Tyler Gunn6676bb52015-10-23 14:39:49 -07001322 * @param videoState The desired video state to answer the call with.
Tyler Gunn6676bb52015-10-23 14:39:49 -07001323 */
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001324 @RequiresPermission(anyOf =
1325 {Manifest.permission.ANSWER_PHONE_CALLS, Manifest.permission.MODIFY_PHONE_STATE})
Tyler Gunn6676bb52015-10-23 14:39:49 -07001326 public void acceptRingingCall(int videoState) {
1327 try {
1328 if (isServiceConnected()) {
Eugene Suslacae3d3e2017-01-31 11:08:11 -08001329 getTelecomService().acceptRingingCallWithVideoState(
1330 mContext.getPackageName(), videoState);
Tyler Gunn6676bb52015-10-23 14:39:49 -07001331 }
1332 } catch (RemoteException e) {
1333 Log.e(TAG, "Error calling ITelecomService#acceptRingingCallWithVideoState", e);
1334 }
1335 }
1336
1337 /**
Santos Cordon9eb45932014-06-27 12:28:43 -07001338 * Silences the ringer if a ringing call exists.
Yorke Leec61d13662015-09-21 17:25:25 -07001339 *
1340 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
Santos Cordon9eb45932014-06-27 12:28:43 -07001341 */
Yorke Leec61d13662015-09-21 17:25:25 -07001342 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon9eb45932014-06-27 12:28:43 -07001343 public void silenceRinger() {
1344 try {
1345 if (isServiceConnected()) {
Yorke Leef1a349b2015-04-29 16:16:50 -07001346 getTelecomService().silenceRinger(mContext.getOpPackageName());
Santos Cordon9eb45932014-06-27 12:28:43 -07001347 }
1348 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001349 Log.e(TAG, "Error calling ITelecomService#silenceRinger", e);
Santos Cordon9eb45932014-06-27 12:28:43 -07001350 }
1351 }
1352
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001353 /**
1354 * Returns whether TTY is supported on this device.
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001355 */
Jeff Sharkey983df8c2017-12-06 20:53:38 -07001356 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001357 @RequiresPermission(anyOf = {
1358 android.Manifest.permission.READ_PRIVILEGED_PHONE_STATE,
1359 android.Manifest.permission.READ_PHONE_STATE
1360 })
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001361 public boolean isTtySupported() {
1362 try {
1363 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001364 return getTelecomService().isTtySupported(mContext.getOpPackageName());
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001365 }
1366 } catch (RemoteException e) {
1367 Log.e(TAG, "RemoteException attempting to get TTY supported state.", e);
1368 }
1369 return false;
1370 }
1371
1372 /**
1373 * 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 -07001374 * settings and have a wired headset plugged in.
1375 * Valid modes are:
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001376 * - {@link TelecomManager#TTY_MODE_OFF}
1377 * - {@link TelecomManager#TTY_MODE_FULL}
1378 * - {@link TelecomManager#TTY_MODE_HCO}
1379 * - {@link TelecomManager#TTY_MODE_VCO}
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001380 * @hide
1381 */
1382 public int getCurrentTtyMode() {
1383 try {
1384 if (isServiceConnected()) {
Svet Ganov16a16892015-04-16 10:32:04 -07001385 return getTelecomService().getCurrentTtyMode(mContext.getOpPackageName());
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001386 }
1387 } catch (RemoteException e) {
1388 Log.e(TAG, "RemoteException attempting to get the current TTY mode.", e);
1389 }
Evan Charlton10197192014-07-19 15:00:29 -07001390 return TTY_MODE_OFF;
Sailesh Nepal001bbbb2014-07-15 14:40:39 -07001391 }
1392
Santos Cordon96efb482014-07-19 14:57:05 -07001393 /**
1394 * Registers a new incoming call. A {@link ConnectionService} should invoke this method when it
Tyler Gunnf5035432017-01-09 09:43:12 -08001395 * has an incoming call. For managed {@link ConnectionService}s, the specified
1396 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
1397 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
1398 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
1399 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to add a new incoming call.
1400 * <p>
Tyler Gunn37653562017-03-13 18:15:15 -07001401 * The incoming call you are adding is assumed to have a video state of
1402 * {@link VideoProfile#STATE_AUDIO_ONLY}, unless the extra value
1403 * {@link #EXTRA_INCOMING_VIDEO_STATE} is specified.
1404 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08001405 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
1406 * associated with the {@link PhoneAccountHandle} and request additional information about the
1407 * call (See {@link ConnectionService#onCreateIncomingConnection}) before starting the incoming
Brad Ebingerec0d3342016-01-29 15:40:43 -08001408 * call UI.
1409 * <p>
Tyler Gunnf5035432017-01-09 09:43:12 -08001410 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
1411 * the {@link PhoneAccountHandle} does not correspond to a registered {@link PhoneAccount} or
1412 * the associated {@link PhoneAccount} is not currently enabled by the user.
1413 * <p>
1414 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
1415 * the {@link PhoneAccount} has {@link PhoneAccount#CAPABILITY_SELF_MANAGED} and the calling app
1416 * does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
1417 *
Santos Cordon96efb482014-07-19 14:57:05 -07001418 * @param phoneAccount A {@link PhoneAccountHandle} registered with
1419 * {@link #registerPhoneAccount}.
1420 * @param extras A bundle that will be passed through to
1421 * {@link ConnectionService#onCreateIncomingConnection}.
1422 */
1423 public void addNewIncomingCall(PhoneAccountHandle phoneAccount, Bundle extras) {
1424 try {
1425 if (isServiceConnected()) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001426 getTelecomService().addNewIncomingCall(
Santos Cordon96efb482014-07-19 14:57:05 -07001427 phoneAccount, extras == null ? new Bundle() : extras);
1428 }
1429 } catch (RemoteException e) {
1430 Log.e(TAG, "RemoteException adding a new incoming call: " + phoneAccount, e);
1431 }
1432 }
1433
Nancy Chen0eb1e402014-08-21 22:52:29 -07001434 /**
Yorke Leec3cf9822014-10-02 09:38:39 -07001435 * Registers a new unknown call with Telecom. This can only be called by the system Telephony
1436 * service. This is invoked when Telephony detects a new unknown connection that was neither
1437 * a new incoming call, nor an user-initiated outgoing call.
1438 *
1439 * @param phoneAccount A {@link PhoneAccountHandle} registered with
1440 * {@link #registerPhoneAccount}.
1441 * @param extras A bundle that will be passed through to
1442 * {@link ConnectionService#onCreateIncomingConnection}.
1443 * @hide
1444 */
1445 @SystemApi
1446 public void addNewUnknownCall(PhoneAccountHandle phoneAccount, Bundle extras) {
1447 try {
1448 if (isServiceConnected()) {
1449 getTelecomService().addNewUnknownCall(
1450 phoneAccount, extras == null ? new Bundle() : extras);
1451 }
1452 } catch (RemoteException e) {
1453 Log.e(TAG, "RemoteException adding a new unknown call: " + phoneAccount, e);
1454 }
1455 }
1456
1457 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07001458 * Processes the specified dial string as an MMI code.
1459 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
1460 * Some of these sequences launch special behavior through handled by Telephony.
Nancy Chen95e8a672014-10-16 18:38:21 -07001461 * This method uses the default subscription.
Nancy Chen0eb1e402014-08-21 22:52:29 -07001462 * <p>
1463 * Requires that the method-caller be set as the system dialer app.
1464 * </p>
1465 *
Yorke Leec61d13662015-09-21 17:25:25 -07001466 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1467 *
Nancy Chen0eb1e402014-08-21 22:52:29 -07001468 * @param dialString The digits to dial.
1469 * @return True if the digits were processed as an MMI code, false otherwise.
1470 */
Yorke Leec61d13662015-09-21 17:25:25 -07001471 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001472 public boolean handleMmi(String dialString) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001473 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07001474 if (service != null) {
1475 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001476 return service.handlePinMmi(dialString, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07001477 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001478 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07001479 }
1480 }
1481 return false;
1482 }
1483
1484 /**
Nancy Chen95e8a672014-10-16 18:38:21 -07001485 * Processes the specified dial string as an MMI code.
1486 * MMI codes are any sequence of characters entered into the dialpad that contain a "*" or "#".
1487 * Some of these sequences launch special behavior through handled by Telephony.
1488 * <p>
1489 * Requires that the method-caller be set as the system dialer app.
1490 * </p>
1491 *
Yorke Leec61d13662015-09-21 17:25:25 -07001492 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1493 *
Nancy Chen95e8a672014-10-16 18:38:21 -07001494 * @param accountHandle The handle for the account the MMI code should apply to.
1495 * @param dialString The digits to dial.
1496 * @return True if the digits were processed as an MMI code, false otherwise.
Nancy Chen95e8a672014-10-16 18:38:21 -07001497 */
Yorke Leec61d13662015-09-21 17:25:25 -07001498 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Yorke Lee06044272015-04-14 15:16:59 -07001499 public boolean handleMmi(String dialString, PhoneAccountHandle accountHandle) {
Nancy Chen95e8a672014-10-16 18:38:21 -07001500 ITelecomService service = getTelecomService();
1501 if (service != null) {
1502 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001503 return service.handlePinMmiForPhoneAccount(accountHandle, dialString,
1504 mContext.getOpPackageName());
Nancy Chen95e8a672014-10-16 18:38:21 -07001505 } catch (RemoteException e) {
1506 Log.e(TAG, "Error calling ITelecomService#handlePinMmi", e);
1507 }
1508 }
1509 return false;
1510 }
1511
1512 /**
Yorke Leec61d13662015-09-21 17:25:25 -07001513 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
1514 *
Nancy Chenb2299c12014-10-29 18:22:11 -07001515 * @param accountHandle The handle for the account to derive an adn query URI for or
1516 * {@code null} to return a URI which will use the default account.
1517 * @return The URI (with the content:// scheme) specific to the specified {@link PhoneAccount}
1518 * for the the content retrieve.
1519 */
Yorke Leec61d13662015-09-21 17:25:25 -07001520 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chenb2299c12014-10-29 18:22:11 -07001521 public Uri getAdnUriForPhoneAccount(PhoneAccountHandle accountHandle) {
1522 ITelecomService service = getTelecomService();
1523 if (service != null && accountHandle != null) {
1524 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001525 return service.getAdnUriForPhoneAccount(accountHandle, mContext.getOpPackageName());
Nancy Chenb2299c12014-10-29 18:22:11 -07001526 } catch (RemoteException e) {
1527 Log.e(TAG, "Error calling ITelecomService#getAdnUriForPhoneAccount", e);
1528 }
1529 }
1530 return Uri.parse("content://icc/adn");
1531 }
1532
1533 /**
Nancy Chen0eb1e402014-08-21 22:52:29 -07001534 * Removes the missed-call notification if one is present.
1535 * <p>
1536 * Requires that the method-caller be set as the system dialer app.
1537 * </p>
Yorke Leec61d13662015-09-21 17:25:25 -07001538 *
1539 * Requires permission: {@link android.Manifest.permission#MODIFY_PHONE_STATE}
Nancy Chen0eb1e402014-08-21 22:52:29 -07001540 */
Yorke Leec61d13662015-09-21 17:25:25 -07001541 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001542 public void cancelMissedCallsNotification() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001543 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07001544 if (service != null) {
1545 try {
Yorke Leef1a349b2015-04-29 16:16:50 -07001546 service.cancelMissedCallsNotification(mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07001547 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001548 Log.e(TAG, "Error calling ITelecomService#cancelMissedCallsNotification", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07001549 }
1550 }
1551 }
1552
1553 /**
1554 * Brings the in-call screen to the foreground if there is an ongoing call. If there is
1555 * currently no ongoing call, then this method does nothing.
1556 * <p>
1557 * Requires that the method-caller be set as the system dialer app or have the
1558 * {@link android.Manifest.permission#READ_PHONE_STATE} permission.
1559 * </p>
1560 *
1561 * @param showDialpad Brings up the in-call dialpad as part of showing the in-call screen.
1562 */
Yorke Leec61d13662015-09-21 17:25:25 -07001563 @RequiresPermission(android.Manifest.permission.READ_PHONE_STATE)
Nancy Chen0eb1e402014-08-21 22:52:29 -07001564 public void showInCallScreen(boolean showDialpad) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001565 ITelecomService service = getTelecomService();
Nancy Chen0eb1e402014-08-21 22:52:29 -07001566 if (service != null) {
1567 try {
Svet Ganov16a16892015-04-16 10:32:04 -07001568 service.showInCallScreen(showDialpad, mContext.getOpPackageName());
Nancy Chen0eb1e402014-08-21 22:52:29 -07001569 } catch (RemoteException e) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001570 Log.e(TAG, "Error calling ITelecomService#showCallScreen", e);
Nancy Chen0eb1e402014-08-21 22:52:29 -07001571 }
1572 }
1573 }
1574
Yorke Lee3e56ba12015-04-23 12:32:36 -07001575 /**
1576 * Places a new outgoing call to the provided address using the system telecom service with
1577 * the specified extras.
1578 *
1579 * This method is equivalent to placing an outgoing call using {@link Intent#ACTION_CALL},
1580 * except that the outgoing call will always be sent via the system telecom service. If
1581 * method-caller is either the user selected default dialer app or preloaded system dialer
1582 * app, then emergency calls will also be allowed.
1583 *
Tyler Gunnf5035432017-01-09 09:43:12 -08001584 * Placing a call via a managed {@link ConnectionService} requires permission:
1585 * {@link android.Manifest.permission#CALL_PHONE}
Yorke Lee3e56ba12015-04-23 12:32:36 -07001586 *
1587 * Usage example:
1588 * <pre>
1589 * Uri uri = Uri.fromParts("tel", "12345", null);
1590 * Bundle extras = new Bundle();
1591 * extras.putBoolean(TelecomManager.EXTRA_START_CALL_WITH_SPEAKERPHONE, true);
1592 * telecomManager.placeCall(uri, extras);
1593 * </pre>
1594 *
Santos Cordon7a060d52015-06-19 14:52:04 -07001595 * The following keys are supported in the supplied extras.
1596 * <ul>
1597 * <li>{@link #EXTRA_OUTGOING_CALL_EXTRAS}</li>
1598 * <li>{@link #EXTRA_PHONE_ACCOUNT_HANDLE}</li>
1599 * <li>{@link #EXTRA_START_CALL_WITH_SPEAKERPHONE}</li>
1600 * <li>{@link #EXTRA_START_CALL_WITH_VIDEO_STATE}</li>
1601 * </ul>
Tyler Gunnf5035432017-01-09 09:43:12 -08001602 * <p>
1603 * An app which implements the self-managed {@link ConnectionService} API uses
1604 * {@link #placeCall(Uri, Bundle)} to inform Telecom of a new outgoing call. A self-managed
1605 * {@link ConnectionService} must include {@link #EXTRA_PHONE_ACCOUNT_HANDLE} to specify its
1606 * associated {@link android.telecom.PhoneAccountHandle}.
1607 *
1608 * Self-managed {@link ConnectionService}s require permission
1609 * {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
Santos Cordon7a060d52015-06-19 14:52:04 -07001610 *
Yorke Lee3e56ba12015-04-23 12:32:36 -07001611 * @param address The address to make the call to.
1612 * @param extras Bundle of extras to use with the call.
1613 */
Tyler Gunnf5035432017-01-09 09:43:12 -08001614 @RequiresPermission(anyOf = {android.Manifest.permission.CALL_PHONE,
1615 android.Manifest.permission.MANAGE_OWN_CALLS})
Yorke Lee3e56ba12015-04-23 12:32:36 -07001616 public void placeCall(Uri address, Bundle extras) {
1617 ITelecomService service = getTelecomService();
1618 if (service != null) {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07001619 if (address == null) {
1620 Log.w(TAG, "Cannot place call to empty address.");
1621 }
Yorke Lee3e56ba12015-04-23 12:32:36 -07001622 try {
Yorke Leea5d5c1d2015-05-05 16:25:55 -07001623 service.placeCall(address, extras == null ? new Bundle() : extras,
1624 mContext.getOpPackageName());
Yorke Lee3e56ba12015-04-23 12:32:36 -07001625 } catch (RemoteException e) {
1626 Log.e(TAG, "Error calling ITelecomService#placeCall", e);
1627 }
1628 }
1629 }
1630
Santos Cordon91371dc02015-05-08 13:52:09 -07001631 /**
1632 * Enables and disables specified phone account.
1633 *
1634 * @param handle Handle to the phone account.
1635 * @param isEnabled Enable state of the phone account.
1636 * @hide
1637 */
1638 @SystemApi
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -06001639 @RequiresPermission(android.Manifest.permission.MODIFY_PHONE_STATE)
Santos Cordon91371dc02015-05-08 13:52:09 -07001640 public void enablePhoneAccount(PhoneAccountHandle handle, boolean isEnabled) {
1641 ITelecomService service = getTelecomService();
1642 if (service != null) {
1643 try {
1644 service.enablePhoneAccount(handle, isEnabled);
1645 } catch (RemoteException e) {
1646 Log.e(TAG, "Error enablePhoneAbbount", e);
1647 }
1648 }
1649 }
1650
Hall Liu0464b9b2016-01-12 15:32:58 -08001651 /**
1652 * Dumps telecom analytics for uploading.
1653 *
1654 * @return
1655 * @hide
1656 */
1657 @SystemApi
1658 @RequiresPermission(Manifest.permission.DUMP)
Hall Liu057def52016-05-05 17:17:07 -07001659 public TelecomAnalytics dumpAnalytics() {
Hall Liu0464b9b2016-01-12 15:32:58 -08001660 ITelecomService service = getTelecomService();
Hall Liu057def52016-05-05 17:17:07 -07001661 TelecomAnalytics result = null;
Hall Liu0464b9b2016-01-12 15:32:58 -08001662 if (service != null) {
1663 try {
1664 result = service.dumpCallAnalytics();
1665 } catch (RemoteException e) {
1666 Log.e(TAG, "Error dumping call analytics", e);
1667 }
1668 }
1669 return result;
1670 }
1671
Abhijith Shastry1908cb842016-02-02 11:10:19 -08001672 /**
Abhijith Shastrya26fe992016-02-29 11:40:24 -08001673 * Creates the {@link Intent} which can be used with {@link Context#startActivity(Intent)} to
1674 * launch the activity to manage blocked numbers.
Abhijith Shastryec30d2f2016-03-04 16:46:08 -08001675 * <p> The activity will display the UI to manage blocked numbers only if
Abhijith Shastrya26fe992016-02-29 11:40:24 -08001676 * {@link android.provider.BlockedNumberContract#canCurrentUserBlockNumbers(Context)} returns
1677 * {@code true} for the current user.
1678 */
1679 public Intent createManageBlockedNumbersIntent() {
1680 ITelecomService service = getTelecomService();
1681 Intent result = null;
1682 if (service != null) {
1683 try {
1684 result = service.createManageBlockedNumbersIntent();
1685 } catch (RemoteException e) {
1686 Log.e(TAG, "Error calling ITelecomService#createManageBlockedNumbersIntent", e);
1687 }
1688 }
1689 return result;
1690 }
1691
Tyler Gunnf5035432017-01-09 09:43:12 -08001692 /**
1693 * Determines whether Telecom would permit an incoming call to be added via the
1694 * {@link #addNewIncomingCall(PhoneAccountHandle, Bundle)} API for the specified
1695 * {@link PhoneAccountHandle}.
1696 * <p>
1697 * A {@link ConnectionService} may not add a call for the specified {@link PhoneAccountHandle}
1698 * in the following situations:
1699 * <ul>
1700 * <li>{@link PhoneAccount} does not have property
1701 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
1702 * {@link ConnectionService}), and the active or held call limit has
1703 * been reached.</li>
1704 * <li>There is an ongoing emergency call.</li>
1705 * </ul>
1706 *
1707 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
1708 * @return {@code true} if telecom will permit an incoming call to be added, {@code false}
1709 * otherwise.
1710 */
1711 public boolean isIncomingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
Tyler Gunn44e01912017-01-31 10:49:05 -08001712 if (phoneAccountHandle == null) {
1713 return false;
1714 }
1715
Tyler Gunnf5035432017-01-09 09:43:12 -08001716 ITelecomService service = getTelecomService();
1717 if (service != null) {
1718 try {
1719 return service.isIncomingCallPermitted(phoneAccountHandle);
1720 } catch (RemoteException e) {
1721 Log.e(TAG, "Error isIncomingCallPermitted", e);
1722 }
1723 }
1724 return false;
1725 }
1726
1727 /**
1728 * Determines whether Telecom would permit an outgoing call to be placed via the
1729 * {@link #placeCall(Uri, Bundle)} API for the specified {@link PhoneAccountHandle}.
1730 * <p>
1731 * A {@link ConnectionService} may not place a call for the specified {@link PhoneAccountHandle}
1732 * in the following situations:
1733 * <ul>
1734 * <li>{@link PhoneAccount} does not have property
1735 * {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set (i.e. it is a managed
1736 * {@link ConnectionService}), and the active, held or ringing call limit has
1737 * been reached.</li>
1738 * <li>{@link PhoneAccount} has property {@link PhoneAccount#CAPABILITY_SELF_MANAGED} set
1739 * (i.e. it is a self-managed {@link ConnectionService} and there is an ongoing call in
1740 * another {@link ConnectionService}.</li>
1741 * <li>There is an ongoing emergency call.</li>
1742 * </ul>
1743 *
1744 * @param phoneAccountHandle The {@link PhoneAccountHandle} the call will be added for.
1745 * @return {@code true} if telecom will permit an outgoing call to be placed, {@code false}
1746 * otherwise.
1747 */
1748 public boolean isOutgoingCallPermitted(PhoneAccountHandle phoneAccountHandle) {
1749 ITelecomService service = getTelecomService();
1750 if (service != null) {
1751 try {
1752 return service.isOutgoingCallPermitted(phoneAccountHandle);
1753 } catch (RemoteException e) {
1754 Log.e(TAG, "Error isOutgoingCallPermitted", e);
1755 }
1756 }
1757 return false;
1758 }
1759
Sanket Padawea8eddd42017-11-03 11:07:35 -07001760 /**
1761 * Called from the recipient side of a handover to indicate a desire to accept the handover
1762 * of an ongoing call to another {@link ConnectionService} identified by
1763 * {@link PhoneAccountHandle} destAcct. For managed {@link ConnectionService}s, the specified
1764 * {@link PhoneAccountHandle} must have been registered with {@link #registerPhoneAccount} and
1765 * the user must have enabled the corresponding {@link PhoneAccount}. This can be checked using
1766 * {@link #getPhoneAccount}. Self-managed {@link ConnectionService}s must have
1767 * {@link android.Manifest.permission#MANAGE_OWN_CALLS} to handover a call to it.
1768 * <p>
1769 * Once invoked, this method will cause the system to bind to the {@link ConnectionService}
1770 * associated with the {@link PhoneAccountHandle} destAcct and call
1771 * (See {@link ConnectionService#onCreateIncomingHandoverConnection}).
1772 * <p>
1773 * For a managed {@link ConnectionService}, a {@link SecurityException} will be thrown if either
1774 * the {@link PhoneAccountHandle} destAcct does not correspond to a registered
1775 * {@link PhoneAccount} or the associated {@link PhoneAccount} is not currently enabled by the
1776 * user.
1777 * <p>
1778 * For a self-managed {@link ConnectionService}, a {@link SecurityException} will be thrown if
1779 * the calling app does not have {@link android.Manifest.permission#MANAGE_OWN_CALLS}.
1780 *
1781 * @param srcAddr The {@link android.net.Uri} of the ongoing call to handover to the caller’s
1782 * {@link ConnectionService}.
1783 * @param videoState Video state after the handover.
1784 * @param destAcct The {@link PhoneAccountHandle} registered to the calling package.
1785 */
1786 public void acceptHandover(Uri srcAddr, int videoState, PhoneAccountHandle destAcct) {
1787 try {
1788 if (isServiceConnected()) {
1789 getTelecomService().acceptHandover(srcAddr, videoState, destAcct);
1790 }
1791 } catch (RemoteException e) {
1792 Log.e(TAG, "RemoteException acceptHandover: " + e);
1793 }
1794 }
Tyler Gunnf5035432017-01-09 09:43:12 -08001795
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001796 private ITelecomService getTelecomService() {
Hall Liue1bc2ec2015-10-09 15:58:37 -07001797 if (mTelecomServiceOverride != null) {
1798 return mTelecomServiceOverride;
1799 }
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001800 return ITelecomService.Stub.asInterface(ServiceManager.getService(Context.TELECOM_SERVICE));
Santos Cordon6c7a3882014-06-25 15:30:08 -07001801 }
Santos Cordon9eb45932014-06-27 12:28:43 -07001802
1803 private boolean isServiceConnected() {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001804 boolean isConnected = getTelecomService() != null;
Santos Cordon9eb45932014-06-27 12:28:43 -07001805 if (!isConnected) {
Tyler Gunnef9f6f92014-09-12 22:16:17 -07001806 Log.w(TAG, "Telecom Service not found.");
Santos Cordon9eb45932014-06-27 12:28:43 -07001807 }
1808 return isConnected;
1809 }
Evan Charlton235c1592014-09-05 15:41:23 +00001810}