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