Docs4dev
Docs
playwright / latest / api / class-androiddevice.html

AndroidDevice

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

Methods​

close​

Disconnects from the device.

Usage

await androidDevice.close();

Returns

drag​

Drags the widget defined by selector towards dest point.

Usage

await androidDevice.drag(selector, dest);
await androidDevice.drag(selector, dest, options);

Arguments

  • selector [AndroidSelector]

    Selector to drag.

  • dest Object

    Point to drag to.

  • options Object (optional)

    • speed number (optional)

      Optional speed of the drag in pixels per second.

    • timeout number (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

fill​

Fills the specific selector input box with text.

Usage

await androidDevice.fill(selector, text);
await androidDevice.fill(selector, text, options);

Arguments

  • selector [AndroidSelector]

    Selector to fill.

  • text string

    Text to be filled in the input box.

  • options Object (optional)

    • timeout number (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

fling​

Flings the widget defined by selector in the specified direction.

Usage

await androidDevice.fling(selector, direction);
await androidDevice.fling(selector, direction, options);

Arguments

  • selector [AndroidSelector]

    Selector to fling.

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

    Fling direction.

  • options Object (optional)

    • speed number (optional)

      Optional speed of the fling in pixels per second.

    • timeout number (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

info​

Returns information about a widget defined by selector.

Usage

await androidDevice.info(selector);

Arguments

  • selector [AndroidSelector]

    Selector to return information about.

Returns

installApk​

Installs an apk on the device.

Usage

await androidDevice.installApk(file);
await androidDevice.installApk(file, options);

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.

Returns

launchBrowser​

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

Usage

await androidDevice.launchBrowser();
await androidDevice.launchBrowser(options);

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)

      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', 'dark', 'no-preference'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'light'.

    • command string (optional)

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

    • deviceScaleFactor number (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 number

        Latitude between -90 and 90.

      • longitude number

        Longitude between -180 and 180.

      • accuracy number (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 (optional)

      • username string

      • password string

      • origin string (optional)

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

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

    • 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 and is not supported in Firefox. 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.

    • 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.

    • proxy Object (optional)

      • server string

        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)

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

      • username string (optional)

        Optional username to use if HTTP proxy requires authentication.

      • password string (optional)

        Optional password to use if HTTP proxy requires authentication.

      Network proxy settings.

    • recordHar Object (optional)

      • 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 string

        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.

      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.

    • recordVideo Object (optional)

      • dir string

        Path to the directory to put videos into.

      • size Object (optional)

        • width number

          Video frame width.

        • height number

          Video frame height.

        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.

      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.

    • 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)

      • width number

        page width in pixels.

      • height number

        page height in pixels.

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

    • 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.

    • videoSize Object (optional)

      Deprecated

      Use recordVideo instead.

      • width number

        Video frame width.

      • height number

        Video frame height.

    • videosPath string (optional)

      Deprecated

      Use recordVideo instead.

    • viewport null | Object (optional)

      • width number

        page width in pixels.

      • height number

        page height in pixels.

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

      note

      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.

Returns

longTap​

Performs a long tap on the widget defined by selector.

Usage

await androidDevice.longTap(selector);
await androidDevice.longTap(selector, options);

Arguments

  • selector [AndroidSelector]

    Selector to tap on.

  • options Object (optional)

    • timeout number (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

model​

Device model.

Usage

androidDevice.model();

Returns

open​

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

Usage

await androidDevice.open(command);

Arguments

Returns

pinchClose​

Pinches the widget defined by selector in the closing direction.

Usage

await androidDevice.pinchClose(selector, percent);
await androidDevice.pinchClose(selector, percent, options);

Arguments

  • selector [AndroidSelector]

    Selector to pinch close.

  • percent number

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

  • options Object (optional)

    • speed number (optional)

      Optional speed of the pinch in pixels per second.

    • timeout number (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

pinchOpen​

Pinches the widget defined by selector in the open direction.

Usage

await androidDevice.pinchOpen(selector, percent);
await androidDevice.pinchOpen(selector, percent, options);

Arguments

  • selector [AndroidSelector]

    Selector to pinch open.

  • percent number

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

  • options Object (optional)

    • speed number (optional)

      Optional speed of the pinch in pixels per second.

    • timeout number (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

press​

Presses the specific key in the widget defined by selector.

Usage

await androidDevice.press(selector, key);
await androidDevice.press(selector, key, options);

Arguments

  • selector [AndroidSelector]

    Selector to press the key in.

  • key [AndroidKey]

    The key to press.

  • options Object (optional)

    • timeout number (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

push​

Copies a file to the device.

Usage

await androidDevice.push(file, path);
await androidDevice.push(file, path, options);

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 number (optional)

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

Returns

screenshot​

Returns the buffer with the captured screenshot of the device.

Usage

await androidDevice.screenshot();
await androidDevice.screenshot(options);

Arguments

  • options Object (optional)

    • path string (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

scroll​

Scrolls the widget defined by selector in the specified direction.

Usage

await androidDevice.scroll(selector, direction, percent);
await androidDevice.scroll(selector, direction, percent, options);

Arguments

  • selector [AndroidSelector]

    Selector to scroll.

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

    Scroll direction.

  • percent number

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

  • options Object (optional)

    • speed number (optional)

      Optional speed of the scroll in pixels per second.

    • timeout number (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

serial​

Device serial number.

Usage

androidDevice.serial();

Returns

setDefaultTimeout​

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

Usage

androidDevice.setDefaultTimeout(timeout);

Arguments

  • timeout number

    Maximum time in milliseconds

shell​

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

Usage

await androidDevice.shell(command);

Arguments

  • command string

    Shell command to execute.

Returns

swipe​

Swipes the widget defined by selector in the specified direction.

Usage

await androidDevice.swipe(selector, direction, percent);
await androidDevice.swipe(selector, direction, percent, options);

Arguments

  • selector [AndroidSelector]

    Selector to swipe.

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

    Swipe direction.

  • percent number

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

  • options Object (optional)

    • speed number (optional)

      Optional speed of the swipe in pixels per second.

    • timeout number (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

tap​

Taps on the widget defined by selector.

Usage

await androidDevice.tap(selector);
await androidDevice.tap(selector, options);

Arguments

  • selector [AndroidSelector]

    Selector to tap on.

  • options Object (optional)

    • duration number (optional)

      Optional duration of the tap in milliseconds.

    • timeout number (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

wait​

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

Usage

await androidDevice.wait(selector);
await androidDevice.wait(selector, options);

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 number (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

waitForEvent​

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

Usage

await androidDevice.waitForEvent(event);
await androidDevice.waitForEvent(event, optionsOrPredicate);

Arguments

  • event string

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

  • optionsOrPredicate function | Object (optional)

    • predicate function

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

    • timeout number (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().

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

Returns

webView​

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.

Usage

await androidDevice.webView(selector);
await androidDevice.webView(selector, options);

Arguments

  • selector Object

    • pkg string (optional)

      Optional Package identifier.

    • socketName string (optional)

      Optional webview socket name.

  • options Object (optional)

    • timeout number (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

webViews​

Currently open WebViews.

Usage

androidDevice.webViews();

Returns

Properties​

input​

Usage

androidDevice.input

Type

Events​

on('close')​

Emitted when the device connection gets closed.

Usage

androidDevice.on('close', data => {});

Event data

on('webview')​

Emitted when a new WebView instance is detected.

Usage

androidDevice.on('webview', data => {});

Event data

© 2024 Microsoft
Licensed under the Apache License, Version 2.0.
https://playwright.dev/docs/api/class-androiddevice