blob: e6fe406dd8e5e6061bdd163fb433f6f08bee4b17 [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 */
Pranav Madapurmath9ad30392024-02-05 15:05:16 -0800193 @SystemApi
194 @FlaggedApi(com.android.server.telecom.flags.Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
Sean Kelley4d3c1782018-05-22 14:35:27 -0700195 public static final String EXTRA_SKIP_CALL_FILTERING =
196 "android.telecom.extra.SKIP_CALL_FILTERING";
197
198 /**
Grace Jiae99fde92021-01-19 14:58:01 -0800199 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
200 * indicates whether a Self-managed {@link PhoneAccount} want to expose its calls to all
201 * {@link InCallService} which declares the metadata
202 * {@link TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS}.
203 */
204 public static final String EXTRA_ADD_SELF_MANAGED_CALLS_TO_INCALLSERVICE =
205 "android.telecom.extra.ADD_SELF_MANAGED_CALLS_TO_INCALLSERVICE";
206
207 /**
Ihab Awadf8b69882014-07-25 15:14:01 -0700208 * Flag indicating that this {@code PhoneAccount} can act as a connection manager for
209 * other connections. The {@link ConnectionService} associated with this {@code PhoneAccount}
210 * will be allowed to manage phone calls including using its own proprietary phone-call
211 * implementation (like VoIP calling) to make calls instead of the telephony stack.
212 * <p>
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700213 * When a user opts to place a call using the SIM-based telephony stack, the
214 * {@link ConnectionService} associated with this {@code PhoneAccount} will be attempted first
215 * if the user has explicitly selected it to be used as the default connection manager.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700216 * <p>
217 * See {@link #getCapabilities}
218 */
Ihab Awadf8b69882014-07-25 15:14:01 -0700219 public static final int CAPABILITY_CONNECTION_MANAGER = 0x1;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700220
221 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700222 * Flag indicating that this {@code PhoneAccount} can make phone calls in place of
Evan Charlton6eb262c2014-07-19 18:18:19 -0700223 * traditional SIM-based telephony calls. This account will be treated as a distinct method
224 * for placing calls alongside the traditional SIM-based telephony stack. This flag is
Ihab Awadf8b69882014-07-25 15:14:01 -0700225 * distinct from {@link #CAPABILITY_CONNECTION_MANAGER} in that it is not allowed to manage
Santos Cordon32c65a52014-10-27 14:57:49 -0700226 * or place calls from the built-in telephony stack.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700227 * <p>
228 * See {@link #getCapabilities}
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700229 * <p>
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700230 */
231 public static final int CAPABILITY_CALL_PROVIDER = 0x2;
232
Ihab Awad7522bbd62014-07-18 15:53:17 -0700233 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700234 * Flag indicating that this {@code PhoneAccount} represents a built-in PSTN SIM
Evan Charlton6eb262c2014-07-19 18:18:19 -0700235 * subscription.
Ihab Awad7522bbd62014-07-18 15:53:17 -0700236 * <p>
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700237 * Only the Android framework can register a {@code PhoneAccount} having this capability.
238 * <p>
239 * See {@link #getCapabilities}
Ihab Awad7522bbd62014-07-18 15:53:17 -0700240 */
241 public static final int CAPABILITY_SIM_SUBSCRIPTION = 0x4;
242
Ihab Awadf8b69882014-07-25 15:14:01 -0700243 /**
Tyler Gunn58cbd7a2016-11-11 11:31:28 -0800244 * Flag indicating that this {@code PhoneAccount} is currently able to place video calls.
245 * <p>
246 * See also {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING} which indicates whether the
247 * {@code PhoneAccount} supports placing video calls.
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700248 * <p>
249 * See {@link #getCapabilities}
Ihab Awadf8b69882014-07-25 15:14:01 -0700250 */
251 public static final int CAPABILITY_VIDEO_CALLING = 0x8;
252
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700253 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700254 * Flag indicating that this {@code PhoneAccount} is capable of placing emergency calls.
255 * By default all PSTN {@code PhoneAccount}s are capable of placing emergency calls.
256 * <p>
257 * See {@link #getCapabilities}
258 */
259 public static final int CAPABILITY_PLACE_EMERGENCY_CALLS = 0x10;
260
261 /**
Evan Charlton134dd682014-11-25 14:12:57 -0800262 * Flag indicating that this {@code PhoneAccount} is capable of being used by all users. This
263 * should only be used by system apps (and will be ignored for all other apps trying to use it).
264 * <p>
265 * See {@link #getCapabilities}
266 * @hide
267 */
Brian Attwellad147f42014-12-19 11:37:16 -0800268 @SystemApi
Evan Charlton134dd682014-11-25 14:12:57 -0800269 public static final int CAPABILITY_MULTI_USER = 0x20;
270
271 /**
Tyler Gunn65a3d342015-07-27 16:06:16 -0700272 * Flag indicating that this {@code PhoneAccount} supports a subject for Calls. This means a
273 * caller is able to specify a short subject line for an outgoing call. A capable receiving
274 * device displays the call subject on the incoming call screen.
275 * <p>
276 * See {@link #getCapabilities}
277 */
278 public static final int CAPABILITY_CALL_SUBJECT = 0x40;
279
280 /**
Bryce Leeb96d89c2015-10-14 16:48:40 -0700281 * Flag indicating that this {@code PhoneAccount} should only be used for emergency calls.
282 * <p>
283 * See {@link #getCapabilities}
284 * @hide
285 */
Hall Liu2ef04112020-09-14 18:34:10 -0700286 @SystemApi
Bryce Leeb96d89c2015-10-14 16:48:40 -0700287 public static final int CAPABILITY_EMERGENCY_CALLS_ONLY = 0x80;
288
289 /**
Tyler Gunn9a365752015-12-09 15:00:18 -0800290 * Flag indicating that for this {@code PhoneAccount}, the ability to make a video call to a
291 * number relies on presence. Should only be set if the {@code PhoneAccount} also has
292 * {@link #CAPABILITY_VIDEO_CALLING}.
293 * <p>
Brad Ebinger722cacf2021-05-14 01:53:56 +0000294 * Note: As of Android 12, using the
Tyler Gunn9a365752015-12-09 15:00:18 -0800295 * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE_VT_CAPABLE} bit on the
296 * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE} column to indicate whether
Brad Ebinger722cacf2021-05-14 01:53:56 +0000297 * a contact's phone number supports video calling has been deprecated and should only be used
298 * on devices where {@link CarrierConfigManager#KEY_USE_RCS_PRESENCE_BOOL} is set. On newer
299 * devices, applications must use {@link android.telephony.ims.RcsUceAdapter} instead to
300 * determine whether or not a contact's phone number supports carrier video calling.
Tyler Gunn9a365752015-12-09 15:00:18 -0800301 * <p>
302 * See {@link #getCapabilities}
303 */
304 public static final int CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE = 0x100;
305
306 /**
Tyler Gunncee9ea62016-03-24 11:45:43 -0700307 * Flag indicating that for this {@link PhoneAccount}, emergency video calling is allowed.
308 * <p>
309 * When set, Telecom will allow emergency video calls to be placed. When not set, Telecom will
310 * convert all outgoing video calls to emergency numbers to audio-only.
311 * @hide
312 */
Hall Liu2ef04112020-09-14 18:34:10 -0700313 @SystemApi
Tyler Gunncee9ea62016-03-24 11:45:43 -0700314 public static final int CAPABILITY_EMERGENCY_VIDEO_CALLING = 0x200;
315
316 /**
Tyler Gunn58cbd7a2016-11-11 11:31:28 -0800317 * Flag indicating that this {@link PhoneAccount} supports video calling.
318 * This is not an indication that the {@link PhoneAccount} is currently able to make a video
319 * call, but rather that it has the ability to make video calls (but not necessarily at this
320 * time).
321 * <p>
322 * Whether a {@link PhoneAccount} can make a video call is ultimately controlled by
323 * {@link #CAPABILITY_VIDEO_CALLING}, which indicates whether the {@link PhoneAccount} is
324 * currently capable of making a video call. Consider a case where, for example, a
325 * {@link PhoneAccount} supports making video calls (e.g.
326 * {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING}), but a current lack of network connectivity
327 * prevents video calls from being made (e.g. {@link #CAPABILITY_VIDEO_CALLING}).
328 * <p>
329 * See {@link #getCapabilities}
330 */
331 public static final int CAPABILITY_SUPPORTS_VIDEO_CALLING = 0x400;
332
333 /**
Tyler Gunnf5035432017-01-09 09:43:12 -0800334 * Flag indicating that this {@link PhoneAccount} is responsible for managing its own
335 * {@link Connection}s. This type of {@link PhoneAccount} is ideal for use with standalone
336 * calling apps which do not wish to use the default phone app for {@link Connection} UX,
337 * but which want to leverage the call and audio routing capabilities of the Telecom framework.
338 * <p>
339 * When set, {@link Connection}s created by the self-managed {@link ConnectionService} will not
340 * be surfaced to implementations of the {@link InCallService} API. Thus it is the
341 * responsibility of a self-managed {@link ConnectionService} to provide a user interface for
342 * its {@link Connection}s.
343 * <p>
344 * Self-managed {@link Connection}s will, however, be displayed on connected Bluetooth devices.
345 */
346 public static final int CAPABILITY_SELF_MANAGED = 0x800;
347
348 /**
Hall Liu95d55872017-01-25 17:12:49 -0800349 * Flag indicating that this {@link PhoneAccount} is capable of making a call with an
350 * RTT (Real-time text) session.
351 * When set, Telecom will attempt to open an RTT session on outgoing calls that specify
352 * that they should be placed with an RTT session , and the in-call app will be displayed
353 * with text entry fields for RTT. Likewise, the in-call app can request that an RTT
354 * session be opened during a call if this bit is set.
355 */
356 public static final int CAPABILITY_RTT = 0x1000;
357
Brad Ebinger3636d742019-05-21 15:28:19 -0700358 /**
359 * Flag indicating that this {@link PhoneAccount} is the preferred SIM subscription for
Hall Liu2ef04112020-09-14 18:34:10 -0700360 * emergency calls. A {@link PhoneAccount} that sets this capability must also
Brad Ebinger3636d742019-05-21 15:28:19 -0700361 * set the {@link #CAPABILITY_SIM_SUBSCRIPTION} and {@link #CAPABILITY_PLACE_EMERGENCY_CALLS}
Hall Liu2ef04112020-09-14 18:34:10 -0700362 * capabilities. There must only be one emergency preferred {@link PhoneAccount} on the device.
Brad Ebinger3636d742019-05-21 15:28:19 -0700363 * <p>
364 * When set, Telecom will prefer this {@link PhoneAccount} over others for emergency calling,
365 * even if the emergency call was placed with a specific {@link PhoneAccount} set using the
366 * extra{@link TelecomManager#EXTRA_PHONE_ACCOUNT_HANDLE} in
367 * {@link Intent#ACTION_CALL_EMERGENCY} or {@link TelecomManager#placeCall(Uri, Bundle)}.
368 *
369 * @hide
370 */
Hall Liu2ef04112020-09-14 18:34:10 -0700371 @SystemApi
Brad Ebinger3636d742019-05-21 15:28:19 -0700372 public static final int CAPABILITY_EMERGENCY_PREFERRED = 0x2000;
373
Ravi Paluri80aa2142019-12-02 11:57:37 +0530374 /**
375 * An adhoc conference call is established by providing a list of addresses to
376 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
377 * {@link ConnectionService} is responsible for connecting all indicated participants
378 * to a conference simultaneously.
379 * This is in contrast to conferences formed by merging calls together (e.g. using
380 * {@link android.telecom.Call#mergeConference()}).
381 */
382 public static final int CAPABILITY_ADHOC_CONFERENCE_CALLING = 0x4000;
383
Shuo Qiand24aea32020-11-24 15:08:49 -0800384 /**
385 * Flag indicating whether this {@link PhoneAccount} is capable of supporting the call composer
386 * functionality for enriched calls.
387 */
388 public static final int CAPABILITY_CALL_COMPOSER = 0x8000;
389
Hunter Knepshield25265682022-01-19 02:25:06 -0800390 /**
391 * Flag indicating that this {@link PhoneAccount} provides SIM-based voice calls, potentially as
392 * an over-the-top solution such as wi-fi calling.
393 *
394 * <p>Similar to {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING}, this capability indicates this
395 * {@link PhoneAccount} has the ability to make voice calls (but not necessarily at this time).
396 * Whether this {@link PhoneAccount} can make a voice call is ultimately controlled by {@link
397 * #CAPABILITY_VOICE_CALLING_AVAILABLE}, which indicates whether this {@link PhoneAccount} is
398 * currently capable of making a voice call. Consider a case where, for example, a {@link
399 * PhoneAccount} supports making voice calls (e.g. {@link
400 * #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS}), but a current lack of network connectivity
401 * prevents voice calls from being made (e.g. {@link #CAPABILITY_VOICE_CALLING_AVAILABLE}).
402 *
403 * <p>In order to declare this capability, this {@link PhoneAccount} must also declare {@link
404 * #CAPABILITY_SIM_SUBSCRIPTION} or {@link #CAPABILITY_CONNECTION_MANAGER} and satisfy the
405 * associated requirements.
406 *
407 * @see #CAPABILITY_VOICE_CALLING_AVAILABLE
408 * @see #getCapabilities
409 */
410 public static final int CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS = 0x10000;
411
412 /**
413 * Flag indicating that this {@link PhoneAccount} is <em>currently</em> able to place SIM-based
414 * voice calls, similar to {@link #CAPABILITY_VIDEO_CALLING}.
415 *
416 * <p>See also {@link #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS}, which indicates whether
417 * the {@code PhoneAccount} supports placing SIM-based voice calls or not.
418 *
419 * <p>In order to declare this capability, this {@link PhoneAccount} must also declare {@link
420 * #CAPABILITY_SIM_SUBSCRIPTION} or {@link #CAPABILITY_CONNECTION_MANAGER} and satisfy the
421 * associated requirements.
422 *
423 * @see #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS
424 * @see #getCapabilities
425 */
426 public static final int CAPABILITY_VOICE_CALLING_AVAILABLE = 0x20000;
427
Thomas Stuart9bfb2432022-09-27 15:02:07 -0700428
429 /**
430 * Flag indicating that this {@link PhoneAccount} supports the use TelecomManager APIs that
431 * utilize {@link android.os.OutcomeReceiver}s or {@link java.util.function.Consumer}s.
432 * Be aware, if this capability is set, {@link #CAPABILITY_SELF_MANAGED} will be amended by
433 * Telecom when this {@link PhoneAccount} is registered via
434 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}.
435 *
436 * <p>
437 * {@link android.os.OutcomeReceiver}s and {@link java.util.function.Consumer}s represent
438 * transactional operations because the operation can succeed or fail. An app wishing to use
439 * transactional operations should define behavior for a successful and failed TelecomManager
440 * API call.
441 *
442 * @see #CAPABILITY_SELF_MANAGED
443 * @see #getCapabilities
444 */
445 public static final int CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS = 0x40000;
446
Grace Jiaef5a4cc2022-12-13 11:08:55 -0800447 /**
448 * Flag indicating that this voip app {@link PhoneAccount} supports the call streaming session
449 * to stream call audio to another remote device via streaming app.
450 *
451 * @see #getCapabilities
452 */
453 public static final int CAPABILITY_SUPPORTS_CALL_STREAMING = 0x80000;
454
455 /* NEXT CAPABILITY: [0x100000, 0x200000, 0x400000] */
Hall Liu95d55872017-01-25 17:12:49 -0800456
457 /**
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700458 * URI scheme for telephone number URIs.
459 */
460 public static final String SCHEME_TEL = "tel";
461
462 /**
463 * URI scheme for voicemail URIs.
464 */
465 public static final String SCHEME_VOICEMAIL = "voicemail";
466
467 /**
468 * URI scheme for SIP URIs.
469 */
470 public static final String SCHEME_SIP = "sip";
471
Nancy Chen3ace54b2014-10-22 17:45:26 -0700472 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800473 * Indicating no icon tint is set.
Santos Cordoncad84a22015-05-13 11:17:25 -0700474 * @hide
Nancy Chen3ace54b2014-10-22 17:45:26 -0700475 */
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800476 public static final int NO_ICON_TINT = 0;
477
478 /**
479 * Indicating no hightlight color is set.
480 */
481 public static final int NO_HIGHLIGHT_COLOR = 0;
Nancy Chen3ace54b2014-10-22 17:45:26 -0700482
Ihab Awad476cc832014-11-03 09:47:51 -0800483 /**
484 * Indicating no resource ID is set.
485 */
486 public static final int NO_RESOURCE_ID = -1;
487
Evan Charlton8c8a0622014-07-20 12:31:00 -0700488 private final PhoneAccountHandle mAccountHandle;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700489 private final Uri mAddress;
490 private final Uri mSubscriptionAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700491 private final int mCapabilities;
Ihab Awad476cc832014-11-03 09:47:51 -0800492 private final int mHighlightColor;
Santos Cordon146a3e32014-07-21 00:00:44 -0700493 private final CharSequence mLabel;
494 private final CharSequence mShortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700495 private final List<String> mSupportedUriSchemes;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800496 private final int mSupportedAudioRoutes;
Santos Cordoncad84a22015-05-13 11:17:25 -0700497 private final Icon mIcon;
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700498 private final Bundle mExtras;
Santos Cordon91371dc02015-05-08 13:52:09 -0700499 private boolean mIsEnabled;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700500 private String mGroupId;
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800501 private final Set<PhoneAccountHandle> mSimultaneousCallingRestriction;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700502
Tyler Gunn3b347812018-08-24 14:17:05 -0700503 @Override
504 public boolean equals(Object o) {
505 if (this == o) return true;
506 if (o == null || getClass() != o.getClass()) return false;
507 PhoneAccount that = (PhoneAccount) o;
508 return mCapabilities == that.mCapabilities &&
509 mHighlightColor == that.mHighlightColor &&
510 mSupportedAudioRoutes == that.mSupportedAudioRoutes &&
511 mIsEnabled == that.mIsEnabled &&
512 Objects.equals(mAccountHandle, that.mAccountHandle) &&
513 Objects.equals(mAddress, that.mAddress) &&
514 Objects.equals(mSubscriptionAddress, that.mSubscriptionAddress) &&
515 Objects.equals(mLabel, that.mLabel) &&
516 Objects.equals(mShortDescription, that.mShortDescription) &&
517 Objects.equals(mSupportedUriSchemes, that.mSupportedUriSchemes) &&
518 areBundlesEqual(mExtras, that.mExtras) &&
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800519 Objects.equals(mGroupId, that.mGroupId)
520 && Objects.equals(mSimultaneousCallingRestriction,
521 that.mSimultaneousCallingRestriction);
Tyler Gunn3b347812018-08-24 14:17:05 -0700522 }
523
524 @Override
525 public int hashCode() {
526 return Objects.hash(mAccountHandle, mAddress, mSubscriptionAddress, mCapabilities,
527 mHighlightColor, mLabel, mShortDescription, mSupportedUriSchemes,
528 mSupportedAudioRoutes,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800529 mExtras, mIsEnabled, mGroupId, mSimultaneousCallingRestriction);
Tyler Gunn3b347812018-08-24 14:17:05 -0700530 }
531
Santos Cordon32c65a52014-10-27 14:57:49 -0700532 /**
533 * Helper class for creating a {@link PhoneAccount}.
534 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700535 public static class Builder {
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800536
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700537 private PhoneAccountHandle mAccountHandle;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700538 private Uri mAddress;
539 private Uri mSubscriptionAddress;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700540 private int mCapabilities;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800541 private int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800542 private int mHighlightColor = NO_HIGHLIGHT_COLOR;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700543 private CharSequence mLabel;
544 private CharSequence mShortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700545 private List<String> mSupportedUriSchemes = new ArrayList<String>();
Santos Cordoncad84a22015-05-13 11:17:25 -0700546 private Icon mIcon;
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700547 private Bundle mExtras;
Santos Cordon91371dc02015-05-08 13:52:09 -0700548 private boolean mIsEnabled = false;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700549 private String mGroupId = "";
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800550 private Set<PhoneAccountHandle> mSimultaneousCallingRestriction = null;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700551
Santos Cordon32c65a52014-10-27 14:57:49 -0700552 /**
553 * Creates a builder with the specified {@link PhoneAccountHandle} and label.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800554 * <p>
555 * Note: each CharSequence or String field is limited to 256 characters. This check is
556 * enforced when registering the PhoneAccount via
557 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
558 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700559 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700560 public Builder(PhoneAccountHandle accountHandle, CharSequence label) {
561 this.mAccountHandle = accountHandle;
562 this.mLabel = label;
563 }
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700564
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700565 /**
566 * Creates an instance of the {@link PhoneAccount.Builder} from an existing
567 * {@link PhoneAccount}.
568 *
569 * @param phoneAccount The {@link PhoneAccount} used to initialize the builder.
570 */
571 public Builder(PhoneAccount phoneAccount) {
572 mAccountHandle = phoneAccount.getAccountHandle();
573 mAddress = phoneAccount.getAddress();
574 mSubscriptionAddress = phoneAccount.getSubscriptionAddress();
575 mCapabilities = phoneAccount.getCapabilities();
Ihab Awad476cc832014-11-03 09:47:51 -0800576 mHighlightColor = phoneAccount.getHighlightColor();
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700577 mLabel = phoneAccount.getLabel();
578 mShortDescription = phoneAccount.getShortDescription();
579 mSupportedUriSchemes.addAll(phoneAccount.getSupportedUriSchemes());
Santos Cordoncad84a22015-05-13 11:17:25 -0700580 mIcon = phoneAccount.getIcon();
Santos Cordon91371dc02015-05-08 13:52:09 -0700581 mIsEnabled = phoneAccount.isEnabled();
Tyler Gunnd426b202015-10-13 13:33:53 -0700582 mExtras = phoneAccount.getExtras();
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700583 mGroupId = phoneAccount.getGroupId();
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800584 mSupportedAudioRoutes = phoneAccount.getSupportedAudioRoutes();
Brad Ebingerad37ddc2024-01-22 12:34:02 -0800585 if (phoneAccount.hasSimultaneousCallingRestriction()) {
586 mSimultaneousCallingRestriction = phoneAccount.getSimultaneousCallingRestriction();
587 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700588 }
589
Santos Cordon32c65a52014-10-27 14:57:49 -0700590 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700591 * Sets the label. See {@link PhoneAccount#getLabel()}.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800592 * <p>
593 * Note: Each CharSequence or String field is limited to 256 characters. This check is
594 * enforced when registering the PhoneAccount via
595 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
596 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Tyler Gunn37653562017-03-13 18:15:15 -0700597 *
598 * @param label The label of the phone account.
599 * @return The builder.
600 * @hide
601 */
602 public Builder setLabel(CharSequence label) {
603 this.mLabel = label;
604 return this;
605 }
606
607 /**
Santos Cordon32c65a52014-10-27 14:57:49 -0700608 * Sets the address. See {@link PhoneAccount#getAddress}.
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800609 * <p>
610 * Note: The entire URI value is limited to 256 characters. This check is
611 * enforced when registering the PhoneAccount via
612 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
613 * {@link IllegalArgumentException} to be thrown if URI is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700614 *
615 * @param value The address of the phone account.
616 * @return The builder.
617 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700618 public Builder setAddress(Uri value) {
619 this.mAddress = value;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700620 return this;
621 }
622
Santos Cordon32c65a52014-10-27 14:57:49 -0700623 /**
624 * Sets the subscription address. See {@link PhoneAccount#getSubscriptionAddress}.
625 *
626 * @param value The subscription address.
627 * @return The builder.
628 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700629 public Builder setSubscriptionAddress(Uri value) {
630 this.mSubscriptionAddress = value;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700631 return this;
632 }
633
Santos Cordon32c65a52014-10-27 14:57:49 -0700634 /**
635 * Sets the capabilities. See {@link PhoneAccount#getCapabilities}.
636 *
637 * @param value The capabilities to set.
638 * @return The builder.
639 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700640 public Builder setCapabilities(int value) {
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700641 this.mCapabilities = value;
642 return this;
643 }
644
Santos Cordon32c65a52014-10-27 14:57:49 -0700645 /**
Santos Cordoncad84a22015-05-13 11:17:25 -0700646 * Sets the icon. See {@link PhoneAccount#getIcon}.
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800647 * <p>
648 * Note: An {@link IllegalArgumentException} if the Icon cannot be written to memory.
649 * This check is enforced when registering the PhoneAccount via
650 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}
Santos Cordon32c65a52014-10-27 14:57:49 -0700651 *
Santos Cordoncad84a22015-05-13 11:17:25 -0700652 * @param icon The icon to set.
Santos Cordon32c65a52014-10-27 14:57:49 -0700653 */
Santos Cordoncad84a22015-05-13 11:17:25 -0700654 public Builder setIcon(Icon icon) {
655 mIcon = icon;
Ihab Awad074bf102014-10-24 11:42:32 -0700656 return this;
657 }
658
659 /**
Ihab Awad476cc832014-11-03 09:47:51 -0800660 * Sets the highlight color. See {@link PhoneAccount#getHighlightColor}.
Ihab Awad074bf102014-10-24 11:42:32 -0700661 *
Ihab Awad476cc832014-11-03 09:47:51 -0800662 * @param value The highlight color.
Ihab Awad074bf102014-10-24 11:42:32 -0700663 * @return The builder.
664 */
Ihab Awad476cc832014-11-03 09:47:51 -0800665 public Builder setHighlightColor(int value) {
666 this.mHighlightColor = value;
Nancy Chen3ace54b2014-10-22 17:45:26 -0700667 return this;
668 }
669
Santos Cordon32c65a52014-10-27 14:57:49 -0700670 /**
671 * Sets the short description. See {@link PhoneAccount#getShortDescription}.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800672 * <p>
673 * Note: Each CharSequence or String field is limited to 256 characters. This check is
674 * enforced when registering the PhoneAccount via
675 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
676 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700677 *
678 * @param value The short description.
679 * @return The builder.
680 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700681 public Builder setShortDescription(CharSequence value) {
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700682 this.mShortDescription = value;
683 return this;
684 }
685
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700686 /**
687 * Specifies an additional URI scheme supported by the {@link PhoneAccount}.
688 *
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800689 * <p>
690 * Each URI scheme is limited to 256 characters. Adding a scheme over 256 characters will
691 * cause an {@link IllegalArgumentException} to be thrown when the account is registered.
692 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700693 * @param uriScheme The URI scheme.
Santos Cordon32c65a52014-10-27 14:57:49 -0700694 * @return The builder.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700695 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700696 public Builder addSupportedUriScheme(String uriScheme) {
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700697 if (!TextUtils.isEmpty(uriScheme) && !mSupportedUriSchemes.contains(uriScheme)) {
698 this.mSupportedUriSchemes.add(uriScheme);
699 }
700 return this;
701 }
702
703 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -0700704 * Specifies the URI schemes supported by the {@link PhoneAccount}.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700705 *
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800706 * <p>
707 * A max of 10 URI schemes can be added per account. Additionally, each URI scheme is
708 * limited to 256 characters. Adding more than 10 URI schemes or 256 characters on any
709 * scheme will cause an {@link IllegalArgumentException} to be thrown when the account
710 * is registered.
711 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700712 * @param uriSchemes The URI schemes.
Santos Cordon32c65a52014-10-27 14:57:49 -0700713 * @return The builder.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700714 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700715 public Builder setSupportedUriSchemes(List<String> uriSchemes) {
716 mSupportedUriSchemes.clear();
717
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700718 if (uriSchemes != null && !uriSchemes.isEmpty()) {
719 for (String uriScheme : uriSchemes) {
Andrew Lee3085a6c2014-09-04 10:59:13 -0700720 addSupportedUriScheme(uriScheme);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700721 }
722 }
723 return this;
724 }
725
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700726 /**
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700727 * Specifies the extras associated with the {@link PhoneAccount}.
728 * <p>
729 * {@code PhoneAccount}s only support extra values of type: {@link String}, {@link Integer},
730 * and {@link Boolean}. Extras which are not of these types are ignored.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800731 * <p>
732 * Note: Each Bundle (Key, Value) String field is limited to 256 characters. Additionally,
733 * the bundle is limited to 100 (Key, Value) pairs total. This check is
734 * enforced when registering the PhoneAccount via
735 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
736 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256
737 * or more than 100 (Key, Value) pairs are in the Bundle.
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700738 *
739 * @param extras
740 * @return
741 */
742 public Builder setExtras(Bundle extras) {
743 mExtras = extras;
744 return this;
745 }
746
747 /**
Santos Cordon91371dc02015-05-08 13:52:09 -0700748 * Sets the enabled state of the phone account.
749 *
750 * @param isEnabled The enabled state.
751 * @return The builder.
752 * @hide
753 */
754 public Builder setIsEnabled(boolean isEnabled) {
755 mIsEnabled = isEnabled;
756 return this;
757 }
758
759 /**
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700760 * Sets the group Id of the {@link PhoneAccount}. When a new {@link PhoneAccount} is
761 * registered to Telecom, it will replace another {@link PhoneAccount} that is already
762 * registered in Telecom and take on the current user defaults and enabled status. There can
763 * only be one {@link PhoneAccount} with a non-empty group number registered to Telecom at a
764 * time. By default, there is no group Id for a {@link PhoneAccount} (an empty String). Only
765 * grouped {@link PhoneAccount}s with the same {@link ConnectionService} can be replaced.
Tyler Gunn5567d742019-10-31 13:04:37 -0700766 * <p>
Tyler Gunnc9503d62020-01-27 10:30:51 -0800767 * Note: This is an API specific to the Telephony stack; the group Id will be ignored for
768 * callers not holding the correct permission.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800769 * <p>
770 * Additionally, each CharSequence or String field is limited to 256 characters.
771 * This check is enforced when registering the PhoneAccount via
772 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
773 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Tyler Gunn5567d742019-10-31 13:04:37 -0700774 *
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700775 * @param groupId The group Id of the {@link PhoneAccount} that will replace any other
776 * registered {@link PhoneAccount} in Telecom with the same Group Id.
777 * @return The builder
778 * @hide
779 */
Tyler Gunn5567d742019-10-31 13:04:37 -0700780 @SystemApi
Tyler Gunnc9503d62020-01-27 10:30:51 -0800781 @RequiresPermission(MODIFY_PHONE_STATE)
Tyler Gunn5567d742019-10-31 13:04:37 -0700782 public @NonNull Builder setGroupId(@NonNull String groupId) {
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700783 if (groupId != null) {
784 mGroupId = groupId;
785 } else {
786 mGroupId = "";
787 }
788 return this;
789 }
790
791 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800792 * Sets the audio routes supported by this {@link PhoneAccount}.
793 *
794 * @param routes bit mask of available routes.
795 * @return The builder.
796 * @hide
797 */
798 public Builder setSupportedAudioRoutes(int routes) {
799 mSupportedAudioRoutes = routes;
800 return this;
801 }
802
803 /**
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800804 * Restricts the ability of this {@link PhoneAccount} to ONLY support simultaneous calling
805 * with the other {@link PhoneAccountHandle}s in this Set.
806 * <p>
807 * If two or more {@link PhoneAccount}s support calling simultaneously, it means that
808 * Telecom allows the user to place additional outgoing calls and receive additional
809 * incoming calls using other {@link PhoneAccount}s while this PhoneAccount also has one or
810 * more active calls.
811 * <p>
812 * If this setter method is never called or cleared using
813 * {@link #clearSimultaneousCallingRestriction()}, there is no restriction and all
814 * {@link PhoneAccount}s registered to Telecom by this package support simultaneous calling.
Brad Ebinger1cfeff52024-02-06 15:36:22 -0800815 * If this setter is called and set as an empty Set, then this {@link PhoneAccount} does
816 * not support simultaneous calling with any other {@link PhoneAccount}s registered by the
817 * same application.
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800818 * <p>
819 * Note: Simultaneous calling restrictions can only be placed on {@link PhoneAccount}s that
820 * were registered by the same application. Simultaneous calling across applications is
821 * always possible as long as the {@link Connection} supports hold. If a
822 * {@link PhoneAccountHandle} is included here and the package name doesn't match this
823 * application's package name, {@link TelecomManager#registerPhoneAccount(PhoneAccount)}
824 * will throw a {@link SecurityException}.
825 *
826 * @param handles The other {@link PhoneAccountHandle}s that support calling simultaneously
Brad Ebinger516e7ab2024-01-19 15:31:57 -0800827 * with this one. Use {@link #clearSimultaneousCallingRestriction()} to remove the
828 * restriction and allow simultaneous calling to be supported across all
829 * {@link PhoneAccount}s registered by this package.
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800830 * @return The Builder used to set up the new PhoneAccount.
831 */
832 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
833 public @NonNull Builder setSimultaneousCallingRestriction(
834 @NonNull Set<PhoneAccountHandle> handles) {
835 if (handles == null) {
836 throw new IllegalArgumentException("the Set of PhoneAccountHandles must not be "
837 + "null");
838 }
839 mSimultaneousCallingRestriction = handles;
840 return this;
841 }
842
843 /**
844 * Clears a previously set simultaneous calling restriction set when
845 * {@link PhoneAccount.Builder#Builder(PhoneAccount)} is used to create a new PhoneAccount
846 * from an existing one.
847 *
848 * @return The Builder used to set up the new PhoneAccount.
849 * @see #setSimultaneousCallingRestriction(Set)
850 */
851 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
852 public @NonNull Builder clearSimultaneousCallingRestriction() {
853 mSimultaneousCallingRestriction = null;
854 return this;
855 }
856
857 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700858 * Creates an instance of a {@link PhoneAccount} based on the current builder settings.
859 *
860 * @return The {@link PhoneAccount}.
861 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700862 public PhoneAccount build() {
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700863 // If no supported URI schemes were defined, assume "tel" is supported.
864 if (mSupportedUriSchemes.isEmpty()) {
Andrew Lee3085a6c2014-09-04 10:59:13 -0700865 addSupportedUriScheme(SCHEME_TEL);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700866 }
867
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700868 return new PhoneAccount(
869 mAccountHandle,
Andrew Lee3085a6c2014-09-04 10:59:13 -0700870 mAddress,
871 mSubscriptionAddress,
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700872 mCapabilities,
Santos Cordoncad84a22015-05-13 11:17:25 -0700873 mIcon,
Ihab Awad476cc832014-11-03 09:47:51 -0800874 mHighlightColor,
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700875 mLabel,
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700876 mShortDescription,
Santos Cordon91371dc02015-05-08 13:52:09 -0700877 mSupportedUriSchemes,
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700878 mExtras,
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800879 mSupportedAudioRoutes,
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700880 mIsEnabled,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800881 mGroupId,
882 mSimultaneousCallingRestriction);
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700883 }
884 }
885
886 private PhoneAccount(
Evan Charlton6eb262c2014-07-19 18:18:19 -0700887 PhoneAccountHandle account,
Andrew Lee3085a6c2014-09-04 10:59:13 -0700888 Uri address,
889 Uri subscriptionAddress,
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700890 int capabilities,
Santos Cordoncad84a22015-05-13 11:17:25 -0700891 Icon icon,
Ihab Awad476cc832014-11-03 09:47:51 -0800892 int highlightColor,
Santos Cordon146a3e32014-07-21 00:00:44 -0700893 CharSequence label,
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700894 CharSequence shortDescription,
Santos Cordon91371dc02015-05-08 13:52:09 -0700895 List<String> supportedUriSchemes,
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700896 Bundle extras,
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800897 int supportedAudioRoutes,
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700898 boolean isEnabled,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800899 String groupId,
900 Set<PhoneAccountHandle> simultaneousCallingRestriction) {
Evan Charlton8c8a0622014-07-20 12:31:00 -0700901 mAccountHandle = account;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700902 mAddress = address;
903 mSubscriptionAddress = subscriptionAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700904 mCapabilities = capabilities;
Santos Cordoncad84a22015-05-13 11:17:25 -0700905 mIcon = icon;
Ihab Awad476cc832014-11-03 09:47:51 -0800906 mHighlightColor = highlightColor;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700907 mLabel = label;
908 mShortDescription = shortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700909 mSupportedUriSchemes = Collections.unmodifiableList(supportedUriSchemes);
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700910 mExtras = extras;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800911 mSupportedAudioRoutes = supportedAudioRoutes;
Santos Cordon91371dc02015-05-08 13:52:09 -0700912 mIsEnabled = isEnabled;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700913 mGroupId = groupId;
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800914 mSimultaneousCallingRestriction = simultaneousCallingRestriction;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700915 }
916
Andrew Lee3085a6c2014-09-04 10:59:13 -0700917 public static Builder builder(
918 PhoneAccountHandle accountHandle,
919 CharSequence label) {
920 return new Builder(accountHandle, label);
921 }
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700922
Ihab Awad807fe0a2014-07-09 12:30:52 -0700923 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700924 * Returns a builder initialized with the current {@link PhoneAccount} instance.
925 *
926 * @return The builder.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700927 */
928 public Builder toBuilder() { return new Builder(this); }
929
930 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700931 * The unique identifier of this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700932 *
Evan Charlton6eb262c2014-07-19 18:18:19 -0700933 * @return A {@code PhoneAccountHandle}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700934 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700935 public PhoneAccountHandle getAccountHandle() {
936 return mAccountHandle;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700937 }
938
939 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -0700940 * The address (e.g., a phone number) associated with this {@code PhoneAccount}. This
Evan Charlton8c8a0622014-07-20 12:31:00 -0700941 * represents the destination from which outgoing calls using this {@code PhoneAccount}
Evan Charlton6eb262c2014-07-19 18:18:19 -0700942 * will appear to come, if applicable, and the destination to which incoming calls using this
Evan Charlton8c8a0622014-07-20 12:31:00 -0700943 * {@code PhoneAccount} may be addressed.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700944 *
Andrew Lee3085a6c2014-09-04 10:59:13 -0700945 * @return A address expressed as a {@code Uri}, for example, a phone number.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700946 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700947 public Uri getAddress() {
948 return mAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700949 }
950
951 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700952 * The raw callback number used for this {@code PhoneAccount}, as distinct from
Andrew Lee3085a6c2014-09-04 10:59:13 -0700953 * {@link #getAddress()}. For the majority of {@code PhoneAccount}s this should be registered
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700954 * as {@code null}. It is used by the system for SIM-based {@code PhoneAccount} registration
Junda Liuf52ac902014-09-25 17:36:48 +0000955 * where {@link android.telephony.TelephonyManager#setLine1NumberForDisplay(String, String)}
956 * has been used to alter the callback number.
957 * <p>
Evan Charlton222db5252014-07-17 16:59:18 -0700958 *
959 * @return The subscription number, suitable for display to the user.
960 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700961 public Uri getSubscriptionAddress() {
962 return mSubscriptionAddress;
Evan Charlton222db5252014-07-17 16:59:18 -0700963 }
964
965 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700966 * The capabilities of this {@code PhoneAccount}.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700967 *
Evan Charlton8c8a0622014-07-20 12:31:00 -0700968 * @return A bit field of flags describing this {@code PhoneAccount}'s capabilities.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700969 */
970 public int getCapabilities() {
971 return mCapabilities;
972 }
973
974 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700975 * Determines if this {@code PhoneAccount} has a capabilities specified by the passed in
976 * bit mask.
977 *
978 * @param capability The capabilities to check.
Santos Cordon895d4b82015-06-25 16:41:48 -0700979 * @return {@code true} if the phone account has the capability.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700980 */
981 public boolean hasCapabilities(int capability) {
982 return (mCapabilities & capability) == capability;
983 }
984
985 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800986 * Determines if this {@code PhoneAccount} has routes specified by the passed in bit mask.
987 *
988 * @param route The routes to check.
989 * @return {@code true} if the phone account has the routes.
990 * @hide
991 */
992 public boolean hasAudioRoutes(int routes) {
993 return (mSupportedAudioRoutes & routes) == routes;
994 }
995
996 /**
Santos Cordon146a3e32014-07-21 00:00:44 -0700997 * A short label describing a {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700998 *
Evan Charlton8c8a0622014-07-20 12:31:00 -0700999 * @return A label for this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001000 */
Santos Cordon146a3e32014-07-21 00:00:44 -07001001 public CharSequence getLabel() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001002 return mLabel;
1003 }
1004
1005 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -07001006 * A short paragraph describing this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001007 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001008 * @return A description for this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001009 */
Santos Cordon146a3e32014-07-21 00:00:44 -07001010 public CharSequence getShortDescription() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001011 return mShortDescription;
1012 }
1013
1014 /**
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001015 * The URI schemes supported by this {@code PhoneAccount}.
1016 *
1017 * @return The URI schemes.
1018 */
1019 public List<String> getSupportedUriSchemes() {
1020 return mSupportedUriSchemes;
1021 }
1022
1023 /**
Tyler Gunn25ed2d72015-10-05 14:14:38 -07001024 * The extras associated with this {@code PhoneAccount}.
1025 * <p>
1026 * A {@link ConnectionService} may provide implementation specific information about the
1027 * {@link PhoneAccount} via the extras.
1028 *
1029 * @return The extras.
1030 */
1031 public Bundle getExtras() {
1032 return mExtras;
1033 }
1034
1035 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001036 * The audio routes supported by this {@code PhoneAccount}.
1037 *
1038 * @hide
1039 */
1040 public int getSupportedAudioRoutes() {
1041 return mSupportedAudioRoutes;
1042 }
1043
1044 /**
Santos Cordoncad84a22015-05-13 11:17:25 -07001045 * The icon to represent this {@code PhoneAccount}.
1046 *
1047 * @return The icon.
1048 */
1049 public Icon getIcon() {
1050 return mIcon;
1051 }
1052
1053 /**
Santos Cordon895d4b82015-06-25 16:41:48 -07001054 * Indicates whether the user has enabled this {@code PhoneAccount} or not. This value is only
1055 * populated for {@code PhoneAccount}s returned by {@link TelecomManager#getPhoneAccount}.
Santos Cordon91371dc02015-05-08 13:52:09 -07001056 *
Santos Cordon895d4b82015-06-25 16:41:48 -07001057 * @return {@code true} if the account is enabled by the user, {@code false} otherwise.
Santos Cordon91371dc02015-05-08 13:52:09 -07001058 */
1059 public boolean isEnabled() {
1060 return mIsEnabled;
1061 }
1062
1063 /**
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001064 * A non-empty {@link String} representing the group that A {@link PhoneAccount} is in or an
1065 * empty {@link String} if the {@link PhoneAccount} is not in a group. If this
1066 * {@link PhoneAccount} is in a group, this new {@link PhoneAccount} will replace a registered
1067 * {@link PhoneAccount} that is in the same group. When the {@link PhoneAccount} is replaced,
1068 * its user defined defaults and enabled status will also pass to this new {@link PhoneAccount}.
1069 * Only {@link PhoneAccount}s that share the same {@link ConnectionService} can be replaced.
1070 *
1071 * @return A non-empty String Id if this {@link PhoneAccount} belongs to a group.
1072 * @hide
1073 */
1074 public String getGroupId() {
1075 return mGroupId;
1076 }
1077
1078 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -07001079 * Determines if the {@link PhoneAccount} supports calls to/from addresses with a specified URI
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001080 * scheme.
1081 *
1082 * @param uriScheme The URI scheme to check.
Santos Cordon895d4b82015-06-25 16:41:48 -07001083 * @return {@code true} if the {@code PhoneAccount} supports calls to/from addresses with the
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001084 * specified URI scheme.
1085 */
1086 public boolean supportsUriScheme(String uriScheme) {
1087 if (mSupportedUriSchemes == null || uriScheme == null) {
1088 return false;
1089 }
1090
1091 for (String scheme : mSupportedUriSchemes) {
1092 if (scheme != null && scheme.equals(uriScheme)) {
1093 return true;
1094 }
1095 }
1096 return false;
1097 }
1098
1099 /**
Ihab Awad476cc832014-11-03 09:47:51 -08001100 * A highlight color to use in displaying information about this {@code PhoneAccount}.
1101 *
1102 * @return A hexadecimal color value.
1103 */
1104 public int getHighlightColor() {
1105 return mHighlightColor;
1106 }
1107
Santos Cordon91371dc02015-05-08 13:52:09 -07001108 /**
1109 * Sets the enabled state of the phone account.
1110 * @hide
1111 */
1112 public void setIsEnabled(boolean isEnabled) {
1113 mIsEnabled = isEnabled;
1114 }
1115
Tyler Gunnf5035432017-01-09 09:43:12 -08001116 /**
1117 * @return {@code true} if the {@link PhoneAccount} is self-managed, {@code false} otherwise.
1118 * @hide
1119 */
1120 public boolean isSelfManaged() {
1121 return (mCapabilities & CAPABILITY_SELF_MANAGED) == CAPABILITY_SELF_MANAGED;
1122 }
1123
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001124 /**
1125 * If a restriction is set (see {@link #hasSimultaneousCallingRestriction()}), this method
1126 * returns the Set of {@link PhoneAccountHandle}s that are allowed to support calls
1127 * simultaneously with this {@link PhoneAccount}.
1128 * <p>
1129 * If this {@link PhoneAccount} is busy with one or more ongoing calls, a restriction is set on
1130 * this PhoneAccount (see {@link #hasSimultaneousCallingRestriction()} to check), and a new
1131 * incoming or outgoing call is received or placed on a PhoneAccount that is not in this Set,
1132 * Telecom will reject or cancel the pending call in favor of keeping the ongoing call alive.
1133 * <p>
1134 * Note: Simultaneous calling restrictions can only be placed on {@link PhoneAccount}s that
1135 * were registered by the same application. Simultaneous calling across applications is
1136 * always possible as long as the {@link Connection} supports hold.
1137 *
1138 * @return the Set of {@link PhoneAccountHandle}s that this {@link PhoneAccount} supports
1139 * simultaneous calls with.
1140 * @throws IllegalStateException If there is no restriction set on this {@link PhoneAccount}
1141 * and this method is called. Whether or not there is a restriction can be checked using
1142 * {@link #hasSimultaneousCallingRestriction()}.
1143 */
1144 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
1145 public @NonNull Set<PhoneAccountHandle> getSimultaneousCallingRestriction() {
1146 if (mSimultaneousCallingRestriction == null) {
1147 throw new IllegalStateException("This method can not be called if there is no "
1148 + "simultaneous calling restriction. See #hasSimultaneousCallingRestriction");
1149 }
1150 return mSimultaneousCallingRestriction;
1151 }
1152
1153 /**
1154 * Whether or not this {@link PhoneAccount} contains a simultaneous calling restriction on it.
1155 *
1156 * @return {@code true} if this PhoneAccount contains a simultaneous calling restriction,
1157 * {@code false} if it does not. Use {@link #getSimultaneousCallingRestriction()} to query which
1158 * other {@link PhoneAccount}s support simultaneous calling with this one.
1159 * @see #getSimultaneousCallingRestriction() for more information on how the sinultaneous
1160 * calling restriction works.
1161 */
1162 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
1163 public boolean hasSimultaneousCallingRestriction() {
1164 return mSimultaneousCallingRestriction != null;
1165 }
1166
Ihab Awad807fe0a2014-07-09 12:30:52 -07001167 //
1168 // Parcelable implementation
1169 //
1170
1171 @Override
1172 public int describeContents() {
1173 return 0;
1174 }
1175
1176 @Override
1177 public void writeToParcel(Parcel out, int flags) {
Ihab Awad476cc832014-11-03 09:47:51 -08001178 if (mAccountHandle == null) {
1179 out.writeInt(0);
1180 } else {
1181 out.writeInt(1);
1182 mAccountHandle.writeToParcel(out, flags);
1183 }
1184 if (mAddress == null) {
1185 out.writeInt(0);
1186 } else {
1187 out.writeInt(1);
1188 mAddress.writeToParcel(out, flags);
1189 }
1190 if (mSubscriptionAddress == null) {
1191 out.writeInt(0);
1192 } else {
1193 out.writeInt(1);
1194 mSubscriptionAddress.writeToParcel(out, flags);
1195 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001196 out.writeInt(mCapabilities);
Ihab Awad476cc832014-11-03 09:47:51 -08001197 out.writeInt(mHighlightColor);
Santos Cordon146a3e32014-07-21 00:00:44 -07001198 out.writeCharSequence(mLabel);
1199 out.writeCharSequence(mShortDescription);
Ihab Awad476cc832014-11-03 09:47:51 -08001200 out.writeStringList(mSupportedUriSchemes);
Santos Cordon91371dc02015-05-08 13:52:09 -07001201
Santos Cordoncad84a22015-05-13 11:17:25 -07001202 if (mIcon == null) {
1203 out.writeInt(0);
1204 } else {
1205 out.writeInt(1);
1206 mIcon.writeToParcel(out, flags);
1207 }
Santos Cordon91371dc02015-05-08 13:52:09 -07001208 out.writeByte((byte) (mIsEnabled ? 1 : 0));
Tyler Gunnef829ec2015-10-08 09:46:23 -07001209 out.writeBundle(mExtras);
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001210 out.writeString(mGroupId);
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001211 out.writeInt(mSupportedAudioRoutes);
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001212 if (mSimultaneousCallingRestriction == null) {
1213 out.writeBoolean(false);
1214 } else {
1215 out.writeBoolean(true);
1216 out.writeTypedList(mSimultaneousCallingRestriction.stream().toList());
1217 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001218 }
1219
Jeff Sharkey9e8f83d2019-02-28 12:06:45 -07001220 public static final @android.annotation.NonNull Creator<PhoneAccount> CREATOR
Evan Charlton8c8a0622014-07-20 12:31:00 -07001221 = new Creator<PhoneAccount>() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001222 @Override
Evan Charlton8c8a0622014-07-20 12:31:00 -07001223 public PhoneAccount createFromParcel(Parcel in) {
1224 return new PhoneAccount(in);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001225 }
1226
1227 @Override
Evan Charlton8c8a0622014-07-20 12:31:00 -07001228 public PhoneAccount[] newArray(int size) {
1229 return new PhoneAccount[size];
Ihab Awad807fe0a2014-07-09 12:30:52 -07001230 }
1231 };
1232
Evan Charlton8c8a0622014-07-20 12:31:00 -07001233 private PhoneAccount(Parcel in) {
Ihab Awad476cc832014-11-03 09:47:51 -08001234 if (in.readInt() > 0) {
1235 mAccountHandle = PhoneAccountHandle.CREATOR.createFromParcel(in);
1236 } else {
1237 mAccountHandle = null;
1238 }
1239 if (in.readInt() > 0) {
1240 mAddress = Uri.CREATOR.createFromParcel(in);
1241 } else {
1242 mAddress = null;
1243 }
1244 if (in.readInt() > 0) {
1245 mSubscriptionAddress = Uri.CREATOR.createFromParcel(in);
1246 } else {
1247 mSubscriptionAddress = null;
1248 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001249 mCapabilities = in.readInt();
Ihab Awad476cc832014-11-03 09:47:51 -08001250 mHighlightColor = in.readInt();
Santos Cordon146a3e32014-07-21 00:00:44 -07001251 mLabel = in.readCharSequence();
1252 mShortDescription = in.readCharSequence();
Ihab Awad476cc832014-11-03 09:47:51 -08001253 mSupportedUriSchemes = Collections.unmodifiableList(in.createStringArrayList());
Santos Cordoncad84a22015-05-13 11:17:25 -07001254 if (in.readInt() > 0) {
1255 mIcon = Icon.CREATOR.createFromParcel(in);
1256 } else {
1257 mIcon = null;
1258 }
Santos Cordon91371dc02015-05-08 13:52:09 -07001259 mIsEnabled = in.readByte() == 1;
Tyler Gunnef829ec2015-10-08 09:46:23 -07001260 mExtras = in.readBundle();
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001261 mGroupId = in.readString();
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001262 mSupportedAudioRoutes = in.readInt();
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001263 if (in.readBoolean()) {
1264 List<PhoneAccountHandle> list = new ArrayList<>();
1265 in.readTypedList(list, PhoneAccountHandle.CREATOR);
1266 mSimultaneousCallingRestriction = new ArraySet<>(list);
1267 } else {
1268 mSimultaneousCallingRestriction = null;
1269 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001270 }
Tyler Gunn76c01a52014-09-30 14:47:51 -07001271
1272 @Override
1273 public String toString() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001274 StringBuilder sb = new StringBuilder().append("[[")
1275 .append(mIsEnabled ? 'X' : ' ')
1276 .append("] PhoneAccount: ")
Tyler Gunn76c01a52014-09-30 14:47:51 -07001277 .append(mAccountHandle)
1278 .append(" Capabilities: ")
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001279 .append(capabilitiesToString())
1280 .append(" Audio Routes: ")
1281 .append(audioRoutesToString())
Tyler Gunn76c01a52014-09-30 14:47:51 -07001282 .append(" Schemes: ");
1283 for (String scheme : mSupportedUriSchemes) {
1284 sb.append(scheme)
1285 .append(" ");
1286 }
Tyler Gunnef829ec2015-10-08 09:46:23 -07001287 sb.append(" Extras: ");
Tyler Gunn25ed2d72015-10-05 14:14:38 -07001288 sb.append(mExtras);
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001289 sb.append(" GroupId: ");
1290 sb.append(Log.pii(mGroupId));
Brad Ebinger5365cc32024-01-26 09:53:55 -08001291 sb.append(" SC Restrictions: ");
1292 if (hasSimultaneousCallingRestriction()) {
1293 sb.append("[ ");
1294 for (PhoneAccountHandle handle : mSimultaneousCallingRestriction) {
1295 sb.append(handle);
1296 sb.append(" ");
1297 }
1298 sb.append("]");
1299 } else {
1300 sb.append("[NONE]");
1301 }
Tyler Gunn76c01a52014-09-30 14:47:51 -07001302 sb.append("]");
1303 return sb.toString();
1304 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001305
1306 /**
1307 * Generates a string representation of a capabilities bitmask.
1308 *
Tyler Gunn3e122f72016-01-11 19:25:00 -08001309 * @return String representation of the capabilities bitmask.
Tyler Gunn1847b4e2018-11-09 08:43:02 -08001310 * @hide
Tyler Gunn3e122f72016-01-11 19:25:00 -08001311 */
Tyler Gunn1847b4e2018-11-09 08:43:02 -08001312 public String capabilitiesToString() {
Tyler Gunn3e122f72016-01-11 19:25:00 -08001313 StringBuilder sb = new StringBuilder();
Tyler Gunnf5035432017-01-09 09:43:12 -08001314 if (hasCapabilities(CAPABILITY_SELF_MANAGED)) {
1315 sb.append("SelfManaged ");
1316 }
Tyler Gunn58cbd7a2016-11-11 11:31:28 -08001317 if (hasCapabilities(CAPABILITY_SUPPORTS_VIDEO_CALLING)) {
1318 sb.append("SuppVideo ");
1319 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001320 if (hasCapabilities(CAPABILITY_VIDEO_CALLING)) {
1321 sb.append("Video ");
1322 }
1323 if (hasCapabilities(CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE)) {
1324 sb.append("Presence ");
1325 }
1326 if (hasCapabilities(CAPABILITY_CALL_PROVIDER)) {
1327 sb.append("CallProvider ");
1328 }
1329 if (hasCapabilities(CAPABILITY_CALL_SUBJECT)) {
1330 sb.append("CallSubject ");
1331 }
1332 if (hasCapabilities(CAPABILITY_CONNECTION_MANAGER)) {
1333 sb.append("ConnectionMgr ");
1334 }
1335 if (hasCapabilities(CAPABILITY_EMERGENCY_CALLS_ONLY)) {
1336 sb.append("EmergOnly ");
1337 }
1338 if (hasCapabilities(CAPABILITY_MULTI_USER)) {
1339 sb.append("MultiUser ");
1340 }
1341 if (hasCapabilities(CAPABILITY_PLACE_EMERGENCY_CALLS)) {
1342 sb.append("PlaceEmerg ");
1343 }
Brad Ebinger3636d742019-05-21 15:28:19 -07001344 if (hasCapabilities(CAPABILITY_EMERGENCY_PREFERRED)) {
1345 sb.append("EmerPrefer ");
1346 }
Tyler Gunncee9ea62016-03-24 11:45:43 -07001347 if (hasCapabilities(CAPABILITY_EMERGENCY_VIDEO_CALLING)) {
1348 sb.append("EmergVideo ");
1349 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001350 if (hasCapabilities(CAPABILITY_SIM_SUBSCRIPTION)) {
1351 sb.append("SimSub ");
1352 }
Hall Liu47ed6202017-11-20 16:25:39 -08001353 if (hasCapabilities(CAPABILITY_RTT)) {
Hunter Knepshield25265682022-01-19 02:25:06 -08001354 sb.append("Rtt ");
Hall Liu47ed6202017-11-20 16:25:39 -08001355 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05301356 if (hasCapabilities(CAPABILITY_ADHOC_CONFERENCE_CALLING)) {
Hunter Knepshield25265682022-01-19 02:25:06 -08001357 sb.append("AdhocConf ");
Ravi Paluri80aa2142019-12-02 11:57:37 +05301358 }
Shuo Qiand24aea32020-11-24 15:08:49 -08001359 if (hasCapabilities(CAPABILITY_CALL_COMPOSER)) {
1360 sb.append("CallComposer ");
1361 }
Hunter Knepshield25265682022-01-19 02:25:06 -08001362 if (hasCapabilities(CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS)) {
1363 sb.append("SuppVoice ");
1364 }
1365 if (hasCapabilities(CAPABILITY_VOICE_CALLING_AVAILABLE)) {
1366 sb.append("Voice ");
1367 }
Thomas Stuart649bedd2023-02-23 15:48:31 -08001368 if (hasCapabilities(CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS)) {
1369 sb.append("TransactOps ");
1370 }
1371 if (hasCapabilities(CAPABILITY_SUPPORTS_CALL_STREAMING)) {
1372 sb.append("Stream ");
1373 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001374 return sb.toString();
1375 }
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001376
1377 private String audioRoutesToString() {
1378 StringBuilder sb = new StringBuilder();
1379
1380 if (hasAudioRoutes(CallAudioState.ROUTE_BLUETOOTH)) {
1381 sb.append("B");
1382 }
1383 if (hasAudioRoutes(CallAudioState.ROUTE_EARPIECE)) {
1384 sb.append("E");
1385 }
1386 if (hasAudioRoutes(CallAudioState.ROUTE_SPEAKER)) {
1387 sb.append("S");
1388 }
1389 if (hasAudioRoutes(CallAudioState.ROUTE_WIRED_HEADSET)) {
1390 sb.append("W");
1391 }
1392
1393 return sb.toString();
1394 }
Tyler Gunn3b347812018-08-24 14:17:05 -07001395
1396 /**
1397 * Determines if two {@link Bundle}s are equal.
1398 * @param extras First {@link Bundle} to check.
1399 * @param newExtras {@link Bundle} to compare against.
1400 * @return {@code true} if the {@link Bundle}s are equal, {@code false} otherwise.
1401 */
1402 private static boolean areBundlesEqual(Bundle extras, Bundle newExtras) {
1403 if (extras == null || newExtras == null) {
1404 return extras == newExtras;
1405 }
1406
1407 if (extras.size() != newExtras.size()) {
1408 return false;
1409 }
1410
1411 for(String key : extras.keySet()) {
1412 if (key != null) {
1413 final Object value = extras.get(key);
1414 final Object newValue = newExtras.get(key);
1415 if (!Objects.equals(value, newValue)) {
1416 return false;
1417 }
1418 }
1419 }
1420 return true;
1421 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001422}