android-7.0.0_r1/s

<!DOCTYPE html>
<html devsite>
<head>


    <meta name="top_category" value="develop" />

    <meta name="subcategory" value="reference" />


      <meta name="book_path" value="/reference/android/support/test/_book.yaml" />


<title>UiDevice</title>


</head>

<body class="gc-documentation develop reference api apilevel-">
<div id="doc-api-level" class="" style="display:none"></div>


<div id="naMessage"></div>

<div id="api-info-block">
<div class="api-level">


</div>


<div class="sum-details-links">

Summary:


  <a href="#pubmethods">Methods</a>


  &#124; <a href="#inhmethods">Inherited Methods</a>

&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>

</div><!-- end sum-details-links -->
</div><!-- end api-info-block -->

<div class="api apilevel-" id="jd-content">

<!-- ======== START OF CLASS DATA ======== -->

<h1 class="api-title">UiDevice</h1>
<p>
<code class="api-signature">
  public


  class
  UiDevice
</code>
<br>


<code class="api-signature">

    extends Object


</code>

<code class="api-signature">


</code>

</p><table class="jd-inheritance-table">


  <tr>

    <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object
    </td>
  </tr>


  <tr>

      <td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;&#x21b3;</td>

    <td colspan="1" class="jd-inheritance-class-cell">android.support.test.uiautomator.UiDevice
    </td>
  </tr>


</table>


<br><hr>


  <p>UiDevice provides access to state information about the device.
 You can also use this class to simulate user actions on the device,
 such as pressing the d-pad or pressing the Home and Menu buttons.</p>


<h2 class="api-section">Summary</h2>


<!-- ========== METHOD SUMMARY =========== -->
<table id="pubmethods" class="responsive methods">
<tr><th colspan="2"><h3>Public methods</h3></th></tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#clearLastTraversedText()">clearLastTraversedText</a>()
      </code>

        <p>Clears the text from the last UI traversal event.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#click(int, int)">click</a>(int x, int y)
      </code>

        <p>Perform a click at arbitrary coordinates specified by the user


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#drag(int, int, int, int, int)">drag</a>(int startX, int startY, int endX, int endY, int steps)
      </code>

        <p>Performs a swipe from one coordinate to another coordinate.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#dumpWindowHierarchy(java.io.File)">dumpWindowHierarchy</a>(File dest)
      </code>

        <p>Dump the current window hierarchy to a <code><a href="/reference/java/io/File.html">File</a></code>.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#dumpWindowHierarchy(java.io.OutputStream)">dumpWindowHierarchy</a>(OutputStream out)
      </code>

        <p>Dump the current window hierarchy to an <code><a href="/reference/java/io/OutputStream.html">OutputStream</a></code>.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#dumpWindowHierarchy(java.lang.String)">dumpWindowHierarchy</a>(String fileName)
      </code>

        <p><em>
      This method is deprecated.
    Use <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#dumpWindowHierarchy(java.io.File)">dumpWindowHierarchy(File)</a></code> or
     <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#dumpWindowHierarchy(java.io.OutputStream)">dumpWindowHierarchy(OutputStream)</a></code> instead.
