Added in API level 8

Summary: Constants | Inherited Constants | Ctors | Methods | Inherited Methods

BackupAgent

Kotlin |Java

public abstract class BackupAgent
extends ContextWrapper

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.backup.BackupAgent

Known direct subclasses

BackupAgentHelper

BackupAgentHelper A convenient BackupAgent wrapper class that automatically manages heterogeneous data sets within the backup data, each identified by a unique key prefix.

Provides the central interface between an application and Android's data backup infrastructure. An application that wishes to participate in the backup and restore mechanism will declare a subclass of BackupAgent, implement the onBackup() and onRestore() methods, and provide the name of its backup agent class in its AndroidManifest.xml file via the <application> tag's android:backupAgent attribute.

Developer Guides

For more information about using BackupAgent, read the Data Backup developer guide.

Basic Operation

When the application makes changes to data that it wishes to keep backed up, it should call the BackupManager.dataChanged() method. This notifies the Android Backup Manager that the application needs an opportunity to update its backup image. The Backup Manager, in turn, schedules a backup pass to be performed at an opportune time.

Restore operations are typically performed only when applications are first installed on a device. At that time, the operating system checks to see whether there is a previously-saved data set available for the application being installed, and if so, begins an immediate restore pass to deliver the backup data as part of the installation process.

When a backup or restore pass is run, the application's process is launched (if not already running), the manifest-declared backup agent class (in the android:backupAgent attribute) is instantiated within that process, and the agent's onCreate() method is invoked. This prepares the agent instance to run the actual backup or restore logic. At this point the agent's onBackup() or onRestore() method will be invoked as appropriate for the operation being performed.

A backup data set consists of one or more "entities," flattened binary data records that are each identified with a key string unique within the data set. Adding a record to the active data set or updating an existing record is done by simply writing new entity data under the desired key. Deleting an entity from the data set is done by writing an entity under that key with header specifying a negative data size, and no actual entity data.

Helper Classes

An extensible agent based on convenient helper classes is available in BackupAgentHelper. That class is particularly suited to handling of simple file or SharedPreferences backup and restore.

Threading

The constructor, as well as onCreate() and onDestroy() lifecycle callbacks run on the main thread (UI thread) of the application that implements the BackupAgent. The data-handling callbacks: onBackup(), onFullBackup(android.app.backup.FullBackupDataOutput), onRestore(), onRestoreFile(), onRestoreFinished(), and onQuotaExceeded() run on binder pool threads.

See also:

Summary

Constants
`int`	`FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED` Flag for `BackupDataOutput#getTransportFlags()` and `FullBackupDataOutput#getTransportFlags()` only.
`int`	`FLAG_DEVICE_TO_DEVICE_TRANSFER` Flag for `BackupDataOutput#getTransportFlags()` and `FullBackupDataOutput#getTransportFlags()` only.
`int`	`TYPE_DIRECTORY` During a full restore, indicates that the file system object being restored is a directory.
`int`	`TYPE_FILE` During a full restore, indicates that the file system object being restored is an ordinary file.

Inherited constants

From class android.content.Context

