blob: dd6c2546898ca2e6ab0284d8dade19673c5df176 [file] [log] [blame]
Kenny Root5a20ea12010-02-23 18:49:11 -08001<HTML>
2<BODY>
Scott Maind17da432010-04-29 21:42:58 -07003<p>Contains the backup and restore functionality available to
4applications. If a user wipes the data on their device or upgrades to a new Android-powered
Scott Mainf4f05b82011-01-07 14:38:23 -08005device, all applications that have enabled backup can restore the user's previous data when the
6application is reinstalled.</p>
Scott Main73e150c2010-09-20 14:11:18 -07007
Scott Mainf4f05b82011-01-07 14:38:23 -08008<p>For more information, see the <a
Scott Main9be01052012-06-22 12:35:08 -07009href="{@docRoot}guide/topics/data/backup.html">Data Backup</a> guide.</p>
Scott Mainb83a2832010-04-29 13:26:53 -070010{@more}
Kenny Root5a20ea12010-02-23 18:49:11 -080011
Scott Mainb83a2832010-04-29 13:26:53 -070012<p>All backup and restore operations are controlled by the {@link
13android.app.backup.BackupManager}. Each application that would
kopriva7ecfe312018-09-17 15:17:50 -070014like to enable backup and preserve its data on remote storage must implement a
Scott Mainb83a2832010-04-29 13:26:53 -070015backup agent. A backup agent can be built by extending either {@link android.app.backup.BackupAgent}
16or {@link android.app.backup.BackupAgentHelper}. The {@link
17android.app.backup.BackupAgentHelper} class provides a wrapper around {@link
18android.app.backup.BackupAgent} that simplifies the procedures to implement a backup agent by
19employing backup helpers such as {@link android.app.backup.SharedPreferencesBackupHelper} and
20{@link android.app.backup.FileBackupHelper}.</p>
Kenny Root5a20ea12010-02-23 18:49:11 -080021
22<p>The backup APIs let applications:</p>
23<ul>
Scott Mainb83a2832010-04-29 13:26:53 -070024 <li>Perform backup of arbitrary data to remote storage</li>
25 <li>Easily perform backup of {@link android.content.SharedPreferences} and files</li>
26 <li>Restore the data saved to remote storage</li>
Kenny Root5a20ea12010-02-23 18:49:11 -080027</ul>
28
Kenny Root5a20ea12010-02-23 18:49:11 -080029</BODY>
30</HTML>