telephony/java/android/telephony/CarrierConfigManager.java

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