MessageQueue+IIdleHandler.xml

<Type Name="MessageQueue+IIdleHandler" FullName="Android.OS.MessageQueue+IIdleHandler">
  <TypeSignature Language="C#" Value="public interface MessageQueue.IIdleHandler : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
  <TypeSignature Language="ILAsm" Value=".class nested public interface auto ansi abstract beforefieldinit MessageQueue/IIdleHandler implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:Android.OS.MessageQueue.IIdleHandler" />
  <TypeSignature Language="F#" Value="type MessageQueue.IIdleHandler = 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/os/MessageQueue$IdleHandler", "", "Android.OS.MessageQueue/IIdleHandlerInvoker")]</AttributeName>
      <AttributeName Language="F#">[&lt;Android.Runtime.Register("android/os/MessageQueue$IdleHandler", "", "Android.OS.MessageQueue/IIdleHandlerInvoker")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Callback interface for discovering when a thread is going to block
            waiting for more messages.</summary>
    <remarks>
      <para>Callback interface for discovering when a thread is going to block
            waiting for more messages.</para>
      <para>
        <format type="text/html">
          <a href="https://developer.android.com/reference/android/os/MessageQueue.IdleHandler" title="Reference documentation">Java documentation for <code>android.os.MessageQueue.IdleHandler</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>
    <since version="Added in API level 1" />
  </Docs>
  <Members>
    <Member MemberName="QueueIdle">
      <MemberSignature Language="C#" Value="public bool QueueIdle ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool QueueIdle() cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.OS.MessageQueue.IIdleHandler.QueueIdle" />
      <MemberSignature Language="F#" Value="abstract member QueueIdle : unit -&gt; bool" Usage="iIdleHandler.QueueIdle " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("queueIdle", "()Z", "GetQueueIdleHandler:Android.OS.MessageQueue/IIdleHandlerInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("queueIdle", "()Z", "GetQueueIdleHandler:Android.OS.MessageQueue/IIdleHandlerInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Called when the message queue has run out of messages and will now
            wait for more.</summary>
        <returns>To be added.</returns>
        <remarks>
          <para>Called when the message queue has run out of messages and will now
            wait for more.  Return true to keep your idle handler active, false
            to have it removed.  This may be called if there are still messages
            pending in the queue, but they are all scheduled to be dispatched
            after the current time.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/os/MessageQueue.IdleHandler#queueIdle()" title="Reference documentation">Java documentation for <code>android.os.MessageQueue.IdleHandler.queueIdle()</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>
        <since version="Added in API level 1" />
      </Docs>
    </Member>
  </Members>
</Type>