2 * Copyright (C) 2015 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 package android.telephony;
19 import com.android.internal.telephony.ICarrierConfigLoader;
21 import android.annotation.NonNull;
22 import android.annotation.Nullable;
23 import android.annotation.SystemApi;
24 import android.content.Context;
25 import android.os.PersistableBundle;
26 import android.os.RemoteException;
27 import android.os.ServiceManager;
30 * Provides access to telephony configuration values that are carrier-specific.
32 * Users should obtain an instance of this class by calling
33 * {@code mContext.getSystemService(Context.CARRIER_CONFIG_SERVICE);}
36 * @see Context#getSystemService
37 * @see Context#CARRIER_CONFIG_SERVICE
39 public class CarrierConfigManager {
40 private final static String TAG = "CarrierConfigManager";
45 public CarrierConfigManager() {
49 * This intent is broadcast by the system when carrier config changes.
51 public static final String
52 ACTION_CARRIER_CONFIG_CHANGED = "android.telephony.action.CARRIER_CONFIG_CHANGED";
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.
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.
64 public static final String
65 KEY_IGNORE_SIM_NETWORK_LOCKED_EVENTS_BOOL = "ignore_sim_network_locked_events_bool";
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.)
74 public static final String
75 KEY_SIM_NETWORK_UNLOCK_ALLOW_DISMISS_BOOL = "sim_network_unlock_allow_dismiss_bool";
77 /** Flag indicating if the phone is a world phone */
78 public static final String KEY_WORLD_PHONE_BOOL = "world_phone_bool";
81 * If true, enable vibration (haptic feedback) for key presses in the EmergencyDialer activity.
82 * The pattern is set on a per-platform basis using config_virtualKeyVibePattern. To be
83 * consistent with the regular Dialer, this value should agree with the corresponding values
84 * from config.xml under apps/Contacts.
86 public static final String
87 KEY_ENABLE_DIALER_KEY_VIBRATION_BOOL = "key_enable_dialer_vibration_bool";
89 /** Flag indicating if dtmf tone type is enabled */
90 public static final String KEY_DTMF_TYPE_ENABLED_BOOL = "dtmf_type_enabled_bool";
92 /** Flag indicating if auto retry is enabled */
93 public static final String KEY_AUTO_RETRY_ENABLED_BOOL = "auto_retry_enabled_bool";
96 * Determine whether we want to play local DTMF tones in a call, or just let the radio/BP handle
97 * playing of the tones.
99 public static final String KEY_ALLOW_LOCAL_DTMF_TONES_BOOL = "allow_local_dtmf_tones_bool";
102 * If true, show an onscreen "Dial" button in the dialer. In practice this is used on all
103 * platforms, even the ones with hard SEND/END keys, but for maximum flexibility it's controlled
104 * by a flag here (which can be overridden on a per-product basis.)
106 public static final String KEY_SHOW_ONSCREEN_DIAL_BUTTON_BOOL = "show_onscreen_dial_button_bool";
108 /** Determines if device implements a noise suppression device for in call audio. */
109 public static final String
110 KEY_HAS_IN_CALL_NOISE_SUPPRESSION_BOOL = "has_in_call_noise_suppression_bool";
113 * Determines if the current device should allow emergency numbers to be logged in the Call Log.
114 * (Some carriers require that emergency calls *not* be logged, presumably to avoid the risk of
115 * accidental redialing from the call log UI. This is a good idea, so the default here is
118 * TODO: on the other hand, it might still be useful to have some record of the emergency calls
119 * you've made, or to be able to look up the exact date/time of an emergency call. So perhaps we
120 * <b>should</b> log those calls, but instead fix the call log to disable the "call" button for
123 public static final String
124 KEY_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG_BOOL = "allow_emergency_numbers_in_call_log_bool";
126 /** If true, removes the Voice Privacy option from Call Settings */
127 public static final String KEY_VOICE_PRIVACY_DISABLE_BOOL = "voice_privacy_disable_bool";
129 /** Control whether users can reach the carrier portions of Cellular Network Settings. */
130 public static final String
131 KEY_HIDE_CARRIER_NETWORK_SETTINGS_BOOL = "hide_carrier_network_settings_bool";
133 /** Control whether users can edit APNs in Settings. */
134 public static final String KEY_APN_EXPAND_BOOL = "apn_expand_bool";
136 /** Control whether users can choose a network operator. */
137 public static final String KEY_OPERATOR_SELECTION_EXPAND_BOOL = "operator_selection_expand_bool";
139 /** Used in Cellular Network Settings for preferred network type. */
140 public static final String KEY_PREFER_2G_BOOL = "prefer_2g_bool";
142 /** Show cdma network mode choices 1x, 3G, global etc. */
143 public static final String KEY_SHOW_CDMA_CHOICES_BOOL = "show_cdma_choices_bool";
145 /** CDMA activation goes through HFA */
146 public static final String KEY_USE_HFA_FOR_PROVISIONING_BOOL = "use_hfa_for_provisioning_bool";
149 * CDMA activation goes through OTASP.
151 * TODO: This should be combined with config_use_hfa_for_provisioning and implemented as an enum
152 * (NONE, HFA, OTASP).
154 public static final String KEY_USE_OTASP_FOR_PROVISIONING_BOOL = "use_otasp_for_provisioning_bool";
156 /** Display carrier settings menu if true */
157 public static final String KEY_CARRIER_SETTINGS_ENABLE_BOOL = "carrier_settings_enable_bool";
159 /** Does not display additional call seting for IMS phone based on GSM Phone */
160 public static final String KEY_ADDITIONAL_CALL_SETTING_BOOL = "additional_call_setting_bool";
162 /** Show APN Settings for some CDMA carriers */
163 public static final String KEY_SHOW_APN_SETTING_CDMA_BOOL = "show_apn_setting_cdma_bool";
165 /** After a CDMA conference call is merged, the swap button should be displayed. */
166 public static final String KEY_SUPPORT_SWAP_AFTER_MERGE_BOOL = "support_swap_after_merge_bool";
169 * Determine whether the voicemail notification is persistent in the notification bar. If true,
170 * the voicemail notifications cannot be dismissed from the notification bar.
172 public static final String
173 KEY_VOICEMAIL_NOTIFICATION_PERSISTENT_BOOL = "voicemail_notification_persistent_bool";
175 /** For IMS video over LTE calls, determines whether video pause signalling is supported. */
176 public static final String
177 KEY_SUPPORT_PAUSE_IMS_VIDEO_CALLS_BOOL = "support_pause_ims_video_calls_bool";
180 * Disables dialing "*228" (OTASP provisioning) on CDMA carriers where it is not supported or is
181 * potentially harmful by locking the SIM to 3G.
183 public static final String
184 KEY_DISABLE_CDMA_ACTIVATION_CODE_BOOL = "disable_cdma_activation_code_bool";
187 * Flag specifying whether VoLTE should be available for carrier, independent of carrier
188 * provisioning. If false: hard disabled. If true: then depends on carrier provisioning,
191 public static final String KEY_CARRIER_VOLTE_AVAILABLE_BOOL = "carrier_volte_available_bool";
193 /** Flag specifying whether VoLTE availability is based on provisioning. */
194 public static final String KEY_CARRIER_VOLTE_PROVISIONED_BOOL = "carrier_volte_provisioned_bool";
196 /** Flag specifying whether VoLTE TTY is supported. */
197 public static final String KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL
198 = "carrier_volte_tty_supported_bool";
201 * If Voice Radio Technology is RIL_RADIO_TECHNOLOGY_LTE:14 or RIL_RADIO_TECHNOLOGY_UNKNOWN:0
202 * this is the value that should be used instead. A configuration value of
203 * RIL_RADIO_TECHNOLOGY_UNKNOWN:0 means there is no replacement value and that the default
204 * assumption for phone type (GSM) should be used.
206 public static final String KEY_VOLTE_REPLACEMENT_RAT_INT = "volte_replacement_rat_int";
208 /* The following 3 fields are related to carrier visual voicemail. */
211 * The carrier number MO sms messages are sent to.
215 public static final String KEY_VVM_DESTINATION_NUMBER_STRING = "vvm_destination_number_string";
218 * The port through which the MO sms messages are sent through.
222 public static final String KEY_VVM_PORT_NUMBER_INT = "vvm_port_number_int";
225 * The type of visual voicemail protocol the carrier adheres to. See {@link TelephonyManager}
226 * for possible values. For example {@link TelephonyManager#VVM_TYPE_OMTP}.
230 public static final String KEY_VVM_TYPE_STRING = "vvm_type_string";
233 * The package name of the carrier's visual voicemail app to ensure that dialer visual voicemail
234 * and carrier visual voicemail are not active at the same time.
238 public static final String KEY_CARRIER_VVM_PACKAGE_NAME_STRING = "carrier_vvm_package_name_string";
240 // These variables are used by the MMS service and exposed through another API, {@link
241 // SmsManager}. The variable names and string values are copied from there.
242 public static final String KEY_MMS_ALIAS_ENABLED_BOOL = "aliasEnabled";
243 public static final String KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL = "allowAttachAudio";
244 public static final String KEY_MMS_APPEND_TRANSACTION_ID_BOOL = "enabledTransID";
245 public static final String KEY_MMS_GROUP_MMS_ENABLED_BOOL = "enableGroupMms";
246 public static final String KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL = "enableMMSDeliveryReports";
247 public static final String KEY_MMS_MMS_ENABLED_BOOL = "enabledMMS";
248 public static final String KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL = "enableMMSReadReports";
249 public static final String KEY_MMS_MULTIPART_SMS_ENABLED_BOOL = "enableMultipartSMS";
250 public static final String KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL = "enabledNotifyWapMMSC";
251 public static final String KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL = "sendMultipartSmsAsSeparateMessages";
252 public static final String KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL = "config_cellBroadcastAppLinks";
253 public static final String KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL = "enableSMSDeliveryReports";
254 public static final String KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL = "supportHttpCharsetHeader";
255 public static final String KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL = "supportMmsContentDisposition";
256 public static final String KEY_MMS_ALIAS_MAX_CHARS_INT = "aliasMaxChars";
257 public static final String KEY_MMS_ALIAS_MIN_CHARS_INT = "aliasMinChars";
258 public static final String KEY_MMS_HTTP_SOCKET_TIMEOUT_INT = "httpSocketTimeout";
259 public static final String KEY_MMS_MAX_IMAGE_HEIGHT_INT = "maxImageHeight";
260 public static final String KEY_MMS_MAX_IMAGE_WIDTH_INT = "maxImageWidth";
261 public static final String KEY_MMS_MAX_MESSAGE_SIZE_INT = "maxMessageSize";
262 public static final String KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT = "maxMessageTextSize";
263 public static final String KEY_MMS_RECIPIENT_LIMIT_INT = "recipientLimit";
264 public static final String KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT = "smsToMmsTextLengthThreshold";
265 public static final String KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT = "smsToMmsTextThreshold";
266 public static final String KEY_MMS_SUBJECT_MAX_LENGTH_INT = "maxSubjectLength";
267 public static final String KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING = "emailGatewayNumber";
268 public static final String KEY_MMS_HTTP_PARAMS_STRING = "httpParams";
269 public static final String KEY_MMS_NAI_SUFFIX_STRING = "naiSuffix";
270 public static final String KEY_MMS_UA_PROF_TAG_NAME_STRING = "uaProfTagName";
271 public static final String KEY_MMS_UA_PROF_URL_STRING = "uaProfUrl";
272 public static final String KEY_MMS_USER_AGENT_STRING = "userAgent";
275 * Flag indicating whether to allow carrier video calls to emergency numbers.
276 * When {@code true}, video calls to emergency numbers will be allowed. When {@code false},
277 * video calls to emergency numbers will be initiated as audio-only calls instead.
282 public static final String BOOL_ALLOW_EMERGENCY_VIDEO_CALLS =
283 "bool_allow_emergency_video_calls";
286 * Flag indicating whether the carrier supports video pause signaling. When {@code true}, the
287 * carrier supports use of the {@link android.telecom.VideoProfile#STATE_PAUSED} video state
288 * to pause transmission of video when the In-Call app is sent to the background.
289 * When {@code false}, video pause signaling is not supported. {@code True} by default unless
290 * a carrier configuration overrides the default.
295 public static final String BOOL_ALLOW_VIDEO_PAUSE =
296 "bool_allow_video_pause";
298 /** The default value for every variable. */
299 private final static PersistableBundle sDefaults;
302 sDefaults = new PersistableBundle();
303 sDefaults.putBoolean(KEY_ADDITIONAL_CALL_SETTING_BOOL, true);
304 sDefaults.putBoolean(KEY_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG_BOOL, false);
305 sDefaults.putBoolean(KEY_ALLOW_LOCAL_DTMF_TONES_BOOL, true);
306 sDefaults.putBoolean(KEY_APN_EXPAND_BOOL, true);
307 sDefaults.putBoolean(KEY_AUTO_RETRY_ENABLED_BOOL, false);
308 sDefaults.putBoolean(KEY_CARRIER_SETTINGS_ENABLE_BOOL, false);
309 sDefaults.putBoolean(KEY_CARRIER_VOLTE_AVAILABLE_BOOL, false);
310 sDefaults.putBoolean(KEY_CARRIER_VOLTE_PROVISIONED_BOOL, false);
311 sDefaults.putBoolean(KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL, true);
312 sDefaults.putBoolean(KEY_DISABLE_CDMA_ACTIVATION_CODE_BOOL, false);
313 sDefaults.putBoolean(KEY_DTMF_TYPE_ENABLED_BOOL, false);
314 sDefaults.putBoolean(KEY_ENABLE_DIALER_KEY_VIBRATION_BOOL, true);
315 sDefaults.putBoolean(KEY_HAS_IN_CALL_NOISE_SUPPRESSION_BOOL, false);
316 sDefaults.putBoolean(KEY_HIDE_CARRIER_NETWORK_SETTINGS_BOOL, false);
317 sDefaults.putBoolean(KEY_IGNORE_SIM_NETWORK_LOCKED_EVENTS_BOOL, false);
318 sDefaults.putBoolean(KEY_OPERATOR_SELECTION_EXPAND_BOOL, true);
319 sDefaults.putBoolean(KEY_PREFER_2G_BOOL, true);
320 sDefaults.putBoolean(KEY_SHOW_APN_SETTING_CDMA_BOOL, false);
321 sDefaults.putBoolean(KEY_SHOW_CDMA_CHOICES_BOOL, false);
322 sDefaults.putBoolean(KEY_SHOW_ONSCREEN_DIAL_BUTTON_BOOL, true);
323 sDefaults.putBoolean(KEY_SIM_NETWORK_UNLOCK_ALLOW_DISMISS_BOOL, true);
324 sDefaults.putBoolean(KEY_SUPPORT_PAUSE_IMS_VIDEO_CALLS_BOOL, true);
325 sDefaults.putBoolean(KEY_SUPPORT_SWAP_AFTER_MERGE_BOOL, true);
326 sDefaults.putBoolean(KEY_USE_HFA_FOR_PROVISIONING_BOOL, false);
327 sDefaults.putBoolean(KEY_USE_OTASP_FOR_PROVISIONING_BOOL, false);
328 sDefaults.putBoolean(KEY_VOICEMAIL_NOTIFICATION_PERSISTENT_BOOL, false);
329 sDefaults.putBoolean(KEY_VOICE_PRIVACY_DISABLE_BOOL, false);
330 sDefaults.putBoolean(KEY_WORLD_PHONE_BOOL, false);
331 sDefaults.putInt(KEY_VOLTE_REPLACEMENT_RAT_INT, 0);
332 sDefaults.putString(KEY_VVM_DESTINATION_NUMBER_STRING, "");
333 sDefaults.putInt(KEY_VVM_PORT_NUMBER_INT, 0);
334 sDefaults.putString(KEY_VVM_TYPE_STRING, "");
335 sDefaults.putString(KEY_CARRIER_VVM_PACKAGE_NAME_STRING, "");
336 sDefaults.putBoolean(BOOL_ALLOW_EMERGENCY_VIDEO_CALLS, false);
337 sDefaults.putBoolean(BOOL_ALLOW_VIDEO_PAUSE, true);
340 sDefaults.putBoolean(KEY_MMS_ALIAS_ENABLED_BOOL, false);
341 sDefaults.putBoolean(KEY_MMS_ALLOW_ATTACH_AUDIO_BOOL, true);
342 sDefaults.putBoolean(KEY_MMS_APPEND_TRANSACTION_ID_BOOL, false);
343 sDefaults.putBoolean(KEY_MMS_GROUP_MMS_ENABLED_BOOL, true);
344 sDefaults.putBoolean(KEY_MMS_MMS_DELIVERY_REPORT_ENABLED_BOOL, false);
345 sDefaults.putBoolean(KEY_MMS_MMS_ENABLED_BOOL, true);
346 sDefaults.putBoolean(KEY_MMS_MMS_READ_REPORT_ENABLED_BOOL, false);
347 sDefaults.putBoolean(KEY_MMS_MULTIPART_SMS_ENABLED_BOOL, true);
348 sDefaults.putBoolean(KEY_MMS_NOTIFY_WAP_MMSC_ENABLED_BOOL, false);
349 sDefaults.putBoolean(KEY_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES_BOOL, false);
350 sDefaults.putBoolean(KEY_MMS_SHOW_CELL_BROADCAST_APP_LINKS_BOOL, true);
351 sDefaults.putBoolean(KEY_MMS_SMS_DELIVERY_REPORT_ENABLED_BOOL, true);
352 sDefaults.putBoolean(KEY_MMS_SUPPORT_HTTP_CHARSET_HEADER_BOOL, false);
353 sDefaults.putBoolean(KEY_MMS_SUPPORT_MMS_CONTENT_DISPOSITION_BOOL, true);
354 sDefaults.putInt(KEY_MMS_ALIAS_MAX_CHARS_INT, 48);
355 sDefaults.putInt(KEY_MMS_ALIAS_MIN_CHARS_INT, 2);
356 sDefaults.putInt(KEY_MMS_HTTP_SOCKET_TIMEOUT_INT, 60 * 1000);
357 sDefaults.putInt(KEY_MMS_MAX_IMAGE_HEIGHT_INT, 480);
358 sDefaults.putInt(KEY_MMS_MAX_IMAGE_WIDTH_INT, 640);
359 sDefaults.putInt(KEY_MMS_MAX_MESSAGE_SIZE_INT, 300 * 1024);
360 sDefaults.putInt(KEY_MMS_MESSAGE_TEXT_MAX_SIZE_INT, -1);
361 sDefaults.putInt(KEY_MMS_RECIPIENT_LIMIT_INT, Integer.MAX_VALUE);
362 sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD_INT, -1);
363 sDefaults.putInt(KEY_MMS_SMS_TO_MMS_TEXT_THRESHOLD_INT, -1);
364 sDefaults.putInt(KEY_MMS_SUBJECT_MAX_LENGTH_INT, 40);
365 sDefaults.putString(KEY_MMS_EMAIL_GATEWAY_NUMBER_STRING, "");
366 sDefaults.putString(KEY_MMS_HTTP_PARAMS_STRING, "");
367 sDefaults.putString(KEY_MMS_NAI_SUFFIX_STRING, "");
368 sDefaults.putString(KEY_MMS_UA_PROF_TAG_NAME_STRING, "x-wap-profile");
369 sDefaults.putString(KEY_MMS_UA_PROF_URL_STRING, "");
370 sDefaults.putString(KEY_MMS_USER_AGENT_STRING, "");
374 * Gets the configuration values for a particular subscription, which is associated with a
375 * specific SIM card. If an invalid subId is used, the returned config will contain default
378 * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}.
379 * @return A {@link PersistableBundle} containing the config for the given subId, or default
380 * values for an invalid subId.
383 public PersistableBundle getConfigForSubId(int subId) {
385 return getICarrierConfigLoader().getConfigForSubId(subId);
386 } catch (RemoteException ex) {
387 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": "
389 } catch (NullPointerException ex) {
390 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": "
397 * Gets the configuration values for the default subscription.
399 * @see #getConfigForSubId
402 public PersistableBundle getConfig() {
403 return getConfigForSubId(SubscriptionManager.getDefaultSubId());
407 * Calling this method triggers telephony services to fetch the current carrier configuration.
409 * Normally this does not need to be called because the platform reloads config on its own.
410 * This should be called by a carrier service app if it wants to update config at an arbitrary
414 * This method returns before the reload has completed, and
415 * {@link android.service.carrier.CarrierService#onLoadConfig} will be called from an
419 public void notifyConfigChangedForSubId(int subId) {
421 getICarrierConfigLoader().notifyConfigChangedForSubId(subId);
422 } catch (RemoteException ex) {
423 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString());
424 } catch (NullPointerException ex) {
425 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString());
430 * Request the carrier config loader to update the cofig for phoneId.
432 * Depending on simState, the config may be cleared or loaded from config app. This is only used
433 * by SubscriptionInfoUpdater.
439 public void updateConfigForPhoneId(int phoneId, String simState) {
441 getICarrierConfigLoader().updateConfigForPhoneId(phoneId, simState);
442 } catch (RemoteException ex) {
443 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString());
444 } catch (NullPointerException ex) {
445 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString());
450 * Returns a new bundle with the default value for every supported configuration variable.
456 public static PersistableBundle getDefaultConfig() {
457 return new PersistableBundle(sDefaults);
461 private ICarrierConfigLoader getICarrierConfigLoader() {
462 return ICarrierConfigLoader.Stub
463 .asInterface(ServiceManager.getService(Context.CARRIER_CONFIG_SERVICE));