Android APIs
public static final class

Settings.Global

extends Settings.NameValueTable
java.lang.Object
   ↳ android.provider.Settings.NameValueTable
     ↳ android.provider.Settings.Global

Class Overview

Global system settings, containing preferences that always apply identically to all defined users. Applications can read these but are not allowed to write; like the "Secure" settings, these are for preferences that the user must explicitly modify through the system UI or specialized APIs for those values.

Summary

Constants
String ADB_ENABLED Whether ADB is enabled.
String AIRPLANE_MODE_ON Whether Airplane Mode is on.
String AIRPLANE_MODE_RADIOS A comma separated list of radios that need to be disabled when airplane mode is on.
String ALWAYS_FINISH_ACTIVITIES If 1, the activity manager will aggressively finish activities and processes as soon as they are no longer needed.
String ANIMATOR_DURATION_SCALE Scaling factor for Animator-based animations.
String AUTO_TIME Value to specify if the user prefers the date, time and time zone to be automatically fetched from the network (NITZ).
String AUTO_TIME_ZONE Value to specify if the user prefers the time zone to be automatically fetched from the network (NITZ).
String BLUETOOTH_ON Whether bluetooth is enabled/disabled 0=disabled.
String DATA_ROAMING Whether or not data roaming is enabled.
String DEBUG_APP Name of an application package to be debugged.
String DEVELOPMENT_SETTINGS_ENABLED Whether user has enabled development settings.
String DEVICE_PROVISIONED Whether the device has been provisioned (0 = false, 1 = true)
String HTTP_PROXY Host name and port for global http proxy.
String INSTALL_NON_MARKET_APPS Whether the package installer should allow installation of apps downloaded from sources other than Google Play.
String MODE_RINGER Ringer mode.
String NETWORK_PREFERENCE User preference for which network(s) should be used.
String RADIO_BLUETOOTH Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.
String RADIO_CELL Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.
String RADIO_NFC Constant for use in AIRPLANE_MODE_RADIOS to specify NFC radio.
String RADIO_WIFI Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.
String SHOW_PROCESSES Control whether the process CPU usage meter should be shown.
String STAY_ON_WHILE_PLUGGED_IN Whether we keep the device on while the device is plugged in.
String SYS_PROP_SETTING_VERSION
String TRANSITION_ANIMATION_SCALE Scaling factor for activity transition animations.
String USB_MASS_STORAGE_ENABLED USB Mass Storage Enabled
String USE_GOOGLE_MAIL If this setting is set (to anything), then all references to Gmail on the device must change to Google Mail.
String WAIT_FOR_DEBUGGER If 1, when launching DEBUG_APP it will wait for the debugger before starting user code.
String WIFI_MAX_DHCP_RETRY_COUNT The maximum number of times we will retry a connection to an access point for which we have failed in acquiring an IP address from DHCP.
String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile data connectivity to be established after a disconnect from Wi-Fi.
String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON Whether to notify the user of open networks.
String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY Delay (in seconds) before repeating the Wi-Fi networks available notification.
String WIFI_NUM_OPEN_NETWORKS_KEPT When the number of open networks exceeds this number, the least-recently-used excess networks will be removed.
String WIFI_ON Whether the Wi-Fi should be on.
String WIFI_SLEEP_POLICY The policy for deciding when Wi-Fi should go to sleep (which will in turn switch to using the mobile data as an Internet connection).
int WIFI_SLEEP_POLICY_DEFAULT Value for WIFI_SLEEP_POLICY to use the default Wi-Fi sleep policy, which is to sleep shortly after the turning off according to the STAY_ON_WHILE_PLUGGED_IN setting.
int WIFI_SLEEP_POLICY_NEVER Value for WIFI_SLEEP_POLICY to never go to sleep.
int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED Value for WIFI_SLEEP_POLICY to use the default policy when the device is on battery, and never go to sleep when the device is plugged in.
String WIFI_WATCHDOG_ON Whether the Wi-Fi watchdog is enabled.
String WINDOW_ANIMATION_SCALE Scaling factor for normal window animations.
[Expand]
Inherited Constants
From class android.provider.Settings.NameValueTable
From interface android.provider.BaseColumns
Fields
public static final Uri CONTENT_URI The content:// style URL for global secure settings items.
Public Constructors
Settings.Global()
Public Methods
static float getFloat(ContentResolver cr, String name, float def)
Convenience function for retrieving a single secure settings value as a floating point number.
static float getFloat(ContentResolver cr, String name)
Convenience function for retrieving a single secure settings value as a float.
static int getInt(ContentResolver cr, String name, int def)
Convenience function for retrieving a single secure settings value as an integer.
static int getInt(ContentResolver cr, String name)
Convenience function for retrieving a single secure settings value as an integer.
static long getLong(ContentResolver cr, String name, long def)
Convenience function for retrieving a single secure settings value as a long.
static long getLong(ContentResolver cr, String name)
Convenience function for retrieving a single secure settings value as a long.
static String getString(ContentResolver resolver, String name)
Look up a name in the database.
static Uri getUriFor(String name)
Construct the content URI for a particular name/value pair, useful for monitoring changes with a ContentObserver.
static boolean putFloat(ContentResolver cr, String name, float value)
Convenience function for updating a single settings value as a floating point number.
static boolean putInt(ContentResolver cr, String name, int value)
Convenience function for updating a single settings value as an integer.
static boolean putLong(ContentResolver cr, String name, long value)
Convenience function for updating a secure settings value as a long integer.
static boolean putString(ContentResolver resolver, String name, String value)
Store a name/value pair into the database.
[Expand]
Inherited Methods
From class android.provider.Settings.NameValueTable
From class java.lang.Object

