CarrierConfigManager.java revision 408f695c9809f6731cafabf20b653fa8b699c49f
1/*
2 * Copyright (C) 2015 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
17package android.telephony;
18
19import android.annotation.NonNull;
20import android.annotation.Nullable;
21import android.annotation.SystemApi;
22import android.content.Context;
23import android.os.PersistableBundle;
24import android.os.RemoteException;
25import android.os.ServiceManager;
26
27import com.android.ims.ImsReasonInfo;
28import com.android.internal.telephony.ICarrierConfigLoader;
29
30/**
31 * Provides access to telephony configuration values that are carrier-specific.
32 * <p>
33 * Users should obtain an instance of this class by calling
34 * {@code mContext.getSystemService(Context.CARRIER_CONFIG_SERVICE);}
35 * </p>
36 *
37 * @see Context#getSystemService
38 * @see Context#CARRIER_CONFIG_SERVICE
39 */
40public class CarrierConfigManager {
41    private final static String TAG = "CarrierConfigManager";
42
43    /**
44     * @hide
45     */
46    public CarrierConfigManager() {
47    }
48
49    /**
50     * This intent is broadcast by the system when carrier config changes.
51     */
52    public static final String
53            ACTION_CARRIER_CONFIG_CHANGED = "android.telephony.action.CARRIER_CONFIG_CHANGED";
54
55    // Below are the keys used in carrier config bundles. To add a new variable, define the key and
56    // give it a default value in sDefaults. If you need to ship a per-network override in the
57    // system image, that can be added in packages/apps/CarrierConfig.
58
59    /**
60     * This flag specifies whether VoLTE availability is based on provisioning. By default this is
61     * false.
62     */
63    public static final String
64            KEY_CARRIER_VOLTE_PROVISIONED_BOOL = "carrier_volte_provisioned_bool";
65
66    /**
67     * Flag indicating whether the Phone app should ignore EVENT_SIM_NETWORK_LOCKED
68     * events from the Sim.
69     * If true, this will prevent the IccNetworkDepersonalizationPanel from being shown, and
70     * effectively disable the "Sim network lock" feature.
71     */
72    public static final String
73            KEY_IGNORE_SIM_NETWORK_LOCKED_EVENTS_BOOL = "ignore_sim_network_locked_events_bool";
74
75    /**
76     * When checking if a given number is the voicemail number, if this flag is true
77     * then in addition to comparing the given number to the voicemail number, we also compare it
78     * to the mdn. If this flag is false, the given number is only compared to the voicemail number.
79     * By default this value is false.
80     */
81    public static final String KEY_MDN_IS_ADDITIONAL_VOICEMAIL_NUMBER_BOOL =
82            "mdn_is_additional_voicemail_number_bool";
83
84    /**
85     * Flag indicating whether the Phone app should provide a "Dismiss" button on the SIM network
86     * unlock screen. The default value is true. If set to false, there will be *no way* to dismiss
87     * the SIM network unlock screen if you don't enter the correct unlock code. (One important
88     * consequence: there will be no way to make an Emergency Call if your SIM is network-locked and
89     * you don't know the PIN.)
90     */
91    public static final String
92            KEY_SIM_NETWORK_UNLOCK_ALLOW_DISMISS_BOOL = "sim_network_unlock_allow_dismiss_bool";
93
94    /** Flag indicating if the phone is a world phone */
95    public static final String KEY_WORLD_PHONE_BOOL = "world_phone_bool";
96
97    /**
98     * Flag to require or skip entitlement checks.
99     * If true, entitlement checks will be executed if device has been configured for it,
100     * If false, entitlement checks will be skipped.
101     */
102    public static final String
103            KEY_REQUIRE_ENTITLEMENT_CHECKS_BOOL = "require_entitlement_checks_bool";
104
105    /**
106     * Flag indicating whether radio is to be restarted on error PDP_FAIL_REGULAR_DEACTIVATION
107     * This is false by default.
108     */
109    public static final String
110            KEY_RESTART_RADIO_ON_PDP_FAIL_REGULAR_DEACTIVATION_BOOL =
111                    "restart_radio_on_pdp_fail_regular_deactivation_bool";
112
113    /**
114     * If true, enable vibration (haptic feedback) for key presses in the EmergencyDialer activity.
115     * The pattern is set on a per-platform basis using config_virtualKeyVibePattern. To be
116     * consistent with the regular Dialer, this value should agree with the corresponding values
117     * from config.xml under apps/Contacts.
118     */
119    public static final String
120            KEY_ENABLE_DIALER_KEY_VIBRATION_BOOL = "enable_dialer_key_vibration_bool";
121
122    /** Flag indicating if dtmf tone type is enabled */
123    public static final String KEY_DTMF_TYPE_ENABLED_BOOL = "dtmf_type_enabled_bool";
124
125    /** Flag indicating if auto retry is enabled */
126    public static final String KEY_AUTO_RETRY_ENABLED_BOOL = "auto_retry_enabled_bool";
127
128    /**
129     * Determine whether we want to play local DTMF tones in a call, or just let the radio/BP handle
130     * playing of the tones.
131     */
132    public static final String KEY_ALLOW_LOCAL_DTMF_TONES_BOOL = "allow_local_dtmf_tones_bool";
133
134    /**
135     * Determines if the carrier requires converting the destination number before sending out an
136     * SMS. Certain networks and numbering plans require different formats.
137     */
138    public static final String KEY_SMS_REQUIRES_DESTINATION_NUMBER_CONVERSION_BOOL=
139            "sms_requires_destination_number_conversion_bool";
140
141    /**
142     * If true, show an onscreen "Dial" button in the dialer. In practice this is used on all
143     * platforms, even the ones with hard SEND/END keys, but for maximum flexibility it's controlled
144     * by a flag here (which can be overridden on a per-product basis.)
145     */
146    public static final String KEY_SHOW_ONSCREEN_DIAL_BUTTON_BOOL = "show_onscreen_dial_button_bool";
147
148    /** Determines if device implements a noise suppression device for in call audio. */
149    public static final String
150            KEY_HAS_IN_CALL_NOISE_SUPPRESSION_BOOL = "has_in_call_noise_suppression_bool";
151
152    /**
153     * Determines if the current device should allow emergency numbers to be logged in the Call Log.
154     * (Some carriers require that emergency calls *not* be logged, presumably to avoid the risk of
155     * accidental redialing from the call log UI. This is a good idea, so the default here is
156     * false.)
157     */
158    public static final String
159            KEY_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG_BOOL = "allow_emergency_numbers_in_call_log_bool";
160
161    /** If true, removes the Voice Privacy option from Call Settings */
162    public static final String KEY_VOICE_PRIVACY_DISABLE_UI_BOOL = "voice_privacy_disable_ui_bool";
163
164    /** Control whether users can reach the carrier portions of Cellular Network Settings. */
165    public static final String
166            KEY_HIDE_CARRIER_NETWORK_SETTINGS_BOOL = "hide_carrier_network_settings_bool";
167
168    /** Control whether users can reach the SIM lock settings. */
169    public static final String
170            KEY_HIDE_SIM_LOCK_SETTINGS_BOOL = "hide_sim_lock_settings_bool";
171
172    /** Control whether users can edit APNs in Settings. */
173    public static final String KEY_APN_EXPAND_BOOL = "apn_expand_bool";
174
175    /** Control whether users can choose a network operator. */
176    public static final String KEY_OPERATOR_SELECTION_EXPAND_BOOL = "operator_selection_expand_bool";
177
178    /** Used in Cellular Network Settings for preferred network type. */
179    public static final String KEY_PREFER_2G_BOOL = "prefer_2g_bool";
180
181    /** Show cdma network mode choices 1x, 3G, global etc. */
182    public static final String KEY_SHOW_CDMA_CHOICES_BOOL = "show_cdma_choices_bool";
183
184    /** CDMA activation goes through HFA */
185    public static final String KEY_USE_HFA_FOR_PROVISIONING_BOOL = "use_hfa_for_provisioning_bool";
186
187    /**
188     * CDMA activation goes through OTASP.
189     * <p>
190     * TODO: This should be combined with config_use_hfa_for_provisioning and implemented as an enum
191     * (NONE, HFA, OTASP).
192     */
193    public static final String KEY_USE_OTASP_FOR_PROVISIONING_BOOL = "use_otasp_for_provisioning_bool";
194
195    /** Display carrier settings menu if true */
196    public static final String KEY_CARRIER_SETTINGS_ENABLE_BOOL = "carrier_settings_enable_bool";
197
198    /** Does not display additional call seting for IMS phone based on GSM Phone */
199    public static final String KEY_ADDITIONAL_CALL_SETTING_BOOL = "additional_call_setting_bool";
200
201    /** Show APN Settings for some CDMA carriers */
202    public static final String KEY_SHOW_APN_SETTING_CDMA_BOOL = "show_apn_setting_cdma_bool";
203
204    /** After a CDMA conference call is merged, the swap button should be displayed. */
205    public static final String KEY_SUPPORT_SWAP_AFTER_MERGE_BOOL = "support_swap_after_merge_bool";
206
207    /**
208     * Since the default voicemail number is empty, if a SIM card does not have a voicemail number
209     * available the user cannot use voicemail. This flag allows the user to edit the voicemail
210     * number in such cases, and is false by default.
211     */
212    public static final String KEY_EDITABLE_VOICEMAIL_NUMBER_BOOL= "editable_voicemail_number_bool";
213
214    /**
215     * Determine whether the voicemail notification is persistent in the notification bar. If true,
216     * the voicemail notifications cannot be dismissed from the notification bar.
217     */
218    public static final String
219            KEY_VOICEMAIL_NOTIFICATION_PERSISTENT_BOOL = "voicemail_notification_persistent_bool";
220
221    /** For IMS video over LTE calls, determines whether video pause signalling is supported. */
222    public static final String
223            KEY_SUPPORT_PAUSE_IMS_VIDEO_CALLS_BOOL = "support_pause_ims_video_calls_bool";
224
225    /**
226     * Disables dialing "*228" (OTASP provisioning) on CDMA carriers where it is not supported or is
227     * potentially harmful by locking the SIM to 3G.
228     */
229    public static final String
230            KEY_DISABLE_CDMA_ACTIVATION_CODE_BOOL = "disable_cdma_activation_code_bool";
231
232    /**
233     * List of RIL radio technologies (See {@link ServiceState} {@code RIL_RADIO_TECHNOLOGY_*}
234     * constants) which support only a single data connection at a time. Some carriers do not
235     * support multiple pdp on UMTS.
236     */
237    public static final String
238            KEY_ONLY_SINGLE_DC_ALLOWED_INT_ARRAY = "only_single_dc_allowed_int_array";
239
240    /**
241     * Override the platform's notion of a network operator being considered roaming.
242     * Value is string array of MCCMNCs to be considered roaming for 3GPP RATs.
243     */
244    public static final String
245            KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY = "gsm_roaming_networks_string_array";
246
247    /**
248     * Override the platform's notion of a network operator being considered not roaming.
249     * Value is string array of MCCMNCs to be considered not roaming for 3GPP RATs.
250     */
251    public static final String
252            KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY = "gsm_nonroaming_networks_string_array";
253
254    /**
255     * Override the platform's notion of a network operator being considered roaming.
256     * Value is string array of SIDs to be considered roaming for 3GPP2 RATs.
257     */
258    public static final String
259            KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY = "cdma_roaming_networks_string_array";
260
261    /**
262     * Override the platform's notion of a network operator being considered non roaming.
263     * Value is string array of SIDs to be considered not roaming for 3GPP2 RATs.
264     */
265    public static final String
266            KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY = "cdma_nonroaming_networks_string_array";
267
268    /**
269     * Override the platform's notion of a network operator being considered non roaming.
270     * If true all networks are considered as home network a.k.a non-roaming.  When false,
271     * the 2 pairs of CMDA and GSM roaming/non-roaming arrays are consulted.
272     *
273     * @see KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY
274     * @see KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY
275     * @see KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY
276     * @see KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY
277     */
278    public static final String
279            KEY_FORCE_HOME_NETWORK_BOOL = "force_home_network_bool";
280
281    /**
282     * Flag specifying whether VoLTE should be available for carrier, independent of carrier
283     * provisioning. If false: hard disabled. If true: then depends on carrier provisioning,
284     * availability, etc.
285     */
286    public static final String KEY_CARRIER_VOLTE_AVAILABLE_BOOL = "carrier_volte_available_bool";
287
288    /**
289     * Flag specifying whether video telephony is available for carrier. If false: hard disabled.
290     * If true: then depends on carrier provisioning, availability, etc.
291     */
292    public static final String KEY_CARRIER_VT_AVAILABLE_BOOL = "carrier_vt_available_bool";
293
294    /**
295     * Flag specifying whether the carrier wants to notify the user when a VT call has been handed
296     * over from WIFI to LTE.
297     * <p>
298     * The handover notification is sent as a
299     * {@link TelephonyManager#EVENT_HANDOVER_VIDEO_FROM_WIFI_TO_LTE}
300     * {@link android.telecom.Connection} event, which an {@link android.telecom.InCallService}
301     * should use to trigger the display of a user-facing message.
302     * <p>
303     * The Connection event is sent to the InCallService only once, the first time it occurs.
304     * @hide
305     */
306    public static final String KEY_NOTIFY_HANDOVER_VIDEO_FROM_WIFI_TO_LTE_BOOL =
307            "notify_handover_video_from_wifi_to_lte_bool";
308
309    /**
310     * Flag specifying whether the carrier supports downgrading a video call (tx, rx or tx/rx)
311     * directly to an audio call.
312     * @hide
313     */
314    public static final String KEY_SUPPORT_DOWNGRADE_VT_TO_AUDIO_BOOL =
315            "support_downgrade_vt_to_audio_bool";
316
317    /**
318     * Where there is no preloaded voicemail number on a SIM card, specifies the carrier's default
319     * voicemail number.
320     * When empty string, no default voicemail number is specified.
321     */
322    public static final String KEY_DEFAULT_VM_NUMBER_STRING = "default_vm_number_string";
323
324    /**
325     * Flag indicating whether we should downgrade/terminate VT calls and disable VT when
326     * data enabled changed (e.g. reach data limit or turn off data).
327     * @hide
328     */
329    public static final String KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS =
330            "ignore_data_enabled_changed_for_video_calls";
331
332    /**
333     * Flag specifying whether WFC over IMS should be available for carrier: independent of
334     * carrier provisioning. If false: hard disabled. If true: then depends on carrier
335     * provisioning, availability etc.
336     */
337    public static final String KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL = "carrier_wfc_ims_available_bool";
338
339    /**
340     * Specifies a map from dialstrings to replacements for roaming network service numbers which
341     * cannot be replaced on the carrier side.
342     * <p>
343     * Individual entries have the format:
344     * [dialstring to replace]:[replacement]
345     */
346    public static final String KEY_DIAL_STRING_REPLACE_STRING_ARRAY =
347            "dial_string_replace_string_array";
348
349    /**
350     * Flag specifying whether WFC over IMS supports the "wifi only" option.  If false, the wifi
351     * calling settings will not include an option for "wifi only".  If true, the wifi calling
352     * settings will include an option for "wifi only"
353     * <p>
354     * By default, it is assumed that WFC supports "wifi only".
355     */
356    public static final String KEY_CARRIER_WFC_SUPPORTS_WIFI_ONLY_BOOL =
357            "carrier_wfc_supports_wifi_only_bool";
358
359    /**
360     * Default WFC_IMS_MODE for home network   0: WIFI_ONLY
361     *                                         1: CELLULAR_PREFERRED
362     *                                         2: WIFI_PREFERRED
363     * @hide
364     */
365    public static final String KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT =
366            "carrier_default_wfc_ims_mode_int";
367
368    /**
369     * Default WFC_IMS_MODE for roaming
370     * See {@link KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT} for valid values.
371     *
372     * @hide
373     */
374    public static final String KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_MODE_INT =
375            "carrier_default_wfc_ims_roaming_mode_int";
376
377    /**
378     * Default WFC_IMS_enabled: true VoWiFi by default is on
379     *                          false VoWiFi by default is off
380     * @hide
381     */
382    public static final String KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL =
383            "carrier_default_wfc_ims_enabled_bool";
384
385    /**
386     * Default WFC_IMS_roaming_enabled: true VoWiFi roaming by default is on
387     *                                  false VoWiFi roaming by default is off
388     * @hide
389     */
390    public static final String KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL =
391            "carrier_default_wfc_ims_roaming_enabled_bool";
392
393    /**
394     * Flag indicating whether failed calls due to no service should prompt the user to enable
395     * WIFI calling.  When {@code true}, if the user attempts to establish a call when there is no
396     * service available, they are connected to WIFI, and WIFI calling is disabled, a different
397     * call failure message will be used to encourage the user to enable WIFI calling.
398     * @hide
399     */
400    public static final String KEY_CARRIER_PROMOTE_WFC_ON_CALL_FAIL_BOOL =
401            "carrier_promote_wfc_on_call_fail_bool";
402
403    /** Flag specifying whether provisioning is required for VOLTE. */
404    public static final String KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL
405            = "carrier_volte_provisioning_required_bool";
406
407    /** Flag specifying whether VoLTE TTY is supported. */
408    public static final String KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL
409            = "carrier_volte_tty_supported_bool";
410
411    /**
412     * Flag specifying whether IMS service can be turned off. If false then the service will not be
413     * turned-off completely, but individual features can be disabled.
414     */
415    public static final String KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL
416            = "carrier_allow_turnoff_ims_bool";
417
418    /**
419     * Flag specifying whether Generic Bootstrapping Architecture capable SIM is required for IMS.
420     */
421    public static final String KEY_CARRIER_IMS_GBA_REQUIRED_BOOL
422            = "carrier_ims_gba_required_bool";
423
424    /**
425     * Flag specifying whether IMS instant lettering is available for the carrier.  {@code True} if
426     * instant lettering is available for the carrier, {@code false} otherwise.
427     */
428    public static final String KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL =
429            "carrier_instant_lettering_available_bool";
430
431    /*
432     * Flag specifying whether IMS should be the first phone attempted for E911 even if the
433     * phone is not in service.
434     */
435    public static final String KEY_CARRIER_USE_IMS_FIRST_FOR_EMERGENCY_BOOL
436            = "carrier_use_ims_first_for_emergency_bool";
437
438    /**
439     * When IMS instant lettering is available for a carrier (see
440     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines the list of characters
441     * which may not be contained in messages.  Should be specified as a regular expression suitable
442     * for use with {@link String#matches(String)}.
443     */
444    public static final String KEY_CARRIER_INSTANT_LETTERING_INVALID_CHARS_STRING =
445            "carrier_instant_lettering_invalid_chars_string";
446
447    /**
448     * When IMS instant lettering is available for a carrier (see
449     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines a list of characters which
450     * must be escaped with a backslash '\' character.  Should be specified as a string containing
451     * the characters to be escaped.  For example to escape quote and backslash the string would be
452     * a quote and a backslash.
453     */
454    public static final String KEY_CARRIER_INSTANT_LETTERING_ESCAPED_CHARS_STRING =
455            "carrier_instant_lettering_escaped_chars_string";
456
457    /**
458     * When IMS instant lettering is available for a carrier (see
459     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines the character encoding
460     * which will be used when determining the length of messages.  Used in the InCall UI to limit
461     * the number of characters the user may type.  If empty-string, the instant lettering
462     * message size limit will be enforced on a 1:1 basis.  That is, each character will count
463     * towards the messages size limit as a single bye.  If a character encoding is specified, the
464     * message size limit will be based on the number of bytes in the message per the specified
465     * encoding.
466     */
467    public static final String KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING =
468            "carrier_instant_lettering_encoding_string";
469
470    /**
471     * When IMS instant lettering is available for a carrier (see
472     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), the length limit for messages.  Used
473     * in the InCall UI to ensure the user cannot enter more characters than allowed by the carrier.
474     * See also {@link #KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING} for more information on how
475     * the length of the message is calculated.
476     */
477    public static final String KEY_CARRIER_INSTANT_LETTERING_LENGTH_LIMIT_INT =
478            "carrier_instant_lettering_length_limit_int";
479
480    /**
481     * If Voice Radio Technology is RIL_RADIO_TECHNOLOGY_LTE:14 or RIL_RADIO_TECHNOLOGY_UNKNOWN:0
482     * this is the value that should be used instead. A configuration value of
483     * RIL_RADIO_TECHNOLOGY_UNKNOWN:0 means there is no replacement value and that the default
484     * assumption for phone type (GSM) should be used.
485     */
486    public static final String KEY_VOLTE_REPLACEMENT_RAT_INT = "volte_replacement_rat_int";
487
488    /**
489     * The default sim call manager to use when the default dialer doesn't implement one. A sim call
490     * manager can control and route outgoing and incoming phone calls, even if they're placed
491     * using another connection service (PSTN, for example).
492     */
493    public static final String KEY_DEFAULT_SIM_CALL_MANAGER_STRING = "default_sim_call_manager_string";
494
495    /**
496     * The default flag specifying whether ETWS/CMAS test setting is forcibly disabled in
497     * Settings->More->Emergency broadcasts menu even though developer options is turned on.
498     */
499    public static final String KEY_CARRIER_FORCE_DISABLE_ETWS_CMAS_TEST_BOOL =
500            "carrier_force_disable_etws_cmas_test_bool";
501
502    /**
503     * The default flag specifying whether "Turn on Notifications" option will be always shown in
504     * Settings->More->Emergency broadcasts menu regardless developer options is turned on or not.
505     */
506    public static final String KEY_ALWAYS_SHOW_EMERGENCY_ALERT_ONOFF_BOOL =
507            "always_show_emergency_alert_onoff_bool";
508
509    /**
510     * The flag to disable cell broadcast severe alert when extreme alert is disabled.
511     * @hide
512     */
513    public static final String KEY_DISABLE_SEVERE_WHEN_EXTREME_DISABLED_BOOL =
514            "disable_severe_when_extreme_disabled_bool";
515
516    /**
517     * The message expiration time in milliseconds for duplicate detection purposes.
518     * @hide
519     */
520    public static final String KEY_MESSAGE_EXPIRATION_TIME_LONG =
521            "message_expiration_time_long";
522
523    /**
524     * The data call retry configuration for different types of APN.
525     * @hide
526     */
527    public static final String KEY_CARRIER_DATA_CALL_RETRY_CONFIG_STRINGS =
528            "carrier_data_call_retry_config_strings";
529
530    /**
531     * Delay between trying APN from the pool
532     * @hide
533     */
534    public static final String KEY_CARRIER_DATA_CALL_APN_DELAY_DEFAULT_LONG =
535            "carrier_data_call_apn_delay_default_long";
536
537    /**
538     * Faster delay between trying APN from the pool
539     * @hide
540     */
541    public static final String KEY_CARRIER_DATA_CALL_APN_DELAY_FASTER_LONG =
542            "carrier_data_call_apn_delay_faster_long";
543
544    /**
545     * Data call setup permanent failure causes by the carrier
546     */
547    public static final String KEY_CARRIER_DATA_CALL_PERMANENT_FAILURE_STRINGS =
548            "carrier_data_call_permanent_failure_strings";
549
550    /**
551     * Default APN types that are metered by the carrier
552     * @hide
553     */
554    public static final String KEY_CARRIER_METERED_APN_TYPES_STRINGS =
555            "carrier_metered_apn_types_strings";
556    /**
557     * Default APN types that are roamig-metered by the carrier
558     * @hide
559     */
560    public static final String KEY_CARRIER_METERED_ROAMING_APN_TYPES_STRINGS =
561            "carrier_metered_roaming_apn_types_strings";
562    /**
563     * CDMA carrier ERI (Enhanced Roaming Indicator) file name
564     * @hide
565     */
566    public static final String KEY_CARRIER_ERI_FILE_NAME_STRING =
567            "carrier_eri_file_name_string";
568
569    /* The following 3 fields are related to carrier visual voicemail. */
570
571    /**
572     * The carrier number mobile outgoing (MO) sms messages are sent to.
573     */
574    public static final String KEY_VVM_DESTINATION_NUMBER_STRING = "vvm_destination_number_string";
575
576    /**
577     * The port through which the mobile outgoing (MO) sms messages are sent through.
578     */
579    public static final String KEY_VVM_PORT_NUMBER_INT = "vvm_port_number_int";
580
581    /**
582     * The type of visual voicemail protocol the carrier adheres to. See {@link TelephonyManager}
583     * for possible values. For example {@link TelephonyManager#VVM_TYPE_OMTP}.
584     */
585    public static final String KEY_VVM_TYPE_STRING = "vvm_type_string";
586
587    /**
588     * Whether cellular data is required to access visual voicemail.
589     */
590    public static final String KEY_VVM_CELLULAR_DATA_REQUIRED_BOOL =
591        "vvm_cellular_data_required_bool";
592
593    /**
594     * Whether to prefetch audio data on new voicemail arrival, defaulted to true.
595     */
596    public static final String KEY_VVM_PREFETCH_BOOL = "vvm_prefetch_bool";
597
598    /**
599     * The package name of the carrier's visual voicemail app to ensure that dialer visual voicemail
600     * and carrier visual voicemail are not active at the same time.
601     */
602    public static final String KEY_CARRIER_VVM_PACKAGE_NAME_STRING = "carrier_vvm_package_name_string";
603
604    /**
605     * Flag specifying whether ICCID is showed in SIM Status screen, default to false.
606     */
607    public static final String KEY_SHOW_ICCID_IN_SIM_STATUS_BOOL = "show_iccid_in_sim_status_bool";
608
609    /**
610     * Flag specifying whether an additional (client initiated) intent needs to be sent on System
611     * update
612     */
613    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_BOOL = "ci_action_on_sys_update_bool";
614
615    /**
616     * Intent to be sent for the additional action on System update
617     */
618    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_INTENT_STRING =
619            "ci_action_on_sys_update_intent_string";
620
621    /**
622     * Extra to be included in the intent sent for additional action on System update
623     */
624    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_STRING =
625            "ci_action_on_sys_update_extra_string";
626
627    /**
628     * Value of extra included in intent sent for additional action on System update
629     */
630    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_VAL_STRING =
631            "ci_action_on_sys_update_extra_val_string";
632
633    /**
634     * Specifies the amount of gap to be added in millis between postdial DTMF tones. When a
635     * non-zero value is specified, the UE shall wait for the specified amount of time before it
636     * sends out successive DTMF tones on the network.
637     */
638    public static final String KEY_GSM_DTMF_TONE_DELAY_INT = "gsm_dtmf_tone_delay_int";
639
640    /**
641     * Specifies the amount of gap to be added in millis between DTMF tones. When a non-zero value
642     * is specified, the UE shall wait for the specified amount of time before it sends out
643     * successive DTMF tones on the network.
644     */
645    public static final String KEY_IMS_DTMF_TONE_DELAY_INT = "ims_dtmf_tone_delay_int";
646
647    /**
648     * Specifies the amount of gap to be added in millis between postdial DTMF tones. When a
649     * non-zero value is specified, the UE shall wait for the specified amount of time before it
650     * sends out successive DTMF tones on the network.
651     */
652    public static final String KEY_CDMA_DTMF_TONE_DELAY_INT = "cdma_dtmf_tone_delay_int";
653
654    /**
655     * Determines whether conference calls are supported by a carrier.  When {@code true},
656     * conference calling is supported, {@code false otherwise}.
657     */
658    public static final String KEY_SUPPORT_CONFERENCE_CALL_BOOL = "support_conference_call_bool";
659
660    /**
661     * Determines whether High Definition audio property is displayed in the dialer UI.
662     * If {@code false}, remove the HD audio property from the connection so that HD audio related
663     * UI is not displayed. If {@code true}, keep HD audio property as it is configured.
664     * @hide
665     */
666    public static final String KEY_DISPLAY_HD_AUDIO_PROPERTY_BOOL =
667            "display_hd_audio_property_bool";
668
669    /**
670     * Determines whether video conference calls are supported by a carrier.  When {@code true},
671     * video calls can be merged into conference calls, {@code false} otherwiwse.
672     * <p>
673     * Note: even if video conference calls are not supported, audio calls may be merged into a
674     * conference if {@link #KEY_SUPPORT_CONFERENCE_CALL_BOOL} is {@code true}.
675     * @hide
676     */
677    public static final String KEY_SUPPORT_VIDEO_CONFERENCE_CALL_BOOL =
678            "support_video_conference_call_bool";
679
680    /**
681     * Determine whether user can toggle Enhanced 4G LTE Mode in Settings.
682     */
683    public static final String KEY_EDITABLE_ENHANCED_4G_LTE_BOOL = "editable_enhanced_4g_lte_bool";
684
685    /**
686     * Determine whether IMS apn can be shown.
687     */
688    public static final String KEY_HIDE_IMS_APN_BOOL = "hide_ims_apn_bool";
689
690    /**
691     * Determine whether preferred network type can be shown.
692     */
693    public static final String KEY_HIDE_PREFERRED_NETWORK_TYPE_BOOL = "hide_preferred_network_type_bool";
694
695    /**
696     * Determine whether user can switch Wi-Fi preferred or Cellular preferred in calling preference.
697     * Some operators support Wi-Fi Calling only, not VoLTE.
698     * They don't need "Cellular preferred" option.
699     * In this case, set uneditalbe attribute for preferred preference.
700     * @hide
701     */
702    public static final String KEY_EDITABLE_WFC_MODE_BOOL = "editable_wfc_mode_bool";
703
704     /**
705      * Flag to indicate if Wi-Fi needs to be disabled in ECBM
706      * @hide
707      **/
708     public static final String
709              KEY_CONFIG_WIFI_DISABLE_IN_ECBM = "config_wifi_disable_in_ecbm";
710
711    /**
712     * List operator-specific error codes and indices of corresponding error strings in
713     * wfcOperatorErrorAlertMessages and wfcOperatorErrorNotificationMessages.
714     *
715     * Example: "REG09|0" specifies error code "REG09" and index "0". This index will be
716     * used to find alert and notification messages in wfcOperatorErrorAlertMessages and
717     * wfcOperatorErrorNotificationMessages.
718     *
719     * @hide
720     */
721    public static final String KEY_WFC_OPERATOR_ERROR_CODES_STRING_ARRAY =
722            "wfc_operator_error_codes_string_array";
723
724    /**
725     * Indexes of SPN format strings in wfcSpnFormats and wfcDataSpnFormats.
726     * @hide
727     */
728    public static final String KEY_WFC_SPN_FORMAT_IDX_INT = "wfc_spn_format_idx_int";
729    /** @hide */
730    public static final String KEY_WFC_DATA_SPN_FORMAT_IDX_INT = "wfc_data_spn_format_idx_int";
731
732    /**
733     * The Component Name of the activity that can setup the emergency addrees for WiFi Calling
734     * as per carrier requirement.
735     * @hide
736     */
737     public static final String KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING =
738            "wfc_emergency_address_carrier_app_string";
739
740    /**
741     * Boolean to decide whether to use #KEY_CARRIER_NAME_STRING from CarrierConfig app.
742     * @hide
743     */
744    public static final String KEY_CARRIER_NAME_OVERRIDE_BOOL = "carrier_name_override_bool";
745
746    /**
747     * String to identify carrier name in CarrierConfig app. This string is used only if
748     * #KEY_CARRIER_NAME_OVERRIDE_BOOL is true
749     * @hide
750     */
751    public static final String KEY_CARRIER_NAME_STRING = "carrier_name_string";
752
753    /**
754     * If this is true, the SIM card (through Customer Service Profile EF file) will be able to
755     * prevent manual operator selection. If false, this SIM setting will be ignored and manual
756     * operator selection will always be available. See CPHS4_2.WW6, CPHS B.4.7.1 for more
757     * information
758     */
759    public static final String KEY_CSP_ENABLED_BOOL = "csp_enabled_bool";
760
761    /**
762     * Allow user to add APNs
763     */
764    public static final String KEY_ALLOW_ADDING_APNS_BOOL = "allow_adding_apns_bool";
765
766    /**
767     * APN types that user is not allowed to modify
768     * @hide
769     */
770    public static final String KEY_READ_ONLY_APN_TYPES_STRING_ARRAY =
771            "read_only_apn_types_string_array";
772
773    /**
774     * APN fields that user is not allowed to modify
775     * @hide
776     */
777    public static final String KEY_READ_ONLY_APN_FIELDS_STRING_ARRAY =
778            "read_only_apn_fields_string_array";
779
780    /**
781     * Boolean indicating if intent for emergency call state changes should be broadcast
782     * @hide
783     */
784    public static final String KEY_BROADCAST_EMERGENCY_CALL_STATE_CHANGES_BOOL =
785            "broadcast_emergency_call_state_changes_bool";
786
787    /**
788     * Cell broadcast additional channels enbled by the carrier
789     * @hide
790     */
791    public static final String KEY_CARRIER_ADDITIONAL_CBS_CHANNELS_STRINGS =
792            "carrier_additional_cbs_channels_strings";
793
794    /**
795      * Indicates whether STK LAUNCH_BROWSER command is disabled.
796      * If {@code true}, then the browser will not be launched
797      * on UI for the LAUNCH_BROWSER STK command.
798      * @hide
799      */
800    public static final String KEY_STK_DISABLE_LAUNCH_BROWSER_BOOL =
801            "stk_disable_launch_browser_bool";
802
803
804    // These variables are used by the MMS service and exposed through another API, {@link
805    // SmsManager}. The variable names and string values are copied from there.
806    public static final String KEY_MMS_ALIAS_ENABLED_BOOL = "aliasEnabled";
807    public static final String KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL = "allowAttachAudio";
808    public static final String KEY_MMS_APPEND_TRANSACTION_ID_BOOL = "enabledTransID";
809    public static final String KEY_MMS_GROUP_MMS_ENABLED_BOOL = "enableGroupMms";
810    public static final String KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL = "enableMMSDeliveryReports";
811    public static final String KEY_MMS_MMS_ENABLED_BOOL = "enabledMMS";
812    public static final String KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL = "enableMMSReadReports";
813    public static final String KEY_MMS_MULTIPART_SMS_ENABLED_BOOL = "enableMultipartSMS";
814    public static final String KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL = "enabledNotifyWapMMSC";
815    public static final String KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL = "sendMultipartSmsAsSeparateMessages";
816    public static final String KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL = "config_cellBroadcastAppLinks";
817    public static final String KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL = "enableSMSDeliveryReports";
818    public static final String KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL = "supportHttpCharsetHeader";
819    public static final String KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL = "supportMmsContentDisposition";
820    public static final String KEY_MMS_ALIAS_MAX_CHARS_INT = "aliasMaxChars";
821    public static final String KEY_MMS_ALIAS_MIN_CHARS_INT = "aliasMinChars";
822    public static final String KEY_MMS_HTTP_SOCKET_TIMEOUT_INT = "httpSocketTimeout";
823    public static final String KEY_MMS_MAX_IMAGE_HEIGHT_INT = "maxImageHeight";
824    public static final String KEY_MMS_MAX_IMAGE_WIDTH_INT = "maxImageWidth";
825    public static final String KEY_MMS_MAX_MESSAGE_SIZE_INT = "maxMessageSize";
826    public static final String KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT = "maxMessageTextSize";
827    public static final String KEY_MMS_RECIPIENT_LIMIT_INT = "recipientLimit";
828    public static final String KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT = "smsToMmsTextLengthThreshold";
829    public static final String KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT = "smsToMmsTextThreshold";
830    public static final String KEY_MMS_SUBJECT_MAX_LENGTH_INT = "maxSubjectLength";
831    public static final String KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING = "emailGatewayNumber";
832    public static final String KEY_MMS_HTTP_PARAMS_STRING = "httpParams";
833    public static final String KEY_MMS_NAI_SUFFIX_STRING = "naiSuffix";
834    public static final String KEY_MMS_UA_PROF_TAG_NAME_STRING = "uaProfTagName";
835    public static final String KEY_MMS_UA_PROF_URL_STRING = "uaProfUrl";
836    public static final String KEY_MMS_USER_AGENT_STRING = "userAgent";
837    /** @hide */
838    public static final String KEY_MMS_CLOSE_CONNECTION_BOOL = "mmsCloseConnection";
839
840    /**
841     * If carriers require differentiate un-provisioned status: cold sim or out of credit sim
842     * a package name and activity name can be provided to launch a supported carrier application
843     * that check the sim provisioning status
844     * The first element is the package name and the second element is the activity name
845     * of the provisioning app
846     * example:
847     * <item>com.google.android.carrierPackageName</item>
848     * <item>com.google.android.carrierPackageName.CarrierActivityName</item>
849     * The ComponentName of the carrier activity that can setup the device and activate with the
850     * network as part of the Setup Wizard flow.
851     * @hide
852     */
853     public static final String KEY_CARRIER_SETUP_APP_STRING = "carrier_setup_app_string";
854
855    /**
856     * A list of component name of carrier signalling receivers which are interested in intent
857     * android.intent.action.CARRIER_SIGNAL_REDIRECTED.
858     * Example:
859     * <item>com.google.android.carrierPackageName/.CarrierSignalReceiverNameA</item>
860     * <item>com.google.android.carrierPackageName/.CarrierSignalReceiverNameB</item>
861     * @hide
862     */
863    public static final String KEY_SIGNAL_REDIRECTION_RECEIVER_STRING_ARRAY =
864            "signal_redirection_receiver_string_array";
865
866    /**
867     * A list of component name of carrier signalling receivers which are interested in intent
868     * android.intent.action.CARRIER_SIGNAL_REQUEST_NETWORK_FAILED.
869     * Example:
870     * <item>com.google.android.carrierPackageName/.CarrierSignalReceiverNameA</item>
871     * <item>com.google.android.carrierPackageName/.CarrierSignalReceiverNameB</item>
872     * @hide
873     */
874    public static final String KEY_SIGNAL_DCFAILURE_RECEIVER_STRING_ARRAY =
875            "signal_dcfailure_receiver_string_array";
876
877    /**
878     * A list of component name of carrier signalling receivers which are interested in intent
879     * android.intent.action.CARRIER_SIGNAL_PCO_VALUE.
880     * Example:
881     * <item>com.google.android.carrierPackageName/.CarrierSignalReceiverNameA</item>
882     * <item>com.google.android.carrierPackageName/.CarrierSignalReceiverNameB</item>
883     * @hide
884     */
885    public static final String KEY_SIGNAL_PCO_RECEIVER_STRING_ARRAY =
886            "signal_pco_receiver_string_array";
887
888    /**
889     * Determines whether the carrier supports making non-emergency phone calls while the phone is
890     * in emergency callback mode.  Default value is {@code true}, meaning that non-emergency calls
891     * are allowed in emergency callback mode.
892     */
893    public static final String KEY_ALLOW_NON_EMERGENCY_CALLS_IN_ECM_BOOL =
894            "allow_non_emergency_calls_in_ecm_bool";
895
896    /**
897     * Flag indicating whether to allow carrier video calls to emergency numbers.
898     * When {@code true}, video calls to emergency numbers will be allowed.  When {@code false},
899     * video calls to emergency numbers will be initiated as audio-only calls instead.
900     */
901    public static final String KEY_ALLOW_EMERGENCY_VIDEO_CALLS_BOOL =
902            "allow_emergency_video_calls_bool";
903
904    /**
905     * Flag indicating whether the carrier supports RCS presence indication for video calls.  When
906     * {@code true}, the carrier supports RCS presence indication for video calls.  When presence
907     * is supported, the device should use the
908     * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE} bit mask and set the
909     * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE_VT_CAPABLE} bit to indicate
910     * whether each contact supports video calling.  The UI is made aware that presence is enabled
911     * via {@link android.telecom.PhoneAccount#CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE}
912     * and can choose to hide or show the video calling icon based on whether a contact supports
913     * video.
914     */
915    public static final String KEY_USE_RCS_PRESENCE_BOOL = "use_rcs_presence_bool";
916
917    /**
918     * The duration in seconds that platform call and message blocking is disabled after the user
919     * contacts emergency services. Platform considers values in the range 0 to 604800 (one week) as
920     * valid. See {@link android.provider.BlockedNumberContract#isBlocked(Context, String)}).
921     */
922    public static final String KEY_DURATION_BLOCKING_DISABLED_AFTER_EMERGENCY_INT =
923            "duration_blocking_disabled_after_emergency_int";
924
925    /**
926     * For carriers which require an empty flash to be sent before sending the normal 3-way calling
927     * flash, the duration in milliseconds of the empty flash to send.  When {@code 0}, no empty
928     * flash is sent.
929     */
930    public static final String KEY_CDMA_3WAYCALL_FLASH_DELAY_INT = "cdma_3waycall_flash_delay_int";
931
932
933    /**
934     * @hide
935     * The default value for preferred CDMA roaming mode (aka CDMA system select.)
936     *          CDMA_ROAMING_MODE_RADIO_DEFAULT = the default roaming mode from the radio
937     *          CDMA_ROAMING_MODE_HOME = Home Networks
938     *          CDMA_ROAMING_MODE_AFFILIATED = Roaming on Affiliated networks
939     *          CDMA_ROAMING_MODE_ANY = Roaming on any networks
940     */
941    public static final String KEY_CDMA_ROAMING_MODE_INT = "cdma_roaming_mode_int";
942    /** @hide */
943    public static final int CDMA_ROAMING_MODE_RADIO_DEFAULT = -1;
944    /** @hide */
945    public static final int CDMA_ROAMING_MODE_HOME = 0;
946    /** @hide */
947    public static final int CDMA_ROAMING_MODE_AFFILIATED = 1;
948    /** @hide */
949    public static final int CDMA_ROAMING_MODE_ANY = 2;
950
951    /**
952     * Report IMEI as device id even if it's a CDMA/LTE phone.
953     *
954     * @hide
955     */
956    public static final String KEY_FORCE_IMEI_BOOL = "force_imei_bool";
957
958    /**
959     * The families of Radio Access Technologies that will get clustered and ratcheted,
960     * ie, we will report transitions up within the family, but not down until we change
961     * cells.  This prevents flapping between base technologies and higher techs that are
962     * granted on demand within the cell.
963     * @hide
964     */
965    public static final String KEY_RATCHET_RAT_FAMILIES =
966            "ratchet_rat_families";
967
968    /**
969     * Flag indicating whether some telephony logic will treat a call which was formerly a video
970     * call as if it is still a video call.  When {@code true}:
971     * <p>
972     * Logic which will automatically drop a video call which takes place over WIFI when a
973     * voice call is answered (see {@link #KEY_DROP_VIDEO_CALL_WHEN_ANSWERING_AUDIO_CALL_BOOL}.
974     * <p>
975     * Logic which determines whether the user can use TTY calling.
976     */
977    public static final String KEY_TREAT_DOWNGRADED_VIDEO_CALLS_AS_VIDEO_CALLS_BOOL =
978            "treat_downgraded_video_calls_as_video_calls_bool";
979
980    /**
981     * When {@code true}, if the user is in an ongoing video call over WIFI and answers an incoming
982     * audio call, the video call will be disconnected before the audio call is answered.  This is
983     * in contrast to the usual expected behavior where a foreground video call would be put into
984     * the background and held when an incoming audio call is answered.
985     */
986    public static final String KEY_DROP_VIDEO_CALL_WHEN_ANSWERING_AUDIO_CALL_BOOL =
987            "drop_video_call_when_answering_audio_call_bool";
988
989    /**
990     * Flag indicating whether the carrier supports merging wifi calls when VoWIFI is disabled.
991     * This can happen in the case of a carrier which allows offloading video calls to WIFI
992     * separately of whether voice over wifi is enabled.  In such a scenario when two video calls
993     * are downgraded to voice, they remain over wifi.  However, if VoWIFI is disabled, these calls
994     * cannot be merged.
995     */
996    public static final String KEY_ALLOW_MERGE_WIFI_CALLS_WHEN_VOWIFI_OFF_BOOL =
997            "allow_merge_wifi_calls_when_vowifi_off_bool";
998
999    /**
1000     * Flag indicating whether the carrier supports the Hold command while in an IMS call.
1001     * <p>
1002     * The device configuration value {@code config_device_respects_hold_carrier_config} ultimately
1003     * controls whether this carrier configuration option is used.  Where
1004     * {@code config_device_respects_hold_carrier_config} is false, the value of the
1005     * {@link #KEY_ALLOW_HOLD_IN_IMS_CALL_BOOL} carrier configuration option is ignored.
1006     * @hide
1007     */
1008    public static final String KEY_ALLOW_HOLD_IN_IMS_CALL_BOOL = "allow_hold_in_ims_call";
1009
1010    /**
1011     * When true, indicates that adding a call is disabled when there is an ongoing video call
1012     * or when there is an ongoing call on wifi which was downgraded from video and VoWifi is
1013     * turned off.
1014     */
1015    public static final String KEY_ALLOW_ADD_CALL_DURING_VIDEO_CALL_BOOL =
1016            "allow_add_call_during_video_call";
1017
1018    /**
1019     * When true, indicates that the HD audio icon in the in-call screen should not be shown for
1020     * VoWifi calls.
1021     * @hide
1022     */
1023    public static final String KEY_WIFI_CALLS_CAN_BE_HD_AUDIO = "wifi_calls_can_be_hd_audio";
1024
1025    /**
1026     * When true, indicates that the HD audio icon in the in-call screen should not be shown for
1027     * video calls.
1028     * @hide
1029     */
1030    public static final String KEY_VIDEO_CALLS_CAN_BE_HD_AUDIO = "video_calls_can_be_hd_audio";
1031
1032    /**
1033     * Defines operator-specific {@link com.android.ims.ImsReasonInfo} mappings.
1034     *
1035     * Format: "ORIGINAL_CODE|MESSAGE|NEW_CODE"
1036     * Where {@code ORIGINAL_CODE} corresponds to a {@link ImsReasonInfo#getCode()} code,
1037     * {@code MESSAGE} corresponds to an expected {@link ImsReasonInfo#getExtraMessage()} string,
1038     * and {@code NEW_CODE} is the new {@code ImsReasonInfo#CODE_*} which this combination of
1039     * original code and message shall be remapped to.
1040     *
1041     * Example: "501|call completion elsewhere|1014"
1042     * When the {@link ImsReasonInfo#getCode()} is {@link ImsReasonInfo#CODE_USER_TERMINATED} and
1043     * the {@link ImsReasonInfo#getExtraMessage()} is {@code "call completion elsewhere"},
1044     * {@link ImsReasonInfo#CODE_ANSWERED_ELSEWHERE} shall be used as the {@link ImsReasonInfo}
1045     * code instead.
1046     * @hide
1047     */
1048    public static final String KEY_IMS_REASONINFO_MAPPING_STRING_ARRAY =
1049            "ims_reasoninfo_mapping_string_array";
1050
1051    /**
1052     * When {@code false}, use default title for Enhanced 4G LTE Mode settings.
1053     * When {@code true}, use the variant.
1054     * @hide
1055     */
1056    public static final String KEY_ENHANCED_4G_LTE_TITLE_VARIANT_BOOL =
1057            "enhanced_4g_lte_title_variant_bool";
1058
1059    /**
1060     * Indicates whether the carrier wants to notify the user when handover of an LTE video call to
1061     * WIFI fails.
1062     * <p>
1063     * When {@code true}, if a video call starts on LTE and the modem reports a failure to handover
1064     * the call to WIFI or if no handover success is reported within 60 seconds of call initiation,
1065     * the {@link android.telephony.TelephonyManager#EVENT_HANDOVER_TO_WIFI_FAILED} event is raised
1066     * on the connection.
1067     * @hide
1068     */
1069    public static final String KEY_NOTIFY_VT_HANDOVER_TO_WIFI_FAILURE_BOOL =
1070            "notify_vt_handover_to_wifi_failure_bool";
1071
1072    /**
1073     * A upper case list of CNAP names that are unhelpful to the user for distinguising calls and
1074     * should be filtered out of the CNAP information. This includes CNAP names such as "WIRELESS
1075     * CALLER" or "UNKNOWN NAME". By default, if there are no filtered names for this carrier, null
1076     * is returned.
1077     * @hide
1078     */
1079    public static final String KEY_FILTERED_CNAP_NAMES_STRING_ARRAY = "filtered_cnap_names_string_array";
1080
1081    /**
1082     * The RCS configuration server URL. This URL is used to initiate RCS provisioning.
1083     */
1084    public static final String KEY_RCS_CONFIG_SERVER_URL_STRING = "rcs_config_server_url_string";
1085
1086    /**
1087     * Determine whether user can change Wi-Fi Calling preference in roaming.
1088     * {@code false} - roaming preference {@link KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_MODE_INT} is
1089     *                 the same as home preference {@link KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT}
1090     *                 and cannot be changed.
1091     * {@code true}  - roaming preference can be changed by user independently.
1092     *
1093     * @hide
1094     */
1095    public static final String KEY_EDITABLE_WFC_ROAMING_MODE_BOOL =
1096            "editable_wfc_roaming_mode_bool";
1097
1098   /**
1099     * Determine whether current lpp_mode used for E-911 needs to be kept persistently.
1100     * {@code false} - not keeping the lpp_mode means using default configuration of gps.conf
1101     *                 when sim is not presented.
1102     * {@code true}  - current lpp_profile of carrier will be kepted persistently
1103     *                 even after sim is removed.
1104     *
1105     * @hide
1106     */
1107    public static final String KEY_PERSIST_LPP_MODE_BOOL = "persist_lpp_mode_bool";
1108
1109    /**
1110     * Carrier specified WiFi networks.
1111     * @hide
1112     */
1113    public static final String KEY_CARRIER_WIFI_STRING_ARRAY = "carrier_wifi_string_array";
1114
1115    /** The default value for every variable. */
1116    private final static PersistableBundle sDefaults;
1117
1118    static {
1119        sDefaults = new PersistableBundle();
1120        sDefaults.putBoolean(KEY_ALLOW_HOLD_IN_IMS_CALL_BOOL, true);
1121        sDefaults.putBoolean(KEY_ADDITIONAL_CALL_SETTING_BOOL, true);
1122        sDefaults.putBoolean(KEY_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG_BOOL, false);
1123        sDefaults.putBoolean(KEY_ALLOW_LOCAL_DTMF_TONES_BOOL, true);
1124        sDefaults.putBoolean(KEY_APN_EXPAND_BOOL, true);
1125        sDefaults.putBoolean(KEY_AUTO_RETRY_ENABLED_BOOL, false);
1126        sDefaults.putBoolean(KEY_CARRIER_SETTINGS_ENABLE_BOOL, false);
1127        sDefaults.putBoolean(KEY_CARRIER_VOLTE_AVAILABLE_BOOL, false);
1128        sDefaults.putBoolean(KEY_CARRIER_VT_AVAILABLE_BOOL, false);
1129        sDefaults.putBoolean(KEY_NOTIFY_HANDOVER_VIDEO_FROM_WIFI_TO_LTE_BOOL, false);
1130        sDefaults.putBoolean(KEY_SUPPORT_DOWNGRADE_VT_TO_AUDIO_BOOL, true);
1131        sDefaults.putString(KEY_DEFAULT_VM_NUMBER_STRING, "");
1132        sDefaults.putBoolean(KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS, false);
1133        sDefaults.putBoolean(KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL, false);
1134        sDefaults.putBoolean(KEY_CARRIER_WFC_SUPPORTS_WIFI_ONLY_BOOL, false);
1135        sDefaults.putBoolean(KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL, false);
1136        sDefaults.putBoolean(KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL, false);
1137        sDefaults.putBoolean(KEY_CARRIER_PROMOTE_WFC_ON_CALL_FAIL_BOOL, false);
1138        sDefaults.putInt(KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT, 2);
1139        sDefaults.putInt(KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_MODE_INT, 2);
1140        sDefaults.putBoolean(KEY_CARRIER_FORCE_DISABLE_ETWS_CMAS_TEST_BOOL, false);
1141        sDefaults.putBoolean(KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL, false);
1142        sDefaults.putBoolean(KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL, true);
1143        sDefaults.putBoolean(KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL, true);
1144        sDefaults.putBoolean(KEY_CARRIER_IMS_GBA_REQUIRED_BOOL, false);
1145        sDefaults.putBoolean(KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL, false);
1146        sDefaults.putBoolean(KEY_CARRIER_USE_IMS_FIRST_FOR_EMERGENCY_BOOL, true);
1147        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_INVALID_CHARS_STRING, "");
1148        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_ESCAPED_CHARS_STRING, "");
1149        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING, "");
1150        sDefaults.putInt(KEY_CARRIER_INSTANT_LETTERING_LENGTH_LIMIT_INT, 64);
1151        sDefaults.putBoolean(KEY_DISABLE_CDMA_ACTIVATION_CODE_BOOL, false);
1152        sDefaults.putBoolean(KEY_DTMF_TYPE_ENABLED_BOOL, false);
1153        sDefaults.putBoolean(KEY_ENABLE_DIALER_KEY_VIBRATION_BOOL, true);
1154        sDefaults.putBoolean(KEY_HAS_IN_CALL_NOISE_SUPPRESSION_BOOL, false);
1155        sDefaults.putBoolean(KEY_HIDE_CARRIER_NETWORK_SETTINGS_BOOL, false);
1156        sDefaults.putBoolean(KEY_HIDE_SIM_LOCK_SETTINGS_BOOL, false);
1157
1158        sDefaults.putBoolean(KEY_CARRIER_VOLTE_PROVISIONED_BOOL, false);
1159        sDefaults.putBoolean(KEY_IGNORE_SIM_NETWORK_LOCKED_EVENTS_BOOL, false);
1160        sDefaults.putBoolean(KEY_MDN_IS_ADDITIONAL_VOICEMAIL_NUMBER_BOOL, false);
1161        sDefaults.putBoolean(KEY_OPERATOR_SELECTION_EXPAND_BOOL, true);
1162        sDefaults.putBoolean(KEY_PREFER_2G_BOOL, true);
1163        sDefaults.putBoolean(KEY_SHOW_APN_SETTING_CDMA_BOOL, false);
1164        sDefaults.putBoolean(KEY_SHOW_CDMA_CHOICES_BOOL, false);
1165        sDefaults.putBoolean(KEY_SMS_REQUIRES_DESTINATION_NUMBER_CONVERSION_BOOL, false);
1166        sDefaults.putBoolean(KEY_SHOW_ONSCREEN_DIAL_BUTTON_BOOL, true);
1167        sDefaults.putBoolean(KEY_SIM_NETWORK_UNLOCK_ALLOW_DISMISS_BOOL, true);
1168        sDefaults.putBoolean(KEY_SUPPORT_PAUSE_IMS_VIDEO_CALLS_BOOL, false);
1169        sDefaults.putBoolean(KEY_SUPPORT_SWAP_AFTER_MERGE_BOOL, true);
1170        sDefaults.putBoolean(KEY_USE_HFA_FOR_PROVISIONING_BOOL, false);
1171        sDefaults.putBoolean(KEY_EDITABLE_VOICEMAIL_NUMBER_BOOL, false);
1172        sDefaults.putBoolean(KEY_USE_OTASP_FOR_PROVISIONING_BOOL, false);
1173        sDefaults.putBoolean(KEY_VOICEMAIL_NOTIFICATION_PERSISTENT_BOOL, false);
1174        sDefaults.putBoolean(KEY_VOICE_PRIVACY_DISABLE_UI_BOOL, false);
1175        sDefaults.putBoolean(KEY_WORLD_PHONE_BOOL, false);
1176        sDefaults.putBoolean(KEY_REQUIRE_ENTITLEMENT_CHECKS_BOOL, true);
1177        sDefaults.putBoolean(KEY_RESTART_RADIO_ON_PDP_FAIL_REGULAR_DEACTIVATION_BOOL, false);
1178        sDefaults.putInt(KEY_VOLTE_REPLACEMENT_RAT_INT, 0);
1179        sDefaults.putString(KEY_DEFAULT_SIM_CALL_MANAGER_STRING, "");
1180        sDefaults.putString(KEY_VVM_DESTINATION_NUMBER_STRING, "");
1181        sDefaults.putInt(KEY_VVM_PORT_NUMBER_INT, 0);
1182        sDefaults.putString(KEY_VVM_TYPE_STRING, "");
1183        sDefaults.putBoolean(KEY_VVM_CELLULAR_DATA_REQUIRED_BOOL, false);
1184        sDefaults.putBoolean(KEY_VVM_PREFETCH_BOOL, true);
1185        sDefaults.putString(KEY_CARRIER_VVM_PACKAGE_NAME_STRING, "");
1186        sDefaults.putBoolean(KEY_SHOW_ICCID_IN_SIM_STATUS_BOOL, false);
1187        sDefaults.putBoolean(KEY_CI_ACTION_ON_SYS_UPDATE_BOOL, false);
1188        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_INTENT_STRING, "");
1189        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_STRING, "");
1190        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_VAL_STRING, "");
1191        sDefaults.putBoolean(KEY_CSP_ENABLED_BOOL, false);
1192        sDefaults.putBoolean(KEY_ALLOW_ADDING_APNS_BOOL, true);
1193        sDefaults.putStringArray(KEY_READ_ONLY_APN_TYPES_STRING_ARRAY, null);
1194        sDefaults.putStringArray(KEY_READ_ONLY_APN_FIELDS_STRING_ARRAY, null);
1195        sDefaults.putBoolean(KEY_BROADCAST_EMERGENCY_CALL_STATE_CHANGES_BOOL, false);
1196        sDefaults.putBoolean(KEY_ALWAYS_SHOW_EMERGENCY_ALERT_ONOFF_BOOL, false);
1197        sDefaults.putBoolean(KEY_DISABLE_SEVERE_WHEN_EXTREME_DISABLED_BOOL, true);
1198        sDefaults.putLong(KEY_MESSAGE_EXPIRATION_TIME_LONG, 86400000L);
1199        sDefaults.putStringArray(KEY_CARRIER_DATA_CALL_RETRY_CONFIG_STRINGS, new String[]{
1200                "default:default_randomization=2000,5000,10000,20000,40000,80000:5000,160000:5000,"
1201                        + "320000:5000,640000:5000,1280000:5000,1800000:5000",
1202                "mms:default_randomization=2000,5000,10000,20000,40000,80000:5000,160000:5000,"
1203                        + "320000:5000,640000:5000,1280000:5000,1800000:5000",
1204                "others:max_retries=3, 5000, 5000, 5000"});
1205        sDefaults.putLong(KEY_CARRIER_DATA_CALL_APN_DELAY_DEFAULT_LONG, 20000);
1206        sDefaults.putLong(KEY_CARRIER_DATA_CALL_APN_DELAY_FASTER_LONG, 3000);
1207        sDefaults.putString(KEY_CARRIER_ERI_FILE_NAME_STRING, "eri.xml");
1208        sDefaults.putInt(KEY_DURATION_BLOCKING_DISABLED_AFTER_EMERGENCY_INT, 7200);
1209        sDefaults.putStringArray(KEY_CARRIER_METERED_APN_TYPES_STRINGS,
1210                new String[]{"default", "mms", "dun", "supl"});
1211        sDefaults.putStringArray(KEY_CARRIER_METERED_ROAMING_APN_TYPES_STRINGS,
1212                new String[]{"default", "mms", "dun", "supl"});
1213
1214        sDefaults.putIntArray(KEY_ONLY_SINGLE_DC_ALLOWED_INT_ARRAY,
1215                new int[]{
1216                    4, /* IS95A */
1217                    5, /* IS95B */
1218                    6, /* 1xRTT */
1219                    7, /* EVDO_0 */
1220                    8, /* EVDO_A */
1221                    12 /* EVDO_B */
1222                });
1223        sDefaults.putStringArray(KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY, null);
1224        sDefaults.putStringArray(KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY, null);
1225        sDefaults.putStringArray(KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY, null);
1226        sDefaults.putStringArray(KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY, null);
1227        sDefaults.putStringArray(KEY_DIAL_STRING_REPLACE_STRING_ARRAY, null);
1228        sDefaults.putBoolean(KEY_FORCE_HOME_NETWORK_BOOL, false);
1229        sDefaults.putInt(KEY_GSM_DTMF_TONE_DELAY_INT, 0);
1230        sDefaults.putInt(KEY_IMS_DTMF_TONE_DELAY_INT, 0);
1231        sDefaults.putInt(KEY_CDMA_DTMF_TONE_DELAY_INT, 100);
1232        sDefaults.putInt(KEY_CDMA_3WAYCALL_FLASH_DELAY_INT , 0);
1233        sDefaults.putBoolean(KEY_SUPPORT_CONFERENCE_CALL_BOOL, true);
1234        sDefaults.putBoolean(KEY_SUPPORT_VIDEO_CONFERENCE_CALL_BOOL, false);
1235        sDefaults.putBoolean(KEY_DISPLAY_HD_AUDIO_PROPERTY_BOOL, true);
1236        sDefaults.putBoolean(KEY_EDITABLE_ENHANCED_4G_LTE_BOOL, true);
1237        sDefaults.putBoolean(KEY_HIDE_IMS_APN_BOOL, false);
1238        sDefaults.putBoolean(KEY_HIDE_PREFERRED_NETWORK_TYPE_BOOL, false);
1239        sDefaults.putBoolean(KEY_ALLOW_EMERGENCY_VIDEO_CALLS_BOOL, false);
1240        sDefaults.putBoolean(KEY_EDITABLE_WFC_MODE_BOOL, true);
1241        sDefaults.putStringArray(KEY_WFC_OPERATOR_ERROR_CODES_STRING_ARRAY, null);
1242        sDefaults.putInt(KEY_WFC_SPN_FORMAT_IDX_INT, 0);
1243        sDefaults.putInt(KEY_WFC_DATA_SPN_FORMAT_IDX_INT, 0);
1244        sDefaults.putString(KEY_WFC_EMERGENCY_ADDRESS_CARRIER_APP_STRING, "");
1245        sDefaults.putBoolean(KEY_CONFIG_WIFI_DISABLE_IN_ECBM, false);
1246        sDefaults.putBoolean(KEY_CARRIER_NAME_OVERRIDE_BOOL, false);
1247        sDefaults.putString(KEY_CARRIER_NAME_STRING, "");
1248
1249        // MMS defaults
1250        sDefaults.putBoolean(KEY_MMS_ALIAS_ENABLED_BOOL, false);
1251        sDefaults.putBoolean(KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL, true);
1252        sDefaults.putBoolean(KEY_MMS_APPEND_TRANSACTION_ID_BOOL, false);
1253        sDefaults.putBoolean(KEY_MMS_GROUP_MMS_ENABLED_BOOL, true);
1254        sDefaults.putBoolean(KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL, false);
1255        sDefaults.putBoolean(KEY_MMS_MMS_ENABLED_BOOL, true);
1256        sDefaults.putBoolean(KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL, false);
1257        sDefaults.putBoolean(KEY_MMS_MULTIPART_SMS_ENABLED_BOOL, true);
1258        sDefaults.putBoolean(KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL, false);
1259        sDefaults.putBoolean(KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL, false);
1260        sDefaults.putBoolean(KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL, true);
1261        sDefaults.putBoolean(KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL, true);
1262        sDefaults.putBoolean(KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL, false);
1263        sDefaults.putBoolean(KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL, true);
1264        sDefaults.putBoolean(KEY_MMS_CLOSE_CONNECTION_BOOL, false);
1265        sDefaults.putInt(KEY_MMS_ALIAS_MAX_CHARS_INT, 48);
1266        sDefaults.putInt(KEY_MMS_ALIAS_MIN_CHARS_INT, 2);
1267        sDefaults.putInt(KEY_MMS_HTTP_SOCKET_TIMEOUT_INT, 60 * 1000);
1268        sDefaults.putInt(KEY_MMS_MAX_IMAGE_HEIGHT_INT, 480);
1269        sDefaults.putInt(KEY_MMS_MAX_IMAGE_WIDTH_INT, 640);
1270        sDefaults.putInt(KEY_MMS_MAX_MESSAGE_SIZE_INT, 300 * 1024);
1271        sDefaults.putInt(KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT, -1);
1272        sDefaults.putInt(KEY_MMS_RECIPIENT_LIMIT_INT, Integer.MAX_VALUE);
1273        sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT, -1);
1274        sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT, -1);
1275        sDefaults.putInt(KEY_MMS_SUBJECT_MAX_LENGTH_INT, 40);
1276        sDefaults.putString(KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING, "");
1277        sDefaults.putString(KEY_MMS_HTTP_PARAMS_STRING, "");
1278        sDefaults.putString(KEY_MMS_NAI_SUFFIX_STRING, "");
1279        sDefaults.putString(KEY_MMS_UA_PROF_TAG_NAME_STRING, "x-wap-profile");
1280        sDefaults.putString(KEY_MMS_UA_PROF_URL_STRING, "");
1281        sDefaults.putString(KEY_MMS_USER_AGENT_STRING, "");
1282        sDefaults.putBoolean(KEY_ALLOW_NON_EMERGENCY_CALLS_IN_ECM_BOOL, true);
1283        sDefaults.putBoolean(KEY_USE_RCS_PRESENCE_BOOL, false);
1284        sDefaults.putBoolean(KEY_FORCE_IMEI_BOOL, false);
1285        sDefaults.putInt(KEY_CDMA_ROAMING_MODE_INT, CDMA_ROAMING_MODE_RADIO_DEFAULT);
1286        sDefaults.putString(KEY_RCS_CONFIG_SERVER_URL_STRING, "");
1287
1288        // Carrier Signalling Receivers
1289        sDefaults.putStringArray(KEY_SIGNAL_REDIRECTION_RECEIVER_STRING_ARRAY, null);
1290        sDefaults.putStringArray(KEY_SIGNAL_DCFAILURE_RECEIVER_STRING_ARRAY, null);
1291        sDefaults.putStringArray(KEY_SIGNAL_PCO_RECEIVER_STRING_ARRAY, null);
1292        sDefaults.putString(KEY_CARRIER_SETUP_APP_STRING, "");
1293
1294        // Rat families: {GPRS, EDGE}, {EVDO, EVDO_A, EVDO_B}, {UMTS, HSPA, HSDPA, HSUPA, HSPAP},
1295        // {LTE, LTE_CA}
1296        // Order is important - lowest precidence first
1297        sDefaults.putStringArray(KEY_RATCHET_RAT_FAMILIES,
1298                new String[]{"1,2","7,8,12","3,11,9,10,15","14,19"});
1299        sDefaults.putBoolean(KEY_TREAT_DOWNGRADED_VIDEO_CALLS_AS_VIDEO_CALLS_BOOL, false);
1300        sDefaults.putBoolean(KEY_DROP_VIDEO_CALL_WHEN_ANSWERING_AUDIO_CALL_BOOL, false);
1301        sDefaults.putBoolean(KEY_ALLOW_MERGE_WIFI_CALLS_WHEN_VOWIFI_OFF_BOOL, true);
1302        sDefaults.putBoolean(KEY_ALLOW_ADD_CALL_DURING_VIDEO_CALL_BOOL, true);
1303        sDefaults.putBoolean(KEY_WIFI_CALLS_CAN_BE_HD_AUDIO, true);
1304        sDefaults.putBoolean(KEY_VIDEO_CALLS_CAN_BE_HD_AUDIO, true);
1305
1306        sDefaults.putStringArray(KEY_IMS_REASONINFO_MAPPING_STRING_ARRAY, null);
1307        sDefaults.putBoolean(KEY_ENHANCED_4G_LTE_TITLE_VARIANT_BOOL, false);
1308        sDefaults.putBoolean(KEY_NOTIFY_VT_HANDOVER_TO_WIFI_FAILURE_BOOL, false);
1309        sDefaults.putStringArray(KEY_FILTERED_CNAP_NAMES_STRING_ARRAY, null);
1310        sDefaults.putBoolean(KEY_EDITABLE_WFC_ROAMING_MODE_BOOL, false);
1311        sDefaults.putBoolean(KEY_STK_DISABLE_LAUNCH_BROWSER_BOOL, false);
1312        sDefaults.putBoolean(KEY_PERSIST_LPP_MODE_BOOL, false);
1313        sDefaults.putStringArray(KEY_CARRIER_WIFI_STRING_ARRAY, null);
1314    }
1315
1316    /**
1317     * Gets the configuration values for a particular subscription, which is associated with a
1318     * specific SIM card. If an invalid subId is used, the returned config will contain default
1319     * values.
1320     *
1321     * <p>Requires Permission:
1322     * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1323     *
1324     * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}.
1325     * @return A {@link PersistableBundle} containing the config for the given subId, or default
1326     *         values for an invalid subId.
1327     */
1328    @Nullable
1329    public PersistableBundle getConfigForSubId(int subId) {
1330        try {
1331            ICarrierConfigLoader loader = getICarrierConfigLoader();
1332            if (loader == null) {
1333                Rlog.w(TAG, "Error getting config for subId " + subId
1334                        + " ICarrierConfigLoader is null");
1335                return null;
1336            }
1337            return loader.getConfigForSubId(subId);
1338        } catch (RemoteException ex) {
1339            Rlog.e(TAG, "Error getting config for subId " + subId + ": "
1340                    + ex.toString());
1341        }
1342        return null;
1343    }
1344
1345    /**
1346     * Gets the configuration values for the default subscription.
1347     *
1348     * <p>Requires Permission:
1349     * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
1350     *
1351     * @see #getConfigForSubId
1352     */
1353    @Nullable
1354    public PersistableBundle getConfig() {
1355        return getConfigForSubId(SubscriptionManager.getDefaultSubscriptionId());
1356    }
1357
1358    /**
1359     * Calling this method triggers telephony services to fetch the current carrier configuration.
1360     * <p>
1361     * Normally this does not need to be called because the platform reloads config on its own.
1362     * This should be called by a carrier service app if it wants to update config at an arbitrary
1363     * moment.
1364     * </p>
1365     * <p>Requires that the calling app has carrier privileges.
1366     * @see #hasCarrierPrivileges
1367     * <p>
1368     * This method returns before the reload has completed, and
1369     * {@link android.service.carrier.CarrierService#onLoadConfig} will be called from an
1370     * arbitrary thread.
1371     * </p>
1372     */
1373    public void notifyConfigChangedForSubId(int subId) {
1374        try {
1375            ICarrierConfigLoader loader = getICarrierConfigLoader();
1376            if (loader == null) {
1377                Rlog.w(TAG, "Error reloading config for subId=" + subId
1378                        + " ICarrierConfigLoader is null");
1379                return;
1380            }
1381            loader.notifyConfigChangedForSubId(subId);
1382        } catch (RemoteException ex) {
1383            Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString());
1384        }
1385    }
1386
1387    /**
1388     * Request the carrier config loader to update the cofig for phoneId.
1389     * <p>
1390     * Depending on simState, the config may be cleared or loaded from config app. This is only used
1391     * by SubscriptionInfoUpdater.
1392     * </p>
1393     *
1394     * @hide
1395     */
1396    @SystemApi
1397    public void updateConfigForPhoneId(int phoneId, String simState) {
1398        try {
1399            ICarrierConfigLoader loader = getICarrierConfigLoader();
1400            if (loader == null) {
1401                Rlog.w(TAG, "Error updating config for phoneId=" + phoneId
1402                        + " ICarrierConfigLoader is null");
1403                return;
1404            }
1405            loader.updateConfigForPhoneId(phoneId, simState);
1406        } catch (RemoteException ex) {
1407            Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString());
1408        }
1409    }
1410
1411    /**
1412     * Returns a new bundle with the default value for every supported configuration variable.
1413     *
1414     * @hide
1415     */
1416    @NonNull
1417    @SystemApi
1418    public static PersistableBundle getDefaultConfig() {
1419        return new PersistableBundle(sDefaults);
1420    }
1421
1422    /** @hide */
1423    @Nullable
1424    private ICarrierConfigLoader getICarrierConfigLoader() {
1425        return ICarrierConfigLoader.Stub
1426                .asInterface(ServiceManager.getService(Context.CARRIER_CONFIG_SERVICE));
1427    }
1428}
1429