java.lang.Object | |
↳ | android.provider.Settings |
The Settings provider contains global system-level device preferences.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Settings.Global | Global system settings, containing preferences that always apply identically to all defined users. | ||||||||||
Settings.NameValueTable | Common base for tables of name/value settings. | ||||||||||
Settings.Secure | Secure system settings, containing system preferences that applications can read but are not allowed to write. | ||||||||||
Settings.SettingNotFoundException | |||||||||||
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_BATTERY_SAVER_SETTINGS | Activity Action: Show battery saver 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_CAST_SETTINGS | Activity Action: Show settings to allow configuration of cast endpoints. | |||||||||
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_HOME_SETTINGS | Activity Action: Show Home selection settings. | |||||||||
String | ACTION_IGNORE_BATTERY_OPTIMIZATION_SETTINGS | Activity Action: Show screen for controlling which apps can ignore battery optimizations. | |||||||||
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_MANAGE_OVERLAY_PERMISSION | Activity Action: Show screen for controlling which apps can draw on top of other apps. | |||||||||
String | ACTION_MANAGE_WRITE_SETTINGS | Activity Action: Show screen for controlling which apps are allowed to write/modify system settings. | |||||||||
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_NOTIFICATION_LISTENER_SETTINGS | Activity Action: Show Notification listener settings. | |||||||||
String | ACTION_NOTIFICATION_POLICY_ACCESS_SETTINGS | Activity Action: Show Do Not Disturb access 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_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS |
Activity Action: Ask the user to allow an to ignore battery optimizations (that is,
put them on the whitelist of apps shown by
ACTION_IGNORE_BATTERY_OPTIMIZATION_SETTINGS ).
|
|||||||||
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_SHOW_REGULATORY_INFO | Activity Action: Show the regulatory information screen for the device. | |||||||||
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_USAGE_ACCESS_SETTINGS | Activity Action: Show settings to control access to usage information. | |||||||||
String | ACTION_USER_DICTIONARY_SETTINGS | Activity Action: Show settings to manage the user input dictionary. | |||||||||
String | ACTION_VOICE_CONTROL_AIRPLANE_MODE | Activity Action: Modify Airplane mode settings using a voice command. | |||||||||
String | ACTION_VOICE_CONTROL_BATTERY_SAVER_MODE | Activity Action: Modify Battery Saver mode setting using a voice command. | |||||||||
String | ACTION_VOICE_CONTROL_DO_NOT_DISTURB_MODE | Activity Action: Modify do not disturb mode settings. | |||||||||
String | ACTION_VOICE_INPUT_SETTINGS | Activity Action: Show settings to configure input methods, in particular allowing the user to enable input methods. | |||||||||
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_AIRPLANE_MODE_ENABLED | Activity Extra: Enable or disable Airplane Mode. | |||||||||
String | EXTRA_AUTHORITIES | Activity Extra: Limit available options in launched activity based on the given authority. | |||||||||
String | EXTRA_BATTERY_SAVER_MODE_ENABLED | Activity Extra: Enable or disable Battery saver mode. | |||||||||
String | EXTRA_DO_NOT_DISTURB_MODE_ENABLED | Activity Extra: Enable or disable Do Not Disturb mode. | |||||||||
String | EXTRA_DO_NOT_DISTURB_MODE_MINUTES | Activity Extra: How many minutes to enable do not disturb mode for. | |||||||||
String | EXTRA_INPUT_METHOD_ID | ||||||||||
String | INTENT_CATEGORY_USAGE_ACCESS_CONFIG | Activity Category: Show application settings related to usage access. | |||||||||
String | METADATA_USAGE_ACCESS_REASON | Metadata key: Reason for needing usage access. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
An app can use this method to check if it is currently allowed to draw on top of other
apps.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
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.
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.
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.
Activity Action: Show settings to allow configuration of APNs.
Input: Nothing.
Output: Nothing.
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.
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.
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.
Activity Action: Show battery saver settings.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
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.
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.
Activity Action: Show settings to allow configuration of cast endpoints.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
Input: Nothing.
Output: Nothing.
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.
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.
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
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.
Activity Action: Show Daydream settings.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
Input: Nothing.
Output: Nothing.
Activity Action: Show Home selection settings. If there are multiple activities
that can satisfy the CATEGORY_HOME
intent, this screen allows you
to pick your preferred activity.
Activity Action: Show screen for controlling which apps can ignore battery optimizations.
Input: Nothing.
Output: Nothing.
You can use PowerManager.isIgnoringBatteryOptimizations()
to determine if an application is
already ignoring optimizations. You can use
ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS
to ask the user to put you
on this list.
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.
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.
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.
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.
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.
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.
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.
Activity Action: Show screen for controlling which apps can draw on top of other apps.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
Input: Optionally, the Intent's data URI can specify the application package name to directly invoke the management GUI specific to the package name. For example "package:com.my.app".
Output: Nothing.
Activity Action: Show screen for controlling which apps are allowed to write/modify system settings.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
Input: Optionally, the Intent's data URI can specify the application package name to directly invoke the management GUI specific to the package name. For example "package:com.my.app".
Output: Nothing.
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.
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.
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
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
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
Activity Action: Show Notification listener settings.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
Input: Nothing.
Output: Nothing.
Activity Action: Show Do Not Disturb access settings.
Users can grant and deny access to Do Not Disturb configuration from here.
See isNotificationPolicyAccessGranted()
for more
details.
Input: Nothing.
Output: Nothing.
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.
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.
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.
Activity Action: Ask the user to allow an to ignore battery optimizations (that is,
put them on the whitelist of apps shown by
ACTION_IGNORE_BATTERY_OPTIMIZATION_SETTINGS
). For an app to use this, it also
must hold the REQUEST_IGNORE_BATTERY_OPTIMIZATIONS
permission.
Note: most applications should not use this; there are many facilities provided by the platform for applications to operate correctly in the various power saving mode. This is only for unusual applications that need to deeply control their own execution, at the potential expense of the user's battery life. Note that these applications greatly run the risk of showing to the user has how power consumers on their device.
Input: The Intent's data URI must specify the application package name to be shown, with the "package" scheme. That is "package:com.my.app".
Output: Nothing.
You can use PowerManager.isIgnoringBatteryOptimizations()
to determine if an application is
already ignoring optimizations.
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
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.
Activity Action: Show system settings.
Input: Nothing.
Output: Nothing.
Activity Action: Show the regulatory information screen for the device.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
Input: Nothing.
Output: Nothing.
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.
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.
Activity Action: Show settings to control access to usage information.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
Input: Nothing.
Output: Nothing.
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.
Activity Action: Modify Airplane mode settings using a voice command.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
This intent MUST be started using
startVoiceActivity
.
Note: The activity implementing this intent MUST verify that
isVoiceInteraction
returns true before
modifying the setting.
Input: To tell which state airplane mode should be set to, add the
EXTRA_AIRPLANE_MODE_ENABLED
extra to this Intent with the state specified.
If the extra is not included, no changes will be made.
Output: Nothing.
Activity Action: Modify Battery Saver mode setting using a voice command.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
This intent MUST be started using
startVoiceActivity
.
Note: The activity implementing this intent MUST verify that
isVoiceInteraction
returns true before
modifying the setting.
Input: To tell which state batter saver mode should be set to, add the
EXTRA_BATTERY_SAVER_MODE_ENABLED
extra to this Intent with the state specified.
If the extra is not included, no changes will be made.
Output: Nothing.
Activity Action: Modify do not disturb mode settings.
In some cases, a matching Activity may not exist, so ensure you safeguard against this.
This intent MUST be started using
startVoiceActivity
.
Note: The Activity implementing this intent MUST verify that
isVoiceInteraction
.
returns true before modifying the setting.
Input: The optional EXTRA_DO_NOT_DISTURB_MODE_MINUTES
extra can be used to indicate
how long the user wishes to avoid interruptions for. The optional
EXTRA_DO_NOT_DISTURB_MODE_ENABLED
extra can be to indicate if the user is
enabling or disabling do not disturb mode. If either extra is not included, the
user maybe asked to provide the value.
Output: Nothing.
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.
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.
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.
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.
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.
Activity Extra: Enable or disable Airplane Mode.
This can be passed as an extra field to the ACTION_VOICE_CONTROL_AIRPLANE_MODE
intent as a boolean to indicate if it should be enabled.
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.
Activity Extra: Enable or disable Battery saver mode.
This can be passed as an extra field to the ACTION_VOICE_CONTROL_BATTERY_SAVER_MODE
intent as a boolean to indicate if it should be enabled.
Activity Extra: Enable or disable Do Not Disturb mode.
This can be passed as an extra field to the ACTION_VOICE_CONTROL_DO_NOT_DISTURB_MODE
intent as a boolean to indicate if it should be enabled.
Activity Extra: How many minutes to enable do not disturb mode for.
This can be passed as an extra field to the ACTION_VOICE_CONTROL_DO_NOT_DISTURB_MODE
intent to indicate how long do not disturb mode should be enabled for.
Activity Category: Show application settings related to usage access.
An activity that provides a user interface for adjusting usage access related
preferences for its containing application. Optional but recommended for apps that
use PACKAGE_USAGE_STATS
.
The activity may define meta-data to describe what usage access is
used for within their app with METADATA_USAGE_ACCESS_REASON
, which
will be displayed in Settings.
Input: Nothing.
Output: Nothing.
Metadata key: Reason for needing usage access.
A key for metadata attached to an activity that receives action
INTENT_CATEGORY_USAGE_ACCESS_CONFIG
, shown to the
user as description of how the app uses usage access.
An app can use this method to check if it is currently allowed to draw on top of other
apps. In order to be allowed to do so, an app must first declare the
SYSTEM_ALERT_WINDOW
permission in its manifest. If it
is currently disallowed, it can prompt the user to grant it this capability through a
management UI by sending an Intent with action
ACTION_MANAGE_OVERLAY_PERMISSION
.
context | A context |
---|