IOnBackInvokedCallback Interface
Definition
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.
Callback allowing applications to handle back events in place of the system.
[Android.Runtime.Register("android/window/OnBackInvokedCallback", "", "Android.Window.IOnBackInvokedCallbackInvoker", ApiSince=33)]
public interface IOnBackInvokedCallback : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable
[<Android.Runtime.Register("android/window/OnBackInvokedCallback", "", "Android.Window.IOnBackInvokedCallbackInvoker", ApiSince=33)>]
type IOnBackInvokedCallback = interface
interface IJavaObject
interface IDisposable
interface IJavaPeerable
- Derived
- Attributes
- Implements
Remarks
Callback allowing applications to handle back events in place of the system.
Callback instances can be added to and removed from OnBackInvokedDispatcher
, which is held at window level and accessible through Activity#getOnBackInvokedDispatcher()
, Dialog#getOnBackInvokedDispatcher()
, Window#getOnBackInvokedDispatcher()
and View#findOnBackInvokedDispatcher()
.
When back is triggered, callbacks on the in-focus window are invoked in reverse order in which they are added within the same priority. Between different priorities, callbacks with higher priority are invoked first.
This replaces Activity#onBackPressed()
, Dialog#onBackPressed()
and android.view.KeyEvent#KEYCODE_BACK
If you want to customize back animation behaviors, in addition to handling back invocations, register its subclass instances OnBackAnimationCallback
instead.
Java documentation for android.window.OnBackInvokedCallback
.
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 |
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 |
Finalized() |
Called when the instance has been finalized. (Inherited from IJavaPeerable) |
OnBackInvoked() |
Called when a back gesture has been completed and committed, or back button pressed has been released and committed. |
SetJniIdentityHashCode(Int32) |
Set the value returned by |
SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from IJavaPeerable) |
SetPeerReference(JniObjectReference) |
Set the value returned by |
UnregisterFromRuntime() |
Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations. (Inherited from IJavaPeerable) |
Extension Methods
JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
JavaCast<TResult>(IJavaObject) | |
GetJniTypeName(IJavaPeerable) |