</em>


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        <a href="/reference/android/support/test/uiautomator/UiObject2.html">UiObject2</a></code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#findObject(android.support.test.uiautomator.BySelector)">findObject</a>(<a href="/reference/android/support/test/uiautomator/BySelector.html">BySelector</a> selector)
      </code>

        <p>Returns the first object to match the <code>selector</code> criteria.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        <a href="/reference/android/support/test/uiautomator/UiObject.html">UiObject</a></code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#findObject(android.support.test.uiautomator.UiSelector)">findObject</a>(<a href="/reference/android/support/test/uiautomator/UiSelector.html">UiSelector</a> selector)
      </code>

        <p>Returns a UiObject which represents a view that matches the specified selector criteria.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        List&lt;<a href="/reference/android/support/test/uiautomator/UiObject2.html">UiObject2</a>&gt;</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#findObjects(android.support.test.uiautomator.BySelector)">findObjects</a>(<a href="/reference/android/support/test/uiautomator/BySelector.html">BySelector</a> selector)
      </code>

        <p>Returns all objects that match the <code>selector</code> criteria.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#freezeRotation()">freezeRotation</a>()
      </code>

        <p>Disables the sensors and freezes the device rotation at its
 current rotation state.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getCurrentActivityName()">getCurrentActivityName</a>()
      </code>

        <p><em>
      This method is deprecated.
    The results returned should be considered unreliable</em>


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getCurrentPackageName()">getCurrentPackageName</a>()
      </code>

        <p>Retrieves the name of the last package to report accessibility events.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        int</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getDisplayHeight()">getDisplayHeight</a>()
      </code>

        <p>Gets the height of the display, in pixels.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        int</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getDisplayRotation()">getDisplayRotation</a>()
      </code>

        <p>Returns the current rotation of the display, as defined in <code><a href="/reference/android/view/Surface.html">Surface</a></code>


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        Point</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getDisplaySizeDp()">getDisplaySizeDp</a>()
      </code>

        <p>Returns the display size in dp (device-independent pixel)

 The returned display size is adjusted per screen rotation.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        int</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getDisplayWidth()">getDisplayWidth</a>()
      </code>

        <p>Gets the width of the display, in pixels.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        static


        <a href="/reference/android/support/test/uiautomator/UiDevice.html">UiDevice</a></code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getInstance()">getInstance</a>()
      </code>

        <p><em>
      This method is deprecated.
    Should use <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#getInstance(android.app.Instrumentation)">getInstance(Instrumentation)</a></code> instead. This version hides
 UiDevice's dependency on having an Instrumentation reference and is prone to misuse.</em>


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        static


        <a href="/reference/android/support/test/uiautomator/UiDevice.html">UiDevice</a></code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getInstance(android.app.Instrumentation)">getInstance</a>(Instrumentation instrumentation)
      </code>

        <p>Retrieves a singleton instance of UiDevice


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getLastTraversedText()">getLastTraversedText</a>()
      </code>

        <p>Retrieves the text from the last UI traversal event received.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getLauncherPackageName()">getLauncherPackageName</a>()
      </code>

        <p>Retrieves default launcher package name


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#getProductName()">getProductName</a>()
      </code>

        <p>Retrieves the product name of the device.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#hasAnyWatcherTriggered()">hasAnyWatcherTriggered</a>()
      </code>

        <p>Checks if any registered <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> have triggered.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#hasObject(android.support.test.uiautomator.BySelector)">hasObject</a>(<a href="/reference/android/support/test/uiautomator/BySelector.html">BySelector</a> selector)
      </code>

        <p>Returns whether there is a match for the given <code>selector</code> criteria.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#hasWatcherTriggered(java.lang.String)">hasWatcherTriggered</a>(String watcherName)
      </code>

        <p>Checks if a specific registered  <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> has triggered.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#isNaturalOrientation()">isNaturalOrientation</a>()
      </code>

        <p>Check if the device is in its natural orientation.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#isScreenOn()">isScreenOn</a>()
      </code>

        <p>Checks the power manager if the screen is ON.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#openNotification()">openNotification</a>()
      </code>

        <p>Opens the notification shade.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#openQuickSettings()">openQuickSettings</a>()
      </code>

        <p>Opens the Quick Settings shade.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        &lt;R&gt;
        R</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#performActionAndWait(java.lang.Runnable, android.support.test.uiautomator.EventCondition<R>, long)">performActionAndWait</a>(Runnable action, <a href="/reference/android/support/test/uiautomator/EventCondition.html">EventCondition</a>&lt;R&gt; condition, long timeout)
      </code>

        <p>Performs the provided <code>action</code> and waits for the <code>condition</code> to be met.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressBack()">pressBack</a>()
      </code>

        <p>Simulates a short press on the BACK button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressDPadCenter()">pressDPadCenter</a>()
      </code>

        <p>Simulates a short press on the CENTER button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressDPadDown()">pressDPadDown</a>()
      </code>

        <p>Simulates a short press on the DOWN button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressDPadLeft()">pressDPadLeft</a>()
      </code>

        <p>Simulates a short press on the LEFT button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressDPadRight()">pressDPadRight</a>()
      </code>

        <p>Simulates a short press on the RIGHT button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressDPadUp()">pressDPadUp</a>()
      </code>

        <p>Simulates a short press on the UP button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressDelete()">pressDelete</a>()
      </code>

        <p>Simulates a short press on the DELETE key.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressEnter()">pressEnter</a>()
      </code>

        <p>Simulates a short press on the ENTER key.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressHome()">pressHome</a>()
      </code>

        <p>Simulates a short press on the HOME button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressKeyCode(int)">pressKeyCode</a>(int keyCode)
      </code>

        <p>Simulates a short press using a key code.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressKeyCode(int, int)">pressKeyCode</a>(int keyCode, int metaState)
      </code>

        <p>Simulates a short press using a key code.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressMenu()">pressMenu</a>()
      </code>

        <p>Simulates a short press on the MENU button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressRecentApps()">pressRecentApps</a>()
      </code>

        <p>Simulates a short press on the Recent Apps button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#pressSearch()">pressSearch</a>()
      </code>

        <p>Simulates a short press on the SEARCH button.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#registerWatcher(java.lang.String, android.support.test.uiautomator.UiWatcher)">registerWatcher</a>(String name, <a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a> watcher)
      </code>

        <p>Registers a <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> to run automatically when the testing framework is unable to
 find a match using a <code><a href="/reference/android/support/test/uiautomator/UiSelector.html">UiSelector</a></code>.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#removeWatcher(java.lang.String)">removeWatcher</a>(String name)
      </code>

        <p>Removes a previously registered <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code>.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#resetWatcherTriggers()">resetWatcherTriggers</a>()
      </code>

        <p>Resets a <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> that has been triggered.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#runWatchers()">runWatchers</a>()
      </code>

        <p>This method forces all registered watchers to run.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#setCompressedLayoutHeirarchy(boolean)">setCompressedLayoutHeirarchy</a>(boolean compressed)
      </code>

        <p>Enables or disables layout hierarchy compression.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#setOrientationLeft()">setOrientationLeft</a>()
      </code>

        <p>Simulates orienting the device to the left and also freezes rotation
 by disabling the sensors.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#setOrientationNatural()">setOrientationNatural</a>()
      </code>

        <p>Simulates orienting the device into its natural orientation and also freezes rotation
 by disabling the sensors.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#setOrientationRight()">setOrientationRight</a>()
      </code>

        <p>Simulates orienting the device to the right and also freezes rotation
 by disabling the sensors.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#sleep()">sleep</a>()
      </code>

        <p>This method simply presses the power button if the screen is ON else
 it does nothing if the screen is already OFF.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#swipe(int, int, int, int, int)">swipe</a>(int startX, int startY, int endX, int endY, int steps)
      </code>

        <p>Performs a swipe from one coordinate to another using the number of steps
 to determine smoothness and speed.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#swipe(android.graphics.Point[], int)">swipe</a>(Point[] segments, int segmentSteps)
      </code>

        <p>Performs a swipe between points in the Point array.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#takeScreenshot(java.io.File, float, int)">takeScreenshot</a>(File storePath, float scale, int quality)
      </code>

        <p>Take a screenshot of current window and store it as PNG

 The screenshot is adjusted per screen rotation


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#takeScreenshot(java.io.File)">takeScreenshot</a>(File storePath)
      </code>

        <p>Take a screenshot of current window and store it as PNG

 Default scale of 1.0f (original size) and 90% quality is used
 The screenshot is adjusted per screen rotation


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#unfreezeRotation()">unfreezeRotation</a>()
      </code>

        <p>Re-enables the sensors and un-freezes the device rotation allowing its contents
 to rotate with the device physical rotation.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        &lt;R&gt;
        R</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#wait(android.support.test.uiautomator.SearchCondition<R>, long)">wait</a>(<a href="/reference/android/support/test/uiautomator/SearchCondition.html">SearchCondition</a>&lt;R&gt; condition, long timeout)
      </code>

        <p>Waits for given the <code>condition</code> to be met.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#waitForIdle(long)">waitForIdle</a>(long timeout)
      </code>

        <p>Waits for the current application to idle.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#waitForIdle()">waitForIdle</a>()
      </code>

        <p>Waits for the current application to idle.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#waitForWindowUpdate(java.lang.String, long)">waitForWindowUpdate</a>(String packageName, long timeout)
      </code>

        <p>Waits for a window content update event to occur.


