Android Guides | Samples

Android.App.Backup Namespace

Contains the backup and restore functionality available to applications.

Remarks

Contains the backup and restore functionality available to applications. If a user wipes the data on their device or upgrades to a new Android-powered device, all applications that have enabled backup can restore the user's previous data when the application is reinstalled.

For more information, see the Data Backup guide.

All backup and restore operations are controlled by the BackupManager. Each application that would like to enable backup and preserve its data on remote strage must implement a backup agent. A backup agent can be built by extending either BackupAgent or BackupAgentHelper. The BackupAgentHelper class provides a wrapper around BackupAgent that simplifies the procedures to implement a backup agent by employing backup helpers such as SharedPreferencesBackupHelper and FileBackupHelper.

The backup APIs let applications:

  • Perform backup of arbitrary data to remote storage
  • Easily perform backup of ISharedPreferences and files
  • Restore the data saved to remote storage

Classes

TypeReason
BackupAgentProvides the central interface between an application and Android's data backup infrastructure.
BackupAgentHelperA convenient BackupAgent wrapper class that automatically manages heterogeneous data sets within the backup data, each identified by a unique key prefix.
BackupDataInputProvides the structured interface through which a BackupAgent reads information from the backup data set, via its BackupAgent.OnRestore(BackupDataInput,Int32,Int32) method.
BackupDataInputStreamProvides an InputStream-like interface for accessing an entity's data during a restore operation.
BackupDataOutputProvides the structured interface through which a BackupAgent commits information to the backup data set, via its BackupAgent.OnBackup(ParcelFileDescriptor,BackupDataOutput,BackupDataOutput) method.
BackupFileTypeEnumerates values returned by several types and taken as a parameter of the BackupAgent.OnRestoreFile member.
BackupManagerThe interface through which an application interacts with the Android backup service to request backup and restore operations.
FileBackupHelperA helper class that can be used in conjunction with BackupAgentHelper to manage the backup of a set of files.
FileBackupHelperBase
FullBackupDataOutputProvides the interface through which a BackupAgent writes entire files to a full backup data set, via its BackupAgent.OnFullBackup(FullBackupDataOutput) method.
IBackupHelperDefines the calling interface that BackupAgentHelper uses when dispatching backup and restore operations to the installed helpers.
IBackupHelperExtensions
RestoreObserverCallback class for receiving progress reports during a restore operation.
SharedPreferencesBackupHelperA helper class that can be used in conjunction with BackupAgentHelper to manage the backup of ISharedPreferences.