`String`	`ACCESSIBILITY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `AccessibilityManager` for giving the user feedback for UI events through the registered event listeners.
`String`	`ACCOUNT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `AccountManager` for receiving intents at a time of your choosing.
`String`	`ACTIVITY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `ActivityManager` for interacting with the global system state.
`String`	`ALARM_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `AlarmManager` for receiving intents at a time of your choosing.
`String`	`APPWIDGET_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `AppWidgetManager` for accessing AppWidgets.
`String`	`APP_OPS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `AppOpsManager` for tracking application operations on the device.
`String`	`APP_SEARCH_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve an `AppSearchManager` for indexing and querying app data managed by the system.
`String`	`AUDIO_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `AudioManager` for handling management of volume, ringer modes and audio routing.
`String`	`BATTERY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `BatteryManager` for managing battery state.
`int`	`BIND_ABOVE_CLIENT` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: indicates that the client application binding to this service considers the service to be more important than the app itself.
`int`	`BIND_ADJUST_WITH_ACTIVITY` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: If binding from an activity, allow the target service's process importance to be raised based on whether the activity is visible to the user, regardless whether another flag is used to reduce the amount that the client process's overall importance is used to impact it.
`int`	`BIND_ALLOW_ACTIVITY_STARTS` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: If binding from an app that is visible, the bound service is allowed to start an activity from background.
`int`	`BIND_ALLOW_OOM_MANAGEMENT` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: allow the process hosting the bound service to go through its normal memory management.
`int`	`BIND_AUTO_CREATE` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: automatically create the service as long as the binding exists.
`int`	`BIND_DEBUG_UNBIND` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: include debugging help for mismatched calls to unbind.
`int`	`BIND_EXTERNAL_SERVICE` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: The service being bound is an `isolated`, `external` service.
`long`	`BIND_EXTERNAL_SERVICE_LONG` Works in the same way as `BIND_EXTERNAL_SERVICE`, but it's defined as a `long` value that is compatible to `BindServiceFlags`.
`int`	`BIND_IMPORTANT` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: this service is very important to the client, so should be brought to the foreground process level when the client is.
`int`	`BIND_INCLUDE_CAPABILITIES` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: If binding from an app that has specific capabilities due to its foreground state such as an activity or foreground service, then this flag will allow the bound app to get the same capabilities, as long as it has the required permissions as well.
`int`	`BIND_NOT_FOREGROUND` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: don't allow this binding to raise the target service's process to the foreground scheduling priority.
`int`	`BIND_NOT_PERCEPTIBLE` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: If binding from an app that is visible or user-perceptible, lower the target service's importance to below the perceptible level.
`int`	`BIND_PACKAGE_ISOLATED_PROCESS` Flag for `bindIsolatedService(Intent, BindServiceFlags, String, Executor, ServiceConnection)`: Bind the service into a shared isolated process, but only with other isolated services from the same package that declare the same process name.
`int`	`BIND_SHARED_ISOLATED_PROCESS` Flag for `bindIsolatedService(Intent, BindServiceFlags, String, Executor, ServiceConnection)`: Bind the service into a shared isolated process.
`int`	`BIND_WAIVE_PRIORITY` Flag for `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`: don't impact the scheduling or memory management priority of the target service's hosting process.
`String`	`BIOMETRIC_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `BiometricManager` for handling biometric and PIN/pattern/password authentication.
`String`	`BLOB_STORE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `BlobStoreManager` for contributing and accessing data blobs from the blob store maintained by the system.
`String`	`BLUETOOTH_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `BluetoothManager` for using Bluetooth.
`String`	`BUGREPORT_SERVICE` Service to capture a bugreport.
`String`	`CAMERA_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `CameraManager` for interacting with camera devices.
`String`	`CAPTIONING_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `CaptioningManager` for obtaining captioning properties and listening for changes in captioning preferences.
`String`	`CARRIER_CONFIG_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `CarrierConfigManager` for reading carrier configuration values.
`String`	`CLIPBOARD_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `ClipboardManager` for accessing and modifying the contents of the global clipboard.
`String`	`COMPANION_DEVICE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `CompanionDeviceManager` for managing companion devices
`String`	`CONNECTIVITY_DIAGNOSTICS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `ConnectivityDiagnosticsManager` for performing network connectivity diagnostics as well as receiving network connectivity information from the system.
`String`	`CONNECTIVITY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `ConnectivityManager` for handling management of network connections.
`String`	`CONSUMER_IR_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `ConsumerIrManager` for transmitting infrared signals from the device.
`String`	`CONTACT_KEYS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `E2eeContactKeysManager` to managing contact keys.
`int`	`CONTEXT_IGNORE_SECURITY` Flag for use with `createPackageContext(String, int)`: ignore any security restrictions on the Context being requested, allowing it to always be loaded.
`int`	`CONTEXT_INCLUDE_CODE` Flag for use with `createPackageContext(String, int)`: include the application code with the context.
`int`	`CONTEXT_RESTRICTED` Flag for use with `createPackageContext(String, int)`: a restricted context may disable specific features.
`String`	`CREDENTIAL_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `CredentialManager` to authenticate a user to your app.
`String`	`CROSS_PROFILE_APPS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `CrossProfileApps` for cross profile operations.
`int`	`DEVICE_ID_DEFAULT` The default device ID, which is the ID of the primary (non-virtual) device.
`int`	`DEVICE_ID_INVALID` Invalid device ID.
`String`	`DEVICE_LOCK_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `DeviceLockManager`.
`String`	`DEVICE_POLICY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `DevicePolicyManager` for working with global device policy management.
`String`	`DISPLAY_HASH_SERVICE` Use with `getSystemService(java.lang.String)` to access `DisplayHashManager` to handle display hashes.
`String`	`DISPLAY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `DisplayManager` for interacting with display devices.
`String`	`DOMAIN_VERIFICATION_SERVICE` Use with `getSystemService(java.lang.String)` to access `DomainVerificationManager` to retrieve approval and user state for declared web domains.
`String`	`DOWNLOAD_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `DownloadManager` for requesting HTTP downloads.
`String`	`DROPBOX_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `DropBoxManager` instance for recording diagnostic logs.
`String`	`EUICC_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `EuiccManager` to manage the device eUICC (embedded SIM).
`String`	`FILE_INTEGRITY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve an `FileIntegrityManager`.
`String`	`FINGERPRINT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `FingerprintManager` for handling management of fingerprints.
`String`	`GAME_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `GameManager`.
`String`	`GRAMMATICAL_INFLECTION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `GrammaticalInflectionManager`.
`String`	`HARDWARE_PROPERTIES_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `HardwarePropertiesManager` for accessing the hardware properties service.
`String`	`HEALTHCONNECT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `HealthConnectManager`.
`String`	`INPUT_METHOD_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `InputMethodManager` for accessing input methods.
`String`	`INPUT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `InputManager` for interacting with input devices.
`String`	`IPSEC_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `IpSecManager` for encrypting Sockets or Networks with IPSec.
`String`	`JOB_SCHEDULER_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `JobScheduler` instance for managing occasional background tasks.
`String`	`KEYGUARD_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `KeyguardManager` for controlling keyguard.
`String`	`LAUNCHER_APPS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `LauncherApps` for querying and monitoring launchable apps across profiles of a user.
`String`	`LAYOUT_INFLATER_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `LayoutInflater` for inflating layout resources in this context.
`String`	`LOCALE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `LocaleManager`.
`String`	`LOCATION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `LocationManager` for controlling location updates.
`String`	`MEDIA_COMMUNICATION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `MediaCommunicationManager` for managing `MediaSession2`.
`String`	`MEDIA_METRICS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `MediaMetricsManager` for interacting with media metrics on the device.
`String`	`MEDIA_PROJECTION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `MediaProjectionManager` instance for managing media projection sessions.
`String`	`MEDIA_ROUTER_SERVICE` Use with `getSystemService(Class)` to retrieve a `MediaRouter` for controlling and managing routing of media.
`String`	`MEDIA_SESSION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `MediaSessionManager` for managing media Sessions.
`String`	`MIDI_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `MidiManager` for accessing the MIDI service.
`int`	`MODE_APPEND` File creation mode: for use with `openFileOutput(String, int)`, if the file already exists then write data to the end of the existing file instead of erasing it.
`int`	`MODE_ENABLE_WRITE_AHEAD_LOGGING` Database open flag: when set, the database is opened with write-ahead logging enabled by default.
`int`	`MODE_MULTI_PROCESS` This constant was deprecated in API level 23. MODE_MULTI_PROCESS does not work reliably in some versions of Android, and furthermore does not provide any mechanism for reconciling concurrent modifications across processes. Applications should not attempt to use it. Instead, they should use an explicit cross-process data management approach such as `ContentProvider`.
`int`	`MODE_NO_LOCALIZED_COLLATORS` Database open flag: when set, the database is opened without support for localized collators.
`int`	`MODE_PRIVATE` File creation mode: the default mode, where the created file can only be accessed by the calling application (or all applications sharing the same user ID).
`int`	`MODE_WORLD_READABLE` This constant was deprecated in API level 17. Creating world-readable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as `ContentProvider`, `BroadcastReceiver`, and `Service`. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
`int`	`MODE_WORLD_WRITEABLE` This constant was deprecated in API level 17. Creating world-writable files is very dangerous, and likely to cause security holes in applications. It is strongly discouraged; instead, applications should use more formal mechanism for interactions such as `ContentProvider`, `BroadcastReceiver`, and `Service`. There are no guarantees that this access mode will remain on a file, such as when it goes through a backup and restore.
`String`	`NETWORK_STATS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `NetworkStatsManager` for querying network usage stats.
`String`	`NFC_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `NfcManager` for using NFC.
`String`	`NOTIFICATION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `NotificationManager` for informing the user of background events.
`String`	`NSD_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `NsdManager` for handling management of network service discovery
`String`	`OVERLAY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `OverlayManager` for managing overlay packages.
`String`	`PEOPLE_SERVICE` Use with `getSystemService(java.lang.String)` to access a `PeopleManager` to interact with your published conversations.
`String`	`PERFORMANCE_HINT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `PerformanceHintManager` for accessing the performance hinting service.
`String`	`PERSISTENT_DATA_BLOCK_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `PersistentDataBlockManager` instance for interacting with a storage device that lives across factory resets.
`String`	`POWER_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `PowerManager` for controlling power management, including "wake locks," which let you keep the device on while you're running long tasks.
`String`	`PRINT_SERVICE` `PrintManager` for printing and managing printers and print tasks.
`String`	`PROFILING_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve an `ProfilingManager`.
`int`	`RECEIVER_EXPORTED` Flag for `registerReceiver(BroadcastReceiver, IntentFilter)`: The receiver can receive broadcasts from other Apps.
`int`	`RECEIVER_NOT_EXPORTED` Flag for `registerReceiver(BroadcastReceiver, IntentFilter)`: The receiver cannot receive broadcasts from other Apps.
`int`	`RECEIVER_VISIBLE_TO_INSTANT_APPS` Flag for `registerReceiver(BroadcastReceiver, IntentFilter)`: The receiver can receive broadcasts from Instant Apps.
`String`	`RESTRICTIONS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `RestrictionsManager` for retrieving application restrictions and requesting permissions for restricted operations.
`String`	`ROLE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `RoleManager` for managing roles.
`String`	`SEARCH_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `SearchManager` for handling searches.
`String`	`SECURITY_STATE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `SecurityStateManager` for accessing the security state manager service.
`String`	`SENSOR_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `SensorManager` for accessing sensors.
`String`	`SHORTCUT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `ShortcutManager` for accessing the launcher shortcut service.
`String`	`STATUS_BAR_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `StatusBarManager` for interacting with the status bar and quick settings.
`String`	`STORAGE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `StorageManager` for accessing system storage functions.
`String`	`STORAGE_STATS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `StorageStatsManager` for accessing system storage statistics.
`String`	`SYSTEM_HEALTH_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `SystemHealthManager` for accessing system health (battery, power, memory, etc) metrics.
`String`	`TELECOM_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `TelecomManager` to manage telecom-related features of the device.
`String`	`TELEPHONY_IMS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve an `ImsManager`.
`String`	`TELEPHONY_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `TelephonyManager` for handling management the telephony features of the device.
`String`	`TELEPHONY_SUBSCRIPTION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `SubscriptionManager` for handling management the telephony subscriptions of the device.
`String`	`TEXT_CLASSIFICATION_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `TextClassificationManager` for text classification services.
`String`	`TEXT_SERVICES_MANAGER_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `TextServicesManager` for accessing text services.
`String`	`TV_INPUT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `TvInputManager` for interacting with TV inputs on the device.
`String`	`TV_INTERACTIVE_APP_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `TvInteractiveAppManager` for interacting with TV interactive applications on the device.
`String`	`UI_MODE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `UiModeManager` for controlling UI modes.
`String`	`USAGE_STATS_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `UsageStatsManager` for querying device usage stats.
`String`	`USB_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `UsbManager` for access to USB devices (as a USB host) and for controlling this device's behavior as a USB device.
`String`	`USER_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `UserManager` for managing users on devices that support multiple users.
`String`	`VIBRATOR_MANAGER_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `VibratorManager` for accessing the device vibrators, interacting with individual ones and playing synchronized effects on multiple vibrators.
`String`	`VIBRATOR_SERVICE` This constant was deprecated in API level 31. Use `VibratorManager` to retrieve the default system vibrator.
`String`	`VIRTUAL_DEVICE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `VirtualDeviceManager` for managing virtual devices.
`String`	`VPN_MANAGEMENT_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `VpnManager` to manage profiles for the platform built-in VPN.
`String`	`WALLPAPER_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a com.android.server.WallpaperService for accessing wallpapers.
`String`	`WIFI_AWARE_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `WifiAwareManager` for handling management of Wi-Fi Aware.
`String`	`WIFI_P2P_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `WifiP2pManager` for handling management of Wi-Fi peer-to-peer connections.
`String`	`WIFI_RTT_RANGING_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `WifiRttManager` for ranging devices with wifi.
`String`	`WIFI_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `WifiManager` for handling management of Wi-Fi access.
`String`	`WINDOW_SERVICE` Use with `getSystemService(java.lang.String)` to retrieve a `WindowManager` for accessing the system's window manager.