</p>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      <a href="/reference/android/support/test/uiautomator/UiDevice.html#wakeUp()">wakeUp</a>()
      </code>

        <p>This method simulates pressing the power button if the screen is OFF else
 it does nothing if the screen is already ON.


</p>

    </td>
  </tr>


</table>


<!-- ========== METHOD SUMMARY =========== -->
<table id="inhmethods" class="methods inhtable">
<tr><th><h3>Inherited methods</h3></th></tr>


<tr class="api apilevel-" >
<td colspan="2">

  <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
          ><img height="34" id="inherited-methods-java.lang.Object-trigger"
          src="/assets/images/styles/disclosure_down.png"
          class="jd-expando-trigger-img" /></a>From
class
<code>

    java.lang.Object

</code>
<div id="inherited-methods-java.lang.Object">
  <div id="inherited-methods-java.lang.Object-list"
        class="jd-inheritedlinks">
  </div>
  <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
    <table class="jd-sumtable-expando responsive">


  <tr class="api apilevel-" >


    <td><code>


        Object</code>
    </td>

    <td width="100%">
      <code>
      clone()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        boolean</code>
    </td>

    <td width="100%">
      <code>
      equals(Object arg0)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        void</code>
    </td>

    <td width="100%">
      <code>
      finalize()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        Class&lt;?&gt;</code>
    </td>

    <td width="100%">
      <code>
      getClass()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        int</code>
    </td>

    <td width="100%">
      <code>
      hashCode()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      notify()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      notifyAll()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        String</code>
    </td>

    <td width="100%">
      <code>
      toString()
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait(long arg0, int arg1)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait(long arg0)
      </code>

    </td>
  </tr>


  <tr class="api apilevel-" >


    <td><code>


        final

        void</code>
    </td>

    <td width="100%">
      <code>
      wait()
      </code>

    </td>
  </tr>


    </table>
  </div>
</div>
</td></tr>


</table>


<!-- XML Attributes -->


<!-- Enum Values -->


<!-- Constants -->


<!-- Fields -->


<!-- Public ctors -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- Protected ctors -->


<!-- ========= METHOD DETAIL ======== -->
<!-- Public methdos -->

<h2 class="api-section">Public methods</h2>


<A NAME="clearLastTraversedText()"></A>

<div class="api apilevel-">
    <h3 class="api-name">clearLastTraversedText</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void clearLastTraversedText ()</pre>


  <p>Clears the text from the last UI traversal event.
 See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#getLastTraversedText()">getLastTraversedText()</a></code>.</p>


</div>


<A NAME="click(int, int)"></A>

<div class="api apilevel-">
    <h3 class="api-name">click</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean click (int x,
                int y)</pre>


  <p>Perform a click at arbitrary coordinates specified by the user</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>x</code></td>
        <td width="100%">
          <code>int</code>:
          coordinate</td>
      </tr>
      <tr>
        <td><code>y</code></td>
        <td width="100%">
          <code>int</code>:
          coordinate</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if the click succeeded else false</td>
      </tr>
    </table>

</div>


<A NAME="drag(int, int, int, int, int)"></A>

<div class="api apilevel-">
    <h3 class="api-name">drag</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean drag (int startX,
                int startY,
                int endX,
                int endY,
                int steps)</pre>


  <p>Performs a swipe from one coordinate to another coordinate. You can control
 the smoothness and speed of the swipe by specifying the number of steps.
 Each step execution is throttled to 5 milliseconds per step, so for a 100
 steps, the swipe will take around 0.5 seconds to complete.</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>startX</code></td>
        <td width="100%">
          <code>int</code>:
          X-axis value for the starting coordinate</td>
      </tr>
      <tr>
        <td><code>startY</code></td>
        <td width="100%">
          <code>int</code>:
          Y-axis value for the starting coordinate</td>
      </tr>
      <tr>
        <td><code>endX</code></td>
        <td width="100%">
          <code>int</code>:
          X-axis value for the ending coordinate</td>
      </tr>
      <tr>
        <td><code>endY</code></td>
        <td width="100%">
          <code>int</code>:
          Y-axis value for the ending coordinate</td>
      </tr>
      <tr>
        <td><code>steps</code></td>
        <td width="100%">
          <code>int</code>:
          is the number of steps for the swipe action</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if swipe is performed, false if the operation fails
 or the coordinates are invalid</td>
      </tr>
    </table>