Constants

public static final String ADB_ENABLED

Added in API level 17

Whether ADB is enabled.

Constant Value: "adb_enabled"

public static final String AIRPLANE_MODE_ON

Added in API level 17

Whether Airplane Mode is on.

Constant Value: "airplane_mode_on"

public static final String AIRPLANE_MODE_RADIOS

Added in API level 17

A comma separated list of radios that need to be disabled when airplane mode is on. This overrides WIFI_ON and BLUETOOTH_ON, if Wi-Fi and bluetooth are included in the comma separated list.

Constant Value: "airplane_mode_radios"

public static final String ALWAYS_FINISH_ACTIVITIES

Added in API level 17

If 1, the activity manager will aggressively finish activities and processes as soon as they are no longer needed. If 0, the normal extended lifetime is used.

Constant Value: "always_finish_activities"

public static final String ANIMATOR_DURATION_SCALE

Added in API level 17

Scaling factor for Animator-based animations. This affects both the start delay and duration of all such animations. Setting to 0 will cause animations to end immediately. The default value is 1.

Constant Value: "animator_duration_scale"

public static final String AUTO_TIME

Added in API level 17

Value to specify if the user prefers the date, time and time zone to be automatically fetched from the network (NITZ). 1=yes, 0=no

Constant Value: "auto_time"

public static final String AUTO_TIME_ZONE

Added in API level 17

Value to specify if the user prefers the time zone to be automatically fetched from the network (NITZ). 1=yes, 0=no

Constant Value: "auto_time_zone"

public static final String BLUETOOTH_ON

Added in API level 17

Whether bluetooth is enabled/disabled 0=disabled. 1=enabled.

Constant Value: "bluetooth_on"

public static final String DATA_ROAMING

Added in API level 17

Whether or not data roaming is enabled. (0 = false, 1 = true)

Constant Value: "data_roaming"

public static final String DEBUG_APP

Added in API level 17

Name of an application package to be debugged.

Constant Value: "debug_app"

public static final String DEVELOPMENT_SETTINGS_ENABLED

Added in API level 17

Whether user has enabled development settings.

Constant Value: "development_settings_enabled"

public static final String DEVICE_PROVISIONED

Added in API level 17

Whether the device has been provisioned (0 = false, 1 = true)

Constant Value: "device_provisioned"

public static final String HTTP_PROXY

Added in API level 17

Host name and port for global http proxy. Uses ':' seperator for between host and port.

Constant Value: "http_proxy"

public static final String INSTALL_NON_MARKET_APPS

Added in API level 17

Whether the package installer should allow installation of apps downloaded from sources other than Google Play. 1 = allow installing from other sources 0 = only allow installing from Google Play

Constant Value: "install_non_market_apps"

public static final String MODE_RINGER

Added in API level 17

Ringer mode. This is used internally, changing this value will not change the ringer mode. See AudioManager.

Constant Value: "mode_ringer"

public static final String NETWORK_PREFERENCE

Added in API level 17

User preference for which network(s) should be used. Only the connectivity service should touch this.

Constant Value: "network_preference"

public static final String RADIO_BLUETOOTH

Added in API level 17

Constant for use in AIRPLANE_MODE_RADIOS to specify Bluetooth radio.

Constant Value: "bluetooth"

public static final String RADIO_CELL

Added in API level 17

Constant for use in AIRPLANE_MODE_RADIOS to specify Cellular radio.

Constant Value: "cell"

public static final String RADIO_NFC

Added in API level 17

Constant for use in AIRPLANE_MODE_RADIOS to specify NFC radio.

Constant Value: "nfc"

public static final String RADIO_WIFI

Added in API level 17

Constant for use in AIRPLANE_MODE_RADIOS to specify Wi-Fi radio.

Constant Value: "wifi"

