Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public final class

Settings

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

Class Overview

The Settings provider contains global system-level device preferences.

Summary

Nested Classes
class Settings.Global Global system settings, containing preferences that always apply identically to all defined users. 
class Settings.NameValueTable Common base for tables of name/value settings. 
class Settings.Secure Secure system settings, containing system preferences that applications can read but are not allowed to write. 
class Settings.SettingNotFoundException  
class Settings.System System settings, containing miscellaneous system preferences. 
Constants
String ACTION_ACCESSIBILITY_SETTINGS Activity Action: Show settings for accessibility modules.
String ACTION_ADD_ACCOUNT Activity Action: Show add account screen for creating a new account.
String ACTION_AIRPLANE_MODE_SETTINGS Activity Action: Show settings to allow entering/exiting airplane mode.
String ACTION_APN_SETTINGS Activity Action: Show settings to allow configuration of APNs.
String ACTION_APPLICATION_DETAILS_SETTINGS Activity Action: Show screen of details about a particular application.
String ACTION_APPLICATION_DEVELOPMENT_SETTINGS Activity Action: Show settings to allow configuration of application development-related settings.
String ACTION_APPLICATION_SETTINGS Activity Action: Show settings to allow configuration of application-related settings.
String ACTION_BLUETOOTH_SETTINGS Activity Action: Show settings to allow configuration of Bluetooth.
String ACTION_CAPTIONING_SETTINGS Activity Action: Show settings for video captioning.
String ACTION_DATA_ROAMING_SETTINGS Activity Action: Show settings for selection of 2G/3G.
String ACTION_DATE_SETTINGS Activity Action: Show settings to allow configuration of date and time.
String ACTION_DEVICE_INFO_SETTINGS Activity Action: Show general device information settings (serial number, software version, phone number, etc.).
String ACTION_DISPLAY_SETTINGS Activity Action: Show settings to allow configuration of display.
String ACTION_DREAM_SETTINGS Activity Action: Show Daydream settings.
String ACTION_INPUT_METHOD_SETTINGS Activity Action: Show settings to configure input methods, in particular allowing the user to enable input methods.
String ACTION_INPUT_METHOD_SUBTYPE_SETTINGS Activity Action: Show settings to enable/disable input method subtypes.
String ACTION_INTERNAL_STORAGE_SETTINGS Activity Action: Show settings for internal storage.
String ACTION_LOCALE_SETTINGS Activity Action: Show settings to allow configuration of locale.
String ACTION_LOCATION_SOURCE_SETTINGS Activity Action: Show settings to allow configuration of current location sources.
String ACTION_MANAGE_ALL_APPLICATIONS_SETTINGS Activity Action: Show settings to manage all applications.
String ACTION_MANAGE_APPLICATIONS_SETTINGS Activity Action: Show settings to manage installed applications.
String ACTION_MEMORY_CARD_SETTINGS Activity Action: Show settings for memory card storage.
String ACTION_NETWORK_OPERATOR_SETTINGS Activity Action: Show settings for selecting the network operator.
String ACTION_NFCSHARING_SETTINGS Activity Action: Show NFC Sharing settings.
String ACTION_NFC_PAYMENT_SETTINGS Activity Action: Show NFC Tap & Pay settings

This shows UI that allows the user to configure Tap&Pay; settings.

String ACTION_NFC_SETTINGS Activity Action: Show NFC settings.
String ACTION_PRINT_SETTINGS Activity Action: Show the top level print settings.
String ACTION_PRIVACY_SETTINGS Activity Action: Show settings to allow configuration of privacy options.
String ACTION_QUICK_LAUNCH_SETTINGS Activity Action: Show settings to allow configuration of quick launch shortcuts.
String ACTION_SEARCH_SETTINGS Activity Action: Show settings for global search.
String ACTION_SECURITY_SETTINGS Activity Action: Show settings to allow configuration of security and location privacy.
String ACTION_SETTINGS Activity Action: Show system settings.
String ACTION_SOUND_SETTINGS Activity Action: Show settings to allow configuration of sound and volume.
String ACTION_SYNC_SETTINGS Activity Action: Show settings to allow configuration of sync settings.
String ACTION_USER_DICTIONARY_SETTINGS Activity Action: Show settings to manage the user input dictionary.
String ACTION_WIFI_IP_SETTINGS Activity Action: Show settings to allow configuration of a static IP address for Wi-Fi.
String ACTION_WIFI_SETTINGS Activity Action: Show settings to allow configuration of Wi-Fi.
String ACTION_WIRELESS_SETTINGS Activity Action: Show settings to allow configuration of wireless controls such as Wi-Fi, Bluetooth and Mobile networks.
String AUTHORITY
String EXTRA_ACCOUNT_TYPES Activity Extra: Limit available options in launched activity based on the given account types.
String EXTRA_AUTHORITIES Activity Extra: Limit available options in launched activity based on the given authority.
String EXTRA_INPUT_METHOD_ID
Public Constructors
Settings ()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ACTION_ACCESSIBILITY_SETTINGS