</div>


<A NAME="dumpWindowHierarchy(java.io.File)"></A>

<div class="api apilevel-">
    <h3 class="api-name">dumpWindowHierarchy</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void dumpWindowHierarchy (File dest)</pre>


  <p>Dump the current window hierarchy to a <code><a href="/reference/java/io/File.html">File</a></code>.</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>dest</code></td>
        <td width="100%">
          <code>File</code>:
          The file in which to store the window hierarchy information.</td>
      </tr>
    </table>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code>IOException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="dumpWindowHierarchy(java.io.OutputStream)"></A>

<div class="api apilevel-">
    <h3 class="api-name">dumpWindowHierarchy</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void dumpWindowHierarchy (OutputStream out)</pre>


  <p>Dump the current window hierarchy to an <code><a href="/reference/java/io/OutputStream.html">OutputStream</a></code>.</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>out</code></td>
        <td width="100%">
          <code>OutputStream</code>:
          The output stream that the window hierarchy information is written to.</td>
      </tr>
    </table>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code>IOException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="dumpWindowHierarchy(java.lang.String)"></A>

<div class="api apilevel-">
    <h3 class="api-name">dumpWindowHierarchy</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void dumpWindowHierarchy (String fileName)</pre>


    <p>
  <p class="caution"><strong>
      This method is deprecated.</strong><br/>
    Use <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#dumpWindowHierarchy(java.io.File)">dumpWindowHierarchy(File)</a></code> or
     <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#dumpWindowHierarchy(java.io.OutputStream)">dumpWindowHierarchy(OutputStream)</a></code> instead.

  </p>
  <p>Helper method used for debugging to dump the current window's layout hierarchy.
 Relative file paths are stored the application's internal private storage location.</p>


</div>


<A NAME="findObject(android.support.test.uiautomator.BySelector)"></A>

<div class="api apilevel-">
    <h3 class="api-name">findObject</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
<a href="/reference/android/support/test/uiautomator/UiObject2.html">UiObject2</a> findObject (<a href="/reference/android/support/test/uiautomator/BySelector.html">BySelector</a> selector)</pre>


  <p>Returns the first object to match the <code>selector</code> criteria. </p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>selector</code></td>
        <td width="100%">
          <code>BySelector</code>
          <!-- no parameter comment --></td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code><a href="/reference/android/support/test/uiautomator/UiObject2.html">UiObject2</a></code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="findObject(android.support.test.uiautomator.UiSelector)"></A>

<div class="api apilevel-">
    <h3 class="api-name">findObject</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
<a href="/reference/android/support/test/uiautomator/UiObject.html">UiObject</a> findObject (<a href="/reference/android/support/test/uiautomator/UiSelector.html">UiSelector</a> selector)</pre>


  <p>Returns a UiObject which represents a view that matches the specified selector criteria.</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code><a href="/reference/android/support/test/uiautomator/UiObject.html">UiObject</a></code></td>
        <td width="100%">UiObject object
</td>
      </tr>
    </table>

</div>


<A NAME="findObjects(android.support.test.uiautomator.BySelector)"></A>

<div class="api apilevel-">
    <h3 class="api-name">findObjects</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
List&lt;<a href="/reference/android/support/test/uiautomator/UiObject2.html">UiObject2</a>&gt; findObjects (<a href="/reference/android/support/test/uiautomator/BySelector.html">BySelector</a> selector)</pre>


  <p>Returns all objects that match the <code>selector</code> criteria. </p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>selector</code></td>
        <td width="100%">
          <code>BySelector</code>
          <!-- no parameter comment --></td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>List&lt;<a href="/reference/android/support/test/uiautomator/UiObject2.html">UiObject2</a>&gt;</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="freezeRotation()"></A>

<div class="api apilevel-">
    <h3 class="api-name">freezeRotation</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void freezeRotation ()</pre>


  <p>Disables the sensors and freezes the device rotation at its
 current rotation state.</p>

      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="getCurrentActivityName()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getCurrentActivityName</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
String getCurrentActivityName ()</pre>


    <p>
  <p class="caution"><strong>
      This method is deprecated.</strong><br/>
    The results returned should be considered unreliable
  </p>
  <p>Retrieves the last activity to report accessibility events.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>String</code></td>
        <td width="100%">String name of activity</td>
      </tr>
    </table>

</div>


<A NAME="getCurrentPackageName()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getCurrentPackageName</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
String getCurrentPackageName ()</pre>


  <p>Retrieves the name of the last package to report accessibility events.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>String</code></td>
        <td width="100%">String name of package</td>
      </tr>
    </table>

</div>


<A NAME="getDisplayHeight()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getDisplayHeight</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
int getDisplayHeight ()</pre>


  <p>Gets the height of the display, in pixels. The size is adjusted based
 on the current orientation of the display.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>int</code></td>
        <td width="100%">height in pixels or zero on failure</td>
      </tr>
    </table>

</div>


<A NAME="getDisplayRotation()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getDisplayRotation</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
int getDisplayRotation ()</pre>


  <p>Returns the current rotation of the display, as defined in <code><a href="/reference/android/view/Surface.html">Surface</a></code></p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>int</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="getDisplaySizeDp()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getDisplaySizeDp</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
Point getDisplaySizeDp ()</pre>


  <p>Returns the display size in dp (device-independent pixel)

 The returned display size is adjusted per screen rotation. Also this will return the actual
 size of the screen, rather than adjusted per system decorations (like status bar).</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>Point</code></td>
        <td width="100%">a Point containing the display size in dp
