CarrierConfigManager.java revision f08361989d3deca76173f82006a00d73d8c6679b
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 com.android.internal.telephony.ICarrierConfigLoader;
20
21import android.annotation.NonNull;
22import android.annotation.Nullable;
23import android.annotation.SystemApi;
24import android.content.Context;
25import android.os.PersistableBundle;
26import android.os.RemoteException;
27import android.os.ServiceManager;
28
29/**
30 * Provides access to telephony configuration values that are carrier-specific.
31 * <p>
32 * Users should obtain an instance of this class by calling
33 * {@code mContext.getSystemService(Context.CARRIER_CONFIG_SERVICE);}
34 * </p>
35 *
36 * @see Context#getSystemService
37 * @see Context#CARRIER_CONFIG_SERVICE
38 */
39public class CarrierConfigManager {
40    private final static String TAG = "CarrierConfigManager";
41
42    /**
43     * @hide
44     */
45    public CarrierConfigManager() {
46    }
47
48    /**
49     * This intent is broadcast by the system when carrier config changes.
50     */
51    public static final String
52            ACTION_CARRIER_CONFIG_CHANGED = "android.telephony.action.CARRIER_CONFIG_CHANGED";
53
54    // Below are the keys used in carrier config bundles. To add a new variable, define the key and
55    // give it a default value in sDefaults. If you need to ship a per-network override in the
56    // system image, that can be added in packages/apps/CarrierConfig.
57
58    /**
59     * Flag indicating whether the Phone app should ignore EVENT_SIM_NETWORK_LOCKED
60     * events from the Sim.
61     * If true, this will prevent the IccNetworkDepersonalizationPanel from being shown, and
62     * effectively disable the "Sim network lock" feature.
63     */
64    public static final String
65            KEY_IGNORE_SIM_NETWORK_LOCKED_EVENTS_BOOL = "ignore_sim_network_locked_events_bool";
66
67    /**
68     * Flag indicating whether the Phone app should provide a "Dismiss" button on the SIM network
69     * unlock screen. The default value is true. If set to false, there will be *no way* to dismiss
70     * the SIM network unlock screen if you don't enter the correct unlock code. (One important
71     * consequence: there will be no way to make an Emergency Call if your SIM is network-locked and
72     * you don't know the PIN.)
73     */
74    public static final String
75            KEY_SIM_NETWORK_UNLOCK_ALLOW_DISMISS_BOOL = "sim_network_unlock_allow_dismiss_bool";
76
77    /** Flag indicating if the phone is a world phone */
78    public static final String KEY_WORLD_PHONE_BOOL = "world_phone_bool";
79
80    /**
81     * Flag to require or skip entitlement checks.
82     * If true, entitlement checks will be executed if device has been configured for it,
83     * If false, entitlement checks will be skipped.
84     */
85    public static final String
86            KEY_REQUIRE_ENTITLEMENT_CHECKS_BOOL = "require_entitlement_checks_bool";
87
88    /**
89     * If true, enable vibration (haptic feedback) for key presses in the EmergencyDialer activity.
90     * The pattern is set on a per-platform basis using config_virtualKeyVibePattern. To be
91     * consistent with the regular Dialer, this value should agree with the corresponding values
92     * from config.xml under apps/Contacts.
93     */
94    public static final String
95            KEY_ENABLE_DIALER_KEY_VIBRATION_BOOL = "enable_dialer_key_vibration_bool";
96
97    /** Flag indicating if dtmf tone type is enabled */
98    public static final String KEY_DTMF_TYPE_ENABLED_BOOL = "dtmf_type_enabled_bool";
99
100    /** Flag indicating if auto retry is enabled */
101    public static final String KEY_AUTO_RETRY_ENABLED_BOOL = "auto_retry_enabled_bool";
102
103    /**
104     * Determine whether we want to play local DTMF tones in a call, or just let the radio/BP handle
105     * playing of the tones.
106     */
107    public static final String KEY_ALLOW_LOCAL_DTMF_TONES_BOOL = "allow_local_dtmf_tones_bool";
108
109    /**
110     * If true, show an onscreen "Dial" button in the dialer. In practice this is used on all
111     * platforms, even the ones with hard SEND/END keys, but for maximum flexibility it's controlled
112     * by a flag here (which can be overridden on a per-product basis.)
113     */
114    public static final String KEY_SHOW_ONSCREEN_DIAL_BUTTON_BOOL = "show_onscreen_dial_button_bool";
115
116    /** Determines if device implements a noise suppression device for in call audio. */
117    public static final String
118            KEY_HAS_IN_CALL_NOISE_SUPPRESSION_BOOL = "has_in_call_noise_suppression_bool";
119
120    /**
121     * Determines if the current device should allow emergency numbers to be logged in the Call Log.
122     * (Some carriers require that emergency calls *not* be logged, presumably to avoid the risk of
123     * accidental redialing from the call log UI. This is a good idea, so the default here is
124     * false.)
125     */
126    public static final String
127            KEY_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG_BOOL = "allow_emergency_numbers_in_call_log_bool";
128
129    /** If true, removes the Voice Privacy option from Call Settings */
130    public static final String KEY_VOICE_PRIVACY_DISABLE_UI_BOOL = "voice_privacy_disable_ui_bool";
131
132    /** Control whether users can reach the carrier portions of Cellular Network Settings. */
133    public static final String
134            KEY_HIDE_CARRIER_NETWORK_SETTINGS_BOOL = "hide_carrier_network_settings_bool";
135
136    /** Control whether users can reach the SIM lock settings. */
137    public static final String
138            KEY_HIDE_SIM_LOCK_SETTINGS_BOOL = "hide_sim_lock_settings_bool";
139
140    /** Control whether users can edit APNs in Settings. */
141    public static final String KEY_APN_EXPAND_BOOL = "apn_expand_bool";
142
143    /** Control whether users can choose a network operator. */
144    public static final String KEY_OPERATOR_SELECTION_EXPAND_BOOL = "operator_selection_expand_bool";
145
146    /** Used in Cellular Network Settings for preferred network type. */
147    public static final String KEY_PREFER_2G_BOOL = "prefer_2g_bool";
148
149    /** Show cdma network mode choices 1x, 3G, global etc. */
150    public static final String KEY_SHOW_CDMA_CHOICES_BOOL = "show_cdma_choices_bool";
151
152    /** CDMA activation goes through HFA */
153    public static final String KEY_USE_HFA_FOR_PROVISIONING_BOOL = "use_hfa_for_provisioning_bool";
154
155    /**
156     * CDMA activation goes through OTASP.
157     * <p>
158     * TODO: This should be combined with config_use_hfa_for_provisioning and implemented as an enum
159     * (NONE, HFA, OTASP).
160     */
161    public static final String KEY_USE_OTASP_FOR_PROVISIONING_BOOL = "use_otasp_for_provisioning_bool";
162
163    /** Display carrier settings menu if true */
164    public static final String KEY_CARRIER_SETTINGS_ENABLE_BOOL = "carrier_settings_enable_bool";
165
166    /** Does not display additional call seting for IMS phone based on GSM Phone */
167    public static final String KEY_ADDITIONAL_CALL_SETTING_BOOL = "additional_call_setting_bool";
168
169    /** Show APN Settings for some CDMA carriers */
170    public static final String KEY_SHOW_APN_SETTING_CDMA_BOOL = "show_apn_setting_cdma_bool";
171
172    /** After a CDMA conference call is merged, the swap button should be displayed. */
173    public static final String KEY_SUPPORT_SWAP_AFTER_MERGE_BOOL = "support_swap_after_merge_bool";
174
175    /**
176     * Determine whether the voicemail notification is persistent in the notification bar. If true,
177     * the voicemail notifications cannot be dismissed from the notification bar.
178     */
179    public static final String
180            KEY_VOICEMAIL_NOTIFICATION_PERSISTENT_BOOL = "voicemail_notification_persistent_bool";
181
182    /** For IMS video over LTE calls, determines whether video pause signalling is supported. */
183    public static final String
184            KEY_SUPPORT_PAUSE_IMS_VIDEO_CALLS_BOOL = "support_pause_ims_video_calls_bool";
185
186    /**
187     * Disables dialing "*228" (OTASP provisioning) on CDMA carriers where it is not supported or is
188     * potentially harmful by locking the SIM to 3G.
189     */
190    public static final String
191            KEY_DISABLE_CDMA_ACTIVATION_CODE_BOOL = "disable_cdma_activation_code_bool";
192
193    /**
194     * Override the platform's notion of a network operator being considered roaming.
195     * Value is string array of MCCMNCs to be considered roaming for 3GPP RATs.
196     */
197    public static final String
198            KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY = "gsm_roaming_networks_string_array";
199
200    /**
201     * Override the platform's notion of a network operator being considered not roaming.
202     * Value is string array of MCCMNCs to be considered not roaming for 3GPP RATs.
203     */
204    public static final String
205            KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY = "gsm_nonroaming_networks_string_array";
206
207    /**
208     * Override the platform's notion of a network operator being considered roaming.
209     * Value is string array of SIDs to be considered roaming for 3GPP2 RATs.
210     */
211    public static final String
212            KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY = "cdma_roaming_networks_string_array";
213
214    /**
215     * Override the platform's notion of a network operator being considered non roaming.
216     * Value is string array of SIDs to be considered not roaming for 3GPP2 RATs.
217     */
218    public static final String
219            KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY = "cdma_nonroaming_networks_string_array";
220
221    /**
222     * Override the platform's notion of a network operator being considered non roaming.
223     * If true all networks are considered as home network a.k.a non-roaming.  When false,
224     * the 2 pairs of CMDA and GSM roaming/non-roaming arrays are consulted.
225     *
226     * @see KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY
227     * @see KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY
228     * @see KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY
229     * @see KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY
230     */
231    public static final String
232            KEY_FORCE_HOME_NETWORK_BOOL = "force_home_network_bool";
233
234    /**
235     * Flag specifying whether VoLTE should be available for carrier, independent of carrier
236     * provisioning. If false: hard disabled. If true: then depends on carrier provisioning,
237     * availability, etc.
238     */
239    public static final String KEY_CARRIER_VOLTE_AVAILABLE_BOOL = "carrier_volte_available_bool";
240
241    /**
242     * Flag specifying whether video telephony is available for carrier. If false: hard disabled.
243     * If true: then depends on carrier provisioning, availability, etc.
244     */
245    public static final String KEY_CARRIER_VT_AVAILABLE_BOOL = "carrier_vt_available_bool";
246
247    /**
248     * Flag specifying whether WFC over IMS should be available for carrier: independent of
249     * carrier provisioning. If false: hard disabled. If true: then depends on carrier
250     * provisioning, availability etc.
251     */
252    public static final String KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL = "carrier_wfc_ims_available_bool";
253
254    /**
255     * Default WFC_IMS_mode 0: WIFI_ONLY
256     *                      1: CELLULAR_PREFERRED
257     *                      2: WIFI_PREFERRED
258     * @hide
259     */
260    public static final String KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT =
261            "carrier_default_wfc_ims_mode_int";
262    /**
263     * Default WFC_IMS_enabled: true VoWiFi by default is on
264     *                          false VoWiFi by default is off
265     * @hide
266     */
267    public static final String KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL =
268            "carrier_default_wfc_ims_enabled_bool";
269
270    /**
271     * Default WFC_IMS_roaming_enabled: true VoWiFi roaming by default is on
272     *                                  false VoWiFi roaming by default is off
273     * @hide
274     */
275    public static final String KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL =
276            "carrier_default_wfc_ims_roaming_enabled_bool";
277
278    /** Flag specifying whether provisioning is required for VOLTE. */
279    public static final String KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL
280            = "carrier_volte_provisioning_required_bool";
281
282    /** Flag specifying whether VoLTE TTY is supported. */
283    public static final String KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL
284            = "carrier_volte_tty_supported_bool";
285
286    /**
287     * Flag specifying whether IMS service can be turned off. If false then the service will not be
288     * turned-off completely, but individual features can be disabled.
289     */
290    public static final String KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL
291            = "carrier_allow_turnoff_ims_bool";
292
293    /**
294     * Flag specifying whether Generic Bootstrapping Architecture capable SIM is required for IMS.
295     */
296    public static final String KEY_CARRIER_IMS_GBA_REQUIRED_BOOL
297            = "carrier_ims_gba_required_bool";
298
299    /**
300     * Flag specifying whether IMS instant lettering is available for the carrier.  {@code True} if
301     * instant lettering is available for the carrier, {@code false} otherwise.
302     */
303    public static final String KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL =
304            "carrier_instant_lettering_available_bool";
305
306    /*
307     * Flag specifying whether IMS should be the first phone attempted for E911 even if the
308     * phone is not in service.
309     */
310    public static final String KEY_CARRIER_USE_IMS_FIRST_FOR_EMERGENCY_BOOL
311            = "carrier_use_ims_first_for_emergency_bool";
312
313    /**
314     * When IMS instant lettering is available for a carrier (see
315     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines the list of characters
316     * which may not be contained in messages.  Should be specified as a regular expression suitable
317     * for use with {@link String#matches(String)}.
318     */
319    public static final String KEY_CARRIER_INSTANT_LETTERING_INVALID_CHARS_STRING =
320            "carrier_instant_lettering_invalid_chars_string";
321
322    /**
323     * When IMS instant lettering is available for a carrier (see
324     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines a list of characters which
325     * must be escaped with a backslash '\' character.  Should be specified as a string containing
326     * the characters to be escaped.  For example to escape quote and backslash the string would be
327     * a quote and a backslash.
328     */
329    public static final String KEY_CARRIER_INSTANT_LETTERING_ESCAPED_CHARS_STRING =
330            "carrier_instant_lettering_escaped_chars_string";
331
332    /**
333     * When IMS instant lettering is available for a carrier (see
334     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines the character encoding
335     * which will be used when determining the length of messages.  Used in the InCall UI to limit
336     * the number of characters the user may type.  If empty-string, the instant lettering
337     * message size limit will be enforced on a 1:1 basis.  That is, each character will count
338     * towards the messages size limit as a single bye.  If a character encoding is specified, the
339     * message size limit will be based on the number of bytes in the message per the specified
340     * encoding.
341     */
342    public static final String KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING =
343            "carrier_instant_lettering_encoding_string";
344
345    /**
346     * When IMS instant lettering is available for a carrier (see
347     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), the length limit for messages.  Used
348     * in the InCall UI to ensure the user cannot enter more characters than allowed by the carrier.
349     * See also {@link #KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING} for more information on how
350     * the length of the message is calculated.
351     */
352    public static final String KEY_CARRIER_INSTANT_LETTERING_LENGTH_LIMIT_INT =
353            "carrier_instant_lettering_length_limit_int";
354
355    /**
356     * If Voice Radio Technology is RIL_RADIO_TECHNOLOGY_LTE:14 or RIL_RADIO_TECHNOLOGY_UNKNOWN:0
357     * this is the value that should be used instead. A configuration value of
358     * RIL_RADIO_TECHNOLOGY_UNKNOWN:0 means there is no replacement value and that the default
359     * assumption for phone type (GSM) should be used.
360     */
361    public static final String KEY_VOLTE_REPLACEMENT_RAT_INT = "volte_replacement_rat_int";
362
363    /**
364     * The default sim call manager to use when the default dialer doesn't implement one. A sim call
365     * manager can control and route outgoing and incoming phone calls, even if they're placed
366     * using another connection service (PSTN, for example).
367     */
368    public static final String KEY_DEFAULT_SIM_CALL_MANAGER_STRING = "default_sim_call_manager_string";
369
370    /**
371     * The default flag specifying whether ETWS/CMAS test setting is forcibly disabled in
372     * Settings->More->Emergency broadcasts menu even though developer options is turned on.
373     */
374    public static final String KEY_CARRIER_FORCE_DISABLE_ETWS_CMAS_TEST_BOOL =
375            "carrier_force_disable_etws_cmas_test_bool";
376
377    /**
378     * The default flag specifying whether "Turn on Notifications" option will be always shown in
379     * Settings->More->Emergency broadcasts menu regardless developer options is turned on or not.
380     */
381    public static final String KEY_ALWAYS_SHOW_EMERGENCY_ALERT_ONOFF_BOOL =
382            "always_show_emergency_alert_onoff_bool";
383
384    /**
385     * The data call APN retry configuration for default type APN.
386     * @hide
387     */
388    public static final String KEY_CARRIER_DATA_CALL_RETRY_CONFIG_DEFAULT_STRING =
389            "carrier_data_call_retry_config_default_string";
390
391    /**
392     * The data call APN retry configuration for other type APNs.
393     * @hide
394     */
395    public static final String KEY_CARRIER_DATA_CALL_RETRY_CONFIG_OTHERS_STRING =
396            "carrier_data_call_retry_config_others_string";
397
398    /**
399     * Delay between trying APN from the pool
400     * @hide
401     */
402    public static final String KEY_CARRIER_DATA_CALL_APN_DELAY_DEFAULT_LONG =
403            "carrier_data_call_apn_delay_default_long";
404
405    /**
406     * Faster delay between trying APN from the pool
407     * @hide
408     */
409    public static final String KEY_CARRIER_DATA_CALL_APN_DELAY_FASTER_LONG =
410            "carrier_data_call_apn_delay_faster_long";
411
412    /* The following 3 fields are related to carrier visual voicemail. */
413
414    /**
415     * The carrier number mobile outgoing (MO) sms messages are sent to.
416     */
417    public static final String KEY_VVM_DESTINATION_NUMBER_STRING = "vvm_destination_number_string";
418
419    /**
420     * The port through which the mobile outgoing (MO) sms messages are sent through.
421     */
422    public static final String KEY_VVM_PORT_NUMBER_INT = "vvm_port_number_int";
423
424    /**
425     * The type of visual voicemail protocol the carrier adheres to. See {@link TelephonyManager}
426     * for possible values. For example {@link TelephonyManager#VVM_TYPE_OMTP}.
427     */
428    public static final String KEY_VVM_TYPE_STRING = "vvm_type_string";
429
430    /**
431     * Whether cellular data is required to access visual voicemail.
432     */
433    public static final String KEY_VVM_CELLULAR_DATA_REQUIRED_BOOLEAN = "vvm_cellular_data_required";
434
435    /**
436     * Whether to prefetch audio data on new voicemail arrival, defaulted to true.
437     */
438    public static final String KEY_VVM_PREFETCH_BOOLEAN = "vvm_prefetch";
439
440    /**
441     * The package name of the carrier's visual voicemail app to ensure that dialer visual voicemail
442     * and carrier visual voicemail are not active at the same time.
443     */
444    public static final String KEY_CARRIER_VVM_PACKAGE_NAME_STRING = "carrier_vvm_package_name_string";
445
446    /**
447     * Flag specifying whether an additional (client initiated) intent needs to be sent on System
448     * update
449     */
450    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_BOOL = "ci_action_on_sys_update_bool";
451
452    /**
453     * Intent to be sent for the additional action on System update
454     */
455    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_INTENT_STRING =
456            "ci_action_on_sys_update_intent_string";
457
458    /**
459     * Extra to be included in the intent sent for additional action on System update
460     */
461    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_STRING =
462            "ci_action_on_sys_update_extra_string";
463
464    /**
465     * Value of extra included in intent sent for additional action on System update
466     */
467    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_VAL_STRING =
468            "ci_action_on_sys_update_extra_val_string";
469
470    /**
471     * Specifies the amount of gap to be added in millis between postdial DTMF tones. When a
472     * non-zero value is specified, the UE shall wait for the specified amount of time before it
473     * sends out successive DTMF tones on the network.
474     */
475    public static final String KEY_GSM_DTMF_TONE_DELAY_INT = "gsm_dtmf_tone_delay_int";
476
477    /**
478     * Specifies the amount of gap to be added in millis between DTMF tones. When a non-zero value
479     * is specified, the UE shall wait for the specified amount of time before it sends out
480     * successive DTMF tones on the network.
481     */
482    public static final String KEY_IMS_DTMF_TONE_DELAY_INT = "ims_dtmf_tone_delay_int";
483
484    /**
485     * Specifies the amount of gap to be added in millis between postdial DTMF tones. When a
486     * non-zero value is specified, the UE shall wait for the specified amount of time before it
487     * sends out successive DTMF tones on the network.
488     */
489    public static final String KEY_CDMA_DTMF_TONE_DELAY_INT = "cdma_dtmf_tone_delay_int";
490
491    /**
492     * Determines whether conference calls are supported by a carrier.  When {@code true},
493     * conference calling is supported, {@code false otherwise}.
494     */
495    public static final String KEY_SUPPORT_CONFERENCE_CALL_BOOL = "support_conference_call_bool";
496
497    /**
498     * Determine whether user can toggle Enhanced 4G LTE Mode in Settings.
499     */
500    public static final String KEY_EDITABLE_ENHANCED_4G_LTE_BOOL = "editable_enhanced_4g_lte_bool";
501
502    /**
503     * Determine whether IMS apn can be shown.
504     */
505    public static final String KEY_HIDE_IMS_APN_BOOL = "hide_ims_apn_bool";
506
507    /**
508     * Determine whether preferred network type can be shown.
509     */
510    public static final String KEY_HIDE_PREFERRED_NETWORK_TYPE_BOOL = "hide_preferred_network_type_bool";
511
512    /**
513     * Determine whether user can switch Wi-Fi preferred or Cellular preferred in calling preference.
514     * Some operators support Wi-Fi Calling only, not VoLTE.
515     * They don't need "Cellular preferred" option.
516     * In this case, set uneditalbe attribute for preferred preference.
517     * @hide
518     */
519    public static final String KEY_EDITABLE_WFC_MODE_BOOL = "editable_wfc_mode_bool";
520
521    /**
522     * If this is true, the SIM card (through Customer Service Profile EF file) will be able to
523     * prevent manual operator selection. If false, this SIM setting will be ignored and manual
524     * operator selection will always be available. See CPHS4_2.WW6, CPHS B.4.7.1 for more
525     * information
526     */
527    public static final String KEY_CSP_ENABLED_BOOL = "csp_enabled_bool";
528
529    /**
530     * Allow user to add APNs
531     */
532    public static final String KEY_ALLOW_ADDING_APNS_BOOL = "allow_adding_apns_bool";
533
534    /**
535     * Boolean indicating if intent for emergency call state changes should be broadcast
536     * @hide
537     */
538    public static final String KEY_BROADCAST_EMERGENCY_CALL_STATE_CHANGES_BOOL =
539            "broadcast_emergency_call_state_changes_bool";
540
541    // These variables are used by the MMS service and exposed through another API, {@link
542    // SmsManager}. The variable names and string values are copied from there.
543    public static final String KEY_MMS_ALIAS_ENABLED_BOOL = "aliasEnabled";
544    public static final String KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL = "allowAttachAudio";
545    public static final String KEY_MMS_APPEND_TRANSACTION_ID_BOOL = "enabledTransID";
546    public static final String KEY_MMS_GROUP_MMS_ENABLED_BOOL = "enableGroupMms";
547    public static final String KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL = "enableMMSDeliveryReports";
548    public static final String KEY_MMS_MMS_ENABLED_BOOL = "enabledMMS";
549    public static final String KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL = "enableMMSReadReports";
550    public static final String KEY_MMS_MULTIPART_SMS_ENABLED_BOOL = "enableMultipartSMS";
551    public static final String KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL = "enabledNotifyWapMMSC";
552    public static final String KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL = "sendMultipartSmsAsSeparateMessages";
553    public static final String KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL = "config_cellBroadcastAppLinks";
554    public static final String KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL = "enableSMSDeliveryReports";
555    public static final String KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL = "supportHttpCharsetHeader";
556    public static final String KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL = "supportMmsContentDisposition";
557    public static final String KEY_MMS_ALIAS_MAX_CHARS_INT = "aliasMaxChars";
558    public static final String KEY_MMS_ALIAS_MIN_CHARS_INT = "aliasMinChars";
559    public static final String KEY_MMS_HTTP_SOCKET_TIMEOUT_INT = "httpSocketTimeout";
560    public static final String KEY_MMS_MAX_IMAGE_HEIGHT_INT = "maxImageHeight";
561    public static final String KEY_MMS_MAX_IMAGE_WIDTH_INT = "maxImageWidth";
562    public static final String KEY_MMS_MAX_MESSAGE_SIZE_INT = "maxMessageSize";
563    public static final String KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT = "maxMessageTextSize";
564    public static final String KEY_MMS_RECIPIENT_LIMIT_INT = "recipientLimit";
565    public static final String KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT = "smsToMmsTextLengthThreshold";
566    public static final String KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT = "smsToMmsTextThreshold";
567    public static final String KEY_MMS_SUBJECT_MAX_LENGTH_INT = "maxSubjectLength";
568    public static final String KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING = "emailGatewayNumber";
569    public static final String KEY_MMS_HTTP_PARAMS_STRING = "httpParams";
570    public static final String KEY_MMS_NAI_SUFFIX_STRING = "naiSuffix";
571    public static final String KEY_MMS_UA_PROF_TAG_NAME_STRING = "uaProfTagName";
572    public static final String KEY_MMS_UA_PROF_URL_STRING = "uaProfUrl";
573    public static final String KEY_MMS_USER_AGENT_STRING = "userAgent";
574
575    /**
576     * Determines whether the carrier supports making non-emergency phone calls while the phone is
577     * in emergency callback mode.  Default value is {@code true}, meaning that non-emergency calls
578     * are allowed in emergency callback mode.
579     */
580    public static final String KEY_ALLOW_NON_EMERGENCY_CALLS_IN_ECM_BOOL =
581            "allow_non_emergency_calls_in_ecm_bool";
582
583    /**
584     * Flag indicating whether to allow carrier video calls to emergency numbers.
585     * When {@code true}, video calls to emergency numbers will be allowed.  When {@code false},
586     * video calls to emergency numbers will be initiated as audio-only calls instead.
587     */
588    public static final String KEY_ALLOW_EMERGENCY_VIDEO_CALLS_BOOL =
589            "allow_emergency_video_calls_bool";
590
591    /**
592     * Flag indicating whether the carrier supports RCS presence indication for video calls.  When
593     * {@code true}, the carrier supports RCS presence indication for video calls.  When presence
594     * is supported, the device should use the
595     * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE} bit mask and set the
596     * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE_VT_CAPABLE} bit to indicate
597     * whether each contact supports video calling.  The UI is made aware that presence is enabled
598     * via {@link android.telecom.PhoneAccount#CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE}
599     * and can choose to hide or show the video calling icon based on whether a contact supports
600     * video.
601     */
602    public static final String KEY_USE_RCS_PRESENCE_BOOL = "use_rcs_presence_bool";
603
604    /**
605     * The duration in seconds that platform call and message blocking is disabled after the user
606     * contacts emergency services. Platform considers values in the range 0 to 604800 (one week) as
607     * valid. See {@link android.provider.BlockedNumberContract#isBlocked(Context, String)}).
608     */
609    public static final String KEY_DURATION_BLOCKING_DISABLED_AFTER_EMERGENCY_INT =
610            "duration_blocking_disabled_after_emergency_int";
611
612    /** The default value for every variable. */
613    private final static PersistableBundle sDefaults;
614
615    static {
616        sDefaults = new PersistableBundle();
617        sDefaults.putBoolean(KEY_ADDITIONAL_CALL_SETTING_BOOL, true);
618        sDefaults.putBoolean(KEY_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG_BOOL, false);
619        sDefaults.putBoolean(KEY_ALLOW_LOCAL_DTMF_TONES_BOOL, true);
620        sDefaults.putBoolean(KEY_APN_EXPAND_BOOL, true);
621        sDefaults.putBoolean(KEY_AUTO_RETRY_ENABLED_BOOL, false);
622        sDefaults.putBoolean(KEY_CARRIER_SETTINGS_ENABLE_BOOL, false);
623        sDefaults.putBoolean(KEY_CARRIER_VOLTE_AVAILABLE_BOOL, false);
624        sDefaults.putBoolean(KEY_CARRIER_VT_AVAILABLE_BOOL, false);
625        sDefaults.putBoolean(KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL, false);
626        sDefaults.putBoolean(KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL, false);
627        sDefaults.putBoolean(KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL, false);
628        sDefaults.putInt(KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT, 2);
629        sDefaults.putBoolean(KEY_CARRIER_FORCE_DISABLE_ETWS_CMAS_TEST_BOOL, false);
630        sDefaults.putBoolean(KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL, false);
631        sDefaults.putBoolean(KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL, true);
632        sDefaults.putBoolean(KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL, true);
633        sDefaults.putBoolean(KEY_CARRIER_IMS_GBA_REQUIRED_BOOL, false);
634        sDefaults.putBoolean(KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL, false);
635        sDefaults.putBoolean(KEY_CARRIER_USE_IMS_FIRST_FOR_EMERGENCY_BOOL, true);
636        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_INVALID_CHARS_STRING, "");
637        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_ESCAPED_CHARS_STRING, "");
638        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING, "");
639        sDefaults.putInt(KEY_CARRIER_INSTANT_LETTERING_LENGTH_LIMIT_INT, 64);
640        sDefaults.putBoolean(KEY_DISABLE_CDMA_ACTIVATION_CODE_BOOL, false);
641        sDefaults.putBoolean(KEY_DTMF_TYPE_ENABLED_BOOL, false);
642        sDefaults.putBoolean(KEY_ENABLE_DIALER_KEY_VIBRATION_BOOL, true);
643        sDefaults.putBoolean(KEY_HAS_IN_CALL_NOISE_SUPPRESSION_BOOL, false);
644        sDefaults.putBoolean(KEY_HIDE_CARRIER_NETWORK_SETTINGS_BOOL, false);
645        sDefaults.putBoolean(KEY_HIDE_SIM_LOCK_SETTINGS_BOOL, false);
646        sDefaults.putBoolean(KEY_IGNORE_SIM_NETWORK_LOCKED_EVENTS_BOOL, false);
647        sDefaults.putBoolean(KEY_OPERATOR_SELECTION_EXPAND_BOOL, true);
648        sDefaults.putBoolean(KEY_PREFER_2G_BOOL, true);
649        sDefaults.putBoolean(KEY_SHOW_APN_SETTING_CDMA_BOOL, false);
650        sDefaults.putBoolean(KEY_SHOW_CDMA_CHOICES_BOOL, false);
651        sDefaults.putBoolean(KEY_SHOW_ONSCREEN_DIAL_BUTTON_BOOL, true);
652        sDefaults.putBoolean(KEY_SIM_NETWORK_UNLOCK_ALLOW_DISMISS_BOOL, true);
653        sDefaults.putBoolean(KEY_SUPPORT_PAUSE_IMS_VIDEO_CALLS_BOOL, false);
654        sDefaults.putBoolean(KEY_SUPPORT_SWAP_AFTER_MERGE_BOOL, true);
655        sDefaults.putBoolean(KEY_USE_HFA_FOR_PROVISIONING_BOOL, false);
656        sDefaults.putBoolean(KEY_USE_OTASP_FOR_PROVISIONING_BOOL, false);
657        sDefaults.putBoolean(KEY_VOICEMAIL_NOTIFICATION_PERSISTENT_BOOL, false);
658        sDefaults.putBoolean(KEY_VOICE_PRIVACY_DISABLE_UI_BOOL, false);
659        sDefaults.putBoolean(KEY_WORLD_PHONE_BOOL, false);
660        sDefaults.putBoolean(KEY_REQUIRE_ENTITLEMENT_CHECKS_BOOL, true);
661        sDefaults.putInt(KEY_VOLTE_REPLACEMENT_RAT_INT, 0);
662        sDefaults.putString(KEY_DEFAULT_SIM_CALL_MANAGER_STRING, "");
663        sDefaults.putString(KEY_VVM_DESTINATION_NUMBER_STRING, "");
664        sDefaults.putInt(KEY_VVM_PORT_NUMBER_INT, 0);
665        sDefaults.putString(KEY_VVM_TYPE_STRING, "");
666        sDefaults.putBoolean(KEY_VVM_CELLULAR_DATA_REQUIRED_BOOLEAN,false);
667        sDefaults.putBoolean(KEY_VVM_PREFETCH_BOOLEAN,true);
668        sDefaults.putString(KEY_CARRIER_VVM_PACKAGE_NAME_STRING, "");
669        sDefaults.putBoolean(KEY_CI_ACTION_ON_SYS_UPDATE_BOOL, false);
670        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_INTENT_STRING, "");
671        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_STRING, "");
672        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_VAL_STRING, "");
673        sDefaults.putBoolean(KEY_CSP_ENABLED_BOOL, false);
674        sDefaults.putBoolean(KEY_ALLOW_ADDING_APNS_BOOL, true);
675        sDefaults.putBoolean(KEY_BROADCAST_EMERGENCY_CALL_STATE_CHANGES_BOOL, false);
676        sDefaults.putBoolean(KEY_ALWAYS_SHOW_EMERGENCY_ALERT_ONOFF_BOOL, false);
677        sDefaults.putString(KEY_CARRIER_DATA_CALL_RETRY_CONFIG_DEFAULT_STRING,
678                "default_randomization=2000,5000,10000,20000,40000,80000:5000,160000:5000,"
679                        + "320000:5000,640000:5000,1280000:5000,1800000:5000");
680        sDefaults.putString(KEY_CARRIER_DATA_CALL_RETRY_CONFIG_OTHERS_STRING,
681                "max_retries=3, 5000, 5000, 5000");
682        sDefaults.putLong(KEY_CARRIER_DATA_CALL_APN_DELAY_DEFAULT_LONG, 20000);
683        sDefaults.putLong(KEY_CARRIER_DATA_CALL_APN_DELAY_FASTER_LONG, 3000);
684        sDefaults.putInt(KEY_DURATION_BLOCKING_DISABLED_AFTER_EMERGENCY_INT, 7200);
685
686        sDefaults.putStringArray(KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY, null);
687        sDefaults.putStringArray(KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY, null);
688        sDefaults.putStringArray(KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY, null);
689        sDefaults.putStringArray(KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY, null);
690        sDefaults.putBoolean(KEY_FORCE_HOME_NETWORK_BOOL, false);
691        sDefaults.putInt(KEY_GSM_DTMF_TONE_DELAY_INT, 0);
692        sDefaults.putInt(KEY_IMS_DTMF_TONE_DELAY_INT, 0);
693        sDefaults.putInt(KEY_CDMA_DTMF_TONE_DELAY_INT, 100);
694        sDefaults.putBoolean(KEY_SUPPORT_CONFERENCE_CALL_BOOL, true);
695        sDefaults.putBoolean(KEY_EDITABLE_ENHANCED_4G_LTE_BOOL, true);
696        sDefaults.putBoolean(KEY_HIDE_IMS_APN_BOOL, false);
697        sDefaults.putBoolean(KEY_HIDE_PREFERRED_NETWORK_TYPE_BOOL, false);
698        sDefaults.putBoolean(KEY_ALLOW_EMERGENCY_VIDEO_CALLS_BOOL, false);
699        sDefaults.putBoolean(KEY_EDITABLE_WFC_MODE_BOOL, true);
700
701        // MMS defaults
702        sDefaults.putBoolean(KEY_MMS_ALIAS_ENABLED_BOOL, false);
703        sDefaults.putBoolean(KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL, true);
704        sDefaults.putBoolean(KEY_MMS_APPEND_TRANSACTION_ID_BOOL, false);
705        sDefaults.putBoolean(KEY_MMS_GROUP_MMS_ENABLED_BOOL, true);
706        sDefaults.putBoolean(KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL, false);
707        sDefaults.putBoolean(KEY_MMS_MMS_ENABLED_BOOL, true);
708        sDefaults.putBoolean(KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL, false);
709        sDefaults.putBoolean(KEY_MMS_MULTIPART_SMS_ENABLED_BOOL, true);
710        sDefaults.putBoolean(KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL, false);
711        sDefaults.putBoolean(KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL, false);
712        sDefaults.putBoolean(KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL, true);
713        sDefaults.putBoolean(KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL, true);
714        sDefaults.putBoolean(KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL, false);
715        sDefaults.putBoolean(KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL, true);
716        sDefaults.putInt(KEY_MMS_ALIAS_MAX_CHARS_INT, 48);
717        sDefaults.putInt(KEY_MMS_ALIAS_MIN_CHARS_INT, 2);
718        sDefaults.putInt(KEY_MMS_HTTP_SOCKET_TIMEOUT_INT, 60 * 1000);
719        sDefaults.putInt(KEY_MMS_MAX_IMAGE_HEIGHT_INT, 480);
720        sDefaults.putInt(KEY_MMS_MAX_IMAGE_WIDTH_INT, 640);
721        sDefaults.putInt(KEY_MMS_MAX_MESSAGE_SIZE_INT, 300 * 1024);
722        sDefaults.putInt(KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT, -1);
723        sDefaults.putInt(KEY_MMS_RECIPIENT_LIMIT_INT, Integer.MAX_VALUE);
724        sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT, -1);
725        sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT, -1);
726        sDefaults.putInt(KEY_MMS_SUBJECT_MAX_LENGTH_INT, 40);
727        sDefaults.putString(KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING, "");
728        sDefaults.putString(KEY_MMS_HTTP_PARAMS_STRING, "");
729        sDefaults.putString(KEY_MMS_NAI_SUFFIX_STRING, "");
730        sDefaults.putString(KEY_MMS_UA_PROF_TAG_NAME_STRING, "x-wap-profile");
731        sDefaults.putString(KEY_MMS_UA_PROF_URL_STRING, "");
732        sDefaults.putString(KEY_MMS_USER_AGENT_STRING, "");
733        sDefaults.putBoolean(KEY_ALLOW_NON_EMERGENCY_CALLS_IN_ECM_BOOL, true);
734        sDefaults.putBoolean(KEY_USE_RCS_PRESENCE_BOOL, false);
735    }
736
737    /**
738     * Gets the configuration values for a particular subscription, which is associated with a
739     * specific SIM card. If an invalid subId is used, the returned config will contain default
740     * values.
741     *
742     * <p>Requires Permission:
743     * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
744     *
745     * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}.
746     * @return A {@link PersistableBundle} containing the config for the given subId, or default
747     *         values for an invalid subId.
748     *
749     * @deprecated use getConfig.
750     */
751    @Nullable
752    public PersistableBundle getConfigForSubId(int subId) {
753        return getConfig(subId);
754    }
755
756    /**
757     * Gets the configuration values for a particular subscription, which is associated with a
758     * specific SIM card. If an invalid subId is used, the returned config will contain default
759     * values.
760     *
761     * <p>Requires Permission:
762     * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
763     *
764     * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}.
765     * @return A {@link PersistableBundle} containing the config for the given subId, or default
766     *         values for an invalid subId.
767     */
768    @Nullable
769    public PersistableBundle getConfig(int subId) {
770        try {
771            ICarrierConfigLoader loader = getICarrierConfigLoader();
772            if (loader == null) {
773                Rlog.w(TAG, "Error getting config for subId " + subId
774                        + " ICarrierConfigLoader is null");
775                return null;
776            }
777            return loader.getConfigForSubId(subId);
778        } catch (RemoteException ex) {
779            Rlog.e(TAG, "Error getting config for subId " + subId + ": "
780                    + ex.toString());
781        }
782        return null;
783    }
784
785    /**
786     * Gets the configuration values for the default subscription.
787     *
788     * <p>Requires Permission:
789     * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
790     *
791     * @return A {@link PersistableBundle} containing the config for the default subscription.
792     */
793    @Nullable
794    public PersistableBundle getConfig() {
795        return getConfig(SubscriptionManager.getDefaultSubscriptionId());
796    }
797
798    /**
799     * Calling this method triggers telephony services to fetch the current carrier configuration.
800     * <p>
801     * Normally this does not need to be called because the platform reloads config on its own.
802     * This should be called by a carrier service app if it wants to update config at an arbitrary
803     * moment.
804     * </p>
805     * <p>Requires that the calling app has carrier privileges.
806     * @see #hasCarrierPrivileges
807     * <p>
808     * This method returns before the reload has completed, and
809     * {@link android.service.carrier.CarrierService#onLoadConfig} will be called from an
810     * arbitrary thread.
811     * </p>
812     *
813     * @deprecated use notifyConfigChanged.
814     */
815    public void notifyConfigChangedForSubId(int subId) {
816        notifyConfigChanged(subId);
817    }
818
819    /**
820     * Calling this method triggers telephony services to fetch the current carrier configuration.
821     * <p>
822     * Normally this does not need to be called because the platform reloads config on its own.
823     * This should be called by a carrier service app if it wants to update config at an arbitrary
824     * moment.
825     * </p>
826     * <p>Requires that the calling app has carrier privileges.
827     * @see #hasCarrierPrivileges
828     * <p>
829     * This method returns before the reload has completed, and
830     * {@link android.service.carrier.CarrierService#onLoadConfig} will be called from an
831     * arbitrary thread.
832     * </p>
833     */
834    public void notifyConfigChanged(int subId) {
835        try {
836            ICarrierConfigLoader loader = getICarrierConfigLoader();
837            if (loader == null) {
838                Rlog.w(TAG, "Error reloading config for subId=" + subId
839                        + " ICarrierConfigLoader is null");
840                return;
841            }
842            loader.notifyConfigChangedForSubId(subId);
843        } catch (RemoteException ex) {
844            Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString());
845        }
846    }
847
848    /**
849     * Request the carrier config loader to update the cofig for phoneId.
850     * <p>
851     * Depending on simState, the config may be cleared or loaded from config app. This is only used
852     * by SubscriptionInfoUpdater.
853     * </p>
854     *
855     * @hide
856     */
857    @SystemApi
858    public void updateConfigForPhoneId(int phoneId, String simState) {
859        try {
860            ICarrierConfigLoader loader = getICarrierConfigLoader();
861            if (loader == null) {
862                Rlog.w(TAG, "Error updating config for phoneId=" + phoneId
863                        + " ICarrierConfigLoader is null");
864                return;
865            }
866            loader.updateConfigForPhoneId(phoneId, simState);
867        } catch (RemoteException ex) {
868            Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString());
869        }
870    }
871
872    /**
873     * Returns a new bundle with the default value for every supported configuration variable.
874     *
875     * @hide
876     */
877    @NonNull
878    @SystemApi
879    public static PersistableBundle getDefaultConfig() {
880        return new PersistableBundle(sDefaults);
881    }
882
883    /** @hide */
884    @Nullable
885    private ICarrierConfigLoader getICarrierConfigLoader() {
886        return ICarrierConfigLoader.Stub
887                .asInterface(ServiceManager.getService(Context.CARRIER_CONFIG_SERVICE));
888    }
889}
890