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