Public constructors
`BackupAgent()`

Public methods
`final void`	`fullBackupFile(File file, FullBackupDataOutput output)` Write an entire file as part of a full-backup operation.
`abstract void`	`onBackup(ParcelFileDescriptor oldState, BackupDataOutput data, ParcelFileDescriptor newState)` The application is being asked to write any data changed since the last time it performed a backup operation.
`void`	`onCreate()` Provided as a convenience for agent implementations that need an opportunity to do one-time initialization before the actual backup or restore operation is begun.
`void`	`onDestroy()` Provided as a convenience for agent implementations that need to do some sort of shutdown process after backup or restore is completed.
`void`	`onFullBackup(FullBackupDataOutput data)` The application is having its entire file system contents backed up.
`void`	`onQuotaExceeded(long backupDataBytes, long quotaBytes)` Notification that the application's current backup operation causes it to exceed the maximum size permitted by the transport.
`abstract void`	`onRestore(BackupDataInput data, int appVersionCode, ParcelFileDescriptor newState)` The application is being restored from backup and should replace any existing data with the contents of the backup.
`void`	`onRestore(BackupDataInput data, long appVersionCode, ParcelFileDescriptor newState)` New version of `onRestore(android.app.backup.BackupDataInput, int, android.os.ParcelFileDescriptor)` that handles a long app version code.
`void`	`onRestoreFile(ParcelFileDescriptor data, long size, File destination, int type, long mode, long mtime)` Handle the data delivered via the given file descriptor during a full restore operation.
`void`	`onRestoreFinished()` The application's restore operation has completed.

Inherited methods

From class


        
          android.content.ContextWrapper