public static final String SHOW_PROCESSES

Added in API level 17

Control whether the process CPU usage meter should be shown.

Constant Value: "show_processes"

public static final String STAY_ON_WHILE_PLUGGED_IN

Added in API level 17

Whether we keep the device on while the device is plugged in. Supported values are:

These values can be OR-ed together.

Constant Value: "stay_on_while_plugged_in"

public static final String SYS_PROP_SETTING_VERSION

Added in API level 17

Constant Value: "sys.settings_global_version"

public static final String TRANSITION_ANIMATION_SCALE

Added in API level 17

Scaling factor for activity transition animations. Setting to 0 will disable window animations.

Constant Value: "transition_animation_scale"

public static final String USB_MASS_STORAGE_ENABLED

Added in API level 17

USB Mass Storage Enabled

Constant Value: "usb_mass_storage_enabled"

public static final String USE_GOOGLE_MAIL

Added in API level 17

If this setting is set (to anything), then all references to Gmail on the device must change to Google Mail.

Constant Value: "use_google_mail"

public static final String WAIT_FOR_DEBUGGER

Added in API level 17

If 1, when launching DEBUG_APP it will wait for the debugger before starting user code. If 0, it will run normally.

Constant Value: "wait_for_debugger"

public static final String WIFI_MAX_DHCP_RETRY_COUNT

Added in API level 17

The maximum number of times we will retry a connection to an access point for which we have failed in acquiring an IP address from DHCP. A value of N means that we will make N+1 connection attempts in all.

Constant Value: "wifi_max_dhcp_retry_count"

public static final String WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS

Added in API level 17

Maximum amount of time in milliseconds to hold a wakelock while waiting for mobile data connectivity to be established after a disconnect from Wi-Fi.

Constant Value: "wifi_mobile_data_transition_wakelock_timeout_ms"

public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON

Added in API level 17

Whether to notify the user of open networks.

If not connected and the scan results have an open network, we will put this notification up. If we attempt to connect to a network or the open network(s) disappear, we remove the notification. When we show the notification, we will not show it again for WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY time.

Constant Value: "wifi_networks_available_notification_on"

public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY

Added in API level 17

Delay (in seconds) before repeating the Wi-Fi networks available notification. Connecting to a network will reset the timer.

Constant Value: "wifi_networks_available_repeat_delay"

public static final String WIFI_NUM_OPEN_NETWORKS_KEPT

Added in API level 17

When the number of open networks exceeds this number, the least-recently-used excess networks will be removed.

Constant Value: "wifi_num_open_networks_kept"

public static final String WIFI_ON

Added in API level 17

Whether the Wi-Fi should be on. Only the Wi-Fi service should touch this.

Constant Value: "wifi_on"

public static final String WIFI_SLEEP_POLICY

Added in API level 17

The policy for deciding when Wi-Fi should go to sleep (which will in turn switch to using the mobile data as an Internet connection).

Set to one of WIFI_SLEEP_POLICY_DEFAULT, WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED, or WIFI_SLEEP_POLICY_NEVER.

Constant Value: "wifi_sleep_policy"

public static final int WIFI_SLEEP_POLICY_DEFAULT

Added in API level 17

Value for WIFI_SLEEP_POLICY to use the default Wi-Fi sleep policy, which is to sleep shortly after the turning off according to the STAY_ON_WHILE_PLUGGED_IN setting.

Constant Value: 0 (0x00000000)

public static final int WIFI_SLEEP_POLICY_NEVER

Added in API level 17

Value for WIFI_SLEEP_POLICY to never go to sleep.

Constant Value: 2 (0x00000002)

public static final int WIFI_SLEEP_POLICY_NEVER_WHILE_PLUGGED

Added in API level 17

Value for WIFI_SLEEP_POLICY to use the default policy when the device is on battery, and never go to sleep when the device is plugged in.

Constant Value: 1 (0x00000001)

public static final String WIFI_WATCHDOG_ON

Added in API level 17

Whether the Wi-Fi watchdog is enabled.

Constant Value: "wifi_watchdog_on"

public static final String WINDOW_ANIMATION_SCALE

Added in API level 17

Scaling factor for normal window animations. Setting to 0 will disable window animations.

Constant Value: "window_animation_scale"

Fields

public static final Uri CONTENT_URI

Added in API level 17

The content:// style URL for global secure settings items. Not public.

Public Constructors

public Settings.Global ()

Added in API level 17

Public Methods

public static float getFloat (ContentResolver cr, String name, float def)

Added in API level 17

Convenience function for retrieving a single secure settings value as a floating point number. Note that internally setting values are always stored as strings; this function converts the string to an float for you. The default value will be returned if the setting is not defined or not a valid float.

