CarrierConfigManager.java revision 08e318e5868b4f21a95fd1b5e8b9659e2d830257
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 /** 41 * @hide 42 */ 43 public CarrierConfigManager() { 44 } 45 46 /** 47 * This intent is broadcast by the system when carrier config changes. 48 */ 49 public static final String 50 ACTION_CARRIER_CONFIG_CHANGED = "android.telephony.action.CARRIER_CONFIG_CHANGED"; 51 52 // Below are the keys used in carrier config bundles. To add a new variable, define the key and 53 // give it a default value in sDefaults. If you need to ship a per-network override in the 54 // system image, that can be added in packages/apps/CarrierConfig. 55 56 /** 57 * Flag indicating whether the Phone app should ignore EVENT_SIM_NETWORK_LOCKED 58 * events from the Sim. 59 * If true, this will prevent the IccNetworkDepersonalizationPanel from being shown, and 60 * effectively disable the "Sim network lock" feature. 61 */ 62 public static final String 63 BOOL_IGNORE_SIM_NETWORK_LOCKED_EVENTS = "bool_ignore_sim_network_locked_events"; 64 65 /** 66 * Flag indicating whether the Phone app should provide a "Dismiss" button on the SIM network 67 * unlock screen. The default value is true. If set to false, there will be *no way* to dismiss 68 * the SIM network unlock screen if you don't enter the correct unlock code. (One important 69 * consequence: there will be no way to make an Emergency Call if your SIM is network-locked and 70 * you don't know the PIN.) 71 */ 72 public static final String 73 BOOL_SIM_NETWORK_UNLOCK_ALLOW_DISMISS = "bool_sim_network_unlock_allow_dismiss"; 74 75 /** Flag indicating if the phone is a world phone */ 76 public static final String BOOL_WORLD_PHONE = "bool_world_phone"; 77 78 /** 79 * If true, enable vibration (haptic feedback) for key presses in the EmergencyDialer activity. 80 * The pattern is set on a per-platform basis using config_virtualKeyVibePattern. To be 81 * consistent with the regular Dialer, this value should agree with the corresponding values 82 * from config.xml under apps/Contacts. 83 */ 84 public static final String 85 BOOL_ENABLE_DIALER_KEY_VIBRATION = "bool_enable_dialer_key_vibration"; 86 87 /** Flag indicating if dtmf tone type is enabled */ 88 public static final String BOOL_DTMF_TYPE_ENABLED = "bool_dtmf_type_enabled"; 89 90 /** Flag indicating if auto retry is enabled */ 91 public static final String BOOL_AUTO_RETRY_ENABLED = "bool_auto_retry_enabled"; 92 93 /** 94 * Determine whether we want to play local DTMF tones in a call, or just let the radio/BP handle 95 * playing of the tones. 96 */ 97 public static final String BOOL_ALLOW_LOCAL_DTMF_TONES = "bool_allow_local_dtmf_tones"; 98 99 /** 100 * If true, show an onscreen "Dial" button in the dialer. In practice this is used on all 101 * platforms, even the ones with hard SEND/END keys, but for maximum flexibility it's controlled 102 * by a flag here (which can be overridden on a per-product basis.) 103 */ 104 public static final String BOOL_SHOW_ONSCREEN_DIAL_BUTTON = "bool_show_onscreen_dial_button"; 105 106 /** Determines if device implements a noise suppression device for in call audio. */ 107 public static final String 108 BOOL_HAS_IN_CALL_NOISE_SUPPRESSION = "bool_has_in_call_noise_suppression"; 109 110 /** 111 * Determines if the current device should allow emergency numbers to be logged in the Call Log. 112 * (Some carriers require that emergency calls *not* be logged, presumably to avoid the risk of 113 * accidental redialing from the call log UI. This is a good idea, so the default here is 114 * false.) 115 * <p> 116 * TODO: on the other hand, it might still be useful to have some record of the emergency calls 117 * you've made, or to be able to look up the exact date/time of an emergency call. So perhaps we 118 * <b>should</b> log those calls, but instead fix the call log to disable the "call" button for 119 * emergency numbers. 120 */ 121 public static final String 122 BOOL_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG = "bool_allow_emergency_numbers_in_call_log"; 123 124 /** If true, removes the Voice Privacy option from Call Settings */ 125 public static final String BOOL_VOICE_PRIVACY_DISABLE = "bool_voice_privacy_disable"; 126 127 /** Control whether users can reach the carrier portions of Cellular Network Settings. */ 128 public static final String 129 BOOL_HIDE_CARRIER_NETWORK_SETTINGS = "bool_hide_carrier_network_settings"; 130 131 /** Control whether users can edit APNs in Settings. */ 132 public static final String BOOL_APN_EXPAND = "bool_apn_expand"; 133 134 /** Control whether users can choose a network operator. */ 135 public static final String BOOL_OPERATOR_SELECTION_EXPAND = "bool_operator_selection_expand"; 136 137 /** Used in Cellular Network Settings for preferred network type. */ 138 public static final String BOOL_PREFER_2G = "bool_prefer_2g"; 139 140 /** Show cdma network mode choices 1x, 3G, global etc. */ 141 public static final String BOOL_SHOW_CDMA_CHOICES = "bool_show_cdma_choices"; 142 143 /** CDMA activation goes through HFA */ 144 public static final String BOOL_USE_HFA_FOR_PROVISIONING = "bool_use_hfa_for_provisioning"; 145 146 /** 147 * CDMA activation goes through OTASP. 148 * <p> 149 * TODO: This should be combined with config_use_hfa_for_provisioning and implemented as an enum 150 * (NONE, HFA, OTASP). 151 */ 152 public static final String BOOL_USE_OTASP_FOR_PROVISIONING = "bool_use_otasp_for_provisioning"; 153 154 /** Display carrier settings menu if true */ 155 public static final String BOOL_CARRIER_SETTINGS_ENABLE = "bool_carrier_settings_enable"; 156 157 /** Does not display additional call seting for IMS phone based on GSM Phone */ 158 public static final String BOOL_ADDITIONAL_CALL_SETTING = "bool_additional_call_setting"; 159 160 /** Show APN Settings for some CDMA carriers */ 161 public static final String BOOL_SHOW_APN_SETTING_CDMA = "bool_show_apn_setting_cdma"; 162 163 /** After a CDMA conference call is merged, the swap button should be displayed. */ 164 public static final String BOOL_SUPPORT_SWAP_AFTER_MERGE = "bool_support_swap_after_merge"; 165 166 /** 167 * Determine whether the voicemail notification is persistent in the notification bar. If true, 168 * the voicemail notifications cannot be dismissed from the notification bar. 169 */ 170 public static final String 171 BOOL_VOICEMAIL_NOTIFICATION_PERSISTENT = "bool_voicemail_notification_persistent"; 172 173 /** For IMS video over LTE calls, determines whether video pause signalling is supported. */ 174 public static final String 175 BOOL_SUPPORT_PAUSE_IMS_VIDEO_CALLS = "bool_support_pause_ims_video_calls"; 176 177 /** 178 * Disables dialing "*228" (OTASP provisioning) on CDMA carriers where it is not supported or is 179 * potentially harmful by locking the SIM to 3G. 180 */ 181 public static final String 182 BOOL_DISABLE_CDMA_ACTIVATION_CODE = "bool_disable_cdma_activation_code"; 183 184 /** 185 * Flag specifying whether VoLTE should be available for carrier, independent of carrier 186 * provisioning. If false: hard disabled. If true: then depends on carrier provisioning, 187 * availability, etc. 188 */ 189 public static final String BOOL_CARRIER_VOLTE_AVAILABLE = "bool_carrier_volte_available"; 190 191 /** Flag specifying whether VoLTE availability is based on provisioning. */ 192 public static final String BOOL_CARRIER_VOLTE_PROVISIONED = "bool_carrier_volte_provisioned"; 193 194 /** Flag specifying whether VoLTE TTY is supported. */ 195 public static final String BOOL_CARRIER_VOLTE_TTY_SUPPORTED 196 = "bool_carrier_volte_tty_supported"; 197 198 /** 199 * If Voice Radio Technology is RIL_RADIO_TECHNOLOGY_LTE:14 or RIL_RADIO_TECHNOLOGY_UNKNOWN:0 200 * this is the value that should be used instead. A configuration value of 201 * RIL_RADIO_TECHNOLOGY_UNKNOWN:0 means there is no replacement value and that the default 202 * assumption for phone type (GSM) should be used. 203 */ 204 public static final String INT_VOLTE_REPLACEMENT_RAT = "int_volte_replacement_rat"; 205 206 /* The following 3 fields are related to carrier visual voicemail. */ 207 208 /** 209 * The carrier number MO sms messages are sent to. 210 * 211 * @hide 212 */ 213 public static final String STRING_VVM_DESTINATION_NUMBER = "string_vvm_destination_number"; 214 215 /** 216 * The port through which the MO sms messages are sent through. 217 * 218 * @hide 219 */ 220 public static final String INT_VVM_PORT_NUMBER = "int_vvm_port_number"; 221 222 /** 223 * The type of visual voicemail protocol the carrier adheres to (see below). 224 * 225 * @hide 226 */ 227 public static final String STRING_VVM_TYPE = "string_vvm_type"; 228 229 private final static String TAG = "CarrierConfigManager"; 230 231 /** The default value for every variable. */ 232 private final static PersistableBundle sDefaults; 233 234 static { 235 sDefaults = new PersistableBundle(); 236 sDefaults.putBoolean(BOOL_ADDITIONAL_CALL_SETTING, true); 237 sDefaults.putBoolean(BOOL_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG, false); 238 sDefaults.putBoolean(BOOL_ALLOW_LOCAL_DTMF_TONES, true); 239 sDefaults.putBoolean(BOOL_APN_EXPAND, true); 240 sDefaults.putBoolean(BOOL_AUTO_RETRY_ENABLED, false); 241 sDefaults.putBoolean(BOOL_CARRIER_SETTINGS_ENABLE, false); 242 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_AVAILABLE, false); 243 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_PROVISIONED, false); 244 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_TTY_SUPPORTED, true); 245 sDefaults.putBoolean(BOOL_DISABLE_CDMA_ACTIVATION_CODE, false); 246 sDefaults.putBoolean(BOOL_DTMF_TYPE_ENABLED, false); 247 sDefaults.putBoolean(BOOL_ENABLE_DIALER_KEY_VIBRATION, true); 248 sDefaults.putBoolean(BOOL_HAS_IN_CALL_NOISE_SUPPRESSION, false); 249 sDefaults.putBoolean(BOOL_HIDE_CARRIER_NETWORK_SETTINGS, false); 250 sDefaults.putBoolean(BOOL_IGNORE_SIM_NETWORK_LOCKED_EVENTS, false); 251 sDefaults.putBoolean(BOOL_OPERATOR_SELECTION_EXPAND, true); 252 sDefaults.putBoolean(BOOL_PREFER_2G, true); 253 sDefaults.putBoolean(BOOL_SHOW_APN_SETTING_CDMA, false); 254 sDefaults.putBoolean(BOOL_SHOW_CDMA_CHOICES, false); 255 sDefaults.putBoolean(BOOL_SHOW_ONSCREEN_DIAL_BUTTON, true); 256 sDefaults.putBoolean(BOOL_SIM_NETWORK_UNLOCK_ALLOW_DISMISS, true); 257 sDefaults.putBoolean(BOOL_SUPPORT_PAUSE_IMS_VIDEO_CALLS, true); 258 sDefaults.putBoolean(BOOL_SUPPORT_SWAP_AFTER_MERGE, true); 259 sDefaults.putBoolean(BOOL_USE_HFA_FOR_PROVISIONING, false); 260 sDefaults.putBoolean(BOOL_USE_OTASP_FOR_PROVISIONING, false); 261 sDefaults.putBoolean(BOOL_VOICEMAIL_NOTIFICATION_PERSISTENT, false); 262 sDefaults.putBoolean(BOOL_VOICE_PRIVACY_DISABLE, false); 263 sDefaults.putBoolean(BOOL_WORLD_PHONE, false); 264 sDefaults.putInt(INT_VOLTE_REPLACEMENT_RAT, 0); 265 sDefaults.putInt(INT_VVM_PORT_NUMBER, 0); 266 sDefaults.putString(STRING_VVM_DESTINATION_NUMBER, ""); 267 sDefaults.putString(STRING_VVM_TYPE, ""); 268 } 269 270 /** 271 * Gets the configuration values for a particular subscription, which is associated with a 272 * specific SIM card. If an invalid subId is used, the returned config will contain default 273 * values. 274 * 275 * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}. 276 * @return A {@link PersistableBundle} containing the config for the given subId, or default 277 * values for an invalid subId. 278 */ 279 @Nullable 280 public PersistableBundle getConfigForSubId(int subId) { 281 try { 282 return getICarrierConfigLoader().getConfigForSubId(subId); 283 } catch (RemoteException ex) { 284 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": " 285 + ex.toString()); 286 } catch (NullPointerException ex) { 287 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": " 288 + ex.toString()); 289 } 290 return null; 291 } 292 293 /** 294 * Gets the configuration values for the default subscription. 295 * 296 * @see #getConfigForSubId 297 */ 298 @Nullable 299 public PersistableBundle getConfig() { 300 return getConfigForSubId(SubscriptionManager.getDefaultSubId()); 301 } 302 303 /** 304 * Calling this method triggers telephony services to fetch the current carrier configuration. 305 * <p> 306 * Normally this does not need to be called because the platform reloads config on its own. Call 307 * this method if your app wants to update config at an arbitrary moment. 308 * </p> 309 * <p> 310 * This method returns before the reload has completed, and 311 * {@link android.service.carrier.CarrierConfigService#onLoadConfig} will be called from an 312 * arbitrary thread. 313 * </p> 314 */ 315 public void reloadCarrierConfigForSubId(int subId) { 316 try { 317 getICarrierConfigLoader().reloadCarrierConfigForSubId(subId); 318 } catch (RemoteException ex) { 319 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString()); 320 } catch (NullPointerException ex) { 321 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString()); 322 } 323 } 324 325 /** 326 * Request the carrier config loader to update the cofig for phoneId. 327 * <p> 328 * Depending on simState, the config may be cleared or loaded from config app. This is only used 329 * by SubscriptionInfoUpdater. 330 * </p> 331 * 332 * @hide 333 */ 334 @SystemApi 335 public void updateConfigForPhoneId(int phoneId, String simState) { 336 try { 337 getICarrierConfigLoader().updateConfigForPhoneId(phoneId, simState); 338 } catch (RemoteException ex) { 339 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString()); 340 } catch (NullPointerException ex) { 341 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString()); 342 } 343 } 344 345 /** 346 * Returns a new bundle with the default value for every supported configuration variable. 347 * 348 * @hide 349 */ 350 @NonNull 351 @SystemApi 352 public static PersistableBundle getDefaultConfig() { 353 return new PersistableBundle(sDefaults); 354 } 355 356 /** @hide */ 357 private ICarrierConfigLoader getICarrierConfigLoader() { 358 return ICarrierConfigLoader.Stub 359 .asInterface(ServiceManager.getService(Context.CARRIER_CONFIG_SERVICE)); 360 } 361} 362