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