IOnBackInvokedCallback.xml

<Type Name="IOnBackInvokedCallback" FullName="Android.Window.IOnBackInvokedCallback">
  <TypeSignature Language="C#" Value="public interface IOnBackInvokedCallback : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IOnBackInvokedCallback implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:Android.Window.IOnBackInvokedCallback" />
  <TypeSignature Language="F#" Value="type IOnBackInvokedCallback = interface&#xA;    interface IJavaObject&#xA;    interface IDisposable&#xA;    interface IJavaPeerable" />
  <AssemblyInfo>
    <AssemblyName>Mono.Android</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces>
    <Interface>
      <InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Android.Runtime.Register("android/window/OnBackInvokedCallback", "", "Android.Window.IOnBackInvokedCallbackInvoker", ApiSince=33)]</AttributeName>
      <AttributeName Language="F#">[&lt;Android.Runtime.Register("android/window/OnBackInvokedCallback", "", "Android.Window.IOnBackInvokedCallbackInvoker", ApiSince=33)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Callback allowing applications to handle back events in place of the system.</summary>
    <remarks>
      <para>Callback allowing applications to handle back events in place of the system.</para>
      <para>Callback instances can be added to and removed from <c>OnBackInvokedDispatcher</c>, which
            is held at window level and accessible through <c>Activity#getOnBackInvokedDispatcher()</c>,
            <c>Dialog#getOnBackInvokedDispatcher()</c>, <c>Window#getOnBackInvokedDispatcher()</c>
            and <c>View#findOnBackInvokedDispatcher()</c>.</para>
      <para>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.</para>
      <para>This replaces <c>Activity#onBackPressed()</c>, <c>Dialog#onBackPressed()</c> and
            <c>android.view.KeyEvent#KEYCODE_BACK</c></para>
      <para>If you want to customize back animation behaviors, in addition to handling back invocations,
            register its subclass instances <c>OnBackAnimationCallback</c> instead.</para>
      <para />
      <para>
        <format type="text/html">
          <a href="https://developer.android.com/reference/android/window/OnBackInvokedCallback" title="Reference documentation">Java documentation for <code>android.window.OnBackInvokedCallback</code>.</a>
        </format>
      </para>
      <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="OnBackInvoked">
      <MemberSignature Language="C#" Value="public void OnBackInvoked ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void OnBackInvoked() cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.Window.IOnBackInvokedCallback.OnBackInvoked" />
      <MemberSignature Language="F#" Value="abstract member OnBackInvoked : unit -&gt; unit" Usage="iOnBackInvokedCallback.OnBackInvoked " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("onBackInvoked", "()V", "GetOnBackInvokedHandler:Android.Window.IOnBackInvokedCallbackInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=33)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("onBackInvoked", "()V", "GetOnBackInvokedHandler:Android.Window.IOnBackInvokedCallbackInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=33)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android33.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android33.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Called when a back gesture has been completed and committed, or back button pressed
            has been released and committed.</summary>
        <remarks>
          <para>Called when a back gesture has been completed and committed, or back button pressed
            has been released and committed.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/window/OnBackInvokedCallback#onBackInvoked()" title="Reference documentation">Java documentation for <code>android.window.OnBackInvokedCallback.onBackInvoked()</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>