CarrierConfigManager.java revision 7ea3e8bf8954343d7b243b6a23bcb8339921f3c8
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    /** Flag specifying whether provisioning is required for VOLTE. */
255    public static final String KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL
256            = "carrier_volte_provisioning_required_bool";
257
258    /** Flag specifying whether VoLTE TTY is supported. */
259    public static final String KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL
260            = "carrier_volte_tty_supported_bool";
261
262    /**
263     * Flag specifying whether IMS service can be turned off. If false then the service will not be
264     * turned-off completely, but individual features can be disabled.
265     */
266    public static final String KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL
267            = "carrier_allow_turnoff_ims_bool";
268
269    /**
270     * Flag specifying whether Generic Bootstrapping Architecture capable SIM is required for IMS.
271     */
272    public static final String KEY_CARRIER_IMS_GBA_REQUIRED_BOOL
273            = "carrier_ims_gba_required_bool";
274
275    /**
276     * Flag specifying whether IMS instant lettering is available for the carrier.  {@code True} if
277     * instant lettering is available for the carrier, {@code false} otherwise.
278     */
279    public static final String KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL =
280            "carrier_instant_lettering_available_bool";
281
282    /*
283     * Flag specifying whether IMS should be the first phone attempted for E911 even if the
284     * phone is not in service.
285     */
286    public static final String KEY_CARRIER_USE_IMS_FIRST_FOR_EMERGENCY_BOOL
287            = "carrier_use_ims_first_for_emergency_bool";
288
289    /**
290     * When IMS instant lettering is available for a carrier (see
291     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines the list of characters
292     * which may not be contained in messages.  Should be specified as a regular expression suitable
293     * for use with {@link String#matches(String)}.
294     */
295    public static final String KEY_CARRIER_INSTANT_LETTERING_INVALID_CHARS_STRING =
296            "carrier_instant_lettering_invalid_chars_string";
297
298    /**
299     * When IMS instant lettering is available for a carrier (see
300     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines a list of characters which
301     * must be escaped with a backslash '\' character.  Should be specified as a string containing
302     * the characters to be escaped.  For example to escape quote and backslash the string would be
303     * a quote and a backslash.
304     */
305    public static final String KEY_CARRIER_INSTANT_LETTERING_ESCAPED_CHARS_STRING =
306            "carrier_instant_lettering_escaped_chars_string";
307
308    /**
309     * When IMS instant lettering is available for a carrier (see
310     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), determines the character encoding
311     * which will be used when determining the length of messages.  Used in the InCall UI to limit
312     * the number of characters the user may type.  If empty-string, the instant lettering
313     * message size limit will be enforced on a 1:1 basis.  That is, each character will count
314     * towards the messages size limit as a single bye.  If a character encoding is specified, the
315     * message size limit will be based on the number of bytes in the message per the specified
316     * encoding.
317     */
318    public static final String KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING =
319            "carrier_instant_lettering_encoding_string";
320
321    /**
322     * When IMS instant lettering is available for a carrier (see
323     * {@link #KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL}), the length limit for messages.  Used
324     * in the InCall UI to ensure the user cannot enter more characters than allowed by the carrier.
325     * See also {@link #KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING} for more information on how
326     * the length of the message is calculated.
327     */
328    public static final String KEY_CARRIER_INSTANT_LETTERING_LENGTH_LIMIT_INT =
329            "carrier_instant_lettering_length_limit_int";
330
331    /**
332     * If Voice Radio Technology is RIL_RADIO_TECHNOLOGY_LTE:14 or RIL_RADIO_TECHNOLOGY_UNKNOWN:0
333     * this is the value that should be used instead. A configuration value of
334     * RIL_RADIO_TECHNOLOGY_UNKNOWN:0 means there is no replacement value and that the default
335     * assumption for phone type (GSM) should be used.
336     */
337    public static final String KEY_VOLTE_REPLACEMENT_RAT_INT = "volte_replacement_rat_int";
338
339    /**
340     * The default sim call manager to use when the default dialer doesn't implement one. A sim call
341     * manager can control and route outgoing and incoming phone calls, even if they're placed
342     * using another connection service (PSTN, for example).
343     */
344    public static final String KEY_DEFAULT_SIM_CALL_MANAGER_STRING = "default_sim_call_manager_string";
345
346    /**
347     * The default flag specifying whether ETWS/CMAS test setting is forcibly disabled in
348     * Settings->More->Emergency broadcasts menu even though developer options is turned on.
349     */
350    public static final String KEY_CARRIER_FORCE_DISABLE_ETWS_CMAS_TEST_BOOL =
351            "carrier_force_disable_etws_cmas_test_bool";
352
353    /**
354     * The default flag specifying whether "Turn on Notifications" option will be always shown in
355     * Settings->More->Emergency broadcasts menu regardless developer options is turned on or not.
356     */
357    public static final String KEY_ALWAYS_SHOW_EMERGENCY_ALERT_ONOFF_BOOL =
358            "always_show_emergency_alert_onoff_bool";
359
360    /**
361     * The data call APN retry configuration for default type APN.
362     * @hide
363     */
364    public static final String KEY_CARRIER_DATA_CALL_RETRY_CONFIG_DEFAULT_STRING =
365            "carrier_data_call_retry_config_default_string";
366
367    /**
368     * The data call APN retry configuration for other type APNs.
369     * @hide
370     */
371    public static final String KEY_CARRIER_DATA_CALL_RETRY_CONFIG_OTHERS_STRING =
372            "carrier_data_call_retry_config_others_string";
373
374    /**
375     * Delay between trying APN from the pool
376     * @hide
377     */
378    public static final String KEY_CARRIER_DATA_CALL_APN_DELAY_DEFAULT_LONG =
379            "carrier_data_call_apn_delay_default_long";
380
381    /**
382     * Faster delay between trying APN from the pool
383     * @hide
384     */
385    public static final String KEY_CARRIER_DATA_CALL_APN_DELAY_FASTER_LONG =
386            "carrier_data_call_apn_delay_faster_long";
387
388    /* The following 3 fields are related to carrier visual voicemail. */
389
390    /**
391     * The carrier number mobile outgoing (MO) sms messages are sent to.
392     */
393    public static final String KEY_VVM_DESTINATION_NUMBER_STRING = "vvm_destination_number_string";
394
395    /**
396     * The port through which the mobile outgoing (MO) sms messages are sent through.
397     */
398    public static final String KEY_VVM_PORT_NUMBER_INT = "vvm_port_number_int";
399
400    /**
401     * The type of visual voicemail protocol the carrier adheres to. See {@link TelephonyManager}
402     * for possible values. For example {@link TelephonyManager#VVM_TYPE_OMTP}.
403     */
404    public static final String KEY_VVM_TYPE_STRING = "vvm_type_string";
405
406    /**
407     * Whether cellular data is required to access visual voicemail.
408     */
409    public static final String KEY_VVM_CELLULAR_DATA_REQUIRED_BOOLEAN = "vvm_cellular_data_required";
410
411    /**
412     * The package name of the carrier's visual voicemail app to ensure that dialer visual voicemail
413     * and carrier visual voicemail are not active at the same time.
414     */
415    public static final String KEY_CARRIER_VVM_PACKAGE_NAME_STRING = "carrier_vvm_package_name_string";
416
417    /**
418     * Flag specifying whether an additional (client initiated) intent needs to be sent on System
419     * update
420     */
421    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_BOOL = "ci_action_on_sys_update_bool";
422
423    /**
424     * Intent to be sent for the additional action on System update
425     */
426    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_INTENT_STRING =
427            "ci_action_on_sys_update_intent_string";
428
429    /**
430     * Extra to be included in the intent sent for additional action on System update
431     */
432    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_STRING =
433            "ci_action_on_sys_update_extra_string";
434
435    /**
436     * Value of extra included in intent sent for additional action on System update
437     */
438    public static final String KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_VAL_STRING =
439            "ci_action_on_sys_update_extra_val_string";
440
441    /**
442     * Specifies the amount of gap to be added in millis between postdial DTMF tones. When a
443     * non-zero value is specified, the UE shall wait for the specified amount of time before it
444     * sends out successive DTMF tones on the network.
445     */
446    public static final String KEY_GSM_DTMF_TONE_DELAY_INT = "gsm_dtmf_tone_delay_int";
447
448    /**
449     * Specifies the amount of gap to be added in millis between DTMF tones. When a non-zero value
450     * is specified, the UE shall wait for the specified amount of time before it sends out
451     * successive DTMF tones on the network.
452     */
453    public static final String KEY_IMS_DTMF_TONE_DELAY_INT = "ims_dtmf_tone_delay_int";
454
455    /**
456     * Specifies the amount of gap to be added in millis between postdial DTMF tones. When a
457     * non-zero value is specified, the UE shall wait for the specified amount of time before it
458     * sends out successive DTMF tones on the network.
459     */
460    public static final String KEY_CDMA_DTMF_TONE_DELAY_INT = "cdma_dtmf_tone_delay_int";
461
462    /**
463     * Determines whether conference calls are supported by a carrier.  When {@code true},
464     * conference calling is supported, {@code false otherwise}.
465     */
466    public static final String KEY_SUPPORT_CONFERENCE_CALL_BOOL = "support_conference_call_bool";
467
468    /**
469     * Determine whether user can toggle Enhanced 4G LTE Mode in Settings.
470     */
471    public static final String KEY_EDITABLE_ENHANCED_4G_LTE_BOOL = "editable_enhanced_4g_lte_bool";
472
473    /**
474     * Determine whether IMS apn can be shown.
475     */
476    public static final String KEY_HIDE_IMS_APN_BOOL = "hide_ims_apn_bool";
477
478    /**
479     * Determine whether preferred network type can be shown.
480     */
481    public static final String KEY_HIDE_PREFERRED_NETWORK_TYPE_BOOL = "hide_preferred_network_type_bool";
482
483    /**
484     * Determine whether user can switch Wi-Fi preferred or Cellular preferred in calling preference.
485     * Some operators support Wi-Fi Calling only, not VoLTE.
486     * They don't need "Cellular preferred" option.
487     * In this case, set uneditalbe attribute for preferred preference.
488     * @hide
489     */
490    public static final String KEY_EDITABLE_WFC_MODE_BOOL = "editable_wfc_mode_bool";
491
492    /**
493     * If this is true, the SIM card (through Customer Service Profile EF file) will be able to
494     * prevent manual operator selection. If false, this SIM setting will be ignored and manual
495     * operator selection will always be available. See CPHS4_2.WW6, CPHS B.4.7.1 for more
496     * information
497     */
498    public static final String KEY_CSP_ENABLED_BOOL = "csp_enabled_bool";
499
500    /**
501     * Allow user to add APNs
502     */
503    public static final String KEY_ALLOW_ADDING_APNS_BOOL = "allow_adding_apns_bool";
504
505    /**
506     * Boolean indicating if intent for emergency call state changes should be broadcast
507     * @hide
508     */
509    public static final String KEY_BROADCAST_EMERGENCY_CALL_STATE_CHANGES_BOOL =
510            "broadcast_emergency_call_state_changes_bool";
511
512    // These variables are used by the MMS service and exposed through another API, {@link
513    // SmsManager}. The variable names and string values are copied from there.
514    public static final String KEY_MMS_ALIAS_ENABLED_BOOL = "aliasEnabled";
515    public static final String KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL = "allowAttachAudio";
516    public static final String KEY_MMS_APPEND_TRANSACTION_ID_BOOL = "enabledTransID";
517    public static final String KEY_MMS_GROUP_MMS_ENABLED_BOOL = "enableGroupMms";
518    public static final String KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL = "enableMMSDeliveryReports";
519    public static final String KEY_MMS_MMS_ENABLED_BOOL = "enabledMMS";
520    public static final String KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL = "enableMMSReadReports";
521    public static final String KEY_MMS_MULTIPART_SMS_ENABLED_BOOL = "enableMultipartSMS";
522    public static final String KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL = "enabledNotifyWapMMSC";
523    public static final String KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL = "sendMultipartSmsAsSeparateMessages";
524    public static final String KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL = "config_cellBroadcastAppLinks";
525    public static final String KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL = "enableSMSDeliveryReports";
526    public static final String KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL = "supportHttpCharsetHeader";
527    public static final String KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL = "supportMmsContentDisposition";
528    public static final String KEY_MMS_ALIAS_MAX_CHARS_INT = "aliasMaxChars";
529    public static final String KEY_MMS_ALIAS_MIN_CHARS_INT = "aliasMinChars";
530    public static final String KEY_MMS_HTTP_SOCKET_TIMEOUT_INT = "httpSocketTimeout";
531    public static final String KEY_MMS_MAX_IMAGE_HEIGHT_INT = "maxImageHeight";
532    public static final String KEY_MMS_MAX_IMAGE_WIDTH_INT = "maxImageWidth";
533    public static final String KEY_MMS_MAX_MESSAGE_SIZE_INT = "maxMessageSize";
534    public static final String KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT = "maxMessageTextSize";
535    public static final String KEY_MMS_RECIPIENT_LIMIT_INT = "recipientLimit";
536    public static final String KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT = "smsToMmsTextLengthThreshold";
537    public static final String KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT = "smsToMmsTextThreshold";
538    public static final String KEY_MMS_SUBJECT_MAX_LENGTH_INT = "maxSubjectLength";
539    public static final String KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING = "emailGatewayNumber";
540    public static final String KEY_MMS_HTTP_PARAMS_STRING = "httpParams";
541    public static final String KEY_MMS_NAI_SUFFIX_STRING = "naiSuffix";
542    public static final String KEY_MMS_UA_PROF_TAG_NAME_STRING = "uaProfTagName";
543    public static final String KEY_MMS_UA_PROF_URL_STRING = "uaProfUrl";
544    public static final String KEY_MMS_USER_AGENT_STRING = "userAgent";
545
546    /**
547     * Determines whether the carrier supports making non-emergency phone calls while the phone is
548     * in emergency callback mode.  Default value is {@code true}, meaning that non-emergency calls
549     * are allowed in emergency callback mode.
550     */
551    public static final String KEY_ALLOW_NON_EMERGENCY_CALLS_IN_ECM_BOOL =
552            "allow_non_emergency_calls_in_ecm_bool";
553
554    /**
555     * Flag indicating whether to allow carrier video calls to emergency numbers.
556     * When {@code true}, video calls to emergency numbers will be allowed.  When {@code false},
557     * video calls to emergency numbers will be initiated as audio-only calls instead.
558     */
559    @SystemApi
560    public static final String BOOL_ALLOW_EMERGENCY_VIDEO_CALLS =
561            "bool_allow_emergency_video_calls";
562
563    /**
564     * Flag indicating whether the carrier supports video pause signaling.  When {@code true}, the
565     * carrier supports use of the {@link android.telecom.VideoProfile#STATE_PAUSED} video state
566     * to pause transmission of video when the In-Call app is sent to the background.
567     * When {@code false}, video pause signaling is not supported.  {@code True} by default unless
568     * a carrier configuration overrides the default.
569     */
570    @SystemApi
571    public static final String BOOL_ALLOW_VIDEO_PAUSE =
572            "bool_allow_video_pause";
573
574
575    /**
576     * Flag indicating whether the carrier supports RCS presence indication for video calls.  When
577     * {@code true}, the carrier supports RCS presence indication for video calls.  When presence
578     * is supported, the device should use the
579     * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE} bit mask and set the
580     * {@link android.provider.ContactsContract.Data#CARRIER_PRESENCE_VT_CAPABLE} bit to indicate
581     * whether each contact supports video calling.  The UI is made aware that presence is enabled
582     * via {@link android.telecom.PhoneAccount#CAPABILITY_VIDEO_CALLING_RELIES_ON_PRESENCE}
583     * and can choose to hide or show the video calling icon based on whether a contact supports
584     * video.
585     */
586    @SystemApi
587    public static final String KEY_USE_RCS_PRESENCE_BOOL = "use_rcs_presence_bool";
588
589    /** The default value for every variable. */
590    private final static PersistableBundle sDefaults;
591
592    static {
593        sDefaults = new PersistableBundle();
594        sDefaults.putBoolean(KEY_ADDITIONAL_CALL_SETTING_BOOL, true);
595        sDefaults.putBoolean(KEY_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG_BOOL, false);
596        sDefaults.putBoolean(KEY_ALLOW_LOCAL_DTMF_TONES_BOOL, true);
597        sDefaults.putBoolean(KEY_APN_EXPAND_BOOL, true);
598        sDefaults.putBoolean(KEY_AUTO_RETRY_ENABLED_BOOL, false);
599        sDefaults.putBoolean(KEY_CARRIER_SETTINGS_ENABLE_BOOL, false);
600        sDefaults.putBoolean(KEY_CARRIER_VOLTE_AVAILABLE_BOOL, false);
601        sDefaults.putBoolean(KEY_CARRIER_VT_AVAILABLE_BOOL, false);
602        sDefaults.putBoolean(KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL, false);
603        sDefaults.putBoolean(KEY_CARRIER_FORCE_DISABLE_ETWS_CMAS_TEST_BOOL, false);
604        sDefaults.putBoolean(KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL, false);
605        sDefaults.putBoolean(KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL, true);
606        sDefaults.putBoolean(KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL, true);
607        sDefaults.putBoolean(KEY_CARRIER_IMS_GBA_REQUIRED_BOOL, false);
608        sDefaults.putBoolean(KEY_CARRIER_INSTANT_LETTERING_AVAILABLE_BOOL, false);
609        sDefaults.putBoolean(KEY_CARRIER_USE_IMS_FIRST_FOR_EMERGENCY_BOOL, true);
610        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_INVALID_CHARS_STRING, "");
611        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_ESCAPED_CHARS_STRING, "");
612        sDefaults.putString(KEY_CARRIER_INSTANT_LETTERING_ENCODING_STRING, "");
613        sDefaults.putInt(KEY_CARRIER_INSTANT_LETTERING_LENGTH_LIMIT_INT, 64);
614        sDefaults.putBoolean(KEY_DISABLE_CDMA_ACTIVATION_CODE_BOOL, false);
615        sDefaults.putBoolean(KEY_DTMF_TYPE_ENABLED_BOOL, false);
616        sDefaults.putBoolean(KEY_ENABLE_DIALER_KEY_VIBRATION_BOOL, true);
617        sDefaults.putBoolean(KEY_HAS_IN_CALL_NOISE_SUPPRESSION_BOOL, false);
618        sDefaults.putBoolean(KEY_HIDE_CARRIER_NETWORK_SETTINGS_BOOL, false);
619        sDefaults.putBoolean(KEY_HIDE_SIM_LOCK_SETTINGS_BOOL, false);
620        sDefaults.putBoolean(KEY_IGNORE_SIM_NETWORK_LOCKED_EVENTS_BOOL, false);
621        sDefaults.putBoolean(KEY_OPERATOR_SELECTION_EXPAND_BOOL, true);
622        sDefaults.putBoolean(KEY_PREFER_2G_BOOL, true);
623        sDefaults.putBoolean(KEY_SHOW_APN_SETTING_CDMA_BOOL, false);
624        sDefaults.putBoolean(KEY_SHOW_CDMA_CHOICES_BOOL, false);
625        sDefaults.putBoolean(KEY_SHOW_ONSCREEN_DIAL_BUTTON_BOOL, true);
626        sDefaults.putBoolean(KEY_SIM_NETWORK_UNLOCK_ALLOW_DISMISS_BOOL, true);
627        sDefaults.putBoolean(KEY_SUPPORT_PAUSE_IMS_VIDEO_CALLS_BOOL, true);
628        sDefaults.putBoolean(KEY_SUPPORT_SWAP_AFTER_MERGE_BOOL, true);
629        sDefaults.putBoolean(KEY_USE_HFA_FOR_PROVISIONING_BOOL, false);
630        sDefaults.putBoolean(KEY_USE_OTASP_FOR_PROVISIONING_BOOL, false);
631        sDefaults.putBoolean(KEY_VOICEMAIL_NOTIFICATION_PERSISTENT_BOOL, false);
632        sDefaults.putBoolean(KEY_VOICE_PRIVACY_DISABLE_UI_BOOL, false);
633        sDefaults.putBoolean(KEY_WORLD_PHONE_BOOL, false);
634        sDefaults.putBoolean(KEY_REQUIRE_ENTITLEMENT_CHECKS_BOOL, true);
635        sDefaults.putInt(KEY_VOLTE_REPLACEMENT_RAT_INT, 0);
636        sDefaults.putString(KEY_DEFAULT_SIM_CALL_MANAGER_STRING, "");
637        sDefaults.putString(KEY_VVM_DESTINATION_NUMBER_STRING, "");
638        sDefaults.putInt(KEY_VVM_PORT_NUMBER_INT, 0);
639        sDefaults.putString(KEY_VVM_TYPE_STRING, "");
640        sDefaults.putBoolean(KEY_VVM_CELLULAR_DATA_REQUIRED_BOOLEAN,false);
641        sDefaults.putString(KEY_CARRIER_VVM_PACKAGE_NAME_STRING, "");
642        sDefaults.putBoolean(KEY_CI_ACTION_ON_SYS_UPDATE_BOOL, false);
643        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_INTENT_STRING, "");
644        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_STRING, "");
645        sDefaults.putString(KEY_CI_ACTION_ON_SYS_UPDATE_EXTRA_VAL_STRING, "");
646        sDefaults.putBoolean(KEY_CSP_ENABLED_BOOL, false);
647        sDefaults.putBoolean(KEY_ALLOW_ADDING_APNS_BOOL, true);
648        sDefaults.putBoolean(KEY_BROADCAST_EMERGENCY_CALL_STATE_CHANGES_BOOL, false);
649        sDefaults.putBoolean(KEY_ALWAYS_SHOW_EMERGENCY_ALERT_ONOFF_BOOL, false);
650        sDefaults.putString(KEY_CARRIER_DATA_CALL_RETRY_CONFIG_DEFAULT_STRING,
651                "default_randomization=2000,5000,10000,20000,40000,80000:5000,160000:5000,"
652                        + "320000:5000,640000:5000,1280000:5000,1800000:5000");
653        sDefaults.putString(KEY_CARRIER_DATA_CALL_RETRY_CONFIG_OTHERS_STRING,
654                "max_retries=3, 5000, 5000, 5000");
655        sDefaults.putLong(KEY_CARRIER_DATA_CALL_APN_DELAY_DEFAULT_LONG, 20000);
656        sDefaults.putLong(KEY_CARRIER_DATA_CALL_APN_DELAY_FASTER_LONG, 3000);
657
658        sDefaults.putStringArray(KEY_GSM_ROAMING_NETWORKS_STRING_ARRAY, null);
659        sDefaults.putStringArray(KEY_GSM_NONROAMING_NETWORKS_STRING_ARRAY, null);
660        sDefaults.putStringArray(KEY_CDMA_ROAMING_NETWORKS_STRING_ARRAY, null);
661        sDefaults.putStringArray(KEY_CDMA_NONROAMING_NETWORKS_STRING_ARRAY, null);
662        sDefaults.putBoolean(KEY_FORCE_HOME_NETWORK_BOOL, false);
663        sDefaults.putInt(KEY_GSM_DTMF_TONE_DELAY_INT, 0);
664        sDefaults.putInt(KEY_IMS_DTMF_TONE_DELAY_INT, 0);
665        sDefaults.putInt(KEY_CDMA_DTMF_TONE_DELAY_INT, 100);
666        sDefaults.putBoolean(KEY_SUPPORT_CONFERENCE_CALL_BOOL, true);
667        sDefaults.putBoolean(KEY_EDITABLE_ENHANCED_4G_LTE_BOOL, true);
668        sDefaults.putBoolean(KEY_HIDE_IMS_APN_BOOL, false);
669        sDefaults.putBoolean(KEY_HIDE_PREFERRED_NETWORK_TYPE_BOOL, false);
670        sDefaults.putBoolean(BOOL_ALLOW_EMERGENCY_VIDEO_CALLS, false);
671        sDefaults.putBoolean(BOOL_ALLOW_VIDEO_PAUSE, true);
672        sDefaults.putBoolean(KEY_EDITABLE_WFC_MODE_BOOL, true);
673
674        // MMS defaults
675        sDefaults.putBoolean(KEY_MMS_ALIAS_ENABLED_BOOL, false);
676        sDefaults.putBoolean(KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL, true);
677        sDefaults.putBoolean(KEY_MMS_APPEND_TRANSACTION_ID_BOOL, false);
678        sDefaults.putBoolean(KEY_MMS_GROUP_MMS_ENABLED_BOOL, true);
679        sDefaults.putBoolean(KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL, false);
680        sDefaults.putBoolean(KEY_MMS_MMS_ENABLED_BOOL, true);
681        sDefaults.putBoolean(KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL, false);
682        sDefaults.putBoolean(KEY_MMS_MULTIPART_SMS_ENABLED_BOOL, true);
683        sDefaults.putBoolean(KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL, false);
684        sDefaults.putBoolean(KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL, false);
685        sDefaults.putBoolean(KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL, true);
686        sDefaults.putBoolean(KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL, true);
687        sDefaults.putBoolean(KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL, false);
688        sDefaults.putBoolean(KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL, true);
689        sDefaults.putInt(KEY_MMS_ALIAS_MAX_CHARS_INT, 48);
690        sDefaults.putInt(KEY_MMS_ALIAS_MIN_CHARS_INT, 2);
691        sDefaults.putInt(KEY_MMS_HTTP_SOCKET_TIMEOUT_INT, 60 * 1000);
692        sDefaults.putInt(KEY_MMS_MAX_IMAGE_HEIGHT_INT, 480);
693        sDefaults.putInt(KEY_MMS_MAX_IMAGE_WIDTH_INT, 640);
694        sDefaults.putInt(KEY_MMS_MAX_MESSAGE_SIZE_INT, 300 * 1024);
695        sDefaults.putInt(KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT, -1);
696        sDefaults.putInt(KEY_MMS_RECIPIENT_LIMIT_INT, Integer.MAX_VALUE);
697        sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT, -1);
698        sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT, -1);
699        sDefaults.putInt(KEY_MMS_SUBJECT_MAX_LENGTH_INT, 40);
700        sDefaults.putString(KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING, "");
701        sDefaults.putString(KEY_MMS_HTTP_PARAMS_STRING, "");
702        sDefaults.putString(KEY_MMS_NAI_SUFFIX_STRING, "");
703        sDefaults.putString(KEY_MMS_UA_PROF_TAG_NAME_STRING, "x-wap-profile");
704        sDefaults.putString(KEY_MMS_UA_PROF_URL_STRING, "");
705        sDefaults.putString(KEY_MMS_USER_AGENT_STRING, "");
706        sDefaults.putBoolean(KEY_ALLOW_NON_EMERGENCY_CALLS_IN_ECM_BOOL, true);
707        sDefaults.putBoolean(KEY_USE_RCS_PRESENCE_BOOL, false);
708    }
709
710    /**
711     * Gets the configuration values for a particular subscription, which is associated with a
712     * specific SIM card. If an invalid subId is used, the returned config will contain default
713     * values.
714     *
715     * <p>Requires Permission:
716     * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
717     *
718     * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}.
719     * @return A {@link PersistableBundle} containing the config for the given subId, or default
720     *         values for an invalid subId.
721     */
722    @Nullable
723    public PersistableBundle getConfigForSubId(int subId) {
724        try {
725            ICarrierConfigLoader loader = getICarrierConfigLoader();
726            if (loader == null) {
727                Rlog.w(TAG, "Error getting config for subId " + subId
728                        + " ICarrierConfigLoader is null");
729                return null;
730            }
731            return loader.getConfigForSubId(subId);
732        } catch (RemoteException ex) {
733            Rlog.e(TAG, "Error getting config for subId " + subId + ": "
734                    + ex.toString());
735        }
736        return null;
737    }
738
739    /**
740     * Gets the configuration values for the default subscription.
741     *
742     * <p>Requires Permission:
743     * {@link android.Manifest.permission#READ_PHONE_STATE READ_PHONE_STATE}
744     *
745     * @see #getConfigForSubId
746     */
747    @Nullable
748    public PersistableBundle getConfig() {
749        return getConfigForSubId(SubscriptionManager.getDefaultSubscriptionId());
750    }
751
752    /**
753     * Calling this method triggers telephony services to fetch the current carrier configuration.
754     * <p>
755     * Normally this does not need to be called because the platform reloads config on its own.
756     * This should be called by a carrier service app if it wants to update config at an arbitrary
757     * moment.
758     * </p>
759     * <p>Requires that the calling app has carrier privileges.
760     * @see #hasCarrierPrivileges
761     * <p>
762     * This method returns before the reload has completed, and
763     * {@link android.service.carrier.CarrierService#onLoadConfig} will be called from an
764     * arbitrary thread.
765     * </p>
766     */
767    public void notifyConfigChangedForSubId(int subId) {
768        try {
769            ICarrierConfigLoader loader = getICarrierConfigLoader();
770            if (loader == null) {
771                Rlog.w(TAG, "Error reloading config for subId=" + subId
772                        + " ICarrierConfigLoader is null");
773                return;
774            }
775            loader.notifyConfigChangedForSubId(subId);
776        } catch (RemoteException ex) {
777            Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString());
778        }
779    }
780
781    /**
782     * Request the carrier config loader to update the cofig for phoneId.
783     * <p>
784     * Depending on simState, the config may be cleared or loaded from config app. This is only used
785     * by SubscriptionInfoUpdater.
786     * </p>
787     *
788     * @hide
789     */
790    @SystemApi
791    public void updateConfigForPhoneId(int phoneId, String simState) {
792        try {
793            ICarrierConfigLoader loader = getICarrierConfigLoader();
794            if (loader == null) {
795                Rlog.w(TAG, "Error updating config for phoneId=" + phoneId
796                        + " ICarrierConfigLoader is null");
797                return;
798            }
799            loader.updateConfigForPhoneId(phoneId, simState);
800        } catch (RemoteException ex) {
801            Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString());
802        }
803    }
804
805    /**
806     * Returns a new bundle with the default value for every supported configuration variable.
807     *
808     * @hide
809     */
810    @NonNull
811    @SystemApi
812    public static PersistableBundle getDefaultConfig() {
813        return new PersistableBundle(sDefaults);
814    }
815
816    /** @hide */
817    @Nullable
818    private ICarrierConfigLoader getICarrierConfigLoader() {
819        return ICarrierConfigLoader.Stub
820                .asInterface(ServiceManager.getService(Context.CARRIER_CONFIG_SERVICE));
821    }
822}
823