File	Doc	Category	Size	Date	Package
IBackupManager.java	API Doc	Android 5.1 API	51314	Sat Mar 14 05:47:58 GMT 2015	android.app.backup

IBackupManager

Fields Summary

Constructors Summary

Methods Summary
public void	acknowledgeFullBackupOrRestore(int token, boolean allow, java.lang.String curPassword, java.lang.String encryptionPassword, android.app.backup.IFullBackupRestoreObserver observer) Confirm that the requested full backup/restore operation can proceed. The system will not actually perform the operation described to fullBackup() / fullRestore() unless the UI calls back into the Backup Manager to confirm, passing the correct token. At the same time, the UI supplies a callback Binder for progress notifications during the operation. The password passed by the confirming entity must match the saved backup or full-device encryption password in order to perform a backup. If a password is supplied for restore, it must match the password used when creating the full backup dataset being used for restore. Callers must hold the android.permission.BACKUP permission to use this method.
public void	agentConnected(java.lang.String packageName, android.os.IBinder agent) Notifies the Backup Manager Service that an agent has become available. This method is only invoked by the Activity Manager.
public void	agentDisconnected(java.lang.String packageName) Notify the Backup Manager Service that an agent has unexpectedly gone away. This method is only invoked by the Activity Manager.
public void	backupNow() Schedule an immediate backup attempt for all pending updates. This is primarily intended for transports to use when they detect a suitable opportunity for doing a backup pass. If there are no pending updates to be sent, no action will be taken. Even if some updates are pending, the transport will still be asked to confirm via the usual requestBackupTime() method. Callers must hold the android.permission.BACKUP permission to use this method.
public android.app.backup.IRestoreSession	beginRestoreSession(java.lang.String packageName, java.lang.String transportID) Begin a restore session. Either or both of packageName and transportID may be null. If packageName is non-null, then only the given package will be considered for restore. If transportID is null, then the restore will use the current active transport. This method requires the android.permission.BACKUP permission except when transportID is null and packageName is the name of the caller's own package. In that case, the restore session returned is suitable for supporting the BackupManager.requestRestore() functionality via RestoreSession.restorePackage() without requiring the app to hold any special permission. param packageName The name of the single package for which a restore will be requested. May be null, in which case all packages in the restore set can be restored. param transportID The name of the transport to use for the restore operation. May be null, in which case the current active transport is used. return An interface to the restore session, or null on error.
public void	clearBackupData(java.lang.String transportName, java.lang.String packageName) Erase all backed-up data for the given package from the given storage destination. Any application can invoke this method for its own package, but only callers who hold the android.permission.BACKUP permission may invoke it for arbitrary packages.
public void	dataChanged(java.lang.String packageName) Tell the system service that the caller has made changes to its data, and therefore needs to undergo an incremental backup pass. Any application can invoke this method for its own package, but only callers who hold the android.permission.BACKUP permission may invoke it for arbitrary packages.
public void	fullBackup(android.os.ParcelFileDescriptor fd, boolean includeApks, boolean includeObbs, boolean includeShared, boolean doWidgets, boolean allApps, boolean allIncludesSystem, boolean doCompress, java.lang.String[] packageNames) Write a full backup of the given package to the supplied file descriptor. The fd may be a socket or other non-seekable destination. If no package names are supplied, then every application on the device will be backed up to the output. This method is synchronous -- it does not return until the backup has completed. Callers must hold the android.permission.BACKUP permission to use this method. param fd The file descriptor to which a 'tar' file stream is to be written param includeApks If true, the resulting tar stream will include the application .apk files themselves as well as their data. param includeObbs If true, the resulting tar stream will include any application expansion (OBB) files themselves belonging to each application. param includeShared If true, the resulting tar stream will include the contents of the device's shared storage (SD card or equivalent). param allApps If true, the resulting tar stream will include all installed applications' data, not just those named in the packageNames parameter. param allIncludesSystem If {@code true}, then {@code allApps} will be interpreted as including packages pre-installed as part of the system. If {@code false}, then setting {@code allApps} to {@code true} will mean only that all 3rd-party applications will be included in the dataset. param packageNames The package names of the apps whose data (and optionally .apk files) are to be backed up. The allApps parameter supersedes this.
public void	fullRestore(android.os.ParcelFileDescriptor fd) Restore device content from the data stream passed through the given socket. The data stream must be in the format emitted by fullBackup(). Callers must hold the android.permission.BACKUP permission to use this method.
public void	fullTransportBackup(java.lang.String[] packageNames) Perform a full-dataset backup of the given applications via the currently active transport. param packageNames The package names of the apps whose data are to be backed up.
public android.content.Intent	getConfigurationIntent(java.lang.String transport) Get the configuration Intent, if any, from the given transport. Callers must hold the android.permission.BACKUP permission in order to use this method. param transport The name of the transport to query. return An Intent to use with Activity#startActivity() to bring up the configuration UI supplied by the transport. If the transport has no configuration UI, it should return {@code null} here.
public java.lang.String	getCurrentTransport() Identify the currently selected transport. Callers must hold the android.permission.BACKUP permission to use this method.
public android.content.Intent	getDataManagementIntent(java.lang.String transport) Get the manage-data UI intent, if any, from the given transport. Callers must hold the android.permission.BACKUP permission in order to use this method.
public java.lang.String	getDataManagementLabel(java.lang.String transport) Get the manage-data menu label, if any, from the given transport. Callers must hold the android.permission.BACKUP permission in order to use this method.
public java.lang.String	getDestinationString(java.lang.String transport) Get the destination string supplied by the given transport. Callers must hold the android.permission.BACKUP permission in order to use this method. param transport The name of the transport to query. return A string describing the current backup destination. This string is used verbatim by the Settings UI as the summary text of the "configure..." item.
public boolean	hasBackupPassword() Reports whether a backup password is currently set. If not, then a null or empty "current password" argument should be passed to setBackupPassword(). Callers must hold the android.permission.BACKUP permission to use this method.
public boolean	isBackupEnabled() Report whether the backup mechanism is currently enabled. Callers must hold the android.permission.BACKUP permission to use this method.
public boolean	isBackupServiceActive(int whichUser) Queries the activity status of backup service as set by {@link #setBackupServiceActive}. param whichUser User handle of the defined user whose backup active state is being queried.
public java.lang.String[]	listAllTransports() Request a list of all available backup transports' names. Callers must hold the android.permission.BACKUP permission to use this method.
public void	opComplete(int token) Notify the backup manager that a BackupAgent has completed the operation corresponding to the given token. param token The transaction token passed to a BackupAgent's doBackup() or doRestore() method. {@hide}
public void	restoreAtInstall(java.lang.String packageName, int token) Notify the Backup Manager Service that an application being installed will need a data-restore pass. This method is only invoked by the Package Manager.
public java.lang.String	selectBackupTransport(java.lang.String transport) Specify the current backup transport. Callers must hold the android.permission.BACKUP permission to use this method. param transport The name of the transport to select. This should be one of {@link BackupManager.TRANSPORT_GOOGLE} or {@link BackupManager.TRANSPORT_ADB}. return The name of the previously selected transport. If the given transport name is not one of the currently available transports, no change is made to the current transport setting and the method returns null.
public void	setAutoRestore(boolean doAutoRestore) Enable/disable automatic restore of application data at install time. When enabled, installation of any package will involve the Backup Manager. If data exists for the newly-installed package, either from the device's current [enabled] backup dataset or from the restore set used in the last wholesale restore operation, that data will be supplied to the new package's restore agent before the package is made generally available for launch. Callers must hold the android.permission.BACKUP permission to use this method. param doAutoRestore When true, enables the automatic app-data restore facility. When false, this facility will be disabled.
public void	setBackupEnabled(boolean isEnabled) Enable/disable the backup service entirely. When disabled, no backup or restore operations will take place. Data-changed notifications will still be observed and collected, however, so that changes made while the mechanism was disabled will still be backed up properly if it is enabled at some point in the future. Callers must hold the android.permission.BACKUP permission to use this method.
public boolean	setBackupPassword(java.lang.String currentPw, java.lang.String newPw) Set the device's backup password. Returns {@code true} if the password was set successfully, {@code false} otherwise. Typically a failure means that an incorrect current password was supplied. Callers must hold the android.permission.BACKUP permission to use this method.
public void	setBackupProvisioned(boolean isProvisioned) Indicate that any necessary one-time provisioning has occurred. Callers must hold the android.permission.BACKUP permission to use this method.
public void	setBackupServiceActive(int whichUser, boolean makeActive) Make the device's backup and restore machinery (in)active. When it is inactive, the device will not perform any backup operations, nor will it deliver data for restore, although clients can still safely call BackupManager methods. param whichUser User handle of the defined user whose backup active state is to be adjusted. param makeActive {@code true} when backup services are to be made active; {@code false} otherwise.