</td>
      </tr>
    </table>

</div>


<A NAME="getDisplayWidth()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getDisplayWidth</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
int getDisplayWidth ()</pre>


  <p>Gets the width of the display, in pixels. The width and height details
 are reported based on the current orientation of the display.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>int</code></td>
        <td width="100%">width in pixels or zero on failure</td>
      </tr>
    </table>

</div>


<A NAME="getInstance()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getInstance</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
<a href="/reference/android/support/test/uiautomator/UiDevice.html">UiDevice</a> getInstance ()</pre>


    <p>
  <p class="caution"><strong>
      This method is deprecated.</strong><br/>
    Should use <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#getInstance(android.app.Instrumentation)">getInstance(Instrumentation)</a></code> instead. This version hides
 UiDevice's dependency on having an Instrumentation reference and is prone to misuse.
  </p>
  <p>Retrieves a singleton instance of UiDevice</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code><a href="/reference/android/support/test/uiautomator/UiDevice.html">UiDevice</a></code></td>
        <td width="100%">UiDevice instance</td>
      </tr>
    </table>

</div>


<A NAME="getInstance(android.app.Instrumentation)"></A>

<div class="api apilevel-">
    <h3 class="api-name">getInstance</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
<a href="/reference/android/support/test/uiautomator/UiDevice.html">UiDevice</a> getInstance (Instrumentation instrumentation)</pre>


  <p>Retrieves a singleton instance of UiDevice</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>instrumentation</code></td>
        <td width="100%">
          <code>Instrumentation</code>
          <!-- no parameter comment --></td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code><a href="/reference/android/support/test/uiautomator/UiDevice.html">UiDevice</a></code></td>
        <td width="100%">UiDevice instance
</td>
      </tr>
    </table>

</div>


<A NAME="getLastTraversedText()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getLastTraversedText</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
String getLastTraversedText ()</pre>


  <p>Retrieves the text from the last UI traversal event received.

 You can use this method to read the contents in a WebView container
 because the accessibility framework fires events
 as each text is highlighted. You can write a test to perform
 directional arrow presses to focus on different elements inside a WebView,
 and call this method to get the text from each traversed element.
 If you are testing a view container that can return a reference to a
 Document Object Model (DOM) object, your test should use the view's
 DOM instead.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>String</code></td>
        <td width="100%">text of the last traversal event, else return an empty string</td>
      </tr>
    </table>

</div>


<A NAME="getLauncherPackageName()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getLauncherPackageName</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
String getLauncherPackageName ()</pre>


  <p>Retrieves default launcher package name</p>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>String</code></td>
        <td width="100%">package name of the default launcher
</td>
      </tr>
    </table>

</div>


<A NAME="getProductName()"></A>

<div class="api apilevel-">
    <h3 class="api-name">getProductName</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
String getProductName ()</pre>


  <p>Retrieves the product name of the device.

 This method provides information on what type of device the test is running on. This value is
 the same as returned by invoking #adb shell getprop ro.product.name.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>String</code></td>
        <td width="100%">product name of the device</td>
      </tr>
    </table>

</div>


<A NAME="hasAnyWatcherTriggered()"></A>

<div class="api apilevel-">
    <h3 class="api-name">hasAnyWatcherTriggered</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean hasAnyWatcherTriggered ()</pre>


  <p>Checks if any registered <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> have triggered.

 See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#registerWatcher(java.lang.String, android.support.test.uiautomator.UiWatcher)">registerWatcher(String, UiWatcher)</a></code>
 See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#hasWatcherTriggered(java.lang.String)">hasWatcherTriggered(String)</a></code></p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="hasObject(android.support.test.uiautomator.BySelector)"></A>

<div class="api apilevel-">
    <h3 class="api-name">hasObject</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean hasObject (<a href="/reference/android/support/test/uiautomator/BySelector.html">BySelector</a> selector)</pre>


  <p>Returns whether there is a match for the given <code>selector</code> criteria. </p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>selector</code></td>
        <td width="100%">
          <code>BySelector</code>
          <!-- no parameter comment --></td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%"><!-- no returns description in source --></td>
      </tr>
    </table>

</div>


<A NAME="hasWatcherTriggered(java.lang.String)"></A>

<div class="api apilevel-">
    <h3 class="api-name">hasWatcherTriggered</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean hasWatcherTriggered (String watcherName)</pre>


  <p>Checks if a specific registered  <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> has triggered.
 See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#registerWatcher(java.lang.String, android.support.test.uiautomator.UiWatcher)">registerWatcher(String, UiWatcher)</a></code>. If a UiWatcher runs and its
 <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html#checkForCondition()">checkForCondition()</a></code> call returned <code>true</code>, then
 the UiWatcher is considered triggered. This is helpful if a watcher is detecting errors
 from ANR or crash dialogs and the test needs to know if a UiWatcher has been triggered.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if triggered else false</td>
      </tr>
    </table>

</div>


<A NAME="isNaturalOrientation()"></A>

<div class="api apilevel-">
    <h3 class="api-name">isNaturalOrientation</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean isNaturalOrientation ()</pre>


  <p>Check if the device is in its natural orientation. This is determined by checking if the
 orientation is at 0 or 180 degrees.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if it is in natural orientation</td>
      </tr>
    </table>

</div>


<A NAME="isScreenOn()"></A>

<div class="api apilevel-">
    <h3 class="api-name">isScreenOn</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean isScreenOn ()</pre>


  <p>Checks the power manager if the screen is ON.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if the screen is ON else false</td>
      </tr>
    </table>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="openNotification()"></A>