Added in API level 5

Activity Action: Show settings for accessibility modules.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.ACCESSIBILITY_SETTINGS"

public static final String ACTION_ADD_ACCOUNT

Added in API level 8

Activity Action: Show add account screen for creating a new account.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

The account types available to add may be restricted by adding an EXTRA_AUTHORITIES extra to the Intent with one or more syncable content provider's authorities. Only account types which can sync with that content provider will be offered to the user.

Account types can also be filtered by adding an EXTRA_ACCOUNT_TYPES extra to the Intent with one or more account types.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.ADD_ACCOUNT_SETTINGS"

public static final String ACTION_AIRPLANE_MODE_SETTINGS

Added in API level 3

Activity Action: Show settings to allow entering/exiting airplane mode.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.AIRPLANE_MODE_SETTINGS"

public static final String ACTION_APN_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of APNs.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.APN_SETTINGS"

public static final String ACTION_APPLICATION_DETAILS_SETTINGS

Added in API level 9

Activity Action: Show screen of details about a particular application.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: The Intent's data URI specifies the application package name to be shown, with the "package" scheme. That is "package:com.my.app".

Output: Nothing.

Constant Value: "android.settings.APPLICATION_DETAILS_SETTINGS"

public static final String ACTION_APPLICATION_DEVELOPMENT_SETTINGS

Added in API level 3

Activity Action: Show settings to allow configuration of application development-related settings. As of JELLY_BEAN_MR1 this action is a required part of the platform.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.APPLICATION_DEVELOPMENT_SETTINGS"

public static final String ACTION_APPLICATION_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of application-related settings.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.APPLICATION_SETTINGS"

public static final String ACTION_BLUETOOTH_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of Bluetooth.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.BLUETOOTH_SETTINGS"

public static final String ACTION_CAPTIONING_SETTINGS

Activity Action: Show settings for video captioning.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.CAPTIONING_SETTINGS"

public static final String ACTION_DATA_ROAMING_SETTINGS

Added in API level 3

Activity Action: Show settings for selection of 2G/3G.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.DATA_ROAMING_SETTINGS"

public static final String ACTION_DATE_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of date and time.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.DATE_SETTINGS"

public static final String ACTION_DEVICE_INFO_SETTINGS

Added in API level 8

Activity Action: Show general device information settings (serial number, software version, phone number, etc.).

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing

Constant Value: "android.settings.DEVICE_INFO_SETTINGS"

public static final String ACTION_DISPLAY_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of display.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.DISPLAY_SETTINGS"

public static final String ACTION_DREAM_SETTINGS

Activity Action: Show Daydream settings.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.DREAM_SETTINGS"

public static final String ACTION_INPUT_METHOD_SETTINGS

Added in API level 3

Activity Action: Show settings to configure input methods, in particular allowing the user to enable input methods.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.INPUT_METHOD_SETTINGS"

public static final String ACTION_INPUT_METHOD_SUBTYPE_SETTINGS

Activity Action: Show settings to enable/disable input method subtypes.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

To tell which input method's subtypes are displayed in the settings, add EXTRA_INPUT_METHOD_ID extra to this Intent with the input method id. If there is no extra in this Intent, subtypes from all installed input methods will be displayed in the settings.

See Also
  • Input: Nothing.

    Output: Nothing.

Constant Value: "android.settings.INPUT_METHOD_SUBTYPE_SETTINGS"

public static final String ACTION_INTERNAL_STORAGE_SETTINGS

Added in API level 3

Activity Action: Show settings for internal storage.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.INTERNAL_STORAGE_SETTINGS"

public static final String ACTION_LOCALE_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of locale.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.LOCALE_SETTINGS"

public static final String ACTION_LOCATION_SOURCE_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of current location sources.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.LOCATION_SOURCE_SETTINGS"

public static final String ACTION_MANAGE_ALL_APPLICATIONS_SETTINGS

Added in API level 9

Activity Action: Show settings to manage all applications.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.MANAGE_ALL_APPLICATIONS_SETTINGS"

public static final String ACTION_MANAGE_APPLICATIONS_SETTINGS

Added in API level 3

Activity Action: Show settings to manage installed applications.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.MANAGE_APPLICATIONS_SETTINGS"