Parameters
cr The ContentResolver to access.
name The name of the setting to retrieve.
def Value to return if the setting is not defined.
Returns
  • The setting's current value, or 'def' if it is not defined or not a valid float.

public static float getFloat (ContentResolver cr, String name)

Added in API level 17

Convenience function for retrieving a single secure settings value as a float. Note that internally setting values are always stored as strings; this function converts the string to a float for you.

This version does not take a default value. If the setting has not been set, or the string value is not a number, it throws Settings.SettingNotFoundException.

Parameters
cr The ContentResolver to access.
name The name of the setting to retrieve.
Returns
  • The setting's current value.
Throws
Settings.SettingNotFoundException Thrown if a setting by the given name can't be found or the setting value is not a float.

public static int getInt (ContentResolver cr, String name, int def)

Added in API level 17

Convenience function for retrieving a single secure settings value as an integer. Note that internally setting values are always stored as strings; this function converts the string to an integer for you. The default value will be returned if the setting is not defined or not an integer.

Parameters
cr The ContentResolver to access.
name The name of the setting to retrieve.
def Value to return if the setting is not defined.
Returns
  • The setting's current value, or 'def' if it is not defined or not a valid integer.

public static int getInt (ContentResolver cr, String name)

Added in API level 17

Convenience function for retrieving a single secure settings value as an integer. Note that internally setting values are always stored as strings; this function converts the string to an integer for you.

This version does not take a default value. If the setting has not been set, or the string value is not a number, it throws Settings.SettingNotFoundException.

Parameters
cr The ContentResolver to access.
name The name of the setting to retrieve.
Returns
  • The setting's current value.
Throws
Settings.SettingNotFoundException Thrown if a setting by the given name can't be found or the setting value is not an integer.

public static long getLong (ContentResolver cr, String name, long def)

Added in API level 17

Convenience function for retrieving a single secure settings value as a long. Note that internally setting values are always stored as strings; this function converts the string to a long for you. The default value will be returned if the setting is not defined or not a long.

Parameters
cr The ContentResolver to access.
name The name of the setting to retrieve.
def Value to return if the setting is not defined.
Returns
  • The setting's current value, or 'def' if it is not defined or not a valid long.

public static long getLong (ContentResolver cr, String name)

Added in API level 17

Convenience function for retrieving a single secure settings value as a long. Note that internally setting values are always stored as strings; this function converts the string to a long for you.

This version does not take a default value. If the setting has not been set, or the string value is not a number, it throws Settings.SettingNotFoundException.

Parameters
cr The ContentResolver to access.
name The name of the setting to retrieve.
Returns
  • The setting's current value.
Throws
Settings.SettingNotFoundException Thrown if a setting by the given name can't be found or the setting value is not an integer.

public static String getString (ContentResolver resolver, String name)

Added in API level 17

Look up a name in the database.

Parameters
resolver to access the database with
name to look up in the table
Returns
  • the corresponding value, or null if not present

public static Uri getUriFor (String name)

Added in API level 17

Construct the content URI for a particular name/value pair, useful for monitoring changes with a ContentObserver.

Parameters
name to look up in the table
Returns
  • the corresponding content URI, or null if not present

public static boolean putFloat (ContentResolver cr, String name, float value)

Added in API level 17

Convenience function for updating a single settings value as a floating point number. This will either create a new entry in the table if the given name does not exist, or modify the value of the existing row with that name. Note that internally setting values are always stored as strings, so this function converts the given value to a string before storing it.

Parameters
cr The ContentResolver to access.
name The name of the setting to modify.
value The new value for the setting.
Returns
  • true if the value was set, false on database errors

public static boolean putInt (ContentResolver cr, String name, int value)

Added in API level 17

Convenience function for updating a single settings value as an integer. This will either create a new entry in the table if the given name does not exist, or modify the value of the existing row with that name. Note that internally setting values are always stored as strings, so this function converts the given value to a string before storing it.

Parameters
cr The ContentResolver to access.
name The name of the setting to modify.
value The new value for the setting.
Returns
  • true if the value was set, false on database errors

public static boolean putLong (ContentResolver cr, String name, long value)

Added in API level 17

Convenience function for updating a secure settings value as a long integer. This will either create a new entry in the table if the given name does not exist, or modify the value of the existing row with that name. Note that internally setting values are always stored as strings, so this function converts the given value to a string before storing it.

Parameters
cr The ContentResolver to access.
name The name of the setting to modify.
value The new value for the setting.
Returns
  • true if the value was set, false on database errors

public static boolean putString (ContentResolver resolver, String name, String value)

Added in API level 17

Store a name/value pair into the database.

Parameters
resolver to access the database with
name to store
value to associate with the name
Returns
  • true if the value was set, false on database errors