File	Doc	Category	Size	Date	Package
IBackupAgent.java	API Doc	Android 5.1 API	20973	Sat Mar 14 05:47:56 GMT 2015	android.app

IBackupAgent

Fields Summary

Constructors Summary

Methods Summary
public void	doBackup(android.os.ParcelFileDescriptor oldState, android.os.ParcelFileDescriptor data, android.os.ParcelFileDescriptor newState, int token, android.app.backup.IBackupManager callbackBinder) Request that the app perform an incremental backup. param oldState Read-only file containing the description blob of the app's data state as of the last backup operation's completion. This file is empty or invalid when a full backup is being requested. param data Read-write file, empty when onBackup() is called, that is the data destination for this backup pass's incrementals. param newState Read-write file, empty when onBackup() is called, where the new state blob is to be recorded. param token Opaque token identifying this transaction. This must be echoed back to the backup service binder once the new data has been written to the data and newState files. param callbackBinder Binder on which to indicate operation completion, passed here as a convenience to the agent.
public void	doFullBackup(android.os.ParcelFileDescriptor data, int token, android.app.backup.IBackupManager callbackBinder) Perform a "full" backup to the given file descriptor. The output file is presumed to be a socket or other non-seekable, write-only data sink. When this method is called, the app should write all of its files to the output. param data Write-only file to receive the backed-up file content stream. The data must be formatted correctly for the resulting archive to be legitimate, so that will be tightly controlled by the available API. param token Opaque token identifying this transaction. This must be echoed back to the backup service binder once the agent is finished restoring the application based on the restore data contents. param callbackBinder Binder on which to indicate operation completion, passed here as a convenience to the agent.
public void	doRestore(android.os.ParcelFileDescriptor data, int appVersionCode, android.os.ParcelFileDescriptor newState, int token, android.app.backup.IBackupManager callbackBinder) Restore an entire data snapshot to the application. param data Read-only file containing the full data snapshot of the app's backup. This is to be a replacement of the app's current data, not to be merged into it. param appVersionCode The android:versionCode attribute of the application that created this data set. This can help the agent distinguish among various historical backup content possibilities. param newState Read-write file, empty when onRestore() is called, that is to be written with the state description that holds after the restore has been completed. param token Opaque token identifying this transaction. This must be echoed back to the backup service binder once the agent is finished restoring the application based on the restore data contents. param callbackBinder Binder on which to indicate operation completion, passed here as a convenience to the agent.
public void	doRestoreFile(android.os.ParcelFileDescriptor data, long size, int type, java.lang.String domain, java.lang.String path, long mode, long mtime, int token, android.app.backup.IBackupManager callbackBinder) Restore a single "file" to the application. The file was typically obtained from a full-backup dataset. The agent reads 'size' bytes of file content from the provided file descriptor. param data Read-only pipe delivering the file content itself. param size Size of the file being restored. param type Type of file system entity, e.g. FullBackup.TYPE_DIRECTORY. param domain Name of the file's semantic domain to which the 'path' argument is a relative path. e.g. FullBackup.DATABASE_TREE_TOKEN. param path Relative path of the file within its semantic domain. param mode Access mode of the file system entity, e.g. 0660. param mtime Last modification time of the file system entity. param token Opaque token identifying this transaction. This must be echoed back to the backup service binder once the agent is finished restoring the application based on the restore data contents. param callbackBinder Binder on which to indicate operation completion, passed here as a convenience to the agent.
public void	doRestoreFinished(int token, android.app.backup.IBackupManager callbackBinder) Provide the app with a canonical "all data has been delivered" end-of-restore callback so that it can do any postprocessing of the restored data that might be appropriate. This is issued after both key/value and full data restore operations have completed. param token Opaque token identifying this transaction. This must be echoed back to the backup service binder once the agent is finished restoring the application based on the restore data contents. param callbackBinder Binder on which to indicate operation completion, passed here as a convenience to the agent.
public void	fail(java.lang.String message) Out of band: instruct the agent to crash within the client process. This is used when the backup infrastructure detects a semantic error post-hoc and needs to pass the problem back to the app. param message The message to be passed to the agent's application in an exception.