Added in API level 8

public abstract class

BackupAgent

extends ContextWrapper

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

Known Direct Subclasses

BackupAgentHelper

Class Overview

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.

Summary

Constants
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.

[Expand]

Inherited Constants

From class android.content.Context

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.
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	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.

[Expand]

Inherited Methods

From class android.content.ContextWrapper

void	attachBaseContext(Context base) Set the base context for this ContextWrapper.
boolean	bindService(Intent service, ServiceConnection conn, int flags) Connect to an application service, creating it if needed.
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	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 user ID has been granted permission to access a specific 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	checkUriPermission(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and user ID has been granted permission to access a specific URI.
int	checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags) Check both a Uri and normal permission.
void	clearWallpaper() This method is deprecated. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
Context	createConfigurationContext(Configuration overrideConfiguration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
Context	createDisplayContext(Display display) Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
Context	createPackageContext(String packageName, int flags) Return a new Context object for the given application name.
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.
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 user ID 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, int pid, int uid, int modeFlags, String message) If a particular process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
void	enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message) Enforce both a Uri and normal permission.
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() Return an AssetManager instance for your application's package.
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	getDatabasePath(String name) Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
File	getDir(String name, int mode) Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
File	getExternalCacheDir() Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()` where the application can place cache files it owns.
File[]	getExternalCacheDirs() Returns absolute paths to application-specific directories on all 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 external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()`) where the application can place persistent files it owns.
File[]	getExternalFilesDirs(String type) Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns.
File[]	getExternalMediaDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place media files.
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.
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 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 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.
Resources	getResources() Return a Resources instance for your 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.
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	isRestricted() Indicates whether this Context is restricted.
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) Open a new private SQLiteDatabase associated with this Context's application package.
SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler) Open a new private SQLiteDatabase associated with this Context's application package.
Drawable	peekWallpaper() This method is deprecated. Use `WallpaperManager.peek()` instead.
Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter) Register a BroadcastReceiver to be run in the main activity thread.
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	revokeUriPermission(Uri uri, int modeFlags) Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)`.
void	sendBroadcast(Intent intent) Broadcast the given intent to all interested BroadcastReceivers.
void	sendBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
void	sendBroadcastAsUser(Intent intent, UserHandle user) Version of `sendBroadcast(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(Intent, String)` that allows you to specify the user the broadcast will be sent to.
void	sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendBroadcast(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(Intent, String, BroadcastReceiver, Handler, int, String, 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	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 `SET_WALLPAPER`.
void	setWallpaper(InputStream data) This method is deprecated. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
void	startActivities(Intent[] intents) Same as `startActivities(Intent[], Bundle)` with no options specified.
void	startActivities(Intent[] intents, Bundle options) Launch multiple new activities.
void	startActivity(Intent intent) Same as `startActivity(Intent, Bundle)` with no options specified.
void	startActivity(Intent intent, Bundle options) Launch a new activity.
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, Bundle options) Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
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	unregisterReceiver(BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.

From class android.content.Context

abstract boolean	bindService(Intent service, ServiceConnection conn, int flags) Connect to an application service, creating it if needed.
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.
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 user ID has been granted permission to access a specific 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	checkUriPermission(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and user ID has been granted permission to access a specific URI.
abstract int	checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags) Check both a Uri and normal permission.
abstract void	clearWallpaper() This method was deprecated in API level 5. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract Context	createConfigurationContext(Configuration overrideConfiguration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
abstract Context	createDisplayContext(Display display) Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
abstract Context	createPackageContext(String packageName, int flags) Return a new Context object for the given application name.
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 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 user ID 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, int pid, int uid, int modeFlags, String message) If a particular process and user ID has not been granted permission to access a specific URI, throw `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 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() Return an AssetManager instance for your application's package.
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.
abstract ContentResolver	getContentResolver() Return a ContentResolver instance for your application's package.
abstract File	getDatabasePath(String name) Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
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.
final Drawable	getDrawable(int id) Return a drawable object associated with a particular resource ID and styled for the current theme.
abstract File	getExternalCacheDir() Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()` where the application can place cache files it owns.
abstract File[]	getExternalCacheDirs() Returns absolute paths to application-specific directories on all 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 external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()`) where the application can place persistent files it owns.
abstract File[]	getExternalFilesDirs(String type) Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns.
abstract File[]	getExternalMediaDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place media files.
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.
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 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 external storage devices where the application's OBB files (if there are any) can be found.
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.
abstract Resources	getResources() Return a Resources instance for your 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) Return a localized string from the application's package's default string table.
final String	getString(int resId, Object... formatArgs) Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
abstract Object	getSystemService(String name) Return the handle to a system-level service by name.
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 5. Use `WallpaperManager.get()` instead.
abstract int	getWallpaperDesiredMinimumHeight() This method was deprecated in API level 5. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
abstract int	getWallpaperDesiredMinimumWidth() This method was deprecated in API level 5. 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.
boolean	isRestricted() Indicates whether this Context is restricted.
final TypedArray	obtainStyledAttributes(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(AttributeSet set, int[] attrs) 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.
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) Open a new private SQLiteDatabase associated with this Context's application package.
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 Drawable	peekWallpaper() This method was deprecated in API level 5. 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.
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, 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.
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)`.
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(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(Intent, String)` that allows you to specify the user 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(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(Intent, String, BroadcastReceiver, Handler, int, String, 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.
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(InputStream data) This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract void	setWallpaper(Bitmap bitmap) This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract void	startActivities(Intent[] intents, Bundle options) Launch multiple new activities.
abstract void	startActivities(Intent[] intents) Same as `startActivities(Intent[], Bundle)` with no options specified.
abstract void	startActivity(Intent intent) Same as `startActivity(Intent, Bundle)` with no options specified.
abstract void	startActivity(Intent intent, Bundle options) Launch a new activity.
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, Bundle options) Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
abstract void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
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(ComponentCallbacks)`.
abstract void	unregisterReceiver(BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Constants

public static final int TYPE_DIRECTORY

Added in API level 14

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

Constant Value: 2 (0x00000002)

public static final int TYPE_FILE

Added in API level 14

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

Constant Value: 1 (0x00000001)

Public Constructors

public BackupAgent ()

Added in API level 8

Public Methods

public final void fullBackupFile (File file, FullBackupDataOutput output)

Added in API level 14

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.

It is safe to explicitly back up files underneath your application's getNoBackupFilesDir() directory, and they will be restored to that location correctly.

Parameters

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

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

Added in API level 8

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	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	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	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

public void onCreate ()

Added in API level 8

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.

Agents do not need to override this method.

public void onDestroy ()

Added in API level 8

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.

public void onFullBackup (FullBackupDataOutput data)

Added in API level 14

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(File, 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 getCacheDir() directory
The contents of the 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 getNoBackupFilesDir() offers.

Parameters

data	A structured wrapper pointing to the backup destination.

Throws

	IOException
IOException

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

Added in API level 8

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	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	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	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

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

Added in API level 14

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	A read-only file descriptor from which the agent can read `size` bytes of file data.
size	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	The File on disk to be restored with the given data.
type	The kind of file system object being restored. This will be either `TYPE_FILE` or `TYPE_DIRECTORY`.
mode	The access mode to be assigned to the destination after its data is written. This is in the standard format used by `chmod()`.
mtime	The modification time of the file when it was backed up, suitable to be assigned to the file after its data is written.

Throws

IOException

public void onRestoreFinished ()

Added in API level 21

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.

Results

Interfaces

Classes

BackupAgent

Class Overview

Developer Guides

Basic Operation

See Also

Summary

Constants

public static final int TYPE_DIRECTORY

public static final int TYPE_FILE

Public Constructors

public BackupAgent ()

Public Methods

public final void fullBackupFile (File file, FullBackupDataOutput output)

Parameters

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

Parameters

Throws

public void onCreate ()

public void onDestroy ()

public void onFullBackup (FullBackupDataOutput data)

Parameters

Throws

See Also

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

Parameters

Throws

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

Parameters

Throws

public void onRestoreFinished ()

See Also