Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b83a283a authored by Scott Main's avatar Scott Main
Browse files

docs: add dev guide for backup 

Change-Id: I168f6b15d3441c9cbea2cd9699612476c7244530
parent fb473bb6

core/java/android/app/backup/BackupAgent.java

+4 −3
Original line number Diff line number Diff line
@@ -162,9 +162,10 @@ public abstract class BackupAgent extends ContextWrapper { 
     *            file descriptor pointing to a full snapshot of the

     *            application's data.  The application should consume every

     *            entity represented in this data stream.

     * @param appVersionCode The

     *            {@link android.R.styleable#AndroidManifest_versionCode android:versionCode}

     *            value of the application that backed up this particular data set. This

     * @param appVersionCode The value of the <a

     * href="{@docRoot}guide/topics/manifest/manifest-element.html#vcode">{@code

     *            android:versionCode}</a> 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.

core/java/android/app/backup/package.html

+16 −11
Original line number Diff line number Diff line
@@ -2,23 +2,28 @@ 
<BODY>

<p>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 will restore the user's previous data and/or

preferences. {@more} All backup management is controlled through

{@link android.app.backup.BackupManager}.  Individual backup functionality is

implemented through a subclass {@link android.app.backup.BackupAgent} and a

simple and easy-to-use implementation is provided in

{@link android.app.backup.BackupAgentHelper}.</p>

device, all applications that have enabled backup will restore the user's previous data.</p>

{@more}



<p>STOPSHIP: add more documentation and remove Dev Guide link if not written!</p>

<p>All backup and restore operations are controlled by the {@link

android.app.backup.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 {@link android.app.backup.BackupAgent}

or {@link android.app.backup.BackupAgentHelper}. The {@link

android.app.backup.BackupAgentHelper} class provides a wrapper around {@link

android.app.backup.BackupAgent} that simplifies the procedures to implement a backup agent by

employing backup helpers such as {@link android.app.backup.SharedPreferencesBackupHelper} and

{@link android.app.backup.FileBackupHelper}.</p>



<p>The backup APIs let applications:</p>

<ul>

  <li>Perform backup of arbitrary data</li>

  <li>Easily perform backup of Preferences and files</li>

  <li>Handle restore of data</li>

  <li>Perform backup of arbitrary data to remote storage</li>

  <li>Easily perform backup of {@link android.content.SharedPreferences} and files</li>

  <li>Restore the data saved to remote storage</li>

</ul>



<p>For a detailed guide to using the backup APIs, see the <a

href="{@docRoot}guide/topics/backup.html">Backup Dev Guide topic</a>.</p>

href="{@docRoot}guide/topics/data/backup.html">Data Backup</a> developer guide.</p>



</BODY>

</HTML>

docs/html/guide/guide_toc.cs

+10 −2
Original line number Diff line number Diff line
@@ -144,9 +144,17 @@ 
      <li><a href="<?cs var:toroot ?>guide/topics/intents/intents-filters.html">

            <span class="en">Intents and Intent Filters</span>

          </a></li>

      <li><a href="<?cs var:toroot ?>guide/topics/data/data-storage.html">

      <li class="toggle-list">

        <div><a href="<?cs var:toroot ?>guide/topics/data/data-storage.html">

            <span class="en">Data Storage</span>

          </a></li>

          </a> <span class="new">new!</span></div>

          <ul>

            <li><a href="<?cs var:toroot ?>guide/topics/data/backup.html">

                <span class="en">Data Backup</span>

              </a> <span class="new">new!</span>

            </li>

          </ul>

      </li>

      <li><a href="<?cs var:toroot ?>guide/topics/providers/content-providers.html">

            <span class="en">Content Providers</span>

          </a></li>

docs/html/guide/topics/data/backup.jd

0 → 100644
+761 −0

File added.

Preview size limit exceeded, changes collapsed.