public static final String ACTION_MEMORY_CARD_SETTINGS

Added in API level 3

Activity Action: Show settings for memory card storage.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.MEMORY_CARD_SETTINGS"

public static final String ACTION_NETWORK_OPERATOR_SETTINGS

Added in API level 3

Activity Action: Show settings for selecting the network operator.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.NETWORK_OPERATOR_SETTINGS"

public static final String ACTION_NFCSHARING_SETTINGS

Activity Action: Show NFC Sharing settings.

This shows UI that allows NDEF Push (Android Beam) to be turned on or off.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing

Constant Value: "android.settings.NFCSHARING_SETTINGS"

public static final String ACTION_NFC_PAYMENT_SETTINGS

Activity Action: Show NFC Tap & Pay settings

This shows UI that allows the user to configure Tap&Pay; settings.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing

Constant Value: "android.settings.NFC_PAYMENT_SETTINGS"

public static final String ACTION_NFC_SETTINGS

Activity Action: Show NFC settings.

This shows UI that allows NFC to be turned on or off.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing

See Also
Constant Value: "android.settings.NFC_SETTINGS"

public static final String ACTION_PRINT_SETTINGS

Activity Action: Show the top level print settings.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.ACTION_PRINT_SETTINGS"

public static final String ACTION_PRIVACY_SETTINGS

Added in API level 5

Activity Action: Show settings to allow configuration of privacy options.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.PRIVACY_SETTINGS"

public static final String ACTION_QUICK_LAUNCH_SETTINGS

Added in API level 3

Activity Action: Show settings to allow configuration of quick launch shortcuts.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.QUICK_LAUNCH_SETTINGS"

public static final String ACTION_SEARCH_SETTINGS

Added in API level 8

Activity Action: Show settings for global search.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing

Constant Value: "android.search.action.SEARCH_SETTINGS"

public static final String ACTION_SECURITY_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of security and location privacy.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.SECURITY_SETTINGS"

public static final String ACTION_SETTINGS

Added in API level 1

Activity Action: Show system settings.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.SETTINGS"

public static final String ACTION_SOUND_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of sound and volume.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.SOUND_SETTINGS"

public static final String ACTION_SYNC_SETTINGS

Added in API level 3

Activity Action: Show settings to allow configuration of sync settings.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

The account types available to add via the add account button may be restricted by adding an EXTRA_AUTHORITIES extra to this Intent with one or more syncable content provider's authorities. Only account types which can sync with that content provider will be offered to the user.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.SYNC_SETTINGS"

public static final String ACTION_USER_DICTIONARY_SETTINGS

Added in API level 3

Activity Action: Show settings to manage the user input dictionary.

Starting with KITKAT , it is guaranteed there will always be an appropriate implementation for this Intent action. In prior releases of the platform this was optional, so ensure you safeguard against it.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.USER_DICTIONARY_SETTINGS"

public static final String ACTION_WIFI_IP_SETTINGS

Added in API level 3

Activity Action: Show settings to allow configuration of a static IP address for Wi-Fi.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.WIFI_IP_SETTINGS"

public static final String ACTION_WIFI_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of Wi-Fi.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.WIFI_SETTINGS"

public static final String ACTION_WIRELESS_SETTINGS

Added in API level 1

Activity Action: Show settings to allow configuration of wireless controls such as Wi-Fi, Bluetooth and Mobile networks.

In some cases, a matching Activity may not exist, so ensure you safeguard against this.

Input: Nothing.

Output: Nothing.

Constant Value: "android.settings.WIRELESS_SETTINGS"

public static final String AUTHORITY

Added in API level 1

Constant Value: "settings"

public static final String EXTRA_ACCOUNT_TYPES

Activity Extra: Limit available options in launched activity based on the given account types.

This can be passed as an extra field in an Activity Intent with one or more account types as a String[]. This field is used by some intents to alter the behavior of the called activity.

Example: The ACTION_ADD_ACCOUNT intent restricts the account types to the specified list.

Constant Value: "account_types"

public static final String EXTRA_AUTHORITIES

Added in API level 8

Activity Extra: Limit available options in launched activity based on the given authority.

This can be passed as an extra field in an Activity Intent with one or more syncable content provider's authorities as a String[]. This field is used by some intents to alter the behavior of the called activity.

Example: The ACTION_ADD_ACCOUNT intent restricts the account types available based on the authority given.

Constant Value: "authorities"

public static final String EXTRA_INPUT_METHOD_ID

Constant Value: "input_method_id"

Public Constructors

public Settings ()

Added in API level 1