Skip to content

AndroidDevice ​

Added in: v1.9

AndroidDevice represents a connected device, either real hardware or emulated. Devices can be obtained using android.devices().

Methods ​

androidDevice.close() ​

Added in: v1.9 async

Disconnects from the device.

androidDevice.drag() ​

Added in: v1.9 async

Drags the widget defined by selector towards dest point.

Arguments

  • selector AndroidSelector

    Selector to drag.

  • dest Object

    Point to drag to.

    • x float
    • y float
  • options Object (optional)

    • speed float (optional)

      Optional speed of the drag in pixels per second.

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.fill() ​

Added in: v1.9 async

Fills the specific selector input box with text.

Arguments

  • selector AndroidSelector

    Selector to fill.

  • text string

    Text to be filled in the input box.

  • options Object (optional)

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.fling() ​

Added in: v1.9 async

Flings the widget defined by selector in the specified direction.

Arguments

  • selector AndroidSelector

    Selector to fling.

  • direction "down" | "up" | "left" | "right"

    Fling direction.

  • options Object (optional)

    • speed float (optional)

      Optional speed of the fling in pixels per second.

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.info() ​

Added in: v1.9 async

Returns information about a widget defined by selector.

Arguments

  • selector AndroidSelector

    Selector to return information about.

Returns

  • Promise<AndroidElementInfo>

androidDevice.installApk() ​

Added in: v1.9 async

Installs an apk on the device.

Arguments

  • file string | Buffer

    Either a path to the apk file, or apk file content.

  • options Object (optional)

    • args Array<string> (optional)

      Optional arguments to pass to the shell:cmd package install call. Defaults to -r -t -S.

androidDevice.launchBrowser() ​

Added in: v1.9 async

Launches Chrome browser on the device, and returns its persistent context.

