FileBackupHelper Class

Reference

Definition

Namespace:: Android.App.Backup

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A helper class that can be used in conjunction with android.app.backup.BackupAgentHelper to manage the backup of a set of files.

[Android.Runtime.Register("android/app/backup/FileBackupHelper", DoNotGenerateAcw=true)]
public class FileBackupHelper : Android.App.Backup.FileBackupHelperBase, Android.App.Backup.IBackupHelper, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/app/backup/FileBackupHelper", DoNotGenerateAcw=true)>]
type FileBackupHelper = class
    inherit FileBackupHelperBase
    interface IBackupHelper
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

Object

FileBackupHelperBase
FileBackupHelper

Attributes: RegisterAttribute

Implements: IBackupHelper IJavaObject IJavaPeerable IDisposable

Remarks

A helper class that can be used in conjunction with android.app.backup.BackupAgentHelper to manage the backup of a set of files. Whenever backup is performed, all files changed since the last backup will be saved in their entirety. When backup first occurs, every file in the list provided to #FileBackupHelper will be backed up.

During restore, if the helper encounters data for a file that was not specified when the FileBackupHelper object was constructed, that data will be ignored. <p class="note"><strong>Note:</strong> This should be used only with small configuration files, not large binary files.

Java documentation for android.app.backup.FileBackupHelper.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

FileBackupHelper(Context, String[])	Construct a helper to manage backup/restore of entire files within the application's data directory hierarchy.
FileBackupHelper(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
PerformBackup(ParcelFileDescriptor, BackupDataOutput, ParcelFileDescriptor)	Based on `oldState`, determine which of the files from the application's data directory need to be backed up, write them to the data stream, and fill in `newState` with the state as it exists now.
RestoreEntity(BackupDataInputStream)	Restore one record [representing a single file] from the restore dataset.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
WriteNewStateDescription(ParcelFileDescriptor)	Called by BackupAgentHelper after a restore operation to write the backup state file corresponding to the data as processed by the helper.

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

PerformBackupAsync(IBackupHelper, ParcelFileDescriptor, BackupDataOutput, ParcelFileDescriptor)
JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to