<div class="api apilevel-">
    <h3 class="api-name">openNotification</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean openNotification ()</pre>


  <p>Opens the notification shade.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="openQuickSettings()"></A>

<div class="api apilevel-">
    <h3 class="api-name">openQuickSettings</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean openQuickSettings ()</pre>


  <p>Opens the Quick Settings shade.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="performActionAndWait(java.lang.Runnable, android.support.test.uiautomator.EventCondition<R>, long)"></A>

<div class="api apilevel-">
    <h3 class="api-name">performActionAndWait</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
R performActionAndWait (Runnable action,
                <a href="/reference/android/support/test/uiautomator/EventCondition.html">EventCondition</a>&lt;R&gt; condition,
                long timeout)</pre>


  <p>Performs the provided <code>action</code> and waits for the <code>condition</code> to be met.</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>action</code></td>
        <td width="100%">
          <code>Runnable</code>:
          The <code><a href="/reference/java/lang/Runnable.html">Runnable</a></code> action to perform.</td>
      </tr>
      <tr>
        <td><code>condition</code></td>
        <td width="100%">
          <code>EventCondition</code>:
          The <code><a href="/reference/android/support/test/uiautomator/EventCondition.html">EventCondition</a></code> to evaluate.</td>
      </tr>
      <tr>
        <td><code>timeout</code></td>
        <td width="100%">
          <code>long</code>:
          Maximum amount of time to wait in milliseconds.</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>R</code></td>
        <td width="100%">The final result returned by the condition.
</td>
      </tr>
    </table>

</div>


<A NAME="pressBack()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressBack</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressBack ()</pre>


  <p>Simulates a short press on the BACK button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressDPadCenter()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressDPadCenter</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressDPadCenter ()</pre>


  <p>Simulates a short press on the CENTER button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressDPadDown()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressDPadDown</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressDPadDown ()</pre>


  <p>Simulates a short press on the DOWN button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressDPadLeft()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressDPadLeft</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressDPadLeft ()</pre>


  <p>Simulates a short press on the LEFT button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressDPadRight()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressDPadRight</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressDPadRight ()</pre>


  <p>Simulates a short press on the RIGHT button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressDPadUp()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressDPadUp</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressDPadUp ()</pre>


  <p>Simulates a short press on the UP button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressDelete()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressDelete</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressDelete ()</pre>


  <p>Simulates a short press on the DELETE key.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressEnter()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressEnter</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressEnter ()</pre>


  <p>Simulates a short press on the ENTER key.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressHome()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressHome</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressHome ()</pre>


  <p>Simulates a short press on the HOME button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressKeyCode(int)"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressKeyCode</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressKeyCode (int keyCode)</pre>


  <p>Simulates a short press using a key code.

 See <code><a href="/reference/android/view/KeyEvent.html">KeyEvent</a></code></p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>keyCode</code></td>
        <td width="100%">
          <code>int</code>
          <!-- no parameter comment --></td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressKeyCode(int, int)"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressKeyCode</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressKeyCode (int keyCode,
                int metaState)</pre>


  <p>Simulates a short press using a key code.

 See <code><a href="/reference/android/view/KeyEvent.html">KeyEvent</a></code>.</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>keyCode</code></td>
        <td width="100%">
          <code>int</code>:
          the key code of the event.</td>
      </tr>
      <tr>
        <td><code>metaState</code></td>
        <td width="100%">
          <code>int</code>:
          an integer in which each bit set to 1 represents a pressed meta key</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressMenu()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressMenu</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressMenu ()</pre>


  <p>Simulates a short press on the MENU button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="pressRecentApps()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressRecentApps</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressRecentApps ()</pre>


  <p>Simulates a short press on the Recent Apps button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="pressSearch()"></A>

<div class="api apilevel-">
    <h3 class="api-name">pressSearch</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean pressSearch ()</pre>


  <p>Simulates a short press on the SEARCH button.</p>

    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if successful, else return false</td>
      </tr>
    </table>

</div>


<A NAME="registerWatcher(java.lang.String, android.support.test.uiautomator.UiWatcher)"></A>

<div class="api apilevel-">
    <h3 class="api-name">registerWatcher</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void registerWatcher (String name,
                <a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a> watcher)</pre>


  <p>Registers a <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> to run automatically when the testing framework is unable to
 find a match using a <code><a href="/reference/android/support/test/uiautomator/UiSelector.html">UiSelector</a></code>. See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#runWatchers()">runWatchers()</a></code></p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>name</code></td>
        <td width="100%">
          <code>String</code>:
          to register the UiWatcher</td>
      </tr>
      <tr>
        <td><code>watcher</code></td>
        <td width="100%">
          <code>UiWatcher</code>:
          <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code></td>
      </tr>
    </table>

</div>


<A NAME="removeWatcher(java.lang.String)"></A>

<div class="api apilevel-">
    <h3 class="api-name">removeWatcher</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void removeWatcher (String name)</pre>


  <p>Removes a previously registered <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code>.

 See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#registerWatcher(java.lang.String, android.support.test.uiautomator.UiWatcher)">registerWatcher(String, UiWatcher)</a></code></p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>name</code></td>
        <td width="100%">
          <code>String</code>:
          used to register the UiWatcher</td>
      </tr>
    </table>

</div>


<A NAME="resetWatcherTriggers()"></A>

