android.provider
Class Settings.Secure

java.lang.Object
  android.provider.Settings.NameValueTable
      android.provider.Settings.Secure

All Implemented Interfaces:

BaseColumns

Enclosing class:

Settings

public static final class Settings.Secure
extends Settings.NameValueTable

Secure system settings, containing system preferences that applications can read but are not allowed to write. These are for preferences that the user must explicitly modify through the system UI or specialized APIs for those values, not modified directly by applications.

Field Summary

static String	ADB_ENABLED Whether ADB is enabled.
static String	ALLOW_MOCK_LOCATION Setting to allow mock locations and location provider status to be injected into the LocationManager service for testing purposes during application development.
static String	ANDROID_ID The Android ID (a unique 64-bit value) as a hex string.
static String	BLUETOOTH_ON Whether bluetooth is enabled/disabled 0=disabled.
static Uri	CONTENT_URI The content:// style URL for this table
static String	DATA_ROAMING Whether or not data roaming is enabled.
static String	DEFAULT_INPUT_METHOD Setting to record the input method used by default, holding the ID of the desired method.
static String	DEVICE_PROVISIONED Whether the device has been provisioned (0 = false, 1 = true)
static String	ENABLED_INPUT_METHODS List of input methods that are currently enabled.
static String	HTTP_PROXY Host name and port for a user-selected proxy.
static String	INSTALL_NON_MARKET_APPS Whether the package installer should allow installation of apps downloaded from sources other than the Android Market (vending machine).
static String	LOCATION_PROVIDERS_ALLOWED Comma-separated list of location providers that activities may access.
static String	LOGGING_ID Deprecated. This identifier is poorly initialized and has many collisions. It should not be used.
static String	LOGGING_ID2 The Logging ID (a unique 64-bit value) as a hex string.
static String	NETWORK_PREFERENCE User preference for which network(s) should be used.
static String	PARENTAL_CONTROL_ENABLED
static String	PARENTAL_CONTROL_LAST_UPDATE
static String	PARENTAL_CONTROL_REDIRECT_URL
static String	SETTINGS_CLASSNAME Settings classname to launch when Settings is clicked from All Applications.
static String	SYS_PROP_SETTING_VERSION
static String	USB_MASS_STORAGE_ENABLED USB Mass Storage Enabled
static String	USE_GOOGLE_MAIL If this setting is set (to anything), then all references to Gmail on the device must change to Google Mail.
static 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.
static 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.
static String	WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON Whether to notify the user of open networks.
static String	WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY Delay (in seconds) before repeating the Wi-Fi networks available notification.
static String	WIFI_NUM_ALLOWED_CHANNELS The number of radio channels that are allowed in the local 802.11 regulatory domain.
static String	WIFI_NUM_OPEN_NETWORKS_KEPT When the number of open networks exceeds this number, the least-recently-used excess networks will be removed.
static String	WIFI_ON Whether the Wi-Fi should be on.
static String	WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE The acceptable packet loss percentage (range 0 - 100) before trying another AP on the same network.
static String	WIFI_WATCHDOG_AP_COUNT The number of access points required for a network in order for the watchdog to monitor it.
static String	WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS The delay between background checks.
static String	WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED Whether the Wi-Fi watchdog is enabled for background checking even after it thinks the user has connected to a good access point.
static String	WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS The timeout for a background ping
static String	WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT The number of initial pings to perform that *may* be ignored if they fail.
static String	WIFI_WATCHDOG_MAX_AP_CHECKS The maximum number of access points (per network) to attempt to test.
static String	WIFI_WATCHDOG_ON Whether the Wi-Fi watchdog is enabled.
static String	WIFI_WATCHDOG_PING_COUNT The number of pings to test if an access point is a good connection.
static String	WIFI_WATCHDOG_PING_DELAY_MS The delay between pings.
static String	WIFI_WATCHDOG_PING_TIMEOUT_MS The timeout per ping.
static String	WIFI_WATCHDOG_WATCH_LIST A comma-separated list of SSIDs for which the Wi-Fi watchdog should be enabled.

Fields inherited from class android.provider.Settings.NameValueTable

NAME, VALUE

Fields inherited from interface android.provider.BaseColumns

_COUNT, _ID

Constructor Summary

Settings.Secure()

Method Summary