`void`	`attachBaseContext(Context base)` Set the base context for this ContextWrapper.
`boolean`	`bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)` Variation of `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)` that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.
`boolean`	`bindService(Intent service, int flags, Executor executor, ServiceConnection conn)` Same as `bindService(Intent, ServiceConnection, int)` with executor to control ServiceConnection callbacks.
`boolean`	`bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags)` See `bindService(android.content.Intent, android.content.ServiceConnection, int)` Call `BindServiceFlags#of(long)` to obtain a BindServiceFlags object.
`boolean`	`bindService(Intent service, ServiceConnection conn, int flags)` Connects to an application service, creating it if needed.
`boolean`	`bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)` See `bindService(android.content.Intent, int, java.util.concurrent.Executor, android.content.ServiceConnection)` Call `BindServiceFlags#of(long)` to obtain a BindServiceFlags object.
`int`	`checkCallingOrSelfPermission(String permission)` Determine whether the calling process of an IPC or you have been granted a particular permission.
`int`	`checkCallingOrSelfUriPermission(Uri uri, int modeFlags)` Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
`int[]`	`checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)` Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.
`int`	`checkCallingPermission(String permission)` Determine whether the calling process of an IPC you are handling has been granted a particular permission.
`int`	`checkCallingUriPermission(Uri uri, int modeFlags)` Determine whether the calling process and uid has been granted permission to access a specific URI.
`int[]`	`checkCallingUriPermissions(List<Uri> uris, int modeFlags)` Determine whether the calling process and uid has been granted permission to access a list of URIs.
`int`	`checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags)` Determine whether a particular process and uid has been granted permission to access a specific content URI.
`int`	`checkPermission(String permission, int pid, int uid)` Determine whether the given permission is allowed for a particular process and user ID running in the system.
`int`	`checkSelfPermission(String permission)` Determine whether you have been granted a particular permission.
`int`	`checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)` Check both a Uri and normal permission.
`int`	`checkUriPermission(Uri uri, int pid, int uid, int modeFlags)` Determine whether a particular process and uid has been granted permission to access a specific URI.
`int[]`	`checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)` Determine whether a particular process and uid has been granted permission to access a list of URIs.
`void`	`clearWallpaper()` This method is deprecated. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `Manifest.permission.SET_WALLPAPER`.
`Context`	`createAttributionContext(String attributionTag)` Return a new Context object for the current Context but attribute to a different tag.
`Context`	`createConfigurationContext(Configuration overrideConfiguration)` Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
`Context`	`createContext(ContextParams contextParams)` Creates a context with specific properties and behaviors.
`Context`	`createDeviceContext(int deviceId)` Returns a new `Context` object from the current context but with device association given by the `deviceId`.
`Context`	`createDeviceProtectedStorageContext()` Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
`Context`	`createDisplayContext(Display display)` Returns a new `Context` object from the current context but with resources adjusted to match the metrics of `display`.
`Context`	`createPackageContext(String packageName, int flags)` Return a new Context object for the given application name.
`Context`	`createWindowContext(int type, Bundle options)` Creates a Context for a non-activity window.
`Context`	`createWindowContext(Display display, int type, Bundle options)` Creates a `Context` for a non-`activity` window on the given `Display`.
`String[]`	`databaseList()` Returns an array of strings naming the private databases associated with this Context's application package.
`boolean`	`deleteDatabase(String name)` Delete an existing private SQLiteDatabase associated with this Context's application package.
`boolean`	`deleteFile(String name)` Delete the given private file associated with this Context's application package.
`boolean`	`deleteSharedPreferences(String name)` Delete an existing shared preferences file.
`void`	`enforceCallingOrSelfPermission(String permission, String message)` If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
`void`	`enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)` If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
`void`	`enforceCallingPermission(String permission, String message)` If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
`void`	`enforceCallingUriPermission(Uri uri, int modeFlags, String message)` If the calling process and uid has not been granted permission to access a specific URI, throw `SecurityException`.
`void`	`enforcePermission(String permission, int pid, int uid, String message)` If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
`void`	`enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)` Enforce both a Uri and normal permission.
`void`	`enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)` If a particular process and uid has not been granted permission to access a specific URI, throw `SecurityException`.
`String[]`	`fileList()` Returns an array of strings naming the private files associated with this Context's application package.
`Context`	`getApplicationContext()` Return the context of the single, global Application object of the current process.
`ApplicationInfo`	`getApplicationInfo()` Return the full application info for this context's package.
`AssetManager`	`getAssets()` Returns an AssetManager instance for the application's package.
`AttributionSource`	`getAttributionSource()`
`Context`	`getBaseContext()`
`File`	`getCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem.
`ClassLoader`	`getClassLoader()` Return a class loader you can use to retrieve classes in this package.
`File`	`getCodeCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
`ContentResolver`	`getContentResolver()` Return a ContentResolver instance for your application's package.
`File`	`getDataDir()` Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.
`File`	`getDatabasePath(String name)` Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, CursorFactory)` is stored.
`int`	`getDeviceId()` Gets the device ID this context is associated with.
`File`	`getDir(String name, int mode)` Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
`Display`	`getDisplay()` Get the display this context is associated with.
`File`	`getExternalCacheDir()` Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.
`File[]`	`getExternalCacheDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.
`File`	`getExternalFilesDir(String type)` Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.
`File[]`	`getExternalFilesDirs(String type)` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.
`File[]`	`getExternalMediaDirs()` This method is deprecated. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a `MediaStore` collection directly, as any app can contribute new media to `MediaStore` with no permissions required, starting in `Build.VERSION_CODES.Q`.
`File`	`getFileStreamPath(String name)` Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
`File`	`getFilesDir()` Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
`Executor`	`getMainExecutor()` Return an `Executor` that will run enqueued tasks on the main thread associated with this context.
`Looper`	`getMainLooper()` Return the Looper for the main thread of the current process.
`File`	`getNoBackupFilesDir()` Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
`File`	`getObbDir()` Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.
`File[]`	`getObbDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.
`String`	`getPackageCodePath()` Return the full path to this context's primary Android package.
`PackageManager`	`getPackageManager()` Return PackageManager instance to find global package information.
`String`	`getPackageName()` Return the name of this application's package.
`String`	`getPackageResourcePath()` Return the full path to this context's primary Android package.
`ContextParams`	`getParams()` Return the set of parameters which this Context was created with, if it was created via `createContext(android.content.ContextParams)`.
`Resources`	`getResources()` Returns a Resources instance for the application's package.
`SharedPreferences`	`getSharedPreferences(String name, int mode)` Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
`Object`	`getSystemService(String name)` Return the handle to a system-level service by name.
`String`	`getSystemServiceName(Class<?> serviceClass)` Gets the name of the system-level service that is represented by the specified class.
`Resources.Theme`	`getTheme()` Return the Theme object associated with this Context.
`Drawable`	`getWallpaper()` This method is deprecated. Use `WallpaperManager.get()` instead.
`int`	`getWallpaperDesiredMinimumHeight()` This method is deprecated. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
`int`	`getWallpaperDesiredMinimumWidth()` This method is deprecated. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
`void`	`grantUriPermission(String toPackage, Uri uri, int modeFlags)` Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
`boolean`	`isDeviceProtectedStorage()` Indicates if the storage APIs of this Context are backed by device-protected storage.
`boolean`	`isRestricted()` Indicates whether this Context is restricted.
`boolean`	`moveDatabaseFrom(Context sourceContext, String name)` Move an existing database file from the given source storage context to this context.
`boolean`	`moveSharedPreferencesFrom(Context sourceContext, String name)` Move an existing shared preferences file from the given source storage context to this context.
`FileInputStream`	`openFileInput(String name)` Open a private file associated with this Context's application package for reading.
`FileOutputStream`	`openFileOutput(String name, int mode)` Open a private file associated with this Context's application package for writing.
`SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)` Open a new private SQLiteDatabase associated with this Context's application package.
`SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)` Open a new private SQLiteDatabase associated with this Context's application package.
`Drawable`	`peekWallpaper()` This method is deprecated. Use `WallpaperManager.peek()` instead.
`void`	`registerComponentCallbacks(ComponentCallbacks callback)` Add a new `ComponentCallbacks` to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.
`void`	`registerDeviceIdChangeListener(Executor executor, IntConsumer listener)` Adds a new device ID changed listener to the `Context`, which will be called when the device association is changed by the system.
`Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter)` Register a BroadcastReceiver to be run in the main activity thread.
`Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags)` Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.
`Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)` Register to receive intent broadcasts, to run in the context of `scheduler`.
`Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)` Register to receive intent broadcasts, to run in the context of `scheduler`.
`void`	`removeStickyBroadcast(Intent intent)` This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`removeStickyBroadcastAsUser(Intent intent, UserHandle user)` This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`revokeSelfPermissionsOnKill(Collection<String> permissions)` Triggers the revocation of one or more permissions for the calling package.
`void`	`revokeUriPermission(Uri uri, int modeFlags)` Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)` or any other mechanism.
`void`	`revokeUriPermission(String targetPackage, Uri uri, int modeFlags)` Remove permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)` for a specific target package.
`void`	`sendBroadcast(Intent intent, String receiverPermission, Bundle options)` Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
`void`	`sendBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
`void`	`sendBroadcast(Intent intent)` Broadcast the given intent to all interested BroadcastReceivers.
`void`	`sendBroadcastAsUser(Intent intent, UserHandle user)` Version of `sendBroadcast(android.content.Intent)` that allows you to specify the user the broadcast will be sent to.
`void`	`sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)` Version of `sendBroadcast(android.content.Intent, java.lang.String)` that allows you to specify the user the broadcast will be sent to.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)` that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.
`void`	`sendOrderedBroadcast(Intent intent, int initialCode, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, String initialData, Bundle initialExtras, Bundle options)`
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendBroadcast(android.content.Intent)` that allows you to receive data back from the broadcast.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options)` Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendBroadcast(android.content.Intent)` that allows you to receive data back from the broadcast.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
`void`	`sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)` that allows you to specify the user the broadcast will be sent to.
`void`	`sendStickyBroadcast(Intent intent)` This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyBroadcast(Intent intent, Bundle options)` This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyBroadcastAsUser(Intent intent, UserHandle user)` This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`setTheme(int resid)` Set the base theme for this context.
`void`	`setWallpaper(Bitmap bitmap)` This method is deprecated. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `Manifest.permission.SET_WALLPAPER`.
`void`	`setWallpaper(InputStream data)` This method is deprecated. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `Manifest.permission.SET_WALLPAPER`.
`void`	`startActivities(Intent[] intents, Bundle options)` Launch multiple new activities.
`void`	`startActivities(Intent[] intents)` Same as `startActivities(android.content.Intent[], android.os.Bundle)` with no options specified.
`void`	`startActivity(Intent intent)` Same as `startActivity(android.content.Intent, android.os.Bundle)` with no options specified.
`void`	`startActivity(Intent intent, Bundle options)` Launch a new activity.
`ComponentName`	`startForegroundService(Intent service)` Similar to `startService(android.content.Intent)`, but with an implicit promise that the Service will call `startForeground(int, android.app.Notification)` once it begins running.
`boolean`	`startInstrumentation(ComponentName className, String profileFile, Bundle arguments)` Start executing an `Instrumentation` class.
`void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)` Same as `startIntentSender(android.content.IntentSender, android.content.Intent, int, int, int, android.os.Bundle)` with no options specified.
`void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Like `startActivity(android.content.Intent, android.os.Bundle)`, but taking a IntentSender to start.
`ComponentName`	`startService(Intent service)` Request that a given application service be started.
`boolean`	`stopService(Intent name)` Request that a given application service be stopped.
`void`	`unbindService(ServiceConnection conn)` Disconnect from an application service.
`void`	`unregisterComponentCallbacks(ComponentCallbacks callback)` Remove a `ComponentCallbacks` object that was previously registered with `registerComponentCallbacks(android.content.ComponentCallbacks)`.
`void`	`unregisterDeviceIdChangeListener(IntConsumer listener)` Removes a device ID changed listener from the Context.
`void`	`unregisterReceiver(BroadcastReceiver receiver)` Unregister a previously registered BroadcastReceiver.
`void`	`updateServiceGroup(ServiceConnection conn, int group, int importance)` For a service previously bound with `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)` or a related method, change how the system manages that service's process in relation to other processes.

From class


        
          android.content.Context

`boolean`	`bindIsolatedService(Intent service, int flags, String instanceName, Executor executor, ServiceConnection conn)` Variation of `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)` that, in the specific case of isolated services, allows the caller to generate multiple instances of a service from a single component declaration.
`boolean`	`bindIsolatedService(Intent service, Context.BindServiceFlags flags, String instanceName, Executor executor, ServiceConnection conn)` See `bindIsolatedService(android.content.Intent, int, java.lang.String, java.util.concurrent.Executor, android.content.ServiceConnection)` Call `BindServiceFlags#of(long)` to obtain a BindServiceFlags object.
`boolean`	`bindService(Intent service, int flags, Executor executor, ServiceConnection conn)` Same as `bindService(Intent, ServiceConnection, int)` with executor to control ServiceConnection callbacks.
`boolean`	`bindService(Intent service, ServiceConnection conn, Context.BindServiceFlags flags)` See `bindService(android.content.Intent, android.content.ServiceConnection, int)` Call `BindServiceFlags#of(long)` to obtain a BindServiceFlags object.
`abstract boolean`	`bindService(Intent service, ServiceConnection conn, int flags)` Connects to an application service, creating it if needed.
`boolean`	`bindService(Intent service, Context.BindServiceFlags flags, Executor executor, ServiceConnection conn)` See `bindService(android.content.Intent, int, java.util.concurrent.Executor, android.content.ServiceConnection)` Call `BindServiceFlags#of(long)` to obtain a BindServiceFlags object.
`boolean`	`bindServiceAsUser(Intent service, ServiceConnection conn, int flags, UserHandle user)` Binds to a service in the given `user` in the same manner as `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)`.
`boolean`	`bindServiceAsUser(Intent service, ServiceConnection conn, Context.BindServiceFlags flags, UserHandle user)` See `bindServiceAsUser(android.content.Intent, android.content.ServiceConnection, int, android.os.UserHandle)` Call `BindServiceFlags#of(long)` to obtain a BindServiceFlags object.
`abstract int`	`checkCallingOrSelfPermission(String permission)` Determine whether the calling process of an IPC or you have been granted a particular permission.
`abstract int`	`checkCallingOrSelfUriPermission(Uri uri, int modeFlags)` Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
`int[]`	`checkCallingOrSelfUriPermissions(List<Uri> uris, int modeFlags)` Determine whether the calling process of an IPC or you has been granted permission to access a list of URIs.
`abstract int`	`checkCallingPermission(String permission)` Determine whether the calling process of an IPC you are handling has been granted a particular permission.
`abstract int`	`checkCallingUriPermission(Uri uri, int modeFlags)` Determine whether the calling process and uid has been granted permission to access a specific URI.
`int[]`	`checkCallingUriPermissions(List<Uri> uris, int modeFlags)` Determine whether the calling process and uid has been granted permission to access a list of URIs.
`int`	`checkContentUriPermissionFull(Uri uri, int pid, int uid, int modeFlags)` Determine whether a particular process and uid has been granted permission to access a specific content URI.
`abstract int`	`checkPermission(String permission, int pid, int uid)` Determine whether the given permission is allowed for a particular process and user ID running in the system.
`abstract int`	`checkSelfPermission(String permission)` Determine whether you have been granted a particular permission.
`abstract int`	`checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags)` Check both a Uri and normal permission.
`abstract int`	`checkUriPermission(Uri uri, int pid, int uid, int modeFlags)` Determine whether a particular process and uid has been granted permission to access a specific URI.
`int[]`	`checkUriPermissions(List<Uri> uris, int pid, int uid, int modeFlags)` Determine whether a particular process and uid has been granted permission to access a list of URIs.
`abstract void`	`clearWallpaper()` This method was deprecated in API level 15. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `Manifest.permission.SET_WALLPAPER`.
`Context`	`createAttributionContext(String attributionTag)` Return a new Context object for the current Context but attribute to a different tag.
`abstract Context`	`createConfigurationContext(Configuration overrideConfiguration)` Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
`Context`	`createContext(ContextParams contextParams)` Creates a context with specific properties and behaviors.
`abstract Context`	`createContextForSplit(String splitName)` Return a new Context object for the given split name.
`Context`	`createDeviceContext(int deviceId)` Returns a new `Context` object from the current context but with device association given by the `deviceId`.
`abstract Context`	`createDeviceProtectedStorageContext()` Return a new Context object for the current Context but whose storage APIs are backed by device-protected storage.
`abstract Context`	`createDisplayContext(Display display)` Returns a new `Context` object from the current context but with resources adjusted to match the metrics of `display`.
`abstract Context`	`createPackageContext(String packageName, int flags)` Return a new Context object for the given application name.
`Context`	`createWindowContext(int type, Bundle options)` Creates a Context for a non-activity window.
`Context`	`createWindowContext(Display display, int type, Bundle options)` Creates a `Context` for a non-`activity` window on the given `Display`.
`abstract String[]`	`databaseList()` Returns an array of strings naming the private databases associated with this Context's application package.
`abstract boolean`	`deleteDatabase(String name)` Delete an existing private SQLiteDatabase associated with this Context's application package.
`abstract boolean`	`deleteFile(String name)` Delete the given private file associated with this Context's application package.
`abstract boolean`	`deleteSharedPreferences(String name)` Delete an existing shared preferences file.
`abstract void`	`enforceCallingOrSelfPermission(String permission, String message)` If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
`abstract void`	`enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message)` If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
`abstract void`	`enforceCallingPermission(String permission, String message)` If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
`abstract void`	`enforceCallingUriPermission(Uri uri, int modeFlags, String message)` If the calling process and uid has not been granted permission to access a specific URI, throw `SecurityException`.
`abstract void`	`enforcePermission(String permission, int pid, int uid, String message)` If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
`abstract void`	`enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message)` Enforce both a Uri and normal permission.
`abstract void`	`enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message)` If a particular process and uid has not been granted permission to access a specific URI, throw `SecurityException`.
`abstract String[]`	`fileList()` Returns an array of strings naming the private files associated with this Context's application package.
`abstract Context`	`getApplicationContext()` Return the context of the single, global Application object of the current process.
`abstract ApplicationInfo`	`getApplicationInfo()` Return the full application info for this context's package.
`abstract AssetManager`	`getAssets()` Returns an AssetManager instance for the application's package.
`AttributionSource`	`getAttributionSource()`
`String`	`getAttributionTag()` Attribution can be used in complex apps to logically separate parts of the app.
`abstract File`	`getCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem.
`abstract ClassLoader`	`getClassLoader()` Return a class loader you can use to retrieve classes in this package.
`abstract File`	`getCodeCacheDir()` Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
`final int`	`getColor(int id)` Returns a color associated with a particular resource ID and styled for the current theme.
`final ColorStateList`	`getColorStateList(int id)` Returns a color state list associated with a particular resource ID and styled for the current theme.
`abstract ContentResolver`	`getContentResolver()` Return a ContentResolver instance for your application's package.
`abstract File`	`getDataDir()` Returns the absolute path to the directory on the filesystem where all private files belonging to this app are stored.
`abstract File`	`getDatabasePath(String name)` Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, CursorFactory)` is stored.
`int`	`getDeviceId()` Gets the device ID this context is associated with.
`abstract File`	`getDir(String name, int mode)` Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
`Display`	`getDisplay()` Get the display this context is associated with.
`final Drawable`	`getDrawable(int id)` Returns a drawable object associated with a particular resource ID and styled for the current theme.
`abstract File`	`getExternalCacheDir()` Returns absolute path to application-specific directory on the primary shared/external storage device where the application can place cache files it owns.
`abstract File[]`	`getExternalCacheDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place cache files it owns.
`abstract File`	`getExternalFilesDir(String type)` Returns the absolute path to the directory on the primary shared/external storage device where the application can place persistent files it owns.
`abstract File[]`	`getExternalFilesDirs(String type)` Returns absolute paths to application-specific directories on all shared/external storage devices where the application can place persistent files it owns.
`abstract File[]`	`getExternalMediaDirs()` This method was deprecated in API level 30. These directories still exist and are scanned, but developers are encouraged to migrate to inserting content into a `MediaStore` collection directly, as any app can contribute new media to `MediaStore` with no permissions required, starting in `Build.VERSION_CODES.Q`.
`abstract File`	`getFileStreamPath(String name)` Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
`abstract File`	`getFilesDir()` Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
`Executor`	`getMainExecutor()` Return an `Executor` that will run enqueued tasks on the main thread associated with this context.
`abstract Looper`	`getMainLooper()` Return the Looper for the main thread of the current process.
`abstract File`	`getNoBackupFilesDir()` Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
`abstract File`	`getObbDir()` Return the primary shared/external storage directory where this application's OBB files (if there are any) can be found.
`abstract File[]`	`getObbDirs()` Returns absolute paths to application-specific directories on all shared/external storage devices where the application's OBB files (if there are any) can be found.
`String`	`getOpPackageName()` Return the package name that should be used for `AppOpsManager` calls from this context, so that app ops manager's uid verification will work with the name.
`abstract String`	`getPackageCodePath()` Return the full path to this context's primary Android package.
`abstract PackageManager`	`getPackageManager()` Return PackageManager instance to find global package information.
`abstract String`	`getPackageName()` Return the name of this application's package.
`abstract String`	`getPackageResourcePath()` Return the full path to this context's primary Android package.
`ContextParams`	`getParams()` Return the set of parameters which this Context was created with, if it was created via `createContext(android.content.ContextParams)`.
`abstract Resources`	`getResources()` Returns a Resources instance for the application's package.
`abstract SharedPreferences`	`getSharedPreferences(String name, int mode)` Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
`final String`	`getString(int resId)` Returns a localized string from the application's package's default string table.
`final String`	`getString(int resId, Object... formatArgs)` Returns a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `String.format(String, Object)`.
`final <T> T`	`getSystemService(Class<T> serviceClass)` Return the handle to a system-level service by class.
`abstract Object`	`getSystemService(String name)` Return the handle to a system-level service by name.
`abstract String`	`getSystemServiceName(Class<?> serviceClass)` Gets the name of the system-level service that is represented by the specified class.
`final CharSequence`	`getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`abstract Resources.Theme`	`getTheme()` Return the Theme object associated with this Context.
`abstract Drawable`	`getWallpaper()` This method was deprecated in API level 15. Use `WallpaperManager.get()` instead.
`abstract int`	`getWallpaperDesiredMinimumHeight()` This method was deprecated in API level 15. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
`abstract int`	`getWallpaperDesiredMinimumWidth()` This method was deprecated in API level 15. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
`abstract void`	`grantUriPermission(String toPackage, Uri uri, int modeFlags)` Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
`abstract boolean`	`isDeviceProtectedStorage()` Indicates if the storage APIs of this Context are backed by device-protected storage.
`boolean`	`isRestricted()` Indicates whether this Context is restricted.
`boolean`	`isUiContext()` Returns `true` if the context is a UI context which can access UI components such as `WindowManager`, `LayoutInflater` or `WallpaperManager`.
`abstract boolean`	`moveDatabaseFrom(Context sourceContext, String name)` Move an existing database file from the given source storage context to this context.
`abstract boolean`	`moveSharedPreferencesFrom(Context sourceContext, String name)` Move an existing shared preferences file from the given source storage context to this context.
`final TypedArray`	`obtainStyledAttributes(AttributeSet set, int[] attrs)` Retrieve styled attribute information in this Context's theme.
`final TypedArray`	`obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes)` Retrieve styled attribute information in this Context's theme.
`final TypedArray`	`obtainStyledAttributes(int resid, int[] attrs)` Retrieve styled attribute information in this Context's theme.
`final TypedArray`	`obtainStyledAttributes(int[] attrs)` Retrieve styled attribute information in this Context's theme.
`abstract FileInputStream`	`openFileInput(String name)` Open a private file associated with this Context's application package for reading.
`abstract FileOutputStream`	`openFileOutput(String name, int mode)` Open a private file associated with this Context's application package for writing.
`abstract SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler)` Open a new private SQLiteDatabase associated with this Context's application package.
`abstract SQLiteDatabase`	`openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory)` Open a new private SQLiteDatabase associated with this Context's application package.
`abstract Drawable`	`peekWallpaper()` This method was deprecated in API level 15. Use `WallpaperManager.peek()` instead.
`void`	`registerComponentCallbacks(ComponentCallbacks callback)` Add a new `ComponentCallbacks` to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.
`void`	`registerDeviceIdChangeListener(Executor executor, IntConsumer listener)` Adds a new device ID changed listener to the `Context`, which will be called when the device association is changed by the system.
`abstract Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter)` Register a BroadcastReceiver to be run in the main activity thread.
`abstract Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, int flags)` Register to receive intent broadcasts, with the receiver optionally being exposed to Instant Apps.
`abstract Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler, int flags)` Register to receive intent broadcasts, to run in the context of `scheduler`.
`abstract Intent`	`registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler)` Register to receive intent broadcasts, to run in the context of `scheduler`.
`abstract void`	`removeStickyBroadcast(Intent intent)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`removeStickyBroadcastAsUser(Intent intent, UserHandle user)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`revokeSelfPermissionOnKill(String permName)` Triggers the asynchronous revocation of a runtime permission.
`void`	`revokeSelfPermissionsOnKill(Collection<String> permissions)` Triggers the revocation of one or more permissions for the calling package.
`abstract void`	`revokeUriPermission(Uri uri, int modeFlags)` Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)` or any other mechanism.
`abstract void`	`revokeUriPermission(String toPackage, Uri uri, int modeFlags)` Remove permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)` for a specific target package.
`void`	`sendBroadcast(Intent intent, String receiverPermission, Bundle options)` Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
`abstract void`	`sendBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
`abstract void`	`sendBroadcast(Intent intent)` Broadcast the given intent to all interested BroadcastReceivers.
`abstract void`	`sendBroadcastAsUser(Intent intent, UserHandle user)` Version of `sendBroadcast(android.content.Intent)` that allows you to specify the user the broadcast will be sent to.
`abstract void`	`sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission)` Version of `sendBroadcast(android.content.Intent, java.lang.String)` that allows you to specify the user the broadcast will be sent to.
`void`	`sendBroadcastWithMultiplePermissions(Intent intent, String[] receiverPermissions)` Broadcast the given intent to all interested BroadcastReceivers, allowing an array of required permissions to be enforced.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, String receiverAppOp, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)` that allows you to specify the App Op to enforce restrictions on which receivers the broadcast will be sent to.
`abstract void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendBroadcast(android.content.Intent)` that allows you to receive data back from the broadcast.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options)` Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
`void`	`sendOrderedBroadcast(Intent intent, String receiverPermission, Bundle options, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendBroadcast(android.content.Intent)` that allows you to receive data back from the broadcast.
`abstract void`	`sendOrderedBroadcast(Intent intent, String receiverPermission)` Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
`abstract void`	`sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` Version of `sendOrderedBroadcast(android.content.Intent, java.lang.String, android.content.BroadcastReceiver, android.os.Handler, int, java.lang.String, android.os.Bundle)` that allows you to specify the user the broadcast will be sent to.
`abstract void`	`sendStickyBroadcast(Intent intent)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`void`	`sendStickyBroadcast(Intent intent, Bundle options)` This method was deprecated in API level 31. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`sendStickyBroadcastAsUser(Intent intent, UserHandle user)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras)` This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
`abstract void`	`setTheme(int resid)` Set the base theme for this context.
`abstract void`	`setWallpaper(Bitmap bitmap)` This method was deprecated in API level 15. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `Manifest.permission.SET_WALLPAPER`.
`abstract void`	`setWallpaper(InputStream data)` This method was deprecated in API level 15. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `Manifest.permission.SET_WALLPAPER`.
`abstract void`	`startActivities(Intent[] intents, Bundle options)` Launch multiple new activities.
`abstract void`	`startActivities(Intent[] intents)` Same as `startActivities(android.content.Intent[], android.os.Bundle)` with no options specified.
`abstract void`	`startActivity(Intent intent)` Same as `startActivity(android.content.Intent, android.os.Bundle)` with no options specified.
`abstract void`	`startActivity(Intent intent, Bundle options)` Launch a new activity.
`abstract ComponentName`	`startForegroundService(Intent service)` Similar to `startService(android.content.Intent)`, but with an implicit promise that the Service will call `startForeground(int, android.app.Notification)` once it begins running.
`abstract boolean`	`startInstrumentation(ComponentName className, String profileFile, Bundle arguments)` Start executing an `Instrumentation` class.
`abstract void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)` Same as `startIntentSender(android.content.IntentSender, android.content.Intent, int, int, int, android.os.Bundle)` with no options specified.
`abstract void`	`startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` Like `startActivity(android.content.Intent, android.os.Bundle)`, but taking a IntentSender to start.
`abstract ComponentName`	`startService(Intent service)` Request that a given application service be started.
`abstract boolean`	`stopService(Intent service)` Request that a given application service be stopped.
`abstract void`	`unbindService(ServiceConnection conn)` Disconnect from an application service.
`void`	`unregisterComponentCallbacks(ComponentCallbacks callback)` Remove a `ComponentCallbacks` object that was previously registered with `registerComponentCallbacks(android.content.ComponentCallbacks)`.
`void`	`unregisterDeviceIdChangeListener(IntConsumer listener)` Removes a device ID changed listener from the Context.
`abstract void`	`unregisterReceiver(BroadcastReceiver receiver)` Unregister a previously registered BroadcastReceiver.
`void`	`updateServiceGroup(ServiceConnection conn, int group, int importance)` For a service previously bound with `bindService(Intent, BindServiceFlags, Executor, ServiceConnection)` or a related method, change how the system manages that service's process in relation to other processes.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED

Added in API level 28

public static final int FLAG_CLIENT_SIDE_ENCRYPTION_ENABLED

Flag for BackupDataOutput#getTransportFlags() and FullBackupDataOutput#getTransportFlags() only.

The transport has client-side encryption enabled. i.e., the user's backup has been encrypted with a key known only to the device, and not to the remote storage solution. Even if an attacker had root access to the remote storage provider they should not be able to decrypt the user's backup data.

Constant Value: 1 (0x00000001)

FLAG_DEVICE_TO_DEVICE_TRANSFER

Added in API level 28

public static final int FLAG_DEVICE_TO_DEVICE_TRANSFER

Flag for BackupDataOutput#getTransportFlags() and FullBackupDataOutput#getTransportFlags() only.

The transport is for a device-to-device transfer. There is no third party or intermediate storage. The user's backup data is sent directly to another device over e.g., USB or WiFi.

Constant Value: 2 (0x00000002)

TYPE_DIRECTORY

Added in API level 14

public static final int TYPE_DIRECTORY

During a full restore, indicates that the file system object being restored is a directory.

Constant Value: 2 (0x00000002)

TYPE_FILE

Added in API level 14

public static final int TYPE_FILE

During a full restore, indicates that the file system object being restored is an ordinary file.

Constant Value: 1 (0x00000001)

Public constructors

BackupAgent

Added in API level 8

public BackupAgent ()

Public methods

fullBackupFile

Added in API level 14

public final void fullBackupFile (File file, 
                FullBackupDataOutput output)

Write an entire file as part of a full-backup operation. The file's contents will be delivered to the backup destination along with the metadata necessary to place it with the proper location and permissions on the device where the data is restored.

Attempting to back up files in directories that are ignored by the backup system will have no effect. For example, if the app calls this method with a file inside the ContextWrapper.getNoBackupFilesDir() directory, it will be ignored. See onFullBackup(android.app.backup.FullBackupDataOutput) for details on what directories are excluded from backups.

Parameters
`file`	`File`: The file to be backed up. The file must exist and be readable by the caller.
`output`	`FullBackupDataOutput`: The destination to which the backed-up file data will be sent.

onBackup

Added in API level 8

public abstract void onBackup (ParcelFileDescriptor oldState, 
                BackupDataOutput data, 
                ParcelFileDescriptor newState)

The application is being asked to write any data changed since the last time it performed a backup operation. The state data recorded during the last backup pass is provided in the oldState file descriptor. If oldState is null, no old state is available and the application should perform a full backup. In both cases, a representation of the final backup state after this pass should be written to the file pointed to by the file descriptor wrapped in newState.

Each entity written to the BackupDataOutput data stream will be transmitted over the current backup transport and stored in the remote data set under the key supplied as part of the entity. Writing an entity with a negative data size instructs the transport to delete whatever entity currently exists under that key from the remote data set.

Parameters
`oldState`	`ParcelFileDescriptor`: An open, read-only ParcelFileDescriptor pointing to the last backup state provided by the application. May be `null`, in which case no prior state is being provided and the application should perform a full backup.
`data`	`BackupDataOutput`: A structured wrapper around an open, read/write file descriptor pointing to the backup data destination. Typically the application will use backup helper classes to write to this file.
`newState`	`ParcelFileDescriptor`: An open, read/write ParcelFileDescriptor pointing to an empty file. The application should record the final backup state here after writing the requested data to the `data` output stream.

Throws
`IOException`

onCreate

Added in API level 8

public void onCreate ()

Provided as a convenience for agent implementations that need an opportunity to do one-time initialization before the actual backup or restore operation is begun.

onDestroy

Added in API level 8

public void onDestroy ()

Provided as a convenience for agent implementations that need to do some sort of shutdown process after backup or restore is completed.

Agents do not need to override this method.

onFullBackup

Added in API level 14

public void onFullBackup (FullBackupDataOutput data)

The application is having its entire file system contents backed up. data points to the backup destination, and the app has the opportunity to choose which files are to be stored. To commit a file as part of the backup, call the fullBackupFile(java.io.File, android.app.backup.FullBackupDataOutput) helper method. After all file data is written to the output, the agent returns from this method and the backup operation concludes.

Certain parts of the app's data are never backed up even if the app explicitly sends them to the output:

The contents of the ContextWrapper.getCacheDir() directory
The contents of the ContextWrapper.getCodeCacheDir() directory
The contents of the ContextWrapper.getNoBackupFilesDir() directory
The contents of the app's shared library directory

The default implementation of this method backs up the entirety of the application's "owned" file system trees to the output other than the few exceptions listed above. Apps only need to override this method if they need to impose special limitations on which files are being stored beyond the control that ContextWrapper.getNoBackupFilesDir() offers. Alternatively they can provide an xml resource to specify what data to include or exclude.

Parameters
`data`	`FullBackupDataOutput`: A structured wrapper pointing to the backup destination.

Throws
	java.io.IOException
`IOException`

See also:

onQuotaExceeded

Added in API level 24

public void onQuotaExceeded (long backupDataBytes, 
                long quotaBytes)

Notification that the application's current backup operation causes it to exceed the maximum size permitted by the transport. The ongoing backup operation is halted and rolled back: any data that had been stored by a previous backup operation is still intact. Typically the quota-exceeded state will be detected before any data is actually transmitted over the network.

The quotaBytes value is the total data size currently permitted for this application. If desired, the application can use this as a hint for determining how much data to store. For example, a messaging application might choose to store only the newest messages, dropping enough older content to stay under the quota.

Note that the maximum quota for the application can change over time. In particular, in the future the quota may grow. Applications that adapt to the quota when deciding what data to store should be aware of this and implement their data storage mechanisms in a way that can take advantage of additional quota.

Parameters
`backupDataBytes`	`long`: The amount of data measured while initializing the backup operation, if the total exceeds the app's alloted quota. If initial measurement suggested that the data would fit but then too much data was actually submitted as part of the operation, then this value is the amount of data that had been streamed into the transport at the time the quota was reached.
`quotaBytes`	`long`: The maximum data size that the transport currently permits this application to store as a backup.

onRestore

Added in API level 8

public abstract void onRestore (BackupDataInput data, 
                int appVersionCode, 
                ParcelFileDescriptor newState)

The application is being restored from backup and should replace any existing data with the contents of the backup. The backup data is provided through the data parameter. Once the restore is finished, the application should write a representation of the final state to the newState file descriptor.

The application is responsible for properly erasing its old data and replacing it with the data supplied to this method. No "clear user data" operation will be performed automatically by the operating system. The exception to this is in the case of a failed restore attempt: if onRestore() throws an exception, the OS will assume that the application's data may now be in an incoherent state, and will clear it before proceeding.

Parameters
`data`	`BackupDataInput`: A structured wrapper around an open, read-only file descriptor pointing to a full snapshot of the application's data. The application should consume every entity represented in this data stream.
`appVersionCode`	`int`: The value of the `android:versionCode` manifest attribute, from the application that backed up this particular data set. This makes it possible for an application's agent to distinguish among any possible older data versions when asked to perform the restore operation.
`newState`	`ParcelFileDescriptor`: An open, read/write ParcelFileDescriptor pointing to an empty file. The application should record the final backup state here after restoring its data from the `data` stream. When a full-backup dataset is being restored, this will be `null`.

Throws
`IOException`

onRestore

Added in API level 28

public void onRestore (BackupDataInput data, 
                long appVersionCode, 
                ParcelFileDescriptor newState)

New version of onRestore(android.app.backup.BackupDataInput, int, android.os.ParcelFileDescriptor) that handles a long app version code. Default implementation casts the version code to an int and calls onRestore(android.app.backup.BackupDataInput, int, android.os.ParcelFileDescriptor).

Parameters
`data`	`BackupDataInput`
`appVersionCode`	`long`
`newState`	`ParcelFileDescriptor`

Throws
`IOException`

onRestoreFile

Added in API level 14

public void onRestoreFile (ParcelFileDescriptor data, 
                long size, 
                File destination, 
                int type, 
                long mode, 
                long mtime)

Handle the data delivered via the given file descriptor during a full restore operation. The agent is given the path to the file's original location as well as its size and metadata.

The file descriptor can only be read for size bytes; attempting to read more data has undefined behavior.

The default implementation creates the destination file/directory and populates it with the data from the file descriptor, then sets the file's access mode and modification time to match the restore arguments.

Parameters
`data`	`ParcelFileDescriptor`: A read-only file descriptor from which the agent can read `size` bytes of file data.
`size`	`long`: The number of bytes of file content to be restored to the given destination. If the file system object being restored is a directory, `size` will be zero.
`destination`	`File`: The File on disk to be restored with the given data.
`type`	`int`: The kind of file system object being restored. This will be either `BackupAgent#TYPE_FILE` or `BackupAgent#TYPE_DIRECTORY`.
`mode`	`long`: The access mode to be assigned to the destination after its data is written. This is in the standard format used by `chmod()`.
`mtime`	`long`: The modification time of the file when it was backed up, suitable to be assigned to the file after its data is written.

Throws
	java.io.IOException
`IOException`

onRestoreFinished

Added in API level 21

public void onRestoreFinished ()

The application's restore operation has completed. This method is called after all available data has been delivered to the application for restore (via either the onRestore() or onRestoreFile() callbacks). This provides the app with a stable end-of-restore opportunity to perform any appropriate post-processing on the data that was just delivered.

See also: