FileDocCategorySizeDatePackage
IRestoreSession.javaAPI DocAndroid 5.1 API13866Sat Mar 14 05:47:58 GMT 2015android.app.backup

IRestoreSession

public interface IRestoreSession implements android.os.IInterface
Binder interface used by clients who wish to manage a restore operation. Every method in this interface requires the android.permission.BACKUP permission. {@hide}

Fields Summary
Constructors Summary
Methods Summary
public voidendRestoreSession()
End this restore session. After this method is called, the IRestoreSession binder is no longer valid.

Note: The caller must invoke this method to end the restore session, even if {@link getAvailableRestoreSets} or {@link performRestore} failed.

public intgetAvailableRestoreSets(android.app.backup.IRestoreObserver observer)
Ask the current transport what the available restore sets are.

param
observer This binder points to an object whose onRestoreSetsAvailable() method will be called to supply the results of the transport's lookup.
return
Zero on success; nonzero on error. The observer will only receive a result callback if this method returned zero.

public intrestoreAll(long token, android.app.backup.IRestoreObserver observer)
Restore the given set onto the device, replacing the current data of any app contained in the restore set with the data previously backed up.

Callers must hold the android.permission.BACKUP permission to use this method.

return
Zero on success; nonzero on error. The observer will only receive progress callbacks if this method returned zero.
param
token The token from {@link getAvailableRestoreSets()} corresponding to the restore set that should be used.
param
observer If non-null, this binder points to an object that will receive progress callbacks during the restore operation.

public intrestorePackage(java.lang.String packageName, android.app.backup.IRestoreObserver observer)
Restore a single application from backup. The data will be restored from the current backup dataset if the given package has stored data there, or from the dataset used during the last full device setup operation if the current backup dataset has no matching data. If no backup data exists for this package in either source, a nonzero value will be returned.

return
Zero on success; nonzero on error. The observer will only receive progress callbacks if this method returned zero.
param
packageName The name of the package whose data to restore. If this is not the name of the caller's own package, then the android.permission.BACKUP permission must be held.
param
observer If non-null, this binder points to an object that will receive progress callbacks during the restore operation.

public intrestoreSome(long token, android.app.backup.IRestoreObserver observer, java.lang.String[] packages)
Restore select packages from the given set onto the device, replacing the current data of any app contained in the set with the data previously backed up.

Callers must hold the android.permission.BACKUP permission to use this method.

return
Zero on success, nonzero on error. The observer will only receive progress callbacks if this method returned zero.
param
token The token from {@link getAvailableRestoreSets()} corresponding to the restore set that should be used.
param
observer If non-null, this binder points to an object that will receive progress callbacks during the restore operation.
param
packages The set of packages for which to attempt a restore. Regardless of the contents of the actual back-end dataset named by {@code token}, only applications mentioned in this list will have their data restored.