static String	getBluetoothA2dpSinkPriorityKey(String address) Get the key that retrieves a bluetooth a2dp sink's priority.
static String	getBluetoothHeadsetPriorityKey(String address) Get the key that retrieves a bluetooth headset's priority.
static float	getFloat(ContentResolver cr, String name) Convenience function for retrieving a single secure settings value as a float.
static float	getFloat(ContentResolver cr, String name, float def) Convenience function for retrieving a single secure settings value as a floating point number.
static int	getInt(ContentResolver cr, String name) Convenience function for retrieving a single secure settings value as an integer.
static int	getInt(ContentResolver cr, String name, int def) Convenience function for retrieving a single secure settings value as an integer.
static long	getLong(ContentResolver cr, String name) Convenience function for retrieving a single secure settings value as a long.
static long	getLong(ContentResolver cr, String name, long def) 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.

Methods inherited from class android.provider.Settings.NameValueTable

getUriFor, putString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYS_PROP_SETTING_VERSION

public static final String SYS_PROP_SETTING_VERSION

See Also:

Constant Field Values

CONTENT_URI

public static final Uri CONTENT_URI

The content:// style URL for this table

ADB_ENABLED

public static final String ADB_ENABLED

Whether ADB is enabled.

See Also:

Constant Field Values

ALLOW_MOCK_LOCATION

public static final String ALLOW_MOCK_LOCATION

Setting to allow mock locations and location provider status to be injected into the LocationManager service for testing purposes during application development. These locations and status values override actual location and status information generated by network, gps, or other location providers.

See Also:

Constant Field Values

ANDROID_ID

public static final String ANDROID_ID

The Android ID (a unique 64-bit value) as a hex string. Identical to that obtained by calling GoogleLoginService.getAndroidId(); it is also placed here so you can get it without binding to a service.

See Also:

Constant Field Values

BLUETOOTH_ON

public static final String BLUETOOTH_ON

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

See Also:

Constant Field Values

DATA_ROAMING

public static final String DATA_ROAMING

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

See Also:

Constant Field Values

DEFAULT_INPUT_METHOD

public static final String DEFAULT_INPUT_METHOD

Setting to record the input method used by default, holding the ID of the desired method.

See Also:

Constant Field Values

DEVICE_PROVISIONED

public static final String DEVICE_PROVISIONED

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

See Also:

Constant Field Values

ENABLED_INPUT_METHODS

public static final String ENABLED_INPUT_METHODS

List of input methods that are currently enabled. This is a string containing the IDs of all enabled input methods, each ID separated by ':'.

See Also:

Constant Field Values

HTTP_PROXY

public static final String HTTP_PROXY

Host name and port for a user-selected proxy.

See Also:

Constant Field Values

INSTALL_NON_MARKET_APPS

public static final String INSTALL_NON_MARKET_APPS

Whether the package installer should allow installation of apps downloaded from sources other than the Android Market (vending machine). 1 = allow installing from other sources 0 = only allow installing from the Android Market

See Also:

Constant Field Values

LOCATION_PROVIDERS_ALLOWED

public static final String LOCATION_PROVIDERS_ALLOWED

Comma-separated list of location providers that activities may access.

See Also:

Constant Field Values

LOGGING_ID

@Deprecated
public static final String LOGGING_ID

Deprecated. This identifier is poorly initialized and has many collisions. It should not be used.

The Logging ID (a unique 64-bit value) as a hex string. Used as a pseudonymous identifier for logging.

See Also:

Constant Field Values

LOGGING_ID2

public static final String LOGGING_ID2

The Logging ID (a unique 64-bit value) as a hex string. Used as a pseudonymous identifier for logging.

See Also:

Constant Field Values

NETWORK_PREFERENCE

public static final String NETWORK_PREFERENCE

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

See Also:

Constant Field Values

PARENTAL_CONTROL_ENABLED

public static final String PARENTAL_CONTROL_ENABLED

See Also:

Constant Field Values

PARENTAL_CONTROL_LAST_UPDATE

public static final String PARENTAL_CONTROL_LAST_UPDATE

See Also:

Constant Field Values

PARENTAL_CONTROL_REDIRECT_URL

public static final String PARENTAL_CONTROL_REDIRECT_URL

See Also:

Constant Field Values

SETTINGS_CLASSNAME

public static final String SETTINGS_CLASSNAME

Settings classname to launch when Settings is clicked from All Applications. Needed because of user testing between the old and new Settings apps.

See Also:

Constant Field Values

USB_MASS_STORAGE_ENABLED

public static final String USB_MASS_STORAGE_ENABLED

USB Mass Storage Enabled

See Also:

Constant Field Values

USE_GOOGLE_MAIL

public static final String USE_GOOGLE_MAIL

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

See Also:

Constant Field Values

WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON

public static final String WIFI_NETWORKS_AVAILABLE_NOTIFICATION_ON

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.

See Also:

Constant Field Values

WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY

public static final String WIFI_NETWORKS_AVAILABLE_REPEAT_DELAY

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

See Also:

Constant Field Values

WIFI_NUM_ALLOWED_CHANNELS

public static final String WIFI_NUM_ALLOWED_CHANNELS

The number of radio channels that are allowed in the local 802.11 regulatory domain.

See Also:

Constant Field Values

WIFI_NUM_OPEN_NETWORKS_KEPT

public static final String WIFI_NUM_OPEN_NETWORKS_KEPT

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

See Also:

Constant Field Values

WIFI_ON

public static final String WIFI_ON

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

See Also:

Constant Field Values

WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE

public static final String WIFI_WATCHDOG_ACCEPTABLE_PACKET_LOSS_PERCENTAGE

The acceptable packet loss percentage (range 0 - 100) before trying another AP on the same network.

See Also:

Constant Field Values

WIFI_WATCHDOG_AP_COUNT

public static final String WIFI_WATCHDOG_AP_COUNT

The number of access points required for a network in order for the watchdog to monitor it.

See Also:

Constant Field Values

WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS

public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_DELAY_MS

The delay between background checks.

See Also:

Constant Field Values

WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED

public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_ENABLED

Whether the Wi-Fi watchdog is enabled for background checking even after it thinks the user has connected to a good access point.

See Also:

Constant Field Values

WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS

public static final String WIFI_WATCHDOG_BACKGROUND_CHECK_TIMEOUT_MS

The timeout for a background ping

See Also:

Constant Field Values

WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT

public static final String WIFI_WATCHDOG_INITIAL_IGNORED_PING_COUNT

The number of initial pings to perform that *may* be ignored if they fail. Again, if these fail, they will *not* be used in packet loss calculation. For example, one network always seemed to time out for the first couple pings, so this is set to 3 by default.

See Also:

Constant Field Values

WIFI_WATCHDOG_MAX_AP_CHECKS

public static final String WIFI_WATCHDOG_MAX_AP_CHECKS

The maximum number of access points (per network) to attempt to test. If this number is reached, the watchdog will no longer monitor the initial connection state for the network. This is a safeguard for networks containing multiple APs whose DNS does not respond to pings.

See Also:

Constant Field Values

WIFI_WATCHDOG_ON

public static final String WIFI_WATCHDOG_ON

Whether the Wi-Fi watchdog is enabled.

See Also:

Constant Field Values

WIFI_WATCHDOG_WATCH_LIST

public static final String WIFI_WATCHDOG_WATCH_LIST

A comma-separated list of SSIDs for which the Wi-Fi watchdog should be enabled.

See Also:

Constant Field Values

WIFI_WATCHDOG_PING_COUNT

public static final String WIFI_WATCHDOG_PING_COUNT

The number of pings to test if an access point is a good connection.

See Also:

Constant Field Values

WIFI_WATCHDOG_PING_DELAY_MS

public static final String WIFI_WATCHDOG_PING_DELAY_MS

The delay between pings.

See Also:

Constant Field Values

WIFI_WATCHDOG_PING_TIMEOUT_MS

public static final String WIFI_WATCHDOG_PING_TIMEOUT_MS

The timeout per ping.

See Also:

Constant Field Values

WIFI_MAX_DHCP_RETRY_COUNT

public static final 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. A value of N means that we will make N+1 connection attempts in all.

See Also:

Constant Field Values

WIFI_MOBILE_DATA_TRANSITION_WAKELOCK_TIMEOUT_MS

public static final 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.

See Also:

Constant Field Values

Constructor Detail

Settings.Secure

public Settings.Secure()

Method Detail

getString

public static String getString(ContentResolver resolver,
                               String name)

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

putString

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

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

getUriFor

public static Uri getUriFor(String name)

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

getInt

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

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.

getInt

public static int getInt(ContentResolver cr,
                         String name)
                  throws Settings.SettingNotFoundException

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.

putInt

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

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

getLong

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

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.

getLong

public static long getLong(ContentResolver cr,
                           String name)
                    throws Settings.SettingNotFoundException

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.

putLong

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

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

getFloat

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

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.

getFloat

public static float getFloat(ContentResolver cr,
                             String name)
                      throws Settings.SettingNotFoundException

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.

putFloat

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

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

getBluetoothHeadsetPriorityKey

public static final String getBluetoothHeadsetPriorityKey(String address)

Get the key that retrieves a bluetooth headset's priority.

getBluetoothA2dpSinkPriorityKey

public static final String getBluetoothA2dpSinkPriorityKey(String address)

Get the key that retrieves a bluetooth a2dp sink's priority.