blob: 83dac184fc5fcdb53a52b56c1b3c06c243976187 [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.
Tyler Gunn35503412024-08-26 16:20:24 +0000178 *
179 * @deprecated this API was only intended to prevent call recording via the microphone by an app
180 * while in a phone call. Audio policies no longer make this possible. Further, this API was
181 * never actually used. Call recording solutions integrated in an OEM dialer app must use
182 * appropriate recording signals to inform the caller/callee of the recording.
Tyler Gunnacdb6862018-01-29 14:30:52 -0800183 * @hide
184 */
Tyler Gunn35503412024-08-26 16:20:24 +0000185 @FlaggedApi(com.android.server.telecom.flags.Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
186 @Deprecated
Hall Liu2ef04112020-09-14 18:34:10 -0700187 @SystemApi
Tyler Gunnacdb6862018-01-29 14:30:52 -0800188 public static final String EXTRA_PLAY_CALL_RECORDING_TONE =
189 "android.telecom.extra.PLAY_CALL_RECORDING_TONE";
190
191 /**
Sean Kelley4d3c1782018-05-22 14:35:27 -0700192 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()} which
193 * indicates whether calls for a {@link PhoneAccount} should skip call filtering.
194 * <p>
195 * If not specified, this will default to false; all calls will undergo call filtering unless
196 * specifically exempted (e.g. {@link Connection#PROPERTY_EMERGENCY_CALLBACK_MODE}.) However,
197 * this may be used to skip call filtering when it has already been performed on another device.
198 * @hide
199 */
Pranav Madapurmath9ad30392024-02-05 15:05:16 -0800200 @SystemApi
201 @FlaggedApi(com.android.server.telecom.flags.Flags.FLAG_TELECOM_RESOLVE_HIDDEN_DEPENDENCIES)
Sean Kelley4d3c1782018-05-22 14:35:27 -0700202 public static final String EXTRA_SKIP_CALL_FILTERING =
203 "android.telecom.extra.SKIP_CALL_FILTERING";
204
205 /**
Grace Jiae99fde92021-01-19 14:58:01 -0800206 * Boolean {@link PhoneAccount} extras key (see {@link PhoneAccount#getExtras()}) which
207 * indicates whether a Self-managed {@link PhoneAccount} want to expose its calls to all
208 * {@link InCallService} which declares the metadata
209 * {@link TelecomManager#METADATA_INCLUDE_SELF_MANAGED_CALLS}.
210 */
211 public static final String EXTRA_ADD_SELF_MANAGED_CALLS_TO_INCALLSERVICE =
212 "android.telecom.extra.ADD_SELF_MANAGED_CALLS_TO_INCALLSERVICE";
213
214 /**
Ihab Awadf8b69882014-07-25 15:14:01 -0700215 * Flag indicating that this {@code PhoneAccount} can act as a connection manager for
216 * other connections. The {@link ConnectionService} associated with this {@code PhoneAccount}
217 * will be allowed to manage phone calls including using its own proprietary phone-call
218 * implementation (like VoIP calling) to make calls instead of the telephony stack.
219 * <p>
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700220 * When a user opts to place a call using the SIM-based telephony stack, the
221 * {@link ConnectionService} associated with this {@code PhoneAccount} will be attempted first
222 * if the user has explicitly selected it to be used as the default connection manager.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700223 * <p>
224 * See {@link #getCapabilities}
225 */
Ihab Awadf8b69882014-07-25 15:14:01 -0700226 public static final int CAPABILITY_CONNECTION_MANAGER = 0x1;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700227
228 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700229 * Flag indicating that this {@code PhoneAccount} can make phone calls in place of
Evan Charlton6eb262c2014-07-19 18:18:19 -0700230 * traditional SIM-based telephony calls. This account will be treated as a distinct method
231 * for placing calls alongside the traditional SIM-based telephony stack. This flag is
Ihab Awadf8b69882014-07-25 15:14:01 -0700232 * distinct from {@link #CAPABILITY_CONNECTION_MANAGER} in that it is not allowed to manage
Santos Cordon32c65a52014-10-27 14:57:49 -0700233 * or place calls from the built-in telephony stack.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700234 * <p>
235 * See {@link #getCapabilities}
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700236 * <p>
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700237 */
238 public static final int CAPABILITY_CALL_PROVIDER = 0x2;
239
Ihab Awad7522bbd62014-07-18 15:53:17 -0700240 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700241 * Flag indicating that this {@code PhoneAccount} represents a built-in PSTN SIM
Evan Charlton6eb262c2014-07-19 18:18:19 -0700242 * subscription.
Ihab Awad7522bbd62014-07-18 15:53:17 -0700243 * <p>
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700244 * Only the Android framework can register a {@code PhoneAccount} having this capability.
245 * <p>
246 * See {@link #getCapabilities}
Ihab Awad7522bbd62014-07-18 15:53:17 -0700247 */
248 public static final int CAPABILITY_SIM_SUBSCRIPTION = 0x4;
249
Ihab Awadf8b69882014-07-25 15:14:01 -0700250 /**
Tyler Gunn58cbd7a2016-11-11 11:31:28 -0800251 * Flag indicating that this {@code PhoneAccount} is currently able to place video calls.
252 * <p>
253 * See also {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING} which indicates whether the
254 * {@code PhoneAccount} supports placing video calls.
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700255 * <p>
256 * See {@link #getCapabilities}
Ihab Awadf8b69882014-07-25 15:14:01 -0700257 */
258 public static final int CAPABILITY_VIDEO_CALLING = 0x8;
259
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700260 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700261 * Flag indicating that this {@code PhoneAccount} is capable of placing emergency calls.
262 * By default all PSTN {@code PhoneAccount}s are capable of placing emergency calls.
263 * <p>
264 * See {@link #getCapabilities}
265 */
266 public static final int CAPABILITY_PLACE_EMERGENCY_CALLS = 0x10;
267
268 /**
Evan Charlton134dd682014-11-25 14:12:57 -0800269 * Flag indicating that this {@code PhoneAccount} is capable of being used by all users. This
270 * should only be used by system apps (and will be ignored for all other apps trying to use it).
271 * <p>
272 * See {@link #getCapabilities}
273 * @hide
274 */
Brian Attwellad147f42014-12-19 11:37:16 -0800275 @SystemApi
Evan Charlton134dd682014-11-25 14:12:57 -0800276 public static final int CAPABILITY_MULTI_USER = 0x20;
277
278 /**
Tyler Gunn65a3d342015-07-27 16:06:16 -0700279 * Flag indicating that this {@code PhoneAccount} supports a subject for Calls. This means a
280 * caller is able to specify a short subject line for an outgoing call. A capable receiving
281 * device displays the call subject on the incoming call screen.
282 * <p>
283 * See {@link #getCapabilities}
284 */
285 public static final int CAPABILITY_CALL_SUBJECT = 0x40;
286
287 /**
Bryce Leeb96d89c2015-10-14 16:48:40 -0700288 * Flag indicating that this {@code PhoneAccount} should only be used for emergency calls.
289 * <p>
290 * See {@link #getCapabilities}
291 * @hide
292 */
Hall Liu2ef04112020-09-14 18:34:10 -0700293 @SystemApi
Bryce Leeb96d89c2015-10-14 16:48:40 -0700294 public static final int CAPABILITY_EMERGENCY_CALLS_ONLY = 0x80;
295
296 /**
Tyler Gunn9a365752015-12-09 15:00:18 -0800297 * Flag indicating that for this {@code PhoneAccount}, the ability to make a video call to a
298 * number relies on presence. Should only be set if the {@code PhoneAccount} also has
299 * {@link #CAPABILITY_VIDEO_CALLING}.
300 * <p>
Brad Ebinger722cacf2021-05-14 01:53:56 +0000301 * Note: As of Android 12, using the
Tyler Gunn9a365752015-12-09 15:00:18 -0800302 * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE_VT_CAPABLE} bit on the
303 * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE} column to indicate whether
Brad Ebinger722cacf2021-05-14 01:53:56 +0000304 * a contact's phone number supports video calling has been deprecated and should only be used
305 * on devices where {@link CarrierConfigManager#KEY_USE_RCS_PRESENCE_BOOL} is set. On newer
306 * devices, applications must use {@link android.telephony.ims.RcsUceAdapter} instead to
307 * determine whether or not a contact's phone number supports carrier video calling.
Tyler Gunn9a365752015-12-09 15:00:18 -0800308 * <p>
309 * See {@link #getCapabilities}
310 */
311 public static final int CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE = 0x100;
312
313 /**
Tyler Gunncee9ea62016-03-24 11:45:43 -0700314 * Flag indicating that for this {@link PhoneAccount}, emergency video calling is allowed.
315 * <p>
316 * When set, Telecom will allow emergency video calls to be placed. When not set, Telecom will
317 * convert all outgoing video calls to emergency numbers to audio-only.
318 * @hide
319 */
Hall Liu2ef04112020-09-14 18:34:10 -0700320 @SystemApi
Tyler Gunncee9ea62016-03-24 11:45:43 -0700321 public static final int CAPABILITY_EMERGENCY_VIDEO_CALLING = 0x200;
322
323 /**
Tyler Gunn58cbd7a2016-11-11 11:31:28 -0800324 * Flag indicating that this {@link PhoneAccount} supports video calling.
325 * This is not an indication that the {@link PhoneAccount} is currently able to make a video
326 * call, but rather that it has the ability to make video calls (but not necessarily at this
327 * time).
328 * <p>
329 * Whether a {@link PhoneAccount} can make a video call is ultimately controlled by
330 * {@link #CAPABILITY_VIDEO_CALLING}, which indicates whether the {@link PhoneAccount} is
331 * currently capable of making a video call. Consider a case where, for example, a
332 * {@link PhoneAccount} supports making video calls (e.g.
333 * {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING}), but a current lack of network connectivity
334 * prevents video calls from being made (e.g. {@link #CAPABILITY_VIDEO_CALLING}).
335 * <p>
336 * See {@link #getCapabilities}
337 */
338 public static final int CAPABILITY_SUPPORTS_VIDEO_CALLING = 0x400;
339
340 /**
Tyler Gunnf5035432017-01-09 09:43:12 -0800341 * Flag indicating that this {@link PhoneAccount} is responsible for managing its own
342 * {@link Connection}s. This type of {@link PhoneAccount} is ideal for use with standalone
343 * calling apps which do not wish to use the default phone app for {@link Connection} UX,
344 * but which want to leverage the call and audio routing capabilities of the Telecom framework.
345 * <p>
346 * When set, {@link Connection}s created by the self-managed {@link ConnectionService} will not
347 * be surfaced to implementations of the {@link InCallService} API. Thus it is the
348 * responsibility of a self-managed {@link ConnectionService} to provide a user interface for
349 * its {@link Connection}s.
350 * <p>
351 * Self-managed {@link Connection}s will, however, be displayed on connected Bluetooth devices.
352 */
353 public static final int CAPABILITY_SELF_MANAGED = 0x800;
354
355 /**
Hall Liu95d55872017-01-25 17:12:49 -0800356 * Flag indicating that this {@link PhoneAccount} is capable of making a call with an
357 * RTT (Real-time text) session.
358 * When set, Telecom will attempt to open an RTT session on outgoing calls that specify
359 * that they should be placed with an RTT session , and the in-call app will be displayed
360 * with text entry fields for RTT. Likewise, the in-call app can request that an RTT
361 * session be opened during a call if this bit is set.
362 */
363 public static final int CAPABILITY_RTT = 0x1000;
364
Brad Ebinger3636d742019-05-21 15:28:19 -0700365 /**
366 * Flag indicating that this {@link PhoneAccount} is the preferred SIM subscription for
Hall Liu2ef04112020-09-14 18:34:10 -0700367 * emergency calls. A {@link PhoneAccount} that sets this capability must also
Brad Ebinger3636d742019-05-21 15:28:19 -0700368 * set the {@link #CAPABILITY_SIM_SUBSCRIPTION} and {@link #CAPABILITY_PLACE_EMERGENCY_CALLS}
Hall Liu2ef04112020-09-14 18:34:10 -0700369 * capabilities. There must only be one emergency preferred {@link PhoneAccount} on the device.
Brad Ebinger3636d742019-05-21 15:28:19 -0700370 * <p>
371 * When set, Telecom will prefer this {@link PhoneAccount} over others for emergency calling,
372 * even if the emergency call was placed with a specific {@link PhoneAccount} set using the
373 * extra{@link TelecomManager#EXTRA_PHONE_ACCOUNT_HANDLE} in
374 * {@link Intent#ACTION_CALL_EMERGENCY} or {@link TelecomManager#placeCall(Uri, Bundle)}.
375 *
376 * @hide
377 */
Hall Liu2ef04112020-09-14 18:34:10 -0700378 @SystemApi
Brad Ebinger3636d742019-05-21 15:28:19 -0700379 public static final int CAPABILITY_EMERGENCY_PREFERRED = 0x2000;
380
Ravi Paluri80aa2142019-12-02 11:57:37 +0530381 /**
382 * An adhoc conference call is established by providing a list of addresses to
383 * {@code TelecomManager#startConference(List<Uri>, int videoState)} where the
384 * {@link ConnectionService} is responsible for connecting all indicated participants
385 * to a conference simultaneously.
386 * This is in contrast to conferences formed by merging calls together (e.g. using
387 * {@link android.telecom.Call#mergeConference()}).
388 */
389 public static final int CAPABILITY_ADHOC_CONFERENCE_CALLING = 0x4000;
390
Shuo Qiand24aea32020-11-24 15:08:49 -0800391 /**
392 * Flag indicating whether this {@link PhoneAccount} is capable of supporting the call composer
393 * functionality for enriched calls.
394 */
395 public static final int CAPABILITY_CALL_COMPOSER = 0x8000;
396
Hunter Knepshield25265682022-01-19 02:25:06 -0800397 /**
398 * Flag indicating that this {@link PhoneAccount} provides SIM-based voice calls, potentially as
399 * an over-the-top solution such as wi-fi calling.
400 *
401 * <p>Similar to {@link #CAPABILITY_SUPPORTS_VIDEO_CALLING}, this capability indicates this
402 * {@link PhoneAccount} has the ability to make voice calls (but not necessarily at this time).
403 * Whether this {@link PhoneAccount} can make a voice call is ultimately controlled by {@link
404 * #CAPABILITY_VOICE_CALLING_AVAILABLE}, which indicates whether this {@link PhoneAccount} is
405 * currently capable of making a voice call. Consider a case where, for example, a {@link
406 * PhoneAccount} supports making voice calls (e.g. {@link
407 * #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS}), but a current lack of network connectivity
408 * prevents voice calls from being made (e.g. {@link #CAPABILITY_VOICE_CALLING_AVAILABLE}).
409 *
410 * <p>In order to declare this capability, this {@link PhoneAccount} must also declare {@link
411 * #CAPABILITY_SIM_SUBSCRIPTION} or {@link #CAPABILITY_CONNECTION_MANAGER} and satisfy the
412 * associated requirements.
413 *
414 * @see #CAPABILITY_VOICE_CALLING_AVAILABLE
415 * @see #getCapabilities
416 */
417 public static final int CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS = 0x10000;
418
419 /**
420 * Flag indicating that this {@link PhoneAccount} is <em>currently</em> able to place SIM-based
421 * voice calls, similar to {@link #CAPABILITY_VIDEO_CALLING}.
422 *
423 * <p>See also {@link #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS}, which indicates whether
424 * the {@code PhoneAccount} supports placing SIM-based voice calls or not.
425 *
426 * <p>In order to declare this capability, this {@link PhoneAccount} must also declare {@link
427 * #CAPABILITY_SIM_SUBSCRIPTION} or {@link #CAPABILITY_CONNECTION_MANAGER} and satisfy the
428 * associated requirements.
429 *
430 * @see #CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS
431 * @see #getCapabilities
432 */
433 public static final int CAPABILITY_VOICE_CALLING_AVAILABLE = 0x20000;
434
Thomas Stuart9bfb2432022-09-27 15:02:07 -0700435
436 /**
437 * Flag indicating that this {@link PhoneAccount} supports the use TelecomManager APIs that
438 * utilize {@link android.os.OutcomeReceiver}s or {@link java.util.function.Consumer}s.
439 * Be aware, if this capability is set, {@link #CAPABILITY_SELF_MANAGED} will be amended by
440 * Telecom when this {@link PhoneAccount} is registered via
441 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}.
442 *
443 * <p>
444 * {@link android.os.OutcomeReceiver}s and {@link java.util.function.Consumer}s represent
445 * transactional operations because the operation can succeed or fail. An app wishing to use
446 * transactional operations should define behavior for a successful and failed TelecomManager
447 * API call.
448 *
449 * @see #CAPABILITY_SELF_MANAGED
450 * @see #getCapabilities
451 */
452 public static final int CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS = 0x40000;
453
Grace Jiaef5a4cc2022-12-13 11:08:55 -0800454 /**
455 * Flag indicating that this voip app {@link PhoneAccount} supports the call streaming session
456 * to stream call audio to another remote device via streaming app.
457 *
458 * @see #getCapabilities
459 */
460 public static final int CAPABILITY_SUPPORTS_CALL_STREAMING = 0x80000;
461
462 /* NEXT CAPABILITY: [0x100000, 0x200000, 0x400000] */
Hall Liu95d55872017-01-25 17:12:49 -0800463
464 /**
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700465 * URI scheme for telephone number URIs.
466 */
467 public static final String SCHEME_TEL = "tel";
468
469 /**
470 * URI scheme for voicemail URIs.
471 */
472 public static final String SCHEME_VOICEMAIL = "voicemail";
473
474 /**
475 * URI scheme for SIP URIs.
476 */
477 public static final String SCHEME_SIP = "sip";
478
Nancy Chen3ace54b2014-10-22 17:45:26 -0700479 /**
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800480 * Indicating no icon tint is set.
Santos Cordoncad84a22015-05-13 11:17:25 -0700481 * @hide
Nancy Chen3ace54b2014-10-22 17:45:26 -0700482 */
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800483 public static final int NO_ICON_TINT = 0;
484
485 /**
486 * Indicating no hightlight color is set.
487 */
488 public static final int NO_HIGHLIGHT_COLOR = 0;
Nancy Chen3ace54b2014-10-22 17:45:26 -0700489
Ihab Awad476cc832014-11-03 09:47:51 -0800490 /**
491 * Indicating no resource ID is set.
492 */
493 public static final int NO_RESOURCE_ID = -1;
494
Evan Charlton8c8a0622014-07-20 12:31:00 -0700495 private final PhoneAccountHandle mAccountHandle;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700496 private final Uri mAddress;
497 private final Uri mSubscriptionAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700498 private final int mCapabilities;
Ihab Awad476cc832014-11-03 09:47:51 -0800499 private final int mHighlightColor;
Santos Cordon146a3e32014-07-21 00:00:44 -0700500 private final CharSequence mLabel;
501 private final CharSequence mShortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700502 private final List<String> mSupportedUriSchemes;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800503 private final int mSupportedAudioRoutes;
Santos Cordoncad84a22015-05-13 11:17:25 -0700504 private final Icon mIcon;
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700505 private final Bundle mExtras;
Santos Cordon91371dc02015-05-08 13:52:09 -0700506 private boolean mIsEnabled;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700507 private String mGroupId;
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800508 private final Set<PhoneAccountHandle> mSimultaneousCallingRestriction;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700509
Tyler Gunn3b347812018-08-24 14:17:05 -0700510 @Override
511 public boolean equals(Object o) {
512 if (this == o) return true;
513 if (o == null || getClass() != o.getClass()) return false;
514 PhoneAccount that = (PhoneAccount) o;
515 return mCapabilities == that.mCapabilities &&
516 mHighlightColor == that.mHighlightColor &&
517 mSupportedAudioRoutes == that.mSupportedAudioRoutes &&
518 mIsEnabled == that.mIsEnabled &&
519 Objects.equals(mAccountHandle, that.mAccountHandle) &&
520 Objects.equals(mAddress, that.mAddress) &&
521 Objects.equals(mSubscriptionAddress, that.mSubscriptionAddress) &&
522 Objects.equals(mLabel, that.mLabel) &&
523 Objects.equals(mShortDescription, that.mShortDescription) &&
524 Objects.equals(mSupportedUriSchemes, that.mSupportedUriSchemes) &&
525 areBundlesEqual(mExtras, that.mExtras) &&
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800526 Objects.equals(mGroupId, that.mGroupId)
527 && Objects.equals(mSimultaneousCallingRestriction,
528 that.mSimultaneousCallingRestriction);
Tyler Gunn3b347812018-08-24 14:17:05 -0700529 }
530
531 @Override
532 public int hashCode() {
533 return Objects.hash(mAccountHandle, mAddress, mSubscriptionAddress, mCapabilities,
534 mHighlightColor, mLabel, mShortDescription, mSupportedUriSchemes,
535 mSupportedAudioRoutes,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800536 mExtras, mIsEnabled, mGroupId, mSimultaneousCallingRestriction);
Tyler Gunn3b347812018-08-24 14:17:05 -0700537 }
538
Santos Cordon32c65a52014-10-27 14:57:49 -0700539 /**
540 * Helper class for creating a {@link PhoneAccount}.
541 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700542 public static class Builder {
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800543
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700544 private PhoneAccountHandle mAccountHandle;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700545 private Uri mAddress;
546 private Uri mSubscriptionAddress;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700547 private int mCapabilities;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800548 private int mSupportedAudioRoutes = CallAudioState.ROUTE_ALL;
Ihab Awad5c9c86e2014-11-12 13:41:16 -0800549 private int mHighlightColor = NO_HIGHLIGHT_COLOR;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700550 private CharSequence mLabel;
551 private CharSequence mShortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700552 private List<String> mSupportedUriSchemes = new ArrayList<String>();
Santos Cordoncad84a22015-05-13 11:17:25 -0700553 private Icon mIcon;
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700554 private Bundle mExtras;
Santos Cordon91371dc02015-05-08 13:52:09 -0700555 private boolean mIsEnabled = false;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700556 private String mGroupId = "";
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800557 private Set<PhoneAccountHandle> mSimultaneousCallingRestriction = null;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700558
Santos Cordon32c65a52014-10-27 14:57:49 -0700559 /**
560 * Creates a builder with the specified {@link PhoneAccountHandle} and label.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800561 * <p>
562 * Note: each CharSequence or String field is limited to 256 characters. This check is
563 * enforced when registering the PhoneAccount via
564 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
565 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700566 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700567 public Builder(PhoneAccountHandle accountHandle, CharSequence label) {
568 this.mAccountHandle = accountHandle;
569 this.mLabel = label;
570 }
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700571
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700572 /**
573 * Creates an instance of the {@link PhoneAccount.Builder} from an existing
574 * {@link PhoneAccount}.
575 *
576 * @param phoneAccount The {@link PhoneAccount} used to initialize the builder.
577 */
578 public Builder(PhoneAccount phoneAccount) {
579 mAccountHandle = phoneAccount.getAccountHandle();
580 mAddress = phoneAccount.getAddress();
581 mSubscriptionAddress = phoneAccount.getSubscriptionAddress();
582 mCapabilities = phoneAccount.getCapabilities();
Ihab Awad476cc832014-11-03 09:47:51 -0800583 mHighlightColor = phoneAccount.getHighlightColor();
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700584 mLabel = phoneAccount.getLabel();
585 mShortDescription = phoneAccount.getShortDescription();
586 mSupportedUriSchemes.addAll(phoneAccount.getSupportedUriSchemes());
Santos Cordoncad84a22015-05-13 11:17:25 -0700587 mIcon = phoneAccount.getIcon();
Santos Cordon91371dc02015-05-08 13:52:09 -0700588 mIsEnabled = phoneAccount.isEnabled();
Tyler Gunnd426b202015-10-13 13:33:53 -0700589 mExtras = phoneAccount.getExtras();
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700590 mGroupId = phoneAccount.getGroupId();
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800591 mSupportedAudioRoutes = phoneAccount.getSupportedAudioRoutes();
Brad Ebingerad37ddc2024-01-22 12:34:02 -0800592 if (phoneAccount.hasSimultaneousCallingRestriction()) {
593 mSimultaneousCallingRestriction = phoneAccount.getSimultaneousCallingRestriction();
594 }
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700595 }
596
Santos Cordon32c65a52014-10-27 14:57:49 -0700597 /**
Tyler Gunn37653562017-03-13 18:15:15 -0700598 * Sets the label. See {@link PhoneAccount#getLabel()}.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800599 * <p>
600 * Note: Each CharSequence or String field is limited to 256 characters. This check is
601 * enforced when registering the PhoneAccount via
602 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
603 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Tyler Gunn37653562017-03-13 18:15:15 -0700604 *
605 * @param label The label of the phone account.
606 * @return The builder.
607 * @hide
608 */
609 public Builder setLabel(CharSequence label) {
610 this.mLabel = label;
611 return this;
612 }
613
614 /**
Santos Cordon32c65a52014-10-27 14:57:49 -0700615 * Sets the address. See {@link PhoneAccount#getAddress}.
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800616 * <p>
617 * Note: The entire URI value is limited to 256 characters. This check is
618 * enforced when registering the PhoneAccount via
619 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
620 * {@link IllegalArgumentException} to be thrown if URI is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700621 *
622 * @param value The address of the phone account.
623 * @return The builder.
624 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700625 public Builder setAddress(Uri value) {
626 this.mAddress = value;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700627 return this;
628 }
629
Santos Cordon32c65a52014-10-27 14:57:49 -0700630 /**
631 * Sets the subscription address. See {@link PhoneAccount#getSubscriptionAddress}.
632 *
633 * @param value The subscription address.
634 * @return The builder.
635 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700636 public Builder setSubscriptionAddress(Uri value) {
637 this.mSubscriptionAddress = value;
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700638 return this;
639 }
640
Santos Cordon32c65a52014-10-27 14:57:49 -0700641 /**
642 * Sets the capabilities. See {@link PhoneAccount#getCapabilities}.
643 *
644 * @param value The capabilities to set.
645 * @return The builder.
646 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700647 public Builder setCapabilities(int value) {
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700648 this.mCapabilities = value;
649 return this;
650 }
651
Santos Cordon32c65a52014-10-27 14:57:49 -0700652 /**
Santos Cordoncad84a22015-05-13 11:17:25 -0700653 * Sets the icon. See {@link PhoneAccount#getIcon}.
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800654 * <p>
655 * Note: An {@link IllegalArgumentException} if the Icon cannot be written to memory.
656 * This check is enforced when registering the PhoneAccount via
657 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)}
Santos Cordon32c65a52014-10-27 14:57:49 -0700658 *
Santos Cordoncad84a22015-05-13 11:17:25 -0700659 * @param icon The icon to set.
Santos Cordon32c65a52014-10-27 14:57:49 -0700660 */
Santos Cordoncad84a22015-05-13 11:17:25 -0700661 public Builder setIcon(Icon icon) {
662 mIcon = icon;
Ihab Awad074bf102014-10-24 11:42:32 -0700663 return this;
664 }
665
666 /**
Ihab Awad476cc832014-11-03 09:47:51 -0800667 * Sets the highlight color. See {@link PhoneAccount#getHighlightColor}.
Ihab Awad074bf102014-10-24 11:42:32 -0700668 *
Ihab Awad476cc832014-11-03 09:47:51 -0800669 * @param value The highlight color.
Ihab Awad074bf102014-10-24 11:42:32 -0700670 * @return The builder.
671 */
Ihab Awad476cc832014-11-03 09:47:51 -0800672 public Builder setHighlightColor(int value) {
673 this.mHighlightColor = value;
Nancy Chen3ace54b2014-10-22 17:45:26 -0700674 return this;
675 }
676
Santos Cordon32c65a52014-10-27 14:57:49 -0700677 /**
678 * Sets the short description. See {@link PhoneAccount#getShortDescription}.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800679 * <p>
680 * Note: Each CharSequence or String field is limited to 256 characters. This check is
681 * enforced when registering the PhoneAccount via
682 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
683 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Santos Cordon32c65a52014-10-27 14:57:49 -0700684 *
685 * @param value The short description.
686 * @return The builder.
687 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700688 public Builder setShortDescription(CharSequence value) {
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700689 this.mShortDescription = value;
690 return this;
691 }
692
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700693 /**
694 * Specifies an additional URI scheme supported by the {@link PhoneAccount}.
695 *
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800696 * <p>
697 * Each URI scheme is limited to 256 characters. Adding a scheme over 256 characters will
698 * cause an {@link IllegalArgumentException} to be thrown when the account is registered.
699 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700700 * @param uriScheme The URI scheme.
Santos Cordon32c65a52014-10-27 14:57:49 -0700701 * @return The builder.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700702 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700703 public Builder addSupportedUriScheme(String uriScheme) {
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700704 if (!TextUtils.isEmpty(uriScheme) && !mSupportedUriSchemes.contains(uriScheme)) {
705 this.mSupportedUriSchemes.add(uriScheme);
706 }
707 return this;
708 }
709
710 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -0700711 * Specifies the URI schemes supported by the {@link PhoneAccount}.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700712 *
Thomas Stuartba6c21c2022-11-21 17:38:21 -0800713 * <p>
714 * A max of 10 URI schemes can be added per account. Additionally, each URI scheme is
715 * limited to 256 characters. Adding more than 10 URI schemes or 256 characters on any
716 * scheme will cause an {@link IllegalArgumentException} to be thrown when the account
717 * is registered.
718 *
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700719 * @param uriSchemes The URI schemes.
Santos Cordon32c65a52014-10-27 14:57:49 -0700720 * @return The builder.
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700721 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700722 public Builder setSupportedUriSchemes(List<String> uriSchemes) {
723 mSupportedUriSchemes.clear();
724
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700725 if (uriSchemes != null && !uriSchemes.isEmpty()) {
726 for (String uriScheme : uriSchemes) {
Andrew Lee3085a6c2014-09-04 10:59:13 -0700727 addSupportedUriScheme(uriScheme);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700728 }
729 }
730 return this;
731 }
732
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700733 /**
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700734 * Specifies the extras associated with the {@link PhoneAccount}.
735 * <p>
736 * {@code PhoneAccount}s only support extra values of type: {@link String}, {@link Integer},
737 * and {@link Boolean}. Extras which are not of these types are ignored.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800738 * <p>
739 * Note: Each Bundle (Key, Value) String field is limited to 256 characters. Additionally,
740 * the bundle is limited to 100 (Key, Value) pairs total. This check is
741 * enforced when registering the PhoneAccount via
742 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
743 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256
744 * or more than 100 (Key, Value) pairs are in the Bundle.
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700745 *
746 * @param extras
747 * @return
748 */
749 public Builder setExtras(Bundle extras) {
750 mExtras = extras;
751 return this;
752 }
753
754 /**
Santos Cordon91371dc02015-05-08 13:52:09 -0700755 * Sets the enabled state of the phone account.
756 *
757 * @param isEnabled The enabled state.
758 * @return The builder.
759 * @hide
760 */
761 public Builder setIsEnabled(boolean isEnabled) {
762 mIsEnabled = isEnabled;
763 return this;
764 }
765
766 /**
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700767 * Sets the group Id of the {@link PhoneAccount}. When a new {@link PhoneAccount} is
768 * registered to Telecom, it will replace another {@link PhoneAccount} that is already
769 * registered in Telecom and take on the current user defaults and enabled status. There can
770 * only be one {@link PhoneAccount} with a non-empty group number registered to Telecom at a
771 * time. By default, there is no group Id for a {@link PhoneAccount} (an empty String). Only
772 * grouped {@link PhoneAccount}s with the same {@link ConnectionService} can be replaced.
Tyler Gunn5567d742019-10-31 13:04:37 -0700773 * <p>
Tyler Gunnc9503d62020-01-27 10:30:51 -0800774 * Note: This is an API specific to the Telephony stack; the group Id will be ignored for
775 * callers not holding the correct permission.
Thomas Stuarte2b0dc52022-12-28 11:10:50 -0800776 * <p>
777 * Additionally, each CharSequence or String field is limited to 256 characters.
778 * This check is enforced when registering the PhoneAccount via
779 * {@link TelecomManager#registerPhoneAccount(PhoneAccount)} and will cause an
780 * {@link IllegalArgumentException} to be thrown if the character field limit is over 256.
Tyler Gunn5567d742019-10-31 13:04:37 -0700781 *
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700782 * @param groupId The group Id of the {@link PhoneAccount} that will replace any other
783 * registered {@link PhoneAccount} in Telecom with the same Group Id.
784 * @return The builder
785 * @hide
786 */
Tyler Gunn5567d742019-10-31 13:04:37 -0700787 @SystemApi
Tyler Gunnc9503d62020-01-27 10:30:51 -0800788 @RequiresPermission(MODIFY_PHONE_STATE)
Tyler Gunn5567d742019-10-31 13:04:37 -0700789 public @NonNull Builder setGroupId(@NonNull String groupId) {
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700790 if (groupId != null) {
791 mGroupId = groupId;
792 } else {
793 mGroupId = "";
794 }
795 return this;
796 }
797
798 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800799 * Sets the audio routes supported by this {@link PhoneAccount}.
800 *
801 * @param routes bit mask of available routes.
802 * @return The builder.
803 * @hide
804 */
805 public Builder setSupportedAudioRoutes(int routes) {
806 mSupportedAudioRoutes = routes;
807 return this;
808 }
809
810 /**
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800811 * Restricts the ability of this {@link PhoneAccount} to ONLY support simultaneous calling
812 * with the other {@link PhoneAccountHandle}s in this Set.
813 * <p>
814 * If two or more {@link PhoneAccount}s support calling simultaneously, it means that
815 * Telecom allows the user to place additional outgoing calls and receive additional
816 * incoming calls using other {@link PhoneAccount}s while this PhoneAccount also has one or
817 * more active calls.
818 * <p>
819 * If this setter method is never called or cleared using
820 * {@link #clearSimultaneousCallingRestriction()}, there is no restriction and all
821 * {@link PhoneAccount}s registered to Telecom by this package support simultaneous calling.
Brad Ebinger1cfeff52024-02-06 15:36:22 -0800822 * If this setter is called and set as an empty Set, then this {@link PhoneAccount} does
823 * not support simultaneous calling with any other {@link PhoneAccount}s registered by the
824 * same application.
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800825 * <p>
826 * Note: Simultaneous calling restrictions can only be placed on {@link PhoneAccount}s that
827 * were registered by the same application. Simultaneous calling across applications is
828 * always possible as long as the {@link Connection} supports hold. If a
829 * {@link PhoneAccountHandle} is included here and the package name doesn't match this
830 * application's package name, {@link TelecomManager#registerPhoneAccount(PhoneAccount)}
831 * will throw a {@link SecurityException}.
832 *
833 * @param handles The other {@link PhoneAccountHandle}s that support calling simultaneously
Brad Ebinger516e7ab2024-01-19 15:31:57 -0800834 * with this one. Use {@link #clearSimultaneousCallingRestriction()} to remove the
835 * restriction and allow simultaneous calling to be supported across all
836 * {@link PhoneAccount}s registered by this package.
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800837 * @return The Builder used to set up the new PhoneAccount.
838 */
839 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
840 public @NonNull Builder setSimultaneousCallingRestriction(
841 @NonNull Set<PhoneAccountHandle> handles) {
842 if (handles == null) {
843 throw new IllegalArgumentException("the Set of PhoneAccountHandles must not be "
844 + "null");
845 }
846 mSimultaneousCallingRestriction = handles;
847 return this;
848 }
849
850 /**
851 * Clears a previously set simultaneous calling restriction set when
852 * {@link PhoneAccount.Builder#Builder(PhoneAccount)} is used to create a new PhoneAccount
853 * from an existing one.
854 *
855 * @return The Builder used to set up the new PhoneAccount.
856 * @see #setSimultaneousCallingRestriction(Set)
857 */
858 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
859 public @NonNull Builder clearSimultaneousCallingRestriction() {
860 mSimultaneousCallingRestriction = null;
861 return this;
862 }
863
864 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700865 * Creates an instance of a {@link PhoneAccount} based on the current builder settings.
866 *
867 * @return The {@link PhoneAccount}.
868 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700869 public PhoneAccount build() {
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700870 // If no supported URI schemes were defined, assume "tel" is supported.
871 if (mSupportedUriSchemes.isEmpty()) {
Andrew Lee3085a6c2014-09-04 10:59:13 -0700872 addSupportedUriScheme(SCHEME_TEL);
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700873 }
874
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700875 return new PhoneAccount(
876 mAccountHandle,
Andrew Lee3085a6c2014-09-04 10:59:13 -0700877 mAddress,
878 mSubscriptionAddress,
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700879 mCapabilities,
Santos Cordoncad84a22015-05-13 11:17:25 -0700880 mIcon,
Ihab Awad476cc832014-11-03 09:47:51 -0800881 mHighlightColor,
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700882 mLabel,
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700883 mShortDescription,
Santos Cordon91371dc02015-05-08 13:52:09 -0700884 mSupportedUriSchemes,
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700885 mExtras,
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800886 mSupportedAudioRoutes,
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700887 mIsEnabled,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800888 mGroupId,
889 mSimultaneousCallingRestriction);
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700890 }
891 }
892
893 private PhoneAccount(
Evan Charlton6eb262c2014-07-19 18:18:19 -0700894 PhoneAccountHandle account,
Andrew Lee3085a6c2014-09-04 10:59:13 -0700895 Uri address,
896 Uri subscriptionAddress,
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700897 int capabilities,
Santos Cordoncad84a22015-05-13 11:17:25 -0700898 Icon icon,
Ihab Awad476cc832014-11-03 09:47:51 -0800899 int highlightColor,
Santos Cordon146a3e32014-07-21 00:00:44 -0700900 CharSequence label,
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700901 CharSequence shortDescription,
Santos Cordon91371dc02015-05-08 13:52:09 -0700902 List<String> supportedUriSchemes,
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700903 Bundle extras,
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800904 int supportedAudioRoutes,
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700905 boolean isEnabled,
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800906 String groupId,
907 Set<PhoneAccountHandle> simultaneousCallingRestriction) {
Evan Charlton8c8a0622014-07-20 12:31:00 -0700908 mAccountHandle = account;
Andrew Lee3085a6c2014-09-04 10:59:13 -0700909 mAddress = address;
910 mSubscriptionAddress = subscriptionAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700911 mCapabilities = capabilities;
Santos Cordoncad84a22015-05-13 11:17:25 -0700912 mIcon = icon;
Ihab Awad476cc832014-11-03 09:47:51 -0800913 mHighlightColor = highlightColor;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700914 mLabel = label;
915 mShortDescription = shortDescription;
Tyler Gunnf5b29dc2014-09-03 09:09:12 -0700916 mSupportedUriSchemes = Collections.unmodifiableList(supportedUriSchemes);
Tyler Gunn25ed2d72015-10-05 14:14:38 -0700917 mExtras = extras;
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800918 mSupportedAudioRoutes = supportedAudioRoutes;
Santos Cordon91371dc02015-05-08 13:52:09 -0700919 mIsEnabled = isEnabled;
Brad Ebinger7298f3b2016-06-10 17:19:42 -0700920 mGroupId = groupId;
Brad Ebingerb0c1d912024-01-12 14:51:35 -0800921 mSimultaneousCallingRestriction = simultaneousCallingRestriction;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700922 }
923
Andrew Lee3085a6c2014-09-04 10:59:13 -0700924 public static Builder builder(
925 PhoneAccountHandle accountHandle,
926 CharSequence label) {
927 return new Builder(accountHandle, label);
928 }
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700929
Ihab Awad807fe0a2014-07-09 12:30:52 -0700930 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700931 * Returns a builder initialized with the current {@link PhoneAccount} instance.
932 *
933 * @return The builder.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700934 */
935 public Builder toBuilder() { return new Builder(this); }
936
937 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700938 * The unique identifier of this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700939 *
Evan Charlton6eb262c2014-07-19 18:18:19 -0700940 * @return A {@code PhoneAccountHandle}.
Ihab Awad807fe0a2014-07-09 12:30:52 -0700941 */
Evan Charlton8c8a0622014-07-20 12:31:00 -0700942 public PhoneAccountHandle getAccountHandle() {
943 return mAccountHandle;
Ihab Awad807fe0a2014-07-09 12:30:52 -0700944 }
945
946 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -0700947 * The address (e.g., a phone number) associated with this {@code PhoneAccount}. This
Evan Charlton8c8a0622014-07-20 12:31:00 -0700948 * represents the destination from which outgoing calls using this {@code PhoneAccount}
Evan Charlton6eb262c2014-07-19 18:18:19 -0700949 * will appear to come, if applicable, and the destination to which incoming calls using this
Evan Charlton8c8a0622014-07-20 12:31:00 -0700950 * {@code PhoneAccount} may be addressed.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700951 *
Andrew Lee3085a6c2014-09-04 10:59:13 -0700952 * @return A address expressed as a {@code Uri}, for example, a phone number.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700953 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700954 public Uri getAddress() {
955 return mAddress;
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700956 }
957
958 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700959 * The raw callback number used for this {@code PhoneAccount}, as distinct from
Andrew Lee3085a6c2014-09-04 10:59:13 -0700960 * {@link #getAddress()}. For the majority of {@code PhoneAccount}s this should be registered
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700961 * as {@code null}. It is used by the system for SIM-based {@code PhoneAccount} registration
Junda Liuf52ac902014-09-25 17:36:48 +0000962 * where {@link android.telephony.TelephonyManager#setLine1NumberForDisplay(String, String)}
963 * has been used to alter the callback number.
964 * <p>
Evan Charlton222db5252014-07-17 16:59:18 -0700965 *
966 * @return The subscription number, suitable for display to the user.
967 */
Andrew Lee3085a6c2014-09-04 10:59:13 -0700968 public Uri getSubscriptionAddress() {
969 return mSubscriptionAddress;
Evan Charlton222db5252014-07-17 16:59:18 -0700970 }
971
972 /**
Evan Charlton8c8a0622014-07-20 12:31:00 -0700973 * The capabilities of this {@code PhoneAccount}.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700974 *
Evan Charlton8c8a0622014-07-20 12:31:00 -0700975 * @return A bit field of flags describing this {@code PhoneAccount}'s capabilities.
Ihab Awad94cf4bf2014-07-17 11:21:19 -0700976 */
977 public int getCapabilities() {
978 return mCapabilities;
979 }
980
981 /**
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700982 * Determines if this {@code PhoneAccount} has a capabilities specified by the passed in
983 * bit mask.
984 *
985 * @param capability The capabilities to check.
Santos Cordon895d4b82015-06-25 16:41:48 -0700986 * @return {@code true} if the phone account has the capability.
Tyler Gunna1ed7d12014-09-08 09:52:22 -0700987 */
988 public boolean hasCapabilities(int capability) {
989 return (mCapabilities & capability) == capability;
990 }
991
992 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -0800993 * Determines if this {@code PhoneAccount} has routes specified by the passed in bit mask.
994 *
995 * @param route The routes to check.
996 * @return {@code true} if the phone account has the routes.
997 * @hide
998 */
999 public boolean hasAudioRoutes(int routes) {
1000 return (mSupportedAudioRoutes & routes) == routes;
1001 }
1002
1003 /**
Santos Cordon146a3e32014-07-21 00:00:44 -07001004 * A short label describing a {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001005 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001006 * @return A label for this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001007 */
Santos Cordon146a3e32014-07-21 00:00:44 -07001008 public CharSequence getLabel() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001009 return mLabel;
1010 }
1011
1012 /**
Ihab Awadb19a0bc2014-08-07 19:46:01 -07001013 * A short paragraph describing this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001014 *
Evan Charlton8c8a0622014-07-20 12:31:00 -07001015 * @return A description for this {@code PhoneAccount}.
Ihab Awad807fe0a2014-07-09 12:30:52 -07001016 */
Santos Cordon146a3e32014-07-21 00:00:44 -07001017 public CharSequence getShortDescription() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001018 return mShortDescription;
1019 }
1020
1021 /**
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001022 * The URI schemes supported by this {@code PhoneAccount}.
1023 *
1024 * @return The URI schemes.
1025 */
1026 public List<String> getSupportedUriSchemes() {
1027 return mSupportedUriSchemes;
1028 }
1029
1030 /**
Tyler Gunn25ed2d72015-10-05 14:14:38 -07001031 * The extras associated with this {@code PhoneAccount}.
1032 * <p>
1033 * A {@link ConnectionService} may provide implementation specific information about the
1034 * {@link PhoneAccount} via the extras.
1035 *
1036 * @return The extras.
1037 */
1038 public Bundle getExtras() {
1039 return mExtras;
1040 }
1041
1042 /**
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001043 * The audio routes supported by this {@code PhoneAccount}.
1044 *
1045 * @hide
1046 */
1047 public int getSupportedAudioRoutes() {
1048 return mSupportedAudioRoutes;
1049 }
1050
1051 /**
Santos Cordoncad84a22015-05-13 11:17:25 -07001052 * The icon to represent this {@code PhoneAccount}.
1053 *
1054 * @return The icon.
1055 */
1056 public Icon getIcon() {
1057 return mIcon;
1058 }
1059
1060 /**
Santos Cordon895d4b82015-06-25 16:41:48 -07001061 * Indicates whether the user has enabled this {@code PhoneAccount} or not. This value is only
1062 * populated for {@code PhoneAccount}s returned by {@link TelecomManager#getPhoneAccount}.
Santos Cordon91371dc02015-05-08 13:52:09 -07001063 *
Santos Cordon895d4b82015-06-25 16:41:48 -07001064 * @return {@code true} if the account is enabled by the user, {@code false} otherwise.
Santos Cordon91371dc02015-05-08 13:52:09 -07001065 */
1066 public boolean isEnabled() {
1067 return mIsEnabled;
1068 }
1069
1070 /**
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001071 * A non-empty {@link String} representing the group that A {@link PhoneAccount} is in or an
1072 * empty {@link String} if the {@link PhoneAccount} is not in a group. If this
1073 * {@link PhoneAccount} is in a group, this new {@link PhoneAccount} will replace a registered
1074 * {@link PhoneAccount} that is in the same group. When the {@link PhoneAccount} is replaced,
1075 * its user defined defaults and enabled status will also pass to this new {@link PhoneAccount}.
1076 * Only {@link PhoneAccount}s that share the same {@link ConnectionService} can be replaced.
1077 *
1078 * @return A non-empty String Id if this {@link PhoneAccount} belongs to a group.
1079 * @hide
1080 */
1081 public String getGroupId() {
1082 return mGroupId;
1083 }
1084
1085 /**
Andrew Lee3085a6c2014-09-04 10:59:13 -07001086 * Determines if the {@link PhoneAccount} supports calls to/from addresses with a specified URI
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001087 * scheme.
1088 *
1089 * @param uriScheme The URI scheme to check.
Santos Cordon895d4b82015-06-25 16:41:48 -07001090 * @return {@code true} if the {@code PhoneAccount} supports calls to/from addresses with the
Tyler Gunnf5b29dc2014-09-03 09:09:12 -07001091 * specified URI scheme.
1092 */
1093 public boolean supportsUriScheme(String uriScheme) {
1094 if (mSupportedUriSchemes == null || uriScheme == null) {
1095 return false;
1096 }
1097
1098 for (String scheme : mSupportedUriSchemes) {
1099 if (scheme != null && scheme.equals(uriScheme)) {
1100 return true;
1101 }
1102 }
1103 return false;
1104 }
1105
1106 /**
Ihab Awad476cc832014-11-03 09:47:51 -08001107 * A highlight color to use in displaying information about this {@code PhoneAccount}.
1108 *
1109 * @return A hexadecimal color value.
1110 */
1111 public int getHighlightColor() {
1112 return mHighlightColor;
1113 }
1114
Santos Cordon91371dc02015-05-08 13:52:09 -07001115 /**
1116 * Sets the enabled state of the phone account.
1117 * @hide
1118 */
1119 public void setIsEnabled(boolean isEnabled) {
1120 mIsEnabled = isEnabled;
1121 }
1122
Tyler Gunnf5035432017-01-09 09:43:12 -08001123 /**
1124 * @return {@code true} if the {@link PhoneAccount} is self-managed, {@code false} otherwise.
1125 * @hide
1126 */
1127 public boolean isSelfManaged() {
1128 return (mCapabilities & CAPABILITY_SELF_MANAGED) == CAPABILITY_SELF_MANAGED;
1129 }
1130
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001131 /**
1132 * If a restriction is set (see {@link #hasSimultaneousCallingRestriction()}), this method
1133 * returns the Set of {@link PhoneAccountHandle}s that are allowed to support calls
1134 * simultaneously with this {@link PhoneAccount}.
1135 * <p>
1136 * If this {@link PhoneAccount} is busy with one or more ongoing calls, a restriction is set on
1137 * this PhoneAccount (see {@link #hasSimultaneousCallingRestriction()} to check), and a new
1138 * incoming or outgoing call is received or placed on a PhoneAccount that is not in this Set,
1139 * Telecom will reject or cancel the pending call in favor of keeping the ongoing call alive.
1140 * <p>
1141 * Note: Simultaneous calling restrictions can only be placed on {@link PhoneAccount}s that
1142 * were registered by the same application. Simultaneous calling across applications is
1143 * always possible as long as the {@link Connection} supports hold.
1144 *
1145 * @return the Set of {@link PhoneAccountHandle}s that this {@link PhoneAccount} supports
1146 * simultaneous calls with.
1147 * @throws IllegalStateException If there is no restriction set on this {@link PhoneAccount}
1148 * and this method is called. Whether or not there is a restriction can be checked using
1149 * {@link #hasSimultaneousCallingRestriction()}.
1150 */
1151 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
1152 public @NonNull Set<PhoneAccountHandle> getSimultaneousCallingRestriction() {
1153 if (mSimultaneousCallingRestriction == null) {
1154 throw new IllegalStateException("This method can not be called if there is no "
1155 + "simultaneous calling restriction. See #hasSimultaneousCallingRestriction");
1156 }
1157 return mSimultaneousCallingRestriction;
1158 }
1159
1160 /**
1161 * Whether or not this {@link PhoneAccount} contains a simultaneous calling restriction on it.
1162 *
1163 * @return {@code true} if this PhoneAccount contains a simultaneous calling restriction,
1164 * {@code false} if it does not. Use {@link #getSimultaneousCallingRestriction()} to query which
1165 * other {@link PhoneAccount}s support simultaneous calling with this one.
1166 * @see #getSimultaneousCallingRestriction() for more information on how the sinultaneous
1167 * calling restriction works.
1168 */
1169 @FlaggedApi(Flags.FLAG_SIMULTANEOUS_CALLING_INDICATIONS)
1170 public boolean hasSimultaneousCallingRestriction() {
1171 return mSimultaneousCallingRestriction != null;
1172 }
1173
Ihab Awad807fe0a2014-07-09 12:30:52 -07001174 //
1175 // Parcelable implementation
1176 //
1177
1178 @Override
1179 public int describeContents() {
1180 return 0;
1181 }
1182
1183 @Override
1184 public void writeToParcel(Parcel out, int flags) {
Ihab Awad476cc832014-11-03 09:47:51 -08001185 if (mAccountHandle == null) {
1186 out.writeInt(0);
1187 } else {
1188 out.writeInt(1);
1189 mAccountHandle.writeToParcel(out, flags);
1190 }
1191 if (mAddress == null) {
1192 out.writeInt(0);
1193 } else {
1194 out.writeInt(1);
1195 mAddress.writeToParcel(out, flags);
1196 }
1197 if (mSubscriptionAddress == null) {
1198 out.writeInt(0);
1199 } else {
1200 out.writeInt(1);
1201 mSubscriptionAddress.writeToParcel(out, flags);
1202 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001203 out.writeInt(mCapabilities);
Ihab Awad476cc832014-11-03 09:47:51 -08001204 out.writeInt(mHighlightColor);
Santos Cordon146a3e32014-07-21 00:00:44 -07001205 out.writeCharSequence(mLabel);
1206 out.writeCharSequence(mShortDescription);
Ihab Awad476cc832014-11-03 09:47:51 -08001207 out.writeStringList(mSupportedUriSchemes);
Santos Cordon91371dc02015-05-08 13:52:09 -07001208
Santos Cordoncad84a22015-05-13 11:17:25 -07001209 if (mIcon == null) {
1210 out.writeInt(0);
1211 } else {
1212 out.writeInt(1);
1213 mIcon.writeToParcel(out, flags);
1214 }
Santos Cordon91371dc02015-05-08 13:52:09 -07001215 out.writeByte((byte) (mIsEnabled ? 1 : 0));
Tyler Gunnef829ec2015-10-08 09:46:23 -07001216 out.writeBundle(mExtras);
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001217 out.writeString(mGroupId);
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001218 out.writeInt(mSupportedAudioRoutes);
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001219 if (mSimultaneousCallingRestriction == null) {
1220 out.writeBoolean(false);
1221 } else {
1222 out.writeBoolean(true);
1223 out.writeTypedList(mSimultaneousCallingRestriction.stream().toList());
1224 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001225 }
1226
Jeff Sharkey9e8f83d2019-02-28 12:06:45 -07001227 public static final @android.annotation.NonNull Creator<PhoneAccount> CREATOR
Evan Charlton8c8a0622014-07-20 12:31:00 -07001228 = new Creator<PhoneAccount>() {
Ihab Awad807fe0a2014-07-09 12:30:52 -07001229 @Override
Evan Charlton8c8a0622014-07-20 12:31:00 -07001230 public PhoneAccount createFromParcel(Parcel in) {
1231 return new PhoneAccount(in);
Ihab Awad807fe0a2014-07-09 12:30:52 -07001232 }
1233
1234 @Override
Evan Charlton8c8a0622014-07-20 12:31:00 -07001235 public PhoneAccount[] newArray(int size) {
1236 return new PhoneAccount[size];
Ihab Awad807fe0a2014-07-09 12:30:52 -07001237 }
1238 };
1239
Evan Charlton8c8a0622014-07-20 12:31:00 -07001240 private PhoneAccount(Parcel in) {
Ihab Awad476cc832014-11-03 09:47:51 -08001241 if (in.readInt() > 0) {
1242 mAccountHandle = PhoneAccountHandle.CREATOR.createFromParcel(in);
1243 } else {
1244 mAccountHandle = null;
1245 }
1246 if (in.readInt() > 0) {
1247 mAddress = Uri.CREATOR.createFromParcel(in);
1248 } else {
1249 mAddress = null;
1250 }
1251 if (in.readInt() > 0) {
1252 mSubscriptionAddress = Uri.CREATOR.createFromParcel(in);
1253 } else {
1254 mSubscriptionAddress = null;
1255 }
Ihab Awad94cf4bf2014-07-17 11:21:19 -07001256 mCapabilities = in.readInt();
Ihab Awad476cc832014-11-03 09:47:51 -08001257 mHighlightColor = in.readInt();
Santos Cordon146a3e32014-07-21 00:00:44 -07001258 mLabel = in.readCharSequence();
1259 mShortDescription = in.readCharSequence();
Ihab Awad476cc832014-11-03 09:47:51 -08001260 mSupportedUriSchemes = Collections.unmodifiableList(in.createStringArrayList());
Santos Cordoncad84a22015-05-13 11:17:25 -07001261 if (in.readInt() > 0) {
1262 mIcon = Icon.CREATOR.createFromParcel(in);
1263 } else {
1264 mIcon = null;
1265 }
Santos Cordon91371dc02015-05-08 13:52:09 -07001266 mIsEnabled = in.readByte() == 1;
Tyler Gunnef829ec2015-10-08 09:46:23 -07001267 mExtras = in.readBundle();
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001268 mGroupId = in.readString();
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001269 mSupportedAudioRoutes = in.readInt();
Brad Ebingerb0c1d912024-01-12 14:51:35 -08001270 if (in.readBoolean()) {
1271 List<PhoneAccountHandle> list = new ArrayList<>();
1272 in.readTypedList(list, PhoneAccountHandle.CREATOR);
1273 mSimultaneousCallingRestriction = new ArraySet<>(list);
1274 } else {
1275 mSimultaneousCallingRestriction = null;
1276 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001277 }
Tyler Gunn76c01a52014-09-30 14:47:51 -07001278
1279 @Override
1280 public String toString() {
Santos Cordon91371dc02015-05-08 13:52:09 -07001281 StringBuilder sb = new StringBuilder().append("[[")
1282 .append(mIsEnabled ? 'X' : ' ')
1283 .append("] PhoneAccount: ")
Tyler Gunn76c01a52014-09-30 14:47:51 -07001284 .append(mAccountHandle)
1285 .append(" Capabilities: ")
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001286 .append(capabilitiesToString())
1287 .append(" Audio Routes: ")
1288 .append(audioRoutesToString())
Tyler Gunn76c01a52014-09-30 14:47:51 -07001289 .append(" Schemes: ");
1290 for (String scheme : mSupportedUriSchemes) {
1291 sb.append(scheme)
1292 .append(" ");
1293 }
Tyler Gunnef829ec2015-10-08 09:46:23 -07001294 sb.append(" Extras: ");
Tyler Gunn25ed2d72015-10-05 14:14:38 -07001295 sb.append(mExtras);
Brad Ebinger7298f3b2016-06-10 17:19:42 -07001296 sb.append(" GroupId: ");
1297 sb.append(Log.pii(mGroupId));
Brad Ebinger5365cc32024-01-26 09:53:55 -08001298 sb.append(" SC Restrictions: ");
1299 if (hasSimultaneousCallingRestriction()) {
1300 sb.append("[ ");
1301 for (PhoneAccountHandle handle : mSimultaneousCallingRestriction) {
1302 sb.append(handle);
1303 sb.append(" ");
1304 }
1305 sb.append("]");
1306 } else {
1307 sb.append("[NONE]");
1308 }
Tyler Gunn76c01a52014-09-30 14:47:51 -07001309 sb.append("]");
1310 return sb.toString();
1311 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001312
1313 /**
1314 * Generates a string representation of a capabilities bitmask.
1315 *
Tyler Gunn3e122f72016-01-11 19:25:00 -08001316 * @return String representation of the capabilities bitmask.
Tyler Gunn1847b4e2018-11-09 08:43:02 -08001317 * @hide
Tyler Gunn3e122f72016-01-11 19:25:00 -08001318 */
Tyler Gunn1847b4e2018-11-09 08:43:02 -08001319 public String capabilitiesToString() {
Tyler Gunn3e122f72016-01-11 19:25:00 -08001320 StringBuilder sb = new StringBuilder();
Tyler Gunnf5035432017-01-09 09:43:12 -08001321 if (hasCapabilities(CAPABILITY_SELF_MANAGED)) {
1322 sb.append("SelfManaged ");
1323 }
Tyler Gunn58cbd7a2016-11-11 11:31:28 -08001324 if (hasCapabilities(CAPABILITY_SUPPORTS_VIDEO_CALLING)) {
1325 sb.append("SuppVideo ");
1326 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001327 if (hasCapabilities(CAPABILITY_VIDEO_CALLING)) {
1328 sb.append("Video ");
1329 }
1330 if (hasCapabilities(CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE)) {
1331 sb.append("Presence ");
1332 }
1333 if (hasCapabilities(CAPABILITY_CALL_PROVIDER)) {
1334 sb.append("CallProvider ");
1335 }
1336 if (hasCapabilities(CAPABILITY_CALL_SUBJECT)) {
1337 sb.append("CallSubject ");
1338 }
1339 if (hasCapabilities(CAPABILITY_CONNECTION_MANAGER)) {
1340 sb.append("ConnectionMgr ");
1341 }
1342 if (hasCapabilities(CAPABILITY_EMERGENCY_CALLS_ONLY)) {
1343 sb.append("EmergOnly ");
1344 }
1345 if (hasCapabilities(CAPABILITY_MULTI_USER)) {
1346 sb.append("MultiUser ");
1347 }
1348 if (hasCapabilities(CAPABILITY_PLACE_EMERGENCY_CALLS)) {
1349 sb.append("PlaceEmerg ");
1350 }
Brad Ebinger3636d742019-05-21 15:28:19 -07001351 if (hasCapabilities(CAPABILITY_EMERGENCY_PREFERRED)) {
1352 sb.append("EmerPrefer ");
1353 }
Tyler Gunncee9ea62016-03-24 11:45:43 -07001354 if (hasCapabilities(CAPABILITY_EMERGENCY_VIDEO_CALLING)) {
1355 sb.append("EmergVideo ");
1356 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001357 if (hasCapabilities(CAPABILITY_SIM_SUBSCRIPTION)) {
1358 sb.append("SimSub ");
1359 }
Hall Liu47ed6202017-11-20 16:25:39 -08001360 if (hasCapabilities(CAPABILITY_RTT)) {
Hunter Knepshield25265682022-01-19 02:25:06 -08001361 sb.append("Rtt ");
Hall Liu47ed6202017-11-20 16:25:39 -08001362 }
Ravi Paluri80aa2142019-12-02 11:57:37 +05301363 if (hasCapabilities(CAPABILITY_ADHOC_CONFERENCE_CALLING)) {
Hunter Knepshield25265682022-01-19 02:25:06 -08001364 sb.append("AdhocConf ");
Ravi Paluri80aa2142019-12-02 11:57:37 +05301365 }
Shuo Qiand24aea32020-11-24 15:08:49 -08001366 if (hasCapabilities(CAPABILITY_CALL_COMPOSER)) {
1367 sb.append("CallComposer ");
1368 }
Hunter Knepshield25265682022-01-19 02:25:06 -08001369 if (hasCapabilities(CAPABILITY_SUPPORTS_VOICE_CALLING_INDICATIONS)) {
1370 sb.append("SuppVoice ");
1371 }
1372 if (hasCapabilities(CAPABILITY_VOICE_CALLING_AVAILABLE)) {
1373 sb.append("Voice ");
1374 }
Thomas Stuart649bedd2023-02-23 15:48:31 -08001375 if (hasCapabilities(CAPABILITY_SUPPORTS_TRANSACTIONAL_OPERATIONS)) {
1376 sb.append("TransactOps ");
1377 }
1378 if (hasCapabilities(CAPABILITY_SUPPORTS_CALL_STREAMING)) {
1379 sb.append("Stream ");
1380 }
Tyler Gunn3e122f72016-01-11 19:25:00 -08001381 return sb.toString();
1382 }
Christine Hallstrom2830ce92016-11-30 16:06:42 -08001383
1384 private String audioRoutesToString() {
1385 StringBuilder sb = new StringBuilder();
1386
1387 if (hasAudioRoutes(CallAudioState.ROUTE_BLUETOOTH)) {
1388 sb.append("B");
1389 }
1390 if (hasAudioRoutes(CallAudioState.ROUTE_EARPIECE)) {
1391 sb.append("E");
1392 }
1393 if (hasAudioRoutes(CallAudioState.ROUTE_SPEAKER)) {
1394 sb.append("S");
1395 }
1396 if (hasAudioRoutes(CallAudioState.ROUTE_WIRED_HEADSET)) {
1397 sb.append("W");
1398 }
1399
1400 return sb.toString();
1401 }
Tyler Gunn3b347812018-08-24 14:17:05 -07001402
1403 /**
1404 * Determines if two {@link Bundle}s are equal.
1405 * @param extras First {@link Bundle} to check.
1406 * @param newExtras {@link Bundle} to compare against.
1407 * @return {@code true} if the {@link Bundle}s are equal, {@code false} otherwise.
1408 */
1409 private static boolean areBundlesEqual(Bundle extras, Bundle newExtras) {
1410 if (extras == null || newExtras == null) {
1411 return extras == newExtras;
1412 }
1413
1414 if (extras.size() != newExtras.size()) {
1415 return false;
1416 }
1417
1418 for(String key : extras.keySet()) {
1419 if (key != null) {
1420 final Object value = extras.get(key);
1421 final Object newValue = newExtras.get(key);
1422 if (!Objects.equals(value, newValue)) {
1423 return false;
1424 }
1425 }
1426 }
1427 return true;
1428 }
Ihab Awad807fe0a2014-07-09 12:30:52 -07001429}