blob: 63db297138253709548ab4fd537d80371754f1fd [file] [log] [blame]
Ihab Awad807fe0a2014-07-09 12:30:52 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Tyler Gunnef9f6f92014-09-12 22:16:17 -070017package android.telecom;
Ihab Awad807fe0a2014-07-09 12:30:52 -070018
Tyler Gunnc9503d62020-01-27 10:30:51 -080019import static android.Manifest.permission.MODIFY_PHONE_STATE;
20
Brad Ebingerb0c1d912024-01-12 14:51:35 -080021import android.annotation.FlaggedApi;
Tyler Gunn5567d742019-10-31 13:04:37 -070022import android.annotation.NonNull;
Tyler Gunnc9503d62020-01-27 10:30:51 -080023import android.annotation.RequiresPermission;
Evan Charlton0e094d92014-11-08 15:49:16 -080024import android.annotation.SystemApi;
Brad Ebinger3636d742019-05-21 15:28:19 -070025import android.content.Intent;
Santos Cordoncad84a22015-05-13 11:17:25 -070026import android.graphics.drawable.Icon;
Ihab Awad94cf4bf2014-07-17 11:21:19 -070027import android.net.Uri;
Tyler Gunn25ed2d72015-10-05 14:14:38 -070028import android.os.Bundle;
Ihab Awad807fe0a2014-07-09 12:30:52 -070029import android.os.Parcel;
30import android.os.Parcelable;
Brad Ebinger722cacf2021-05-14 01:53:56 +000031import android.telephony.CarrierConfigManager;
Hall Liu221f8042020-09-23 15:36:58 -070032import android.telephony.TelephonyManager;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -070033import android.text.TextUtils;
Brad Ebingerb0c1d912024-01-12 14:51:35 -080034import android.util.ArraySet;
35
36import com.android.internal.telephony.flags.Flags;
Ihab Awad807fe0a2014-07-09 12:30:52 -070037
Tyler Gunnf5b29dc2014-09-03 09:09:12 -070038import java.util.ArrayList;
39import java.util.Collections;
40import java.util.List;
Tyler Gunn3b347812018-08-24 14:17:05 -070041import java.util.Objects;
Brad Ebingerb0c1d912024-01-12 14:51:35 -080042import java.util.Set;
Ihab Awad807fe0a2014-07-09 12:30:52 -070043
44/**
Santos Cordon32c65a52014-10-27 14:57:49 -070045 * Represents a distinct method to place or receive a phone call. Apps which can place calls and
46 * want those calls to be integrated into the dialer and in-call UI should build an instance of
Brian Attwellad147f42014-12-19 11:37:16 -080047 * this class and register it with the system using {@link TelecomManager}.
Santos Cordon32c65a52014-10-27 14:57:49 -070048 * <p>
49 * {@link TelecomManager} uses registered {@link PhoneAccount}s to present the user with
50 * alternative options when placing a phone call. When building a {@link PhoneAccount}, the app
Brian Attwellad147f42014-12-19 11:37:16 -080051 * should supply a valid {@link PhoneAccountHandle} that references the connection service
Santos Cordon32c65a52014-10-27 14:57:49 -070052 * implementation Telecom will use to interact with the app.
Ihab Awad807fe0a2014-07-09 12:30:52 -070053 */
Yorke Lee400470f2015-05-12 13:31:25 -070054public final class PhoneAccount implements Parcelable {
Ihab Awad94cf4bf2014-07-17 11:21:19 -070055
56 /**
Hall Liu4bb53ec2020-09-29 15:15:24 -070057 * Integer extra which determines the order in which {@link PhoneAccount}s are sorted
Hall Liu2ef04112020-09-14 18:34:10 -070058 *
59 * This is an extras key set via {@link Builder#setExtras} which determines the order in which
60 * {@link PhoneAccount}s from the same {@link ConnectionService} are sorted. The accounts
Hall Liu4bb53ec2020-09-29 15:15:24 -070061 * are sorted in ascending order by this key, and this ordering is used to
Hall Liu2ef04112020-09-14 18:34:10 -070062 * determine priority when a call can be placed via multiple accounts.
Hall Liu221f8042020-09-23 15:36:58 -070063 *
64 * When multiple {@link PhoneAccount}s are supplied with the same sort order key, no ordering is
65 * guaranteed between those {@link PhoneAccount}s. Additionally, no ordering is guaranteed
66 * between {@link PhoneAccount}s that do not supply this extra, and all such accounts
67 * will be sorted after the accounts that do supply this extra.
68 *
69 * An example of a sort order key is slot index (see {@link TelephonyManager#getSlotIndex()}),
70 * which is the one used by the cell Telephony stack.
Srikanth Chintala62428402017-03-27 19:27:52 +053071 * @hide
72 */
Hall Liu2ef04112020-09-14 18:34:10 -070073 @SystemApi
Srikanth Chintala62428402017-03-27 19:27:52 +053074 public static final String EXTRA_SORT_ORDER =
75 "android.telecom.extra.SORT_ORDER";
76
77 /**
78 * {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which determines the
Tyler Gunnd426b202015-10-13 13:33:53 -070079 * maximum permitted length of a call subject specified via the
80 * {@link TelecomManager#EXTRA_CALL_SUBJECT} extra on an
81 * {@link android.content.Intent#ACTION_CALL} intent. Ultimately a {@link ConnectionService} is
82 * responsible for enforcing the maximum call subject length when sending the message, however
83 * this extra is provided so that the user interface can proactively limit the length of the
84 * call subject as the user types it.
85 */
86 public static final String EXTRA_CALL_SUBJECT_MAX_LENGTH =
87 "android.telecom.extra.CALL_SUBJECT_MAX_LENGTH";
88
89 /**
90 * {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which determines the
91 * character encoding to be used when determining the length of messages.
92 * The user interface can use this when determining the number of characters the user may type
93 * in a call subject. If empty-string, the call subject message size limit will be enforced on
94 * a 1:1 basis. That is, each character will count towards the messages size limit as a single
95 * character. If a character encoding is specified, the message size limit will be based on the
96 * number of bytes in the message per the specified encoding. See
97 * {@link #EXTRA_CALL_SUBJECT_MAX_LENGTH} for more information on the call subject maximum
98 * length.
99 */
100 public static final String EXTRA_CALL_SUBJECT_CHARACTER_ENCODING =
101 "android.telecom.extra.CALL_SUBJECT_CHARACTER_ENCODING";
102
Hall Liue576fc42020-01-22 17:17:13 -0800103 /**
104 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
105 * indicates that all calls from this {@link PhoneAccount} should be treated as VoIP calls
Hall Liu2ef04112020-09-14 18:34:10 -0700106 * rather than cellular calls by the Telecom audio handling logic.
Srikanth Chintalaf77d4a12017-04-03 18:08:14 +0530107 */
108 public static final String EXTRA_ALWAYS_USE_VOIP_AUDIO_MODE =
109 "android.telecom.extra.ALWAYS_USE_VOIP_AUDIO_MODE";
110
Tyler Gunnd426b202015-10-13 13:33:53 -0700111 /**
Tyler Gunn8bf76572017-04-06 15:30:08 -0700112 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
113 * indicates whether this {@link PhoneAccount} is capable of supporting a request to handover a
Sanket Padawea8eddd42017-11-03 11:07:35 -0700114 * connection (see {@code android.telecom.Call#handoverTo()}) to this {@link PhoneAccount} from
115 * a {@link PhoneAccount} specifying {@link #EXTRA_SUPPORTS_HANDOVER_FROM}.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700116 * <p>
117 * A handover request is initiated by the user from the default dialer app to indicate a desire
118 * to handover a call from one {@link PhoneAccount}/{@link ConnectionService} to another.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700119 */
120 public static final String EXTRA_SUPPORTS_HANDOVER_TO =
121 "android.telecom.extra.SUPPORTS_HANDOVER_TO";
122
123 /**
124 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
Ta-wei Yen9d20d982017-06-02 11:07:07 -0700125 * indicates whether this {@link PhoneAccount} supports using a fallback if video calling is
126 * not available. This extra is for device level support, {@link
127 * android.telephony.CarrierConfigManager#KEY_ALLOW_VIDEO_CALLING_FALLBACK_BOOL} should also
128 * be checked to ensure it is not disabled by individual carrier.
129 *
130 * @hide
131 */
132 public static final String EXTRA_SUPPORTS_VIDEO_CALLING_FALLBACK =
133 "android.telecom.extra.SUPPORTS_VIDEO_CALLING_FALLBACK";
134
135 /**
136 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
Tyler Gunn8bf76572017-04-06 15:30:08 -0700137 * indicates whether this {@link PhoneAccount} is capable of supporting a request to handover a
138 * connection from this {@link PhoneAccount} to another {@link PhoneAccount}.
Sanket Padawea8eddd42017-11-03 11:07:35 -0700139 * (see {@code android.telecom.Call#handoverTo()}) which specifies
Tyler Gunn8bf76572017-04-06 15:30:08 -0700140 * {@link #EXTRA_SUPPORTS_HANDOVER_TO}.
141 * <p>
142 * A handover request is initiated by the user from the default dialer app to indicate a desire
143 * to handover a call from one {@link PhoneAccount}/{@link ConnectionService} to another.
Tyler Gunn8bf76572017-04-06 15:30:08 -0700144 */
145 public static final String EXTRA_SUPPORTS_HANDOVER_FROM =
146 "android.telecom.extra.SUPPORTS_HANDOVER_FROM";
147
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700148
149 /**
150 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
151 * indicates whether a Self-Managed {@link PhoneAccount} should log its calls to the call log.
Brad Ebingerbb1a55f2017-06-26 13:26:14 -0700152 * Self-Managed {@link PhoneAccount}s are responsible for their own notifications, so the system
153 * will not create a notification when a missed call is logged.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700154 * <p>
155 * By default, Self-Managed {@link PhoneAccount}s do not log their calls to the call log.
156 * Setting this extra to {@code true} provides a means for them to log their calls.
Tyler Gunn2155c4c2018-04-05 09:43:41 -0700157 * <p>
158 * Note: Only calls where the {@link Call.Details#getHandle()} {@link Uri#getScheme()} is
159 * {@link #SCHEME_SIP} or {@link #SCHEME_TEL} will be logged at the current time.
Tyler Gunn9f6f0472017-04-17 18:25:22 -0700160 */
161 public static final String EXTRA_LOG_SELF_MANAGED_CALLS =
162 "android.telecom.extra.LOG_SELF_MANAGED_CALLS";
163
Tyler Gunn8bf76572017-04-06 15:30:08 -0700164 /**
Tyler Gunnacdb6862018-01-29 14:30:52 -0800165 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
166 * indicates whether calls for a {@link PhoneAccount} should generate a "call recording tone"
167 * when the user is recording audio on the device.
168 * <p>
169 * The call recording tone is played over the telephony audio stream so that the remote party
170 * has an audible indication that it is possible their call is being recorded using a call
171 * recording app on the device.
172 * <p>
173 * This extra only has an effect for calls placed via Telephony (e.g.
174 * {@link #CAPABILITY_SIM_SUBSCRIPTION}).
175 * <p>
176 * The call recording tone is a 1400 hz tone which repeats every 15 seconds while recording is
177 * in progress.
178 * @hide
179 */
Hall Liu2ef04112020-09-14 18:34:10 -0700180 @SystemApi
Tyler Gunnacdb6862018-01-29 14:30:52 -0800181 public static final String EXTRA_PLAY_CALL_RECORDING_TONE =
182 "android.telecom.extra.PLAY_CALL_RECORDING_TONE";
183
184 /**
Sean Kelley4d3c1782018-05-22 14:35:27 -0700185 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()} which
186 * indicates whether calls for a {@link PhoneAccount} should skip call filtering.
187 * <p>
188 * If not specified, this will default to false; all calls will undergo call filtering unless
189 * specifically exempted (e.g. {@link Connection#PROPERTY_EMERGENCY_CALLBACK_MODE}.) However,
190 * this may be used to skip call filtering when it has already been performed on another device.
191 * @hide
192 */
193 public static final String EXTRA_SKIP_CALL_FILTERING =
194 "android.telecom.extra.SKIP_CALL_FILTERING";
195
196 /**
Grace Jiae99fde92021-01-19 14:58:01 -0800197 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
198 * indicates whether a Self-managed {@link PhoneAccount} want to expose its calls to all
199 * {@link InCallService} which declares the metadata
200 * {@link TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS}.
201 */
202 public static final String EXTRA_ADD_SELF_MANAGED_CALLS_TO_INCALLSERVICE =
203 "android.telecom.extra.ADD_SELF_MANAGED_CALLS_TO_INCALLSERVICE";
204
205 /**
Ihab Awadf8b69882014-07-25 15:14:01 -0700206 * Flag indicating that this {@code PhoneAccount} can act as a connection manager for
207 * other connections. The {@link ConnectionService} associated with this {@code PhoneAccount}
208 * will be allowed to manage phone calls including using its own proprietary phone-call
209 * implementation (like VoIP calling) to make calls instead of the telephony stack.
210 * <p>
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700211 * When a user opts to place a call using the SIM-based telephony stack, the
212 * {@link ConnectionService} associated with this {@code PhoneAccount} will be attempted first
213 * if the user has explicitly selected it to be used as the default connection manager.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700214 * <p>
215 * See {@link #getCapabilities}
216 */
Ihab Awadf8b69882014-07-25 15:14:01 -0700217 public static final int CAPABILITY_CONNECTION_MANAGER = 0x1;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700218
219 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700220 * Flag indicating that this {@code PhoneAccount} can make phone calls in place of
Evan Charlton6eb262c2014-07-19 18:18:19 -0700221 * traditional SIM-based telephony calls. This account will be treated as a distinct method
222 * for placing calls alongside the traditional SIM-based telephony stack. This flag is
Ihab Awadf8b69882014-07-25 15:14:01 -0700223 * distinct from {@link #CAPABILITY_CONNECTION_MANAGER} in that it is not allowed to manage
Santos Cordon32c65a52014-10-27 14:57:49 -0700224 * or place calls from the built-in telephony stack.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700225 * <p>
226 * See {@link #getCapabilities}
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700227 * <p>
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700228 */
229 public static final int CAPABILITY_CALL_PROVIDER = 0x2;
230
Ihab Awad7522bbd62014-07-18 15:53:17 -0700231 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700232 * Flag indicating that this {@code PhoneAccount} represents a built-in PSTN SIM
Evan Charlton6eb262c2014-07-19 18:18:19 -0700233 * subscription.
Ihab Awad7522bbd62014-07-18 15:53:17 -0700234 * <p>
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700235 * Only the Android framework can register a {@code PhoneAccount} having this capability.
236 * <p>
237 * See {@link #getCapabilities}
Ihab Awad7522bbd62014-07-18 15:53:17 -0700238 */
239 public static final int CAPABILITY_SIM_SUBSCRIPTION = 0x4;
240
Ihab Awadf8b69882014-07-25 15:14:01 -0700241 /**
Tyler Gunn58cbd7a2016-11-11 11:31:28 -0800242 * Flag indicating that this {@code PhoneAccount} is currently able to place video calls.
243 * <p>
244 * See also {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING} which indicates whether the
245 * {@code PhoneAccount} supports placing video calls.
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700246 * <p>
247 * See {@link #getCapabilities}
Ihab Awadf8b69882014-07-25 15:14:01 -0700248 */
249 public static final int CAPABILITY_VIDEO_CALLING = 0x8;
250
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700251 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700252 * Flag indicating that this {@code PhoneAccount} is capable of placing emergency calls.
253 * By default all PSTN {@code PhoneAccount}s are capable of placing emergency calls.
254 * <p>
255 * See {@link #getCapabilities}
256 */
257 public static final int CAPABILITY_PLACE_EMERGENCY_CALLS = 0x10;
258
259 /**
Evan Charlton134dd682014-11-25 14:12:57 -0800260 * Flag indicating that this {@code PhoneAccount} is capable of being used by all users. This
261 * should only be used by system apps (and will be ignored for all other apps trying to use it).
262 * <p>
263 * See {@link #getCapabilities}
264 * @hide
265 */
Brian Attwellad147f42014-12-19 11:37:16 -0800266 @SystemApi
Evan Charlton134dd682014-11-25 14:12:57 -0800267 public static final int CAPABILITY_MULTI_USER = 0x20;
268
269 /**
Tyler Gunn65a3d342015-07-27 16:06:16 -0700270 * Flag indicating that this {@code PhoneAccount} supports a subject for Calls. This means a
271 * caller is able to specify a short subject line for an outgoing call. A capable receiving
272 * device displays the call subject on the incoming call screen.
273 * <p>
274 * See {@link #getCapabilities}
275 */
276 public static final int CAPABILITY_CALL_SUBJECT = 0x40;
277
278 /**
Bryce Leeb96d89c2015-10-14 16:48:40 -0700279 * Flag indicating that this {@code PhoneAccount} should only be used for emergency calls.
280 * <p>
281 * See {@link #getCapabilities}
282 * @hide
283 */
Hall Liu2ef04112020-09-14 18:34:10 -0700284 @SystemApi
Bryce Leeb96d89c2015-10-14 16:48:40 -0700285 public static final int CAPABILITY_EMERGENCY_CALLS_ONLY = 0x80;
286
287 /**
Tyler Gunn9a365752015-12-09 15:00:18 -0800288 * Flag indicating that for this {@code PhoneAccount}, the ability to make a video call to a
289 * number relies on presence. Should only be set if the {@code PhoneAccount} also has
290 * {@link #CAPABILITY_VIDEO_CALLING}.
291 * <p>
Brad Ebinger722cacf2021-05-14 01:53:56 +0000292 * Note: As of Android 12, using the
Tyler Gunn9a365752015-12-09 15:00:18 -0800293 * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE_VT_CAPABLE} bit on the
294 * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE} column to indicate whether
Brad Ebinger722cacf2021-05-14 01:53:56 +0000295 * a contact's phone number supports video calling has been deprecated and should only be used
296 * on devices where {@link CarrierConfigManager#KEY_USE_RCS_PRESENCE_BOOL} is set. On newer
297 * devices, applications must use {@link android.telephony.ims.RcsUceAdapter} instead to
298 * determine whether or not a contact's phone number supports carrier video calling.
Tyler Gunn9a365752015-12-09 15:00:18 -0800299 * <p>
300 * See {@link #getCapabilities}
301 */
302 public static final int CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE = 0x100;
303
304 /**
Tyler Gunncee9ea62016-03-24 11:45:43 -0700305 * Flag indicating that for this {@link PhoneAccount}, emergency video calling is allowed.
306 * <p>
307 * When set, Telecom will allow emergency video calls to be placed. When not set, Telecom will
308 * convert all outgoing video calls to emergency numbers to audio-only.
309 * @hide
310 */
Hall Liu2ef04112020-09-14 18:34:10 -0700311 @SystemApi
Tyler Gunncee9ea62016-03-24 11:45:43 -0700312 public static final int CAPABILITY_EMERGENCY_VIDEO_CALLING = 0x200;
313
314 /**
Tyler Gunn58cbd7a2016-11-11 11:31:28 -0800315 * Flag indicating that this {@link PhoneAccount} supports video calling.
316 * This is not an indication that the {@link PhoneAccount} is currently able to make a video
317 * call, but rather that it has the ability to make video calls (but not necessarily at this
318 * time).
319 * <p>
320 * Whether a {@link PhoneAccount} can make a video call is ultimately controlled by
321 * {@link #CAPABILITY_VIDEO_CALLING}, which indicates whether the {@link PhoneAccount} is
322 * currently capable of making a video call. Consider a case where, for example, a
323 * {@link PhoneAccount} supports making video calls (e.g.
324 * {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING}), but a current lack of network connectivity
325 * prevents video calls from being made (e.g. {@link #CAPABILITY_VIDEO_CALLING}).
326 * <p>
327 * See {@link #getCapabilities}
328 */
329 public static final int CAPABILITY_SUPPORTS_VIDEO_CALLING = 0x400;
330
331 /**
Tyler Gunnf5035432017-01-09 09:43:12 -0800332 * Flag indicating that this {@link PhoneAccount} is responsible for managing its own
333 * {@link Connection}s. This type of {@link PhoneAccount} is ideal for use with standalone
334 * calling apps which do not wish to use the default phone app for {@link Connection} UX,
335 * but which want to leverage the call and audio routing capabilities of the Telecom framework.
336 * <p>
337 * When set, {@link Connection}s created by the self-managed {@link ConnectionService} will not
338 * be surfaced to implementations of the {@link InCallService} API. Thus it is the
339 * responsibility of a self-managed {@link ConnectionService} to provide a user interface for
340 * its {@link Connection}s.
341 * <p>
342 * Self-managed {@link Connection}s will, however, be displayed on connected Bluetooth devices.
343 */
344 public static final int CAPABILITY_SELF_MANAGED = 0x800;
345
346 /**
Hall Liu95d55872017-01-25 17:12:49 -0800347 * Flag indicating that this {@link PhoneAccount} is capable of making a call with an
348 * RTT (Real-time text) session.
349 * When set, Telecom will attempt to open an RTT session on outgoing calls that specify
350 * that they should be placed with an RTT session , and the in-call app will be displayed
351 * with text entry fields for RTT. Likewise, the in-call app can request that an RTT
352 * session be opened during a call if this bit is set.
353 */
354 public static final int CAPABILITY_RTT = 0x1000;
355
Brad Ebinger3636d742019-05-21 15:28:19 -0700356 /**
357 * Flag indicating that this {@link PhoneAccount} is the preferred SIM subscription for
Hall Liu2ef04112020-09-14 18:34:10 -0700358 * emergency calls. A {@link PhoneAccount} that sets this capability must also
Brad Ebinger3636d742019-05-21 15:28:19 -0700359 * set the {@link #CAPABILITY_SIM_SUBSCRIPTION} and {@link #CAPABILITY_PLACE_EMERGENCY_CALLS}
Hall Liu2ef04112020-09-14 18:34:10 -0700360 * capabilities. There must only be one emergency preferred {@link PhoneAccount} on the device.
Brad Ebinger3636d742019-05-21 15:28:19 -0700361 * <p>
362 * When set, Telecom will prefer this {@link PhoneAccount} over others for emergency calling,
363 * even if the emergency call was placed with a specific {@link PhoneAccount} set using the
364 * extra{@link TelecomManager#EXTRA_PHONE_ACCOUNT_HANDLE} in
365 * {@link Intent#ACTION_CALL_EMERGENCY} or {@link TelecomManager#placeCall(Uri, Bundle)}.
366 *
367 * @hide
368 */
Hall Liu2ef04112020-09-14 18:34:10 -0700369 @SystemApi
Brad Ebinger3636d742019-05-21 15:28:19 -0700370 public static final int CAPABILITY_EMERGENCY_PREFERRED = 0x2000;
371
Ravi Paluri80aa2142019-12-02 11:57:37 +0530372 /**
373 * An adhoc conference call is established by providing a list of addresses to
374 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
375 * {@link ConnectionService} is responsible for connecting all indicated participants
376 * to a conference simultaneously.
377 * This is in contrast to conferences formed by merging calls together (e.g. using
378 * {@link android.telecom.Call#mergeConference()}).
379 */
380 public static final int CAPABILITY_ADHOC_CONFERENCE_CALLING = 0x4000;
381
Shuo Qiand24aea32020-11-24 15:08:49 -0800382 /**
383 * Flag indicating whether this {@link PhoneAccount} is capable of supporting the call composer
384 * functionality for enriched calls.
385 */
386 public static final int CAPABILITY_CALL_COMPOSER = 0x8000;
387
Hunter Knepshield25265682022-01-19 02:25:06 -0800388 /**
389 * Flag indicating that this {@link PhoneAccount} provides SIM-based voice calls, potentially as
390 * an over-the-top solution such as wi-fi calling.
391 *
392 * <p>Similar to {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING}, this capability indicates this
393 * {@link PhoneAccount} has the ability to make voice calls (but not necessarily at this time).
394 * Whether this {@link PhoneAccount} can make a voice call is ultimately controlled by {@link
395 * #CAPABILITY_VOICE_CALLING_AVAILABLE}, which indicates whether this {@link PhoneAccount} is
396 * currently capable of making a voice call. Consider a case where, for example, a {@link
397 * PhoneAccount} supports making voice calls (e.g. {@link
398 * #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS}), but a current lack of network connectivity
399 * prevents voice calls from being made (e.g. {@link #CAPABILITY_VOICE_CALLING_AVAILABLE}).
400 *
401 * <p>In order to declare this capability, this {@link PhoneAccount} must also declare {@link
402 * #CAPABILITY_SIM_SUBSCRIPTION} or {@link #CAPABILITY_CONNECTION_MANAGER} and satisfy the
403 * associated requirements.
404 *
405 * @see #CAPABILITY_VOICE_CALLING_AVAILABLE
406 * @see #getCapabilities
407 */
408 public static final int CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS = 0x10000;
409
410 /**
411 * Flag indicating that this {@link PhoneAccount} is <em>currently</em> able to place SIM-based
412 * voice calls, similar to {@link #CAPABILITY_VIDEO_CALLING}.
413 *
414 * <p>See also {@link #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS}, which indicates whether
415 * the {@code PhoneAccount} supports placing SIM-based voice calls or not.
416 *
417 * <p>In order to declare this capability, this {@link PhoneAccount} must also declare {@link
418 * #CAPABILITY_SIM_SUBSCRIPTION} or {@link #CAPABILITY_CONNECTION_MANAGER} and satisfy the
419 * associated requirements.
420 *
421 * @see #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS
422 * @see #getCapabilities
423 */
424 public static final int CAPABILITY_VOICE_CALLING_AVAILABLE = 0x20000;
425
Thomas Stuart9bfb2432022-09-27 15:02:07 -0700426
427 /**
428 * Flag indicating that this {@link PhoneAccount} supports the use TelecomManager APIs that
429 * utilize {@link android.os.OutcomeReceiver}s or {@link java.util.function.Consumer}s.
430 * Be aware, if this capability is set, {@link #CAPABILITY_SELF_MANAGED} will be amended by
431 * Telecom when this {@link PhoneAccount} is registered via
432 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}.
433 *
434 * <p>
435 * {@link android.os.OutcomeReceiver}s and {@link java.util.function.Consumer}s represent
436 * transactional operations because the operation can succeed or fail. An app wishing to use
437 * transactional operations should define behavior for a successful and failed TelecomManager
438 * API call.
439 *
440 * @see #CAPABILITY_SELF_MANAGED
441 * @see #getCapabilities
442 */
443 public static final int CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS = 0x40000;
444
Grace Jiaef5a4cc2022-12-13 11:08:55 -0800445 /**
446 * Flag indicating that this voip app {@link PhoneAccount} supports the call streaming session
447 * to stream call audio to another remote device via streaming app.
448 *
449 * @see #getCapabilities
450 */
451 public static final int CAPABILITY_SUPPORTS_CALL_STREAMING = 0x80000;
452
453 /* NEXT CAPABILITY: [0x100000, 0x200000, 0x400000] */
Hall Liu95d55872017-01-25 17:12:49 -0800454
455 /**
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700456 * URI scheme for telephone number URIs.
457 */
458 public static final String SCHEME_TEL = "tel";
459
460 /**
461 * URI scheme for voicemail URIs.
462 */
463 public static final String SCHEME_VOICEMAIL = "voicemail";
464
465 /**
466 * URI scheme for SIP URIs.
467 */
468 public static final String SCHEME_SIP = "sip";
469
Nancy Chen3ace54b2014-10-22 17:45:26 -0700470 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800471 * Indicating no icon tint is set.
Santos Cordoncad84a22015-05-13 11:17:25 -0700472 * @hide
Nancy Chen3ace54b2014-10-22 17:45:26 -0700473 */
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800474 public static final int NO_ICON_TINT = 0;
475
476 /**
477 * Indicating no hightlight color is set.
478 */
479 public static final int NO_HIGHLIGHT_COLOR = 0;
Nancy Chen3ace54b2014-10-22 17:45:26 -0700480
Ihab Awad476cc832014-11-03 09:47:51 -0800481 /**
482 * Indicating no resource ID is set.
483 */
484 public static final int NO_RESOURCE_ID = -1;
485
Evan Charlton8c8a0622014-07-20 12:31:00 -0700486 private final PhoneAccountHandle mAccountHandle;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700487 private final Uri mAddress;
488 private final Uri mSubscriptionAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700489 private final int mCapabilities;
Ihab Awad476cc832014-11-03 09:47:51 -0800490 private final int mHighlightColor;
Santos Cordon146a3e32014-07-21 00:00:44 -0700491 private final CharSequence mLabel;
492 private final CharSequence mShortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700493 private final List<String> mSupportedUriSchemes;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800494 private final int mSupportedAudioRoutes;
Santos Cordoncad84a22015-05-13 11:17:25 -0700495 private final Icon mIcon;
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700496 private final Bundle mExtras;
Santos Cordon91371dc02015-05-08 13:52:09 -0700497 private boolean mIsEnabled;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700498 private String mGroupId;
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800499 private final Set<PhoneAccountHandle> mSimultaneousCallingRestriction;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700500
Tyler Gunn3b347812018-08-24 14:17:05 -0700501 @Override
502 public boolean equals(Object o) {
503 if (this == o) return true;
504 if (o == null || getClass() != o.getClass()) return false;
505 PhoneAccount that = (PhoneAccount) o;
506 return mCapabilities == that.mCapabilities &&
507 mHighlightColor == that.mHighlightColor &&
508 mSupportedAudioRoutes == that.mSupportedAudioRoutes &&
509 mIsEnabled == that.mIsEnabled &&
510 Objects.equals(mAccountHandle, that.mAccountHandle) &&
511 Objects.equals(mAddress, that.mAddress) &&
512 Objects.equals(mSubscriptionAddress, that.mSubscriptionAddress) &&
513 Objects.equals(mLabel, that.mLabel) &&
514 Objects.equals(mShortDescription, that.mShortDescription) &&
515 Objects.equals(mSupportedUriSchemes, that.mSupportedUriSchemes) &&
516 areBundlesEqual(mExtras, that.mExtras) &&
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800517 Objects.equals(mGroupId, that.mGroupId)
518 && Objects.equals(mSimultaneousCallingRestriction,
519 that.mSimultaneousCallingRestriction);
Tyler Gunn3b347812018-08-24 14:17:05 -0700520 }
521
522 @Override
523 public int hashCode() {
524 return Objects.hash(mAccountHandle, mAddress, mSubscriptionAddress, mCapabilities,
525 mHighlightColor, mLabel, mShortDescription, mSupportedUriSchemes,
526 mSupportedAudioRoutes,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800527 mExtras, mIsEnabled, mGroupId, mSimultaneousCallingRestriction);
Tyler Gunn3b347812018-08-24 14:17:05 -0700528 }
529
Santos Cordon32c65a52014-10-27 14:57:49 -0700530 /**
531 * Helper class for creating a {@link PhoneAccount}.
532 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700533 public static class Builder {
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800534
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700535 private PhoneAccountHandle mAccountHandle;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700536 private Uri mAddress;
537 private Uri mSubscriptionAddress;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700538 private int mCapabilities;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800539 private int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800540 private int mHighlightColor = NO_HIGHLIGHT_COLOR;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700541 private CharSequence mLabel;
542 private CharSequence mShortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700543 private List<String> mSupportedUriSchemes = new ArrayList<String>();
Santos Cordoncad84a22015-05-13 11:17:25 -0700544 private Icon mIcon;
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700545 private Bundle mExtras;
Santos Cordon91371dc02015-05-08 13:52:09 -0700546 private boolean mIsEnabled = false;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700547 private String mGroupId = "";
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800548 private Set<PhoneAccountHandle> mSimultaneousCallingRestriction = null;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700549
Santos Cordon32c65a52014-10-27 14:57:49 -0700550 /**
551 * Creates a builder with the specified {@link PhoneAccountHandle} and label.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800552 * <p>
553 * Note: each CharSequence or String field is limited to 256 characters. This check is
554 * enforced when registering the PhoneAccount via
555 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
556 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700557 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700558 public Builder(PhoneAccountHandle accountHandle, CharSequence label) {
559 this.mAccountHandle = accountHandle;
560 this.mLabel = label;
561 }
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700562
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700563 /**
564 * Creates an instance of the {@link PhoneAccount.Builder} from an existing
565 * {@link PhoneAccount}.
566 *
567 * @param phoneAccount The {@link PhoneAccount} used to initialize the builder.
568 */
569 public Builder(PhoneAccount phoneAccount) {
570 mAccountHandle = phoneAccount.getAccountHandle();
571 mAddress = phoneAccount.getAddress();
572 mSubscriptionAddress = phoneAccount.getSubscriptionAddress();
573 mCapabilities = phoneAccount.getCapabilities();
Ihab Awad476cc832014-11-03 09:47:51 -0800574 mHighlightColor = phoneAccount.getHighlightColor();
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700575 mLabel = phoneAccount.getLabel();
576 mShortDescription = phoneAccount.getShortDescription();
577 mSupportedUriSchemes.addAll(phoneAccount.getSupportedUriSchemes());
Santos Cordoncad84a22015-05-13 11:17:25 -0700578 mIcon = phoneAccount.getIcon();
Santos Cordon91371dc02015-05-08 13:52:09 -0700579 mIsEnabled = phoneAccount.isEnabled();
Tyler Gunnd426b202015-10-13 13:33:53 -0700580 mExtras = phoneAccount.getExtras();
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700581 mGroupId = phoneAccount.getGroupId();
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800582 mSupportedAudioRoutes = phoneAccount.getSupportedAudioRoutes();
Brad Ebingerad37ddc2024-01-22 12:34:02 -0800583 if (phoneAccount.hasSimultaneousCallingRestriction()) {
584 mSimultaneousCallingRestriction = phoneAccount.getSimultaneousCallingRestriction();
585 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700586 }
587
Santos Cordon32c65a52014-10-27 14:57:49 -0700588 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700589 * Sets the label. See {@link PhoneAccount#getLabel()}.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800590 * <p>
591 * Note: Each CharSequence or String field is limited to 256 characters. This check is
592 * enforced when registering the PhoneAccount via
593 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
594 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Tyler Gunn37653562017-03-13 18:15:15 -0700595 *
596 * @param label The label of the phone account.
597 * @return The builder.
598 * @hide
599 */
600 public Builder setLabel(CharSequence label) {
601 this.mLabel = label;
602 return this;
603 }
604
605 /**
Santos Cordon32c65a52014-10-27 14:57:49 -0700606 * Sets the address. See {@link PhoneAccount#getAddress}.
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800607 * <p>
608 * Note: The entire URI value is limited to 256 characters. This check is
609 * enforced when registering the PhoneAccount via
610 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
611 * {@link IllegalArgumentException} to be thrown if URI is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700612 *
613 * @param value The address of the phone account.
614 * @return The builder.
615 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700616 public Builder setAddress(Uri value) {
617 this.mAddress = value;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700618 return this;
619 }
620
Santos Cordon32c65a52014-10-27 14:57:49 -0700621 /**
622 * Sets the subscription address. See {@link PhoneAccount#getSubscriptionAddress}.
623 *
624 * @param value The subscription address.
625 * @return The builder.
626 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700627 public Builder setSubscriptionAddress(Uri value) {
628 this.mSubscriptionAddress = value;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700629 return this;
630 }
631
Santos Cordon32c65a52014-10-27 14:57:49 -0700632 /**
633 * Sets the capabilities. See {@link PhoneAccount#getCapabilities}.
634 *
635 * @param value The capabilities to set.
636 * @return The builder.
637 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700638 public Builder setCapabilities(int value) {
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700639 this.mCapabilities = value;
640 return this;
641 }
642
Santos Cordon32c65a52014-10-27 14:57:49 -0700643 /**
Santos Cordoncad84a22015-05-13 11:17:25 -0700644 * Sets the icon. See {@link PhoneAccount#getIcon}.
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800645 * <p>
646 * Note: An {@link IllegalArgumentException} if the Icon cannot be written to memory.
647 * This check is enforced when registering the PhoneAccount via
648 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}
Santos Cordon32c65a52014-10-27 14:57:49 -0700649 *
Santos Cordoncad84a22015-05-13 11:17:25 -0700650 * @param icon The icon to set.
Santos Cordon32c65a52014-10-27 14:57:49 -0700651 */
Santos Cordoncad84a22015-05-13 11:17:25 -0700652 public Builder setIcon(Icon icon) {
653 mIcon = icon;
Ihab Awad074bf102014-10-24 11:42:32 -0700654 return this;
655 }
656
657 /**
Ihab Awad476cc832014-11-03 09:47:51 -0800658 * Sets the highlight color. See {@link PhoneAccount#getHighlightColor}.
Ihab Awad074bf102014-10-24 11:42:32 -0700659 *
Ihab Awad476cc832014-11-03 09:47:51 -0800660 * @param value The highlight color.
Ihab Awad074bf102014-10-24 11:42:32 -0700661 * @return The builder.
662 */
Ihab Awad476cc832014-11-03 09:47:51 -0800663 public Builder setHighlightColor(int value) {
664 this.mHighlightColor = value;
Nancy Chen3ace54b2014-10-22 17:45:26 -0700665 return this;
666 }
667
Santos Cordon32c65a52014-10-27 14:57:49 -0700668 /**
669 * Sets the short description. See {@link PhoneAccount#getShortDescription}.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800670 * <p>
671 * Note: Each CharSequence or String field is limited to 256 characters. This check is
672 * enforced when registering the PhoneAccount via
673 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
674 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700675 *
676 * @param value The short description.
677 * @return The builder.
678 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700679 public Builder setShortDescription(CharSequence value) {
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700680 this.mShortDescription = value;
681 return this;
682 }
683
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700684 /**
685 * Specifies an additional URI scheme supported by the {@link PhoneAccount}.
686 *
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800687 * <p>
688 * Each URI scheme is limited to 256 characters. Adding a scheme over 256 characters will
689 * cause an {@link IllegalArgumentException} to be thrown when the account is registered.
690 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700691 * @param uriScheme The URI scheme.
Santos Cordon32c65a52014-10-27 14:57:49 -0700692 * @return The builder.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700693 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700694 public Builder addSupportedUriScheme(String uriScheme) {
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700695 if (!TextUtils.isEmpty(uriScheme) && !mSupportedUriSchemes.contains(uriScheme)) {
696 this.mSupportedUriSchemes.add(uriScheme);
697 }
698 return this;
699 }
700
701 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -0700702 * Specifies the URI schemes supported by the {@link PhoneAccount}.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700703 *
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800704 * <p>
705 * A max of 10 URI schemes can be added per account. Additionally, each URI scheme is
706 * limited to 256 characters. Adding more than 10 URI schemes or 256 characters on any
707 * scheme will cause an {@link IllegalArgumentException} to be thrown when the account
708 * is registered.
709 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700710 * @param uriSchemes The URI schemes.
Santos Cordon32c65a52014-10-27 14:57:49 -0700711 * @return The builder.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700712 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700713 public Builder setSupportedUriSchemes(List<String> uriSchemes) {
714 mSupportedUriSchemes.clear();
715
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700716 if (uriSchemes != null && !uriSchemes.isEmpty()) {
717 for (String uriScheme : uriSchemes) {
Andrew Lee3085a6c2014-09-04 10:59:13 -0700718 addSupportedUriScheme(uriScheme);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700719 }
720 }
721 return this;
722 }
723
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700724 /**
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700725 * Specifies the extras associated with the {@link PhoneAccount}.
726 * <p>
727 * {@code PhoneAccount}s only support extra values of type: {@link String}, {@link Integer},
728 * and {@link Boolean}. Extras which are not of these types are ignored.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800729 * <p>
730 * Note: Each Bundle (Key, Value) String field is limited to 256 characters. Additionally,
731 * the bundle is limited to 100 (Key, Value) pairs total. This check is
732 * enforced when registering the PhoneAccount via
733 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
734 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256
735 * or more than 100 (Key, Value) pairs are in the Bundle.
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700736 *
737 * @param extras
738 * @return
739 */
740 public Builder setExtras(Bundle extras) {
741 mExtras = extras;
742 return this;
743 }
744
745 /**
Santos Cordon91371dc02015-05-08 13:52:09 -0700746 * Sets the enabled state of the phone account.
747 *
748 * @param isEnabled The enabled state.
749 * @return The builder.
750 * @hide
751 */
752 public Builder setIsEnabled(boolean isEnabled) {
753 mIsEnabled = isEnabled;
754 return this;
755 }
756
757 /**
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700758 * Sets the group Id of the {@link PhoneAccount}. When a new {@link PhoneAccount} is
759 * registered to Telecom, it will replace another {@link PhoneAccount} that is already
760 * registered in Telecom and take on the current user defaults and enabled status. There can
761 * only be one {@link PhoneAccount} with a non-empty group number registered to Telecom at a
762 * time. By default, there is no group Id for a {@link PhoneAccount} (an empty String). Only
763 * grouped {@link PhoneAccount}s with the same {@link ConnectionService} can be replaced.
Tyler Gunn5567d742019-10-31 13:04:37 -0700764 * <p>
Tyler Gunnc9503d62020-01-27 10:30:51 -0800765 * Note: This is an API specific to the Telephony stack; the group Id will be ignored for
766 * callers not holding the correct permission.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800767 * <p>
768 * Additionally, each CharSequence or String field is limited to 256 characters.
769 * This check is enforced when registering the PhoneAccount via
770 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
771 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Tyler Gunn5567d742019-10-31 13:04:37 -0700772 *
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700773 * @param groupId The group Id of the {@link PhoneAccount} that will replace any other
774 * registered {@link PhoneAccount} in Telecom with the same Group Id.
775 * @return The builder
776 * @hide
777 */
Tyler Gunn5567d742019-10-31 13:04:37 -0700778 @SystemApi
Tyler Gunnc9503d62020-01-27 10:30:51 -0800779 @RequiresPermission(MODIFY_PHONE_STATE)
Tyler Gunn5567d742019-10-31 13:04:37 -0700780 public @NonNull Builder setGroupId(@NonNull String groupId) {
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700781 if (groupId != null) {
782 mGroupId = groupId;
783 } else {
784 mGroupId = "";
785 }
786 return this;
787 }
788
789 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800790 * Sets the audio routes supported by this {@link PhoneAccount}.
791 *
792 * @param routes bit mask of available routes.
793 * @return The builder.
794 * @hide
795 */
796 public Builder setSupportedAudioRoutes(int routes) {
797 mSupportedAudioRoutes = routes;
798 return this;
799 }
800
801 /**
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800802 * Restricts the ability of this {@link PhoneAccount} to ONLY support simultaneous calling
803 * with the other {@link PhoneAccountHandle}s in this Set.
804 * <p>
805 * If two or more {@link PhoneAccount}s support calling simultaneously, it means that
806 * Telecom allows the user to place additional outgoing calls and receive additional
807 * incoming calls using other {@link PhoneAccount}s while this PhoneAccount also has one or
808 * more active calls.
809 * <p>
810 * If this setter method is never called or cleared using
811 * {@link #clearSimultaneousCallingRestriction()}, there is no restriction and all
812 * {@link PhoneAccount}s registered to Telecom by this package support simultaneous calling.
813 * <p>
814 * Note: Simultaneous calling restrictions can only be placed on {@link PhoneAccount}s that
815 * were registered by the same application. Simultaneous calling across applications is
816 * always possible as long as the {@link Connection} supports hold. If a
817 * {@link PhoneAccountHandle} is included here and the package name doesn't match this
818 * application's package name, {@link TelecomManager#registerPhoneAccount(PhoneAccount)}
819 * will throw a {@link SecurityException}.
820 *
821 * @param handles The other {@link PhoneAccountHandle}s that support calling simultaneously
Brad Ebinger516e7ab2024-01-19 15:31:57 -0800822 * with this one. Use {@link #clearSimultaneousCallingRestriction()} to remove the
823 * restriction and allow simultaneous calling to be supported across all
824 * {@link PhoneAccount}s registered by this package.
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800825 * @return The Builder used to set up the new PhoneAccount.
826 */
827 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
828 public @NonNull Builder setSimultaneousCallingRestriction(
829 @NonNull Set<PhoneAccountHandle> handles) {
830 if (handles == null) {
831 throw new IllegalArgumentException("the Set of PhoneAccountHandles must not be "
832 + "null");
833 }
834 mSimultaneousCallingRestriction = handles;
835 return this;
836 }
837
838 /**
839 * Clears a previously set simultaneous calling restriction set when
840 * {@link PhoneAccount.Builder#Builder(PhoneAccount)} is used to create a new PhoneAccount
841 * from an existing one.
842 *
843 * @return The Builder used to set up the new PhoneAccount.
844 * @see #setSimultaneousCallingRestriction(Set)
845 */
846 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
847 public @NonNull Builder clearSimultaneousCallingRestriction() {
848 mSimultaneousCallingRestriction = null;
849 return this;
850 }
851
852 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700853 * Creates an instance of a {@link PhoneAccount} based on the current builder settings.
854 *
855 * @return The {@link PhoneAccount}.
856 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700857 public PhoneAccount build() {
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700858 // If no supported URI schemes were defined, assume "tel" is supported.
859 if (mSupportedUriSchemes.isEmpty()) {
Andrew Lee3085a6c2014-09-04 10:59:13 -0700860 addSupportedUriScheme(SCHEME_TEL);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700861 }
862
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700863 return new PhoneAccount(
864 mAccountHandle,
Andrew Lee3085a6c2014-09-04 10:59:13 -0700865 mAddress,
866 mSubscriptionAddress,
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700867 mCapabilities,
Santos Cordoncad84a22015-05-13 11:17:25 -0700868 mIcon,
Ihab Awad476cc832014-11-03 09:47:51 -0800869 mHighlightColor,
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700870 mLabel,
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700871 mShortDescription,
Santos Cordon91371dc02015-05-08 13:52:09 -0700872 mSupportedUriSchemes,
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700873 mExtras,
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800874 mSupportedAudioRoutes,
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700875 mIsEnabled,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800876 mGroupId,
877 mSimultaneousCallingRestriction);
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700878 }
879 }
880
881 private PhoneAccount(
Evan Charlton6eb262c2014-07-19 18:18:19 -0700882 PhoneAccountHandle account,
Andrew Lee3085a6c2014-09-04 10:59:13 -0700883 Uri address,
884 Uri subscriptionAddress,
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700885 int capabilities,
Santos Cordoncad84a22015-05-13 11:17:25 -0700886 Icon icon,
Ihab Awad476cc832014-11-03 09:47:51 -0800887 int highlightColor,
Santos Cordon146a3e32014-07-21 00:00:44 -0700888 CharSequence label,
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700889 CharSequence shortDescription,
Santos Cordon91371dc02015-05-08 13:52:09 -0700890 List<String> supportedUriSchemes,
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700891 Bundle extras,
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800892 int supportedAudioRoutes,
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700893 boolean isEnabled,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800894 String groupId,
895 Set<PhoneAccountHandle> simultaneousCallingRestriction) {
Evan Charlton8c8a0622014-07-20 12:31:00 -0700896 mAccountHandle = account;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700897 mAddress = address;
898 mSubscriptionAddress = subscriptionAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700899 mCapabilities = capabilities;
Santos Cordoncad84a22015-05-13 11:17:25 -0700900 mIcon = icon;
Ihab Awad476cc832014-11-03 09:47:51 -0800901 mHighlightColor = highlightColor;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700902 mLabel = label;
903 mShortDescription = shortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700904 mSupportedUriSchemes = Collections.unmodifiableList(supportedUriSchemes);
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700905 mExtras = extras;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800906 mSupportedAudioRoutes = supportedAudioRoutes;
Santos Cordon91371dc02015-05-08 13:52:09 -0700907 mIsEnabled = isEnabled;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700908 mGroupId = groupId;
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800909 mSimultaneousCallingRestriction = simultaneousCallingRestriction;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700910 }
911
Andrew Lee3085a6c2014-09-04 10:59:13 -0700912 public static Builder builder(
913 PhoneAccountHandle accountHandle,
914 CharSequence label) {
915 return new Builder(accountHandle, label);
916 }
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700917
Ihab Awad807fe0a2014-07-09 12:30:52 -0700918 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700919 * Returns a builder initialized with the current {@link PhoneAccount} instance.
920 *
921 * @return The builder.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700922 */
923 public Builder toBuilder() { return new Builder(this); }
924
925 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700926 * The unique identifier of this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700927 *
Evan Charlton6eb262c2014-07-19 18:18:19 -0700928 * @return A {@code PhoneAccountHandle}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700929 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700930 public PhoneAccountHandle getAccountHandle() {
931 return mAccountHandle;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700932 }
933
934 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -0700935 * The address (e.g., a phone number) associated with this {@code PhoneAccount}. This
Evan Charlton8c8a0622014-07-20 12:31:00 -0700936 * represents the destination from which outgoing calls using this {@code PhoneAccount}
Evan Charlton6eb262c2014-07-19 18:18:19 -0700937 * will appear to come, if applicable, and the destination to which incoming calls using this
Evan Charlton8c8a0622014-07-20 12:31:00 -0700938 * {@code PhoneAccount} may be addressed.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700939 *
Andrew Lee3085a6c2014-09-04 10:59:13 -0700940 * @return A address expressed as a {@code Uri}, for example, a phone number.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700941 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700942 public Uri getAddress() {
943 return mAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700944 }
945
946 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700947 * The raw callback number used for this {@code PhoneAccount}, as distinct from
Andrew Lee3085a6c2014-09-04 10:59:13 -0700948 * {@link #getAddress()}. For the majority of {@code PhoneAccount}s this should be registered
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700949 * as {@code null}. It is used by the system for SIM-based {@code PhoneAccount} registration
Junda Liuf52ac902014-09-25 17:36:48 +0000950 * where {@link android.telephony.TelephonyManager#setLine1NumberForDisplay(String, String)}
951 * has been used to alter the callback number.
952 * <p>
Evan Charlton222db5252014-07-17 16:59:18 -0700953 *
954 * @return The subscription number, suitable for display to the user.
955 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700956 public Uri getSubscriptionAddress() {
957 return mSubscriptionAddress;
Evan Charlton222db5252014-07-17 16:59:18 -0700958 }
959
960 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700961 * The capabilities of this {@code PhoneAccount}.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700962 *
Evan Charlton8c8a0622014-07-20 12:31:00 -0700963 * @return A bit field of flags describing this {@code PhoneAccount}'s capabilities.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700964 */
965 public int getCapabilities() {
966 return mCapabilities;
967 }
968
969 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700970 * Determines if this {@code PhoneAccount} has a capabilities specified by the passed in
971 * bit mask.
972 *
973 * @param capability The capabilities to check.
Santos Cordon895d4b82015-06-25 16:41:48 -0700974 * @return {@code true} if the phone account has the capability.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700975 */
976 public boolean hasCapabilities(int capability) {
977 return (mCapabilities & capability) == capability;
978 }
979
980 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800981 * Determines if this {@code PhoneAccount} has routes specified by the passed in bit mask.
982 *
983 * @param route The routes to check.
984 * @return {@code true} if the phone account has the routes.
985 * @hide
986 */
987 public boolean hasAudioRoutes(int routes) {
988 return (mSupportedAudioRoutes & routes) == routes;
989 }
990
991 /**
Santos Cordon146a3e32014-07-21 00:00:44 -0700992 * A short label describing a {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700993 *
Evan Charlton8c8a0622014-07-20 12:31:00 -0700994 * @return A label for this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700995 */
Santos Cordon146a3e32014-07-21 00:00:44 -0700996 public CharSequence getLabel() {
Ihab Awad807fe0a2014-07-09 12:30:52 -0700997 return mLabel;
998 }
999
1000 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -07001001 * A short paragraph describing this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001002 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001003 * @return A description for this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001004 */
Santos Cordon146a3e32014-07-21 00:00:44 -07001005 public CharSequence getShortDescription() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001006 return mShortDescription;
1007 }
1008
1009 /**
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001010 * The URI schemes supported by this {@code PhoneAccount}.
1011 *
1012 * @return The URI schemes.
1013 */
1014 public List<String> getSupportedUriSchemes() {
1015 return mSupportedUriSchemes;
1016 }
1017
1018 /**
Tyler Gunn25ed2d72015-10-05 14:14:38 -07001019 * The extras associated with this {@code PhoneAccount}.
1020 * <p>
1021 * A {@link ConnectionService} may provide implementation specific information about the
1022 * {@link PhoneAccount} via the extras.
1023 *
1024 * @return The extras.
1025 */
1026 public Bundle getExtras() {
1027 return mExtras;
1028 }
1029
1030 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001031 * The audio routes supported by this {@code PhoneAccount}.
1032 *
1033 * @hide
1034 */
1035 public int getSupportedAudioRoutes() {
1036 return mSupportedAudioRoutes;
1037 }
1038
1039 /**
Santos Cordoncad84a22015-05-13 11:17:25 -07001040 * The icon to represent this {@code PhoneAccount}.
1041 *
1042 * @return The icon.
1043 */
1044 public Icon getIcon() {
1045 return mIcon;
1046 }
1047
1048 /**
Santos Cordon895d4b82015-06-25 16:41:48 -07001049 * Indicates whether the user has enabled this {@code PhoneAccount} or not. This value is only
1050 * populated for {@code PhoneAccount}s returned by {@link TelecomManager#getPhoneAccount}.
Santos Cordon91371dc02015-05-08 13:52:09 -07001051 *
Santos Cordon895d4b82015-06-25 16:41:48 -07001052 * @return {@code true} if the account is enabled by the user, {@code false} otherwise.
Santos Cordon91371dc02015-05-08 13:52:09 -07001053 */
1054 public boolean isEnabled() {
1055 return mIsEnabled;
1056 }
1057
1058 /**
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001059 * A non-empty {@link String} representing the group that A {@link PhoneAccount} is in or an
1060 * empty {@link String} if the {@link PhoneAccount} is not in a group. If this
1061 * {@link PhoneAccount} is in a group, this new {@link PhoneAccount} will replace a registered
1062 * {@link PhoneAccount} that is in the same group. When the {@link PhoneAccount} is replaced,
1063 * its user defined defaults and enabled status will also pass to this new {@link PhoneAccount}.
1064 * Only {@link PhoneAccount}s that share the same {@link ConnectionService} can be replaced.
1065 *
1066 * @return A non-empty String Id if this {@link PhoneAccount} belongs to a group.
1067 * @hide
1068 */
1069 public String getGroupId() {
1070 return mGroupId;
1071 }
1072
1073 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -07001074 * Determines if the {@link PhoneAccount} supports calls to/from addresses with a specified URI
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001075 * scheme.
1076 *
1077 * @param uriScheme The URI scheme to check.
Santos Cordon895d4b82015-06-25 16:41:48 -07001078 * @return {@code true} if the {@code PhoneAccount} supports calls to/from addresses with the
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001079 * specified URI scheme.
1080 */
1081 public boolean supportsUriScheme(String uriScheme) {
1082 if (mSupportedUriSchemes == null || uriScheme == null) {
1083 return false;
1084 }
1085
1086 for (String scheme : mSupportedUriSchemes) {
1087 if (scheme != null && scheme.equals(uriScheme)) {
1088 return true;
1089 }
1090 }
1091 return false;
1092 }
1093
1094 /**
Ihab Awad476cc832014-11-03 09:47:51 -08001095 * A highlight color to use in displaying information about this {@code PhoneAccount}.
1096 *
1097 * @return A hexadecimal color value.
1098 */
1099 public int getHighlightColor() {
1100 return mHighlightColor;
1101 }
1102
Santos Cordon91371dc02015-05-08 13:52:09 -07001103 /**
1104 * Sets the enabled state of the phone account.
1105 * @hide
1106 */
1107 public void setIsEnabled(boolean isEnabled) {
1108 mIsEnabled = isEnabled;
1109 }
1110
Tyler Gunnf5035432017-01-09 09:43:12 -08001111 /**
1112 * @return {@code true} if the {@link PhoneAccount} is self-managed, {@code false} otherwise.
1113 * @hide
1114 */
1115 public boolean isSelfManaged() {
1116 return (mCapabilities & CAPABILITY_SELF_MANAGED) == CAPABILITY_SELF_MANAGED;
1117 }
1118
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001119 /**
1120 * If a restriction is set (see {@link #hasSimultaneousCallingRestriction()}), this method
1121 * returns the Set of {@link PhoneAccountHandle}s that are allowed to support calls
1122 * simultaneously with this {@link PhoneAccount}.
1123 * <p>
1124 * If this {@link PhoneAccount} is busy with one or more ongoing calls, a restriction is set on
1125 * this PhoneAccount (see {@link #hasSimultaneousCallingRestriction()} to check), and a new
1126 * incoming or outgoing call is received or placed on a PhoneAccount that is not in this Set,
1127 * Telecom will reject or cancel the pending call in favor of keeping the ongoing call alive.
1128 * <p>
1129 * Note: Simultaneous calling restrictions can only be placed on {@link PhoneAccount}s that
1130 * were registered by the same application. Simultaneous calling across applications is
1131 * always possible as long as the {@link Connection} supports hold.
1132 *
1133 * @return the Set of {@link PhoneAccountHandle}s that this {@link PhoneAccount} supports
1134 * simultaneous calls with.
1135 * @throws IllegalStateException If there is no restriction set on this {@link PhoneAccount}
1136 * and this method is called. Whether or not there is a restriction can be checked using
1137 * {@link #hasSimultaneousCallingRestriction()}.
1138 */
1139 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
1140 public @NonNull Set<PhoneAccountHandle> getSimultaneousCallingRestriction() {
1141 if (mSimultaneousCallingRestriction == null) {
1142 throw new IllegalStateException("This method can not be called if there is no "
1143 + "simultaneous calling restriction. See #hasSimultaneousCallingRestriction");
1144 }
1145 return mSimultaneousCallingRestriction;
1146 }
1147
1148 /**
1149 * Whether or not this {@link PhoneAccount} contains a simultaneous calling restriction on it.
1150 *
1151 * @return {@code true} if this PhoneAccount contains a simultaneous calling restriction,
1152 * {@code false} if it does not. Use {@link #getSimultaneousCallingRestriction()} to query which
1153 * other {@link PhoneAccount}s support simultaneous calling with this one.
1154 * @see #getSimultaneousCallingRestriction() for more information on how the sinultaneous
1155 * calling restriction works.
1156 */
1157 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
1158 public boolean hasSimultaneousCallingRestriction() {
1159 return mSimultaneousCallingRestriction != null;
1160 }
1161
Ihab Awad807fe0a2014-07-09 12:30:52 -07001162 //
1163 // Parcelable implementation
1164 //
1165
1166 @Override
1167 public int describeContents() {
1168 return 0;
1169 }
1170
1171 @Override
1172 public void writeToParcel(Parcel out, int flags) {
Ihab Awad476cc832014-11-03 09:47:51 -08001173 if (mAccountHandle == null) {
1174 out.writeInt(0);
1175 } else {
1176 out.writeInt(1);
1177 mAccountHandle.writeToParcel(out, flags);
1178 }
1179 if (mAddress == null) {
1180 out.writeInt(0);
1181 } else {
1182 out.writeInt(1);
1183 mAddress.writeToParcel(out, flags);
1184 }
1185 if (mSubscriptionAddress == null) {
1186 out.writeInt(0);
1187 } else {
1188 out.writeInt(1);
1189 mSubscriptionAddress.writeToParcel(out, flags);
1190 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001191 out.writeInt(mCapabilities);
Ihab Awad476cc832014-11-03 09:47:51 -08001192 out.writeInt(mHighlightColor);
Santos Cordon146a3e32014-07-21 00:00:44 -07001193 out.writeCharSequence(mLabel);
1194 out.writeCharSequence(mShortDescription);
Ihab Awad476cc832014-11-03 09:47:51 -08001195 out.writeStringList(mSupportedUriSchemes);
Santos Cordon91371dc02015-05-08 13:52:09 -07001196
Santos Cordoncad84a22015-05-13 11:17:25 -07001197 if (mIcon == null) {
1198 out.writeInt(0);
1199 } else {
1200 out.writeInt(1);
1201 mIcon.writeToParcel(out, flags);
1202 }
Santos Cordon91371dc02015-05-08 13:52:09 -07001203 out.writeByte((byte) (mIsEnabled ? 1 : 0));
Tyler Gunnef829ec2015-10-08 09:46:23 -07001204 out.writeBundle(mExtras);
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001205 out.writeString(mGroupId);
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001206 out.writeInt(mSupportedAudioRoutes);
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001207 if (mSimultaneousCallingRestriction == null) {
1208 out.writeBoolean(false);
1209 } else {
1210 out.writeBoolean(true);
1211 out.writeTypedList(mSimultaneousCallingRestriction.stream().toList());
1212 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001213 }
1214
Jeff Sharkey9e8f83d2019-02-28 12:06:45 -07001215 public static final @android.annotation.NonNull Creator<PhoneAccount> CREATOR
Evan Charlton8c8a0622014-07-20 12:31:00 -07001216 = new Creator<PhoneAccount>() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001217 @Override
Evan Charlton8c8a0622014-07-20 12:31:00 -07001218 public PhoneAccount createFromParcel(Parcel in) {
1219 return new PhoneAccount(in);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001220 }
1221
1222 @Override
Evan Charlton8c8a0622014-07-20 12:31:00 -07001223 public PhoneAccount[] newArray(int size) {
1224 return new PhoneAccount[size];
Ihab Awad807fe0a2014-07-09 12:30:52 -07001225 }
1226 };
1227
Evan Charlton8c8a0622014-07-20 12:31:00 -07001228 private PhoneAccount(Parcel in) {
Ihab Awad476cc832014-11-03 09:47:51 -08001229 if (in.readInt() > 0) {
1230 mAccountHandle = PhoneAccountHandle.CREATOR.createFromParcel(in);
1231 } else {
1232 mAccountHandle = null;
1233 }
1234 if (in.readInt() > 0) {
1235 mAddress = Uri.CREATOR.createFromParcel(in);
1236 } else {
1237 mAddress = null;
1238 }
1239 if (in.readInt() > 0) {
1240 mSubscriptionAddress = Uri.CREATOR.createFromParcel(in);
1241 } else {
1242 mSubscriptionAddress = null;
1243 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001244 mCapabilities = in.readInt();
Ihab Awad476cc832014-11-03 09:47:51 -08001245 mHighlightColor = in.readInt();
Santos Cordon146a3e32014-07-21 00:00:44 -07001246 mLabel = in.readCharSequence();
1247 mShortDescription = in.readCharSequence();
Ihab Awad476cc832014-11-03 09:47:51 -08001248 mSupportedUriSchemes = Collections.unmodifiableList(in.createStringArrayList());
Santos Cordoncad84a22015-05-13 11:17:25 -07001249 if (in.readInt() > 0) {
1250 mIcon = Icon.CREATOR.createFromParcel(in);
1251 } else {
1252 mIcon = null;
1253 }
Santos Cordon91371dc02015-05-08 13:52:09 -07001254 mIsEnabled = in.readByte() == 1;
Tyler Gunnef829ec2015-10-08 09:46:23 -07001255 mExtras = in.readBundle();
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001256 mGroupId = in.readString();
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001257 mSupportedAudioRoutes = in.readInt();
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001258 if (in.readBoolean()) {
1259 List<PhoneAccountHandle> list = new ArrayList<>();
1260 in.readTypedList(list, PhoneAccountHandle.CREATOR);
1261 mSimultaneousCallingRestriction = new ArraySet<>(list);
1262 } else {
1263 mSimultaneousCallingRestriction = null;
1264 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001265 }
Tyler Gunn76c01a52014-09-30 14:47:51 -07001266
1267 @Override
1268 public String toString() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001269 StringBuilder sb = new StringBuilder().append("[[")
1270 .append(mIsEnabled ? 'X' : ' ')
1271 .append("] PhoneAccount: ")
Tyler Gunn76c01a52014-09-30 14:47:51 -07001272 .append(mAccountHandle)
1273 .append(" Capabilities: ")
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001274 .append(capabilitiesToString())
1275 .append(" Audio Routes: ")
1276 .append(audioRoutesToString())
Tyler Gunn76c01a52014-09-30 14:47:51 -07001277 .append(" Schemes: ");
1278 for (String scheme : mSupportedUriSchemes) {
1279 sb.append(scheme)
1280 .append(" ");
1281 }
Tyler Gunnef829ec2015-10-08 09:46:23 -07001282 sb.append(" Extras: ");
Tyler Gunn25ed2d72015-10-05 14:14:38 -07001283 sb.append(mExtras);
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001284 sb.append(" GroupId: ");
1285 sb.append(Log.pii(mGroupId));
Tyler Gunn76c01a52014-09-30 14:47:51 -07001286 sb.append("]");
1287 return sb.toString();
1288 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001289
1290 /**
1291 * Generates a string representation of a capabilities bitmask.
1292 *
Tyler Gunn3e122f72016-01-11 19:25:00 -08001293 * @return String representation of the capabilities bitmask.
Tyler Gunn1847b4e2018-11-09 08:43:02 -08001294 * @hide
Tyler Gunn3e122f72016-01-11 19:25:00 -08001295 */
Tyler Gunn1847b4e2018-11-09 08:43:02 -08001296 public String capabilitiesToString() {
Tyler Gunn3e122f72016-01-11 19:25:00 -08001297 StringBuilder sb = new StringBuilder();
Tyler Gunnf5035432017-01-09 09:43:12 -08001298 if (hasCapabilities(CAPABILITY_SELF_MANAGED)) {
1299 sb.append("SelfManaged ");
1300 }
Tyler Gunn58cbd7a2016-11-11 11:31:28 -08001301 if (hasCapabilities(CAPABILITY_SUPPORTS_VIDEO_CALLING)) {
1302 sb.append("SuppVideo ");
1303 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001304 if (hasCapabilities(CAPABILITY_VIDEO_CALLING)) {
1305 sb.append("Video ");
1306 }
1307 if (hasCapabilities(CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE)) {
1308 sb.append("Presence ");
1309 }
1310 if (hasCapabilities(CAPABILITY_CALL_PROVIDER)) {
1311 sb.append("CallProvider ");
1312 }
1313 if (hasCapabilities(CAPABILITY_CALL_SUBJECT)) {
1314 sb.append("CallSubject ");
1315 }
1316 if (hasCapabilities(CAPABILITY_CONNECTION_MANAGER)) {
1317 sb.append("ConnectionMgr ");
1318 }
1319 if (hasCapabilities(CAPABILITY_EMERGENCY_CALLS_ONLY)) {
1320 sb.append("EmergOnly ");
1321 }
1322 if (hasCapabilities(CAPABILITY_MULTI_USER)) {
1323 sb.append("MultiUser ");
1324 }
1325 if (hasCapabilities(CAPABILITY_PLACE_EMERGENCY_CALLS)) {
1326 sb.append("PlaceEmerg ");
1327 }
Brad Ebinger3636d742019-05-21 15:28:19 -07001328 if (hasCapabilities(CAPABILITY_EMERGENCY_PREFERRED)) {
1329 sb.append("EmerPrefer ");
1330 }
Tyler Gunncee9ea62016-03-24 11:45:43 -07001331 if (hasCapabilities(CAPABILITY_EMERGENCY_VIDEO_CALLING)) {
1332 sb.append("EmergVideo ");
1333 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001334 if (hasCapabilities(CAPABILITY_SIM_SUBSCRIPTION)) {
1335 sb.append("SimSub ");
1336 }
Hall Liu47ed6202017-11-20 16:25:39 -08001337 if (hasCapabilities(CAPABILITY_RTT)) {
Hunter Knepshield25265682022-01-19 02:25:06 -08001338 sb.append("Rtt ");
Hall Liu47ed6202017-11-20 16:25:39 -08001339 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05301340 if (hasCapabilities(CAPABILITY_ADHOC_CONFERENCE_CALLING)) {
Hunter Knepshield25265682022-01-19 02:25:06 -08001341 sb.append("AdhocConf ");
Ravi Paluri80aa2142019-12-02 11:57:37 +05301342 }
Shuo Qiand24aea32020-11-24 15:08:49 -08001343 if (hasCapabilities(CAPABILITY_CALL_COMPOSER)) {
1344 sb.append("CallComposer ");
1345 }
Hunter Knepshield25265682022-01-19 02:25:06 -08001346 if (hasCapabilities(CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS)) {
1347 sb.append("SuppVoice ");
1348 }
1349 if (hasCapabilities(CAPABILITY_VOICE_CALLING_AVAILABLE)) {
1350 sb.append("Voice ");
1351 }
Thomas Stuart649bedd2023-02-23 15:48:31 -08001352 if (hasCapabilities(CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS)) {
1353 sb.append("TransactOps ");
1354 }
1355 if (hasCapabilities(CAPABILITY_SUPPORTS_CALL_STREAMING)) {
1356 sb.append("Stream ");
1357 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001358 return sb.toString();
1359 }
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001360
1361 private String audioRoutesToString() {
1362 StringBuilder sb = new StringBuilder();
1363
1364 if (hasAudioRoutes(CallAudioState.ROUTE_BLUETOOTH)) {
1365 sb.append("B");
1366 }
1367 if (hasAudioRoutes(CallAudioState.ROUTE_EARPIECE)) {
1368 sb.append("E");
1369 }
1370 if (hasAudioRoutes(CallAudioState.ROUTE_SPEAKER)) {
1371 sb.append("S");
1372 }
1373 if (hasAudioRoutes(CallAudioState.ROUTE_WIRED_HEADSET)) {
1374 sb.append("W");
1375 }
1376
1377 return sb.toString();
1378 }
Tyler Gunn3b347812018-08-24 14:17:05 -07001379
1380 /**
1381 * Determines if two {@link Bundle}s are equal.
1382 * @param extras First {@link Bundle} to check.
1383 * @param newExtras {@link Bundle} to compare against.
1384 * @return {@code true} if the {@link Bundle}s are equal, {@code false} otherwise.
1385 */
1386 private static boolean areBundlesEqual(Bundle extras, Bundle newExtras) {
1387 if (extras == null || newExtras == null) {
1388 return extras == newExtras;
1389 }
1390
1391 if (extras.size() != newExtras.size()) {
1392 return false;
1393 }
1394
1395 for(String key : extras.keySet()) {
1396 if (key != null) {
1397 final Object value = extras.get(key);
1398 final Object newValue = newExtras.get(key);
1399 if (!Objects.equals(value, newValue)) {
1400 return false;
1401 }
1402 }
1403 }
1404 return true;
1405 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001406}