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