Share via


IBackupHelper Interface

Definition

Defines the calling interface that BackupAgentHelper uses when dispatching backup and restore operations to the installed helpers.

[Android.Runtime.Register("android/app/backup/BackupHelper", "", "Android.App.Backup.IBackupHelperInvoker")]
public interface IBackupHelper : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/app/backup/BackupHelper", "", "Android.App.Backup.IBackupHelperInvoker")>]
type IBackupHelper = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
Derived
Attributes
Implements

Remarks

Defines the calling interface that BackupAgentHelper uses when dispatching backup and restore operations to the installed helpers. Applications can define and install their own helpers as well as using those provided as part of the Android framework.

Although multiple helper objects may be installed simultaneously, each helper is responsible only for handling its own data, and will not see entities created by other components within the backup system. Invocations of multiple helpers are performed sequentially by the BackupAgentHelper, with each helper given a chance to access its own saved state from within the state record produced during the previous backup operation.

Java documentation for android.app.backup.BackupHelper.

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.

Properties

Handle

Gets the JNI value of the underlying Android object.

(Inherited from IJavaObject)
JniIdentityHashCode

Returns the value of java.lang.System.identityHashCode() for the wrapped instance.

(Inherited from IJavaPeerable)
JniManagedPeerState

State of the managed peer.

(Inherited from IJavaPeerable)
JniPeerMembers

Member access and invocation support.

(Inherited from IJavaPeerable)
PeerReference

Returns a JniObjectReference of the wrapped Java object instance.

(Inherited from IJavaPeerable)

Methods

Disposed()

Called when the instance has been disposed.

(Inherited from IJavaPeerable)
DisposeUnlessReferenced()

If there are no outstanding references to this instance, then calls Dispose(); otherwise, does nothing.

(Inherited from IJavaPeerable)
Finalized()

Called when the instance has been finalized.

(Inherited from IJavaPeerable)
PerformBackup(ParcelFileDescriptor, BackupDataOutput, ParcelFileDescriptor)

Based on oldState, determine what application content needs to be backed up, write it to data, and fill in newState with the complete state as it exists now.

RestoreEntity(BackupDataInputStream)

Called by android.app.backup.BackupAgentHelper BackupAgentHelper to restore a single entity from the restore data set.

SetJniIdentityHashCode(Int32)

Set the value returned by JniIdentityHashCode.

(Inherited from IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates) (Inherited from IJavaPeerable)
SetPeerReference(JniObjectReference)

Set the value returned by PeerReference.

(Inherited from IJavaPeerable)
UnregisterFromRuntime()

Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations.

(Inherited from IJavaPeerable)
WriteNewStateDescription(ParcelFileDescriptor)

Called by android.app.backup.BackupAgentHelper BackupAgentHelper after a restore operation to write the backup state file corresponding to the data as processed by the helper.

Extension Methods

PerformBackupAsync(IBackupHelper, ParcelFileDescriptor, BackupDataOutput, ParcelFileDescriptor)
JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to