Arguments

  • options Object (optional)

    • acceptDownloads boolean (optional)

      Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.

    • args Array<string> (optional) Added in: v1.29

      WARNING

      Use custom browser args at your own risk, as some of them may break Playwright functionality.

      Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.

    • baseURL string (optional)

      When using page.goto(), page.route(), page.waitForURL(), page.waitForRequest(), or page.waitForResponse() it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples:

      • baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
      • baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
      • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
    • bypassCSP boolean (optional)

      Toggles bypassing page's Content-Security-Policy. Defaults to false.

    • colorScheme null | "light" | "dark" | "no-preference" (optional)

      Emulates prefers-colors-scheme media feature, supported values are 'light' and 'dark'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'light'.

    • contrast null | "no-preference" | "more" (optional)

      Emulates 'prefers-contrast' media feature, supported values are 'no-preference', 'more'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.

    • deviceScaleFactor float (optional)

      Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.

    • extraHTTPHeaders Object<string, string> (optional)

      An object containing additional HTTP headers to be sent with every request. Defaults to none.

    • forcedColors null | "active" | "none" (optional)

      Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'none'.

    • geolocation Object (optional)

      • latitude float

        Latitude between -90 and 90.

      • longitude float

        Longitude between -180 and 180.

      • accuracy float (optional)

        Non-negative accuracy value. Defaults to 0.

    • hasTouch boolean (optional)

      Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.

    • httpCredentials Object | Array<Object> (optional)

      Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

      Pass an array to use different credentials for different origins. The first entry that matches the request origin is used, and entries with no origin match any request.

      • username string

      • password string

      • origin string (optional)

        Restrain sending http credentials on specific origin (scheme://host:port).

      • send "unauthorized" | "always" (optional)

        This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.

    • ignoreHTTPSErrors boolean (optional)

      Whether to ignore HTTPS errors when sending network requests. Defaults to false.

    • isMobile boolean (optional)

      Whether the meta viewport tag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults to false. Learn more about mobile emulation.

    • javaScriptEnabled boolean (optional)

      Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.

    • locale string (optional)

      Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.

    • locateOnlyVisible boolean (optional)

      Whether locators in this context find only visible elements. Defaults to false.

      When enabled, Playwright applies two rules:

      1. The element that a locator finds must be visible. Actions, assertions and queries behave as if locator.visible() was called at the end of the locator chain.
      2. locator.first(), locator.last() and locator.nth() select among visible elements. They behave as if locator.visible() was called immediately before them.
      js
      // <div hidden>One</div> <div>Two</div> <div>Three</div>
      await expect(page.locator('div')).toHaveCount(2);
      await expect(page.locator('div').first()).toHaveText('Two');
      await expect(page.locator('div').last()).toHaveText('Three');

      An explicit visibility filter always has priority. Playwright does not add its own filter in a position that already has one. For example, page.locator('div').filter({ visible: false }).first() finds the first hidden element.

      All other parts of the locator chain are not filtered. In page.locator('section').getByRole('button'), the button must be visible, but the section can be hidden by the visibility rules, for example because it has zero size. The same applies to the inner locators of locator.filter(),

      locator.and() and locator.or(): only the second rule applies to them.

      This option does not change the accessibility rules of page.getByRole() or the behavior of selector-based methods such as page.$().

    • logger Logger (optional)

      Logger sink for Playwright logging.

    • offline boolean (optional)

      Whether to emulate network being offline. Defaults to false. Learn more about network emulation.

    • permissions Array<string> (optional)

      A list of permissions to grant to all pages in this context. See browserContext.grantPermissions() for more details. Defaults to none.

    • pkg string (optional)

      Optional package name to launch instead of default Chrome for Android.

    • proxy Object (optional) Added in: v1.29

      Network proxy settings.

      • server string Added in: v1.29

        Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.

      • bypass string (optional) Added in: v1.29

        Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".

      • username string (optional) Added in: v1.29

        Optional username to use if HTTP proxy requires authentication.

      • password string (optional) Added in: v1.29

        Optional password to use if HTTP proxy requires authentication.

    • recordHar Object (optional)

      Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close() for the HAR to be saved.

      • omitContent boolean (optional)

        Optional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use content policy instead.

      • content "omit" | "embed" | "attach" (optional)

        Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file as per HAR specification. Defaults to attach for .zip output files and to embed for all other file extensions.

      • path path

        Path on the filesystem to write the HAR file to. If the file name ends with .zip, content: 'attach' is used by default.

      • mode "full" | "minimal" (optional)

        When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.

      • urlFilter string | RegExp (optional)

        A glob or regex pattern to filter requests that are stored in the HAR. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor. Defaults to none.

    • recordVideo Object (optional)

      Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close() for videos to be saved.

      • dir path (optional)

        Path to the directory to put videos into. If not specified, the videos will be stored in artifactsDir (see browserType.launch() options).

      • size Object (optional)

        Optional dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.

        • width int

          Video frame width.

        • height int

          Video frame height.

      • fps int (optional)

        Frame rate of the recorded videos in frames per second. Defaults to 25. Firefox and WebKit currently capture up to 25 frames per second.

      • showActions Object (optional)

        If specified, enables visual annotations on interacted elements during video recording.

        • duration float (optional)

          How long each annotation is displayed in milliseconds. Defaults to 500.

        • position "top-left" | "top" | "top-right" | "bottom-left" | "bottom" | "bottom-right" (optional)

          Position of the action title overlay. Defaults to "top-right".

        • fontSize int (optional)

          Font size of the action title in pixels. Defaults to 24. Deprecated, use style.title instead.

        • cursor "none" | "pointer" (optional)

          Cursor decoration shown for pointer actions. "pointer" (the default) renders a mouse pointer that animates from the previous action point to the next one. "none" disables the cursor decoration.

        • style Object (optional)

          Styles of the action decorations.

          • point string (optional)

            CSS declarations for the zero-sized marker centered on the action point. Not shown when omitted.

          • highlight string (optional)

            CSS declarations for the box that covers the target element. Not shown when omitted.

          • title string (optional)

            CSS declarations for the action title.

    • reducedMotion null | "reduce" | "no-preference" (optional)

      Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.

    • screen Object (optional)

      Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.

      • width int

        page width in pixels.

      • height int

        page height in pixels.

    • serviceWorkers "allow" | "block" (optional)

      Whether to allow sites to register Service workers. Defaults to 'allow'.

      • 'allow': Service Workers can be registered.
      • 'block': Playwright will block all registration of Service Workers.
    • strictSelectors boolean (optional)

      If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to false. See Locator to learn more about the strict mode.

    • timezoneId string (optional)

      Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.

    • userAgent string (optional)

      Specific user agent to use in this context.

    • viewport null | Object (optional)

      Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent viewport emulation. Learn more about viewport emulation.

      INFO

      The null value opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.

      • width int

        page width in pixels.

      • height int

        page height in pixels.

Returns

  • Promise<BrowserContext>

androidDevice.longTap() ​

Added in: v1.9 async

Performs a long tap on the widget defined by selector.

Arguments

  • selector AndroidSelector

    Selector to tap on.

  • options Object (optional)

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.model() ​

Added in: v1.9

Device model.

Returns

  • string

androidDevice.open() ​

Added in: v1.9 async

Launches a process in the shell on the device and returns a socket to communicate with the launched process.

Arguments

  • command string

    Shell command to execute.

Returns

  • Promise<AndroidSocket>

androidDevice.pinchClose() ​

Added in: v1.9 async

Pinches the widget defined by selector in the closing direction.

Arguments

  • selector AndroidSelector

    Selector to pinch close.

  • percent float

    The size of the pinch as a percentage of the widget's size.

  • options Object (optional)

    • speed float (optional)

      Optional speed of the pinch in pixels per second.

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.pinchOpen() ​

Added in: v1.9 async

Pinches the widget defined by selector in the open direction.

Arguments

  • selector AndroidSelector

    Selector to pinch open.

  • percent float

    The size of the pinch as a percentage of the widget's size.

  • options Object (optional)

    • speed float (optional)

      Optional speed of the pinch in pixels per second.

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.press() ​

Added in: v1.9 async

Presses the specific key in the widget defined by selector.

Arguments

  • selector AndroidSelector

    Selector to press the key in.

  • key AndroidKey

    The key to press.

  • options Object (optional)

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.push() ​

Added in: v1.9 async

Copies a file to the device.

Arguments

  • file string | Buffer

    Either a path to the file, or file content.

  • path string

    Path to the file on the device.

  • options Object (optional)

    • mode int (optional)

      Optional file mode, defaults to 644 (rw-r--r--).

androidDevice.screenshot() ​

Added in: v1.9 async

Returns the buffer with the captured screenshot of the device.

Arguments

  • options Object (optional)

    • path path (optional)

      The file path to save the image to. If path is a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk.

Returns

  • Promise<Buffer>

androidDevice.scroll() ​

Added in: v1.9 async

Scrolls the widget defined by selector in the specified direction.

Arguments

  • selector AndroidSelector

    Selector to scroll.

  • direction "down" | "up" | "left" | "right"

    Scroll direction.

  • percent float

    Distance to scroll as a percentage of the widget's size.

  • options Object (optional)

    • speed float (optional)

      Optional speed of the scroll in pixels per second.

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.serial() ​

Added in: v1.9

Device serial number.

Returns

  • string

androidDevice.setDefaultTimeout() ​

Added in: v1.9

This setting will change the default maximum time for all the methods accepting timeout option.

Arguments

  • timeout float

    Maximum time in milliseconds

androidDevice.shell() ​

Added in: v1.9 async

Executes a shell command on the device and returns its output.

Arguments

  • command string

    Shell command to execute.

Returns

  • Promise<Buffer>

androidDevice.swipe() ​

Added in: v1.9 async

Swipes the widget defined by selector in the specified direction.

Arguments

  • selector AndroidSelector

    Selector to swipe.

  • direction "down" | "up" | "left" | "right"

    Swipe direction.

  • percent float

    Distance to swipe as a percentage of the widget's size.

  • options Object (optional)

    • speed float (optional)

      Optional speed of the swipe in pixels per second.

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.tap() ​

Added in: v1.9 async

Taps on the widget defined by selector.

Arguments

  • selector AndroidSelector

    Selector to tap on.

  • options Object (optional)

    • duration float (optional)

      Optional duration of the tap in milliseconds.

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.wait() ​

Added in: v1.9 async

Waits for the specific selector to either appear or disappear, depending on the state.

Arguments

  • selector AndroidSelector

    Selector to wait for.

  • options Object (optional)

    • state "gone" (optional)

      Optional state. Can be either:

      • default - wait for element to be present.
      • 'gone' - wait for element to not be present.
    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

androidDevice.waitForEvent() ​

Added in: v1.9 async

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value.

Arguments

  • event string

    Event name, same one typically passed into *.on(event).

  • optionsOrPredicate function() | Object (optional)

    Either a predicate that receives an event or an options object. Optional.

    • predicate function()

      receives the event data and resolves to truthy value when the waiting should resolve.

    • timeout float (optional)

      maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout().

Returns

  • Promise<any>

androidDevice.webView() ​

Added in: v1.9 async

This method waits until AndroidWebView matching the selector is opened and returns it. If there is already an open AndroidWebView matching the selector, returns immediately.

Arguments

  • selector Object

    • pkg string (optional)

      Optional Package identifier.

    • socketName string (optional)

      Optional webview socket name.

  • options Object (optional)

    • timeout float (optional)

      Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout() method.

Returns

  • Promise<AndroidWebView>

androidDevice.webViews() ​

Added in: v1.9

Currently open WebViews.

Returns

  • Array<AndroidWebView>

Properties ​

androidDevice.input ​

Added in: v1.9

Type

  • AndroidInput

Events ​

androidDevice.on('close') ​

Added in: v1.28

Emitted when the device connection gets closed.

Event data

  • AndroidDevice

androidDevice.on('webView') ​

Added in: v1.9

Emitted when a new WebView instance is detected.

Event data

  • AndroidWebView

Released under the Apache 2.0 License.