<div class="api apilevel-">
    <h3 class="api-name">resetWatcherTriggers</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void resetWatcherTriggers ()</pre>


  <p>Resets a <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></code> that has been triggered.
 If a UiWatcher runs and its <code><a href="/reference/android/support/test/uiautomator/UiWatcher.html#checkForCondition()">checkForCondition()</a></code> call
 returned <code>true</code>, then the UiWatcher is considered triggered.
 See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#registerWatcher(java.lang.String, android.support.test.uiautomator.UiWatcher)">registerWatcher(String, UiWatcher)</a></code></p>


</div>


<A NAME="runWatchers()"></A>

<div class="api apilevel-">
    <h3 class="api-name">runWatchers</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void runWatchers ()</pre>


  <p>This method forces all registered watchers to run.
 See <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#registerWatcher(java.lang.String, android.support.test.uiautomator.UiWatcher)">registerWatcher(String, UiWatcher)</a></code></p>


</div>


<A NAME="setCompressedLayoutHeirarchy(boolean)"></A>

<div class="api apilevel-">
    <h3 class="api-name">setCompressedLayoutHeirarchy</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void setCompressedLayoutHeirarchy (boolean compressed)</pre>


  <p>Enables or disables layout hierarchy compression.

 If compression is enabled, the layout hierarchy derived from the Acessibility
 framework will only contain nodes that are important for uiautomator
 testing. Any unnecessary surrounding layout nodes that make viewing
 and searching the hierarchy inefficient are removed.</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>compressed</code></td>
        <td width="100%">
          <code>boolean</code>:
          true to enable compression; else, false to disable</td>
      </tr>
    </table>

</div>


<A NAME="setOrientationLeft()"></A>

<div class="api apilevel-">
    <h3 class="api-name">setOrientationLeft</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void setOrientationLeft ()</pre>


  <p>Simulates orienting the device to the left and also freezes rotation
 by disabling the sensors.

 If you want to un-freeze the rotation and re-enable the sensors
 see <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#unfreezeRotation()">unfreezeRotation()</a></code>.</p>

      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="setOrientationNatural()"></A>

<div class="api apilevel-">
    <h3 class="api-name">setOrientationNatural</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void setOrientationNatural ()</pre>


  <p>Simulates orienting the device into its natural orientation and also freezes rotation
 by disabling the sensors.

 If you want to un-freeze the rotation and re-enable the sensors
 see <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#unfreezeRotation()">unfreezeRotation()</a></code>.</p>

      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="setOrientationRight()"></A>

<div class="api apilevel-">
    <h3 class="api-name">setOrientationRight</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void setOrientationRight ()</pre>


  <p>Simulates orienting the device to the right and also freezes rotation
 by disabling the sensors.

 If you want to un-freeze the rotation and re-enable the sensors
 see <code><a href="/reference/android/support/test/uiautomator/UiDevice.html#unfreezeRotation()">unfreezeRotation()</a></code>.</p>

      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="sleep()"></A>

<div class="api apilevel-">
    <h3 class="api-name">sleep</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void sleep ()</pre>


  <p>This method simply presses the power button if the screen is ON else
 it does nothing if the screen is already OFF.</p>

      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="swipe(int, int, int, int, int)"></A>

<div class="api apilevel-">
    <h3 class="api-name">swipe</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean swipe (int startX,
                int startY,
                int endX,
                int endY,
                int steps)</pre>


  <p>Performs a swipe from one coordinate to another using the number of steps
 to determine smoothness and speed. Each step execution is throttled to 5ms
 per step. So for a 100 steps, the swipe will take about 1/2 second to complete.</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>steps</code></td>
        <td width="100%">
          <code>int</code>:
          is the number of move steps sent to the system</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">false if the operation fails or the coordinates are invalid</td>
      </tr>
    </table>

</div>


<A NAME="swipe(android.graphics.Point[], int)"></A>

<div class="api apilevel-">
    <h3 class="api-name">swipe</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean swipe (Point[] segments,
                int segmentSteps)</pre>


  <p>Performs a swipe between points in the Point array. Each step execution is throttled
 to 5ms per step. So for a 100 steps, the swipe will take about 1/2 second to complete</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>segments</code></td>
        <td width="100%">
          <code>Point</code>:
          is Point array containing at least one Point object</td>
      </tr>
      <tr>
        <td><code>segmentSteps</code></td>
        <td width="100%">
          <code>int</code>:
          steps to inject between two Points</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true on success</td>
      </tr>
    </table>

</div>


<A NAME="takeScreenshot(java.io.File, float, int)"></A>

<div class="api apilevel-">
    <h3 class="api-name">takeScreenshot</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean takeScreenshot (File storePath,
                float scale,
                int quality)</pre>


  <p>Take a screenshot of current window and store it as PNG

 The screenshot is adjusted per screen rotation</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>storePath</code></td>
        <td width="100%">
          <code>File</code>:
          where the PNG should be written to</td>
      </tr>
      <tr>
        <td><code>scale</code></td>
        <td width="100%">
          <code>float</code>:
          scale the screenshot down if needed; 1.0f for original size</td>
      </tr>
      <tr>
        <td><code>quality</code></td>
        <td width="100%">
          <code>int</code>:
          quality of the PNG compression; range: 0-100</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if screen shot is created successfully, false otherwise</td>
      </tr>
    </table>

</div>


<A NAME="takeScreenshot(java.io.File)"></A>

<div class="api apilevel-">
    <h3 class="api-name">takeScreenshot</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean takeScreenshot (File storePath)</pre>


  <p>Take a screenshot of current window and store it as PNG

 Default scale of 1.0f (original size) and 90% quality is used
 The screenshot is adjusted per screen rotation</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>storePath</code></td>
        <td width="100%">
          <code>File</code>:
          where the PNG should be written to</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if screen shot is created successfully, false otherwise</td>
      </tr>
    </table>

</div>


<A NAME="unfreezeRotation()"></A>

<div class="api apilevel-">
    <h3 class="api-name">unfreezeRotation</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void unfreezeRotation ()</pre>


  <p>Re-enables the sensors and un-freezes the device rotation allowing its contents
 to rotate with the device physical rotation. During a test execution, it is best to
 keep the device frozen in a specific orientation until the test case execution has completed.</p>
      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<A NAME="wait(android.support.test.uiautomator.SearchCondition<R>, long)"></A>

<div class="api apilevel-">
    <h3 class="api-name">wait</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
R wait (<a href="/reference/android/support/test/uiautomator/SearchCondition.html">SearchCondition</a>&lt;R&gt; condition,
                long timeout)</pre>


  <p>Waits for given the <code>condition</code> to be met.</p>
    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>condition</code></td>
        <td width="100%">
          <code>SearchCondition</code>:
          The <code><a href="/reference/android/support/test/uiautomator/SearchCondition.html">SearchCondition</a></code> to evaluate.</td>
      </tr>
      <tr>
        <td><code>timeout</code></td>
        <td width="100%">
          <code>long</code>:
          Maximum amount of time to wait in milliseconds.</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>R</code></td>
        <td width="100%">The final result returned by the condition.
</td>
      </tr>
    </table>

</div>


<A NAME="waitForIdle(long)"></A>

<div class="api apilevel-">
    <h3 class="api-name">waitForIdle</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void waitForIdle (long timeout)</pre>


  <p>Waits for the current application to idle.</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>timeout</code></td>
        <td width="100%">
          <code>long</code>:
          in milliseconds</td>
      </tr>
    </table>

</div>


<A NAME="waitForIdle()"></A>

<div class="api apilevel-">
    <h3 class="api-name">waitForIdle</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void waitForIdle ()</pre>


  <p>Waits for the current application to idle.
 Default wait timeout is 10 seconds</p>


</div>


<A NAME="waitForWindowUpdate(java.lang.String, long)"></A>

<div class="api apilevel-">
    <h3 class="api-name">waitForWindowUpdate</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
boolean waitForWindowUpdate (String packageName,
                long timeout)</pre>


  <p>Waits for a window content update event to occur.

 If a package name for the window is specified, but the current window
 does not have the same package name, the function returns immediately.</p>

    <table class="responsive">
    <tr><th colspan=2>Parameters</th></tr>
      <tr>
        <td><code>packageName</code></td>
        <td width="100%">
          <code>String</code>:
          the specified window package name (can be <code>null</code>).
        If <code>null</code>, a window update from any front-end window will end the wait</td>
      </tr>
      <tr>
        <td><code>timeout</code></td>
        <td width="100%">
          <code>long</code>:
          the timeout for the wait</td>
      </tr>
    </table>
    <table class="responsive">
      <tr><th colspan=2>Returns</th></tr>
      <tr>
        <td><code>boolean</code></td>
        <td width="100%">true if a window update occurred, false if timeout has elapsed or if the current
         window does not have the specified package name</td>
      </tr>
    </table>

</div>


<A NAME="wakeUp()"></A>

<div class="api apilevel-">
    <h3 class="api-name">wakeUp</h3>
    <div class="api-level">
      <div></div>


    </div>
<pre class="api-signature no-pretty-print">
void wakeUp ()</pre>


  <p>This method simulates pressing the power button if the screen is OFF else
 it does nothing if the screen is already ON.

 If the screen was OFF and it just got turned ON, this method will insert a 500ms delay
 to allow the device time to wake up and accept input.</p>

      <table class="responsive">
      <tr><th colspan=2>Throws</th></tr>
        <tr>
          <td><code></code></td>
          <td width="100%">RemoteException</td>
        </tr>
        <tr>
          <td><code>RemoteException</code></td>
          <td width="100%"></td>
        </tr>
      </table>


</div>


<!-- ========= METHOD DETAIL ======== -->


<!-- ========= END OF CLASS DATA ========= -->

</div><!-- end jd-content -->


<div class="data-reference-resources-wrapper">

  <ul data-reference-resources>


    <li><h2>Interfaces</h2>
      <ul>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/IAutomationSupport.html">IAutomationSupport</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiWatcher.html">UiWatcher</a></li>
      </ul>
    </li>

    <li><h2>Classes</h2>
      <ul>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/By.html">By</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/BySelector.html">BySelector</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/Configurator.html">Configurator</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/EventCondition.html">EventCondition</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/SearchCondition.html">SearchCondition</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiAutomatorInstrumentationTestRunner.html">UiAutomatorInstrumentationTestRunner</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiAutomatorTestCase.html">UiAutomatorTestCase</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiCollection.html">UiCollection</a></li>
          <li class="selected api apilevel-"><a href="/reference/android/support/test/uiautomator/UiDevice.html">UiDevice</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiObject.html">UiObject</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiObject2.html">UiObject2</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiObject2Condition.html">UiObject2Condition</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiScrollable.html">UiScrollable</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiSelector.html">UiSelector</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/Until.html">Until</a></li>
      </ul>
    </li>

    <li><h2>Enums</h2>
      <ul>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/Direction.html">Direction</a></li>
      </ul>
    </li>

    <li><h2>Exceptions</h2>
      <ul>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/StaleObjectException.html">StaleObjectException</a></li>
          <li class="api apilevel-"><a href="/reference/android/support/test/uiautomator/UiObjectNotFoundException.html">UiObjectNotFoundException</a></li>
      </ul>
    </li>

  </ul>

</div>


</body>
</html>