Interface AndroidDevice

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

interface AndroidDevice {
    input: AndroidInput;
    "[asyncDispose]"(): Promise<void>;
    addListener(
        event: "close",
        listener: (androidDevice: AndroidDevice) => any,
    ): this;
    addListener(
        event: "webview",
        listener: (androidWebView: AndroidWebView) => any,
    ): this;
    close(): Promise<void>;
    drag(
        selector: AndroidSelector,
        dest: { x: number; y: number },
        options?: { speed?: number; timeout?: number },
    ): Promise<void>;
    fill(
        selector: AndroidSelector,
        text: string,
        options?: { timeout?: number },
    ): Promise<void>;
    fling(
        selector: AndroidSelector,
        direction: "down" | "up" | "left" | "right",
        options?: { speed?: number; timeout?: number },
    ): Promise<void>;
    info(selector: AndroidSelector): Promise<AndroidElementInfo>;
    installApk(
        file: string | Buffer<ArrayBufferLike>,
        options?: { args?: string[] },
    ): Promise<void>;
    launchBrowser(
        options?: {
            acceptDownloads?: boolean;
            args?: string[];
            baseURL?: string;
            bypassCSP?: boolean;
            colorScheme?: "light" | "dark" | "no-preference" | null;
            contrast?: "no-preference" | "more" | null;
            deviceScaleFactor?: number;
            extraHTTPHeaders?: { [key: string]: string };
            forcedColors?: "none" | "active" | null;
            geolocation?: { accuracy?: number; latitude: number; longitude: number };
            hasTouch?: boolean;
            httpCredentials?: {
                origin?: string;
                password: string;
                send?: "always" | "unauthorized";
                username: string;
            };
            ignoreHTTPSErrors?: boolean;
            isMobile?: boolean;
            javaScriptEnabled?: boolean;
            locale?: string;
            logger?: Logger;
            offline?: boolean;
            permissions?: string[];
            pkg?: string;
            proxy?: {
                bypass?: string;
                password?: string;
                server: string;
                username?: string;
            };
            recordHar?: {
                content?: "embed"
                | "attach"
                | "omit";
                mode?: "full" | "minimal";
                omitContent?: boolean;
                path: string;
                urlFilter?: string | RegExp;
            };
            recordVideo?: {
                dir?: string;
                showActions?: {
                    cursor?: "none"
                    | "pointer";
                    duration?: number;
                    fontSize?: number;
                    position?:
                        | "top-left"
                        | "top"
                        | "top-right"
                        | "bottom-left"
                        | "bottom"
                        | "bottom-right";
                };
                size?: { height: number; width: number };
            };
            reducedMotion?: "reduce"
            | "no-preference"
            | null;
            screen?: { height: number; width: number };
            serviceWorkers?: "block" | "allow";
            strictSelectors?: boolean;
            timezoneId?: string;
            userAgent?: string;
            viewport?: { height: number; width: number } | null;
        },
    ): Promise<BrowserContext>;
    longTap(
        selector: AndroidSelector,
        options?: { timeout?: number },
    ): Promise<void>;
    model(): string;
    off(event: "close", listener: (androidDevice: AndroidDevice) => any): this;
    off(
        event: "webview",
        listener: (androidWebView: AndroidWebView) => any,
    ): this;
    on(event: "close", listener: (androidDevice: AndroidDevice) => any): this;
    on(
        event: "webview",
        listener: (androidWebView: AndroidWebView) => any,
    ): this;
    once(event: "close", listener: (androidDevice: AndroidDevice) => any): this;
    once(
        event: "webview",
        listener: (androidWebView: AndroidWebView) => any,
    ): this;
    open(command: string): Promise<AndroidSocket>;
    pinchClose(
        selector: AndroidSelector,
        percent: number,
        options?: { speed?: number; timeout?: number },
    ): Promise<void>;
    pinchOpen(
        selector: AndroidSelector,
        percent: number,
        options?: { speed?: number; timeout?: number },
    ): Promise<void>;
    prependListener(
        event: "close",
        listener: (androidDevice: AndroidDevice) => any,
    ): this;
    prependListener(
        event: "webview",
        listener: (androidWebView: AndroidWebView) => any,
    ): this;
    press(
        selector: AndroidSelector,
        key: AndroidKey,
        options?: { timeout?: number },
    ): Promise<void>;
    push(
        file: string | Buffer<ArrayBufferLike>,
        path: string,
        options?: { mode?: number },
    ): Promise<void>;
    removeListener(
        event: "close",
        listener: (androidDevice: AndroidDevice) => any,
    ): this;
    removeListener(
        event: "webview",
        listener: (androidWebView: AndroidWebView) => any,
    ): this;
    screenshot(options?: { path?: string }): Promise<Buffer<ArrayBufferLike>>;
    scroll(
        selector: AndroidSelector,
        direction: "down" | "up" | "left" | "right",
        percent: number,
        options?: { speed?: number; timeout?: number },
    ): Promise<void>;
    serial(): string;
    setDefaultTimeout(timeout: number): void;
    shell(command: string): Promise<Buffer<ArrayBufferLike>>;
    swipe(
        selector: AndroidSelector,
        direction: "down" | "up" | "left" | "right",
        percent: number,
        options?: { speed?: number; timeout?: number },
    ): Promise<void>;
    tap(
        selector: AndroidSelector,
        options?: { duration?: number; timeout?: number },
    ): Promise<void>;
    wait(
        selector: AndroidSelector,
        options?: { state?: "gone"; timeout?: number },
    ): Promise<void>;
    waitForEvent(
        event: "close",
        optionsOrPredicate?:
            | {
                predicate?: (
                    androidDevice: AndroidDevice,
                ) => boolean | Promise<boolean>;
                signal?: AbortSignal;
                timeout?: number;
            }
            | ((androidDevice: AndroidDevice) => boolean | Promise<boolean>),
    ): Promise<AndroidDevice>;
    waitForEvent(
        event: "webview",
        optionsOrPredicate?:
            | {
                predicate?: (
                    androidWebView: AndroidWebView,
                ) => boolean | Promise<boolean>;
                signal?: AbortSignal;
                timeout?: number;
            }
            | ((androidWebView: AndroidWebView) => boolean | Promise<boolean>),
    ): Promise<AndroidWebView>;
    webView(
        selector: { pkg?: string; socketName?: string },
        options?: { timeout?: number },
    ): Promise<AndroidWebView>;
    webViews(): AndroidWebView[];
}

Index

Properties

input

input: AndroidInput

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24736

addListener

addListener(
event: "close",
listener: (androidDevice: AndroidDevice) => any,
): this
Emitted when the device connection gets closed.
Parameters
- event: "close"
- listener: (androidDevice: AndroidDevice) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23959
addListener(
event: "webview",
listener: (androidWebView: AndroidWebView) => any,
): this
Emitted when a new WebView instance is detected.
Parameters
- event: "webview"
- listener: (androidWebView: AndroidWebView) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23964

close

close(): Promise<void>
Disconnects from the device.

Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23999

drag

drag(
    selector: AndroidSelector,
    dest: { x: number; y: number },
    options?: { speed?: number; timeout?: number },
): Promise<void>
Drags the widget defined by selector towards dest point.
Parameters
- selector: AndroidSelector
  Selector to drag.
- dest: { x: number; y: number }
  Point to drag to.
- Optionaloptions: { speed?: number; timeout?: number }
  - Optionalspeed?: number
    
    Optional speed of the drag in pixels per second.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24009

fill

fill(
    selector: AndroidSelector,
    text: string,
    options?: { timeout?: number },
): Promise<void>
Fills the specific selector input box with text.
Parameters
- selector: AndroidSelector
  Selector to fill.
- text: string
  Text to be filled in the input box.
- Optionaloptions: { timeout?: number }
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24036

fling

fling(
    selector: AndroidSelector,
    direction: "down" | "up" | "left" | "right",
    options?: { speed?: number; timeout?: number },
): Promise<void>
Flings the widget defined by selector in the specified direction.
Parameters
- selector: AndroidSelector
  Selector to fling.
- direction: "down" | "up" | "left" | "right"
  Fling direction.
- Optionaloptions: { speed?: number; timeout?: number }
  - Optionalspeed?: number
    
    Optional speed of the fling in pixels per second.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24054

info

info(selector: AndroidSelector): Promise<AndroidElementInfo>
Returns information about a widget defined by selector.
Parameters
- selector: AndroidSelector
  Selector to return information about.
Returns Promise<AndroidElementInfo>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24074

installApk

installApk(
file: string | Buffer<ArrayBufferLike>,
options?: { args?: string[] },
): Promise<void>
Installs an apk on the device.
Parameters
- file: string | Buffer<ArrayBufferLike>
  Either a path to the apk file, or apk file content.
- Optionaloptions: { args?: string[] }
  - Optionalargs?: string[]
    
    Optional arguments to pass to the shell:cmd package install call. Defaults to -r -t -S.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24081

launchBrowser

launchBrowser(
    options?: {
        acceptDownloads?: boolean;
        args?: string[];
        baseURL?: string;
        bypassCSP?: boolean;
        colorScheme?: "light" | "dark" | "no-preference" | null;
        contrast?: "no-preference" | "more" | null;
        deviceScaleFactor?: number;
        extraHTTPHeaders?: { [key: string]: string };
        forcedColors?: "none" | "active" | null;
        geolocation?: { accuracy?: number; latitude: number; longitude: number };
        hasTouch?: boolean;
        httpCredentials?: {
            origin?: string;
            password: string;
            send?: "always" | "unauthorized";
            username: string;
        };
        ignoreHTTPSErrors?: boolean;
        isMobile?: boolean;
        javaScriptEnabled?: boolean;
        locale?: string;
        logger?: Logger;
        offline?: boolean;
        permissions?: string[];
        pkg?: string;
        proxy?: {
            bypass?: string;
            password?: string;
            server: string;
            username?: string;
        };
        recordHar?: {
            content?: "embed"
            | "attach"
            | "omit";
            mode?: "full" | "minimal";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        };
        recordVideo?: {
            dir?: string;
            showActions?: {
                cursor?: "none"
                | "pointer";
                duration?: number;
                fontSize?: number;
                position?:
                    | "top-left"
                    | "top"
                    | "top-right"
                    | "bottom-left"
                    | "bottom"
                    | "bottom-right";
            };
            size?: { height: number; width: number };
        };
        reducedMotion?: "reduce"
        | "no-preference"
        | null;
        screen?: { height: number; width: number };
        serviceWorkers?: "block" | "allow";
        strictSelectors?: boolean;
        timezoneId?: string;
        userAgent?: string;
        viewport?: { height: number; width: number } | null;
    },
): Promise<BrowserContext>
Launches Chrome browser on the device, and returns its persistent context.
Parameters
- Optionaloptions: {
      acceptDownloads?: boolean;
      args?: string[];
      baseURL?: string;
      bypassCSP?: boolean;
      colorScheme?: "light" | "dark" | "no-preference" | null;
      contrast?: "no-preference" | "more" | null;
      deviceScaleFactor?: number;
      extraHTTPHeaders?: { [key: string]: string };
      forcedColors?: "none" | "active" | null;
      geolocation?: { accuracy?: number; latitude: number; longitude: number };
      hasTouch?: boolean;
      httpCredentials?: {
          origin?: string;
          password: string;
          send?: "always" | "unauthorized";
          username: string;
      };
      ignoreHTTPSErrors?: boolean;
      isMobile?: boolean;
      javaScriptEnabled?: boolean;
      locale?: string;
      logger?: Logger;
      offline?: boolean;
      permissions?: string[];
      pkg?: string;
      proxy?: {
          bypass?: string;
          password?: string;
          server: string;
          username?: string;
      };
      recordHar?: {
          content?: "embed"
          | "attach"
          | "omit";
          mode?: "full" | "minimal";
          omitContent?: boolean;
          path: string;
          urlFilter?: string | RegExp;
      };
      recordVideo?: {
          dir?: string;
          showActions?: {
              cursor?: "none"
              | "pointer";
              duration?: number;
              fontSize?: number;
              position?:
                  | "top-left"
                  | "top"
                  | "top-right"
                  | "bottom-left"
                  | "bottom"
                  | "bottom-right";
          };
          size?: { height: number; width: number };
      };
      reducedMotion?: "reduce"
      | "no-preference"
      | null;
      screen?: { height: number; width: number };
      serviceWorkers?: "block" | "allow";
      strictSelectors?: boolean;
      timezoneId?: string;
      userAgent?: string;
      viewport?: { height: number; width: number } | null;
  }
  - OptionalacceptDownloads?: boolean
    
    Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
  - Optionalargs?: string[]
    
    NOTE 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.
  - OptionalbaseURL?: string
    
    When using page.goto(url[, options]), page.route(url, handler[, options]), page.waitForURL(url[, options]), page.waitForRequest(urlOrPredicate[, options]), or page.waitForResponse(urlOrPredicate[, options]) 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
  - OptionalbypassCSP?: boolean
    
    Toggles bypassing page's Content-Security-Policy. Defaults to false.
  - OptionalcolorScheme?: "light" | "dark" | "no-preference" | null
    
    Emulates prefers-colors-scheme media feature, supported values are 'light' and 'dark'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'light'.
  - Optionalcontrast?: "no-preference" | "more" | null
    
    Emulates 'prefers-contrast' media feature, supported values are 'no-preference', 'more'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
  - OptionaldeviceScaleFactor?: number
    
    Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.
  - OptionalextraHTTPHeaders?: { [key: string]: string }
    
    An object containing additional HTTP headers to be sent with every request. Defaults to none.
  - OptionalforcedColors?: "none" | "active" | null
    
    Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'none'.
  - Optionalgeolocation?: { accuracy?: number; latitude: number; longitude: number }
    
    Optionalaccuracy?: number
    
    Non-negative accuracy value. Defaults to 0.
    
    latitude: number
    
    Latitude between -90 and 90.
    
    longitude: number
    
    Longitude between -180 and 180.
  - OptionalhasTouch?: boolean
    
    Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
  - OptionalhttpCredentials?: {
        origin?: string;
        password: string;
        send?: "always" | "unauthorized";
        username: string;
    }
    
    Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
    
    Optionalorigin?: string
    
    Restrain sending http credentials on specific origin (scheme://host:port).
    
    password: string
    
    Optionalsend?: "always" | "unauthorized"
    
    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'.
    
    username: string
  - OptionalignoreHTTPSErrors?: boolean
    
    Whether to ignore HTTPS errors when sending network requests. Defaults to false.
  - OptionalisMobile?: boolean
    
    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.
  - OptionaljavaScriptEnabled?: boolean
    
    Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.
  - Optionallocale?: string
    
    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.
  - Optionallogger?: Logger
    
    Logger sink for Playwright logging.
    
    Deprecated
    The logs received by the logger are incomplete. Please use tracing instead.
  - Optionaloffline?: boolean
    
    Whether to emulate network being offline. Defaults to false. Learn more about network emulation.
  - Optionalpermissions?: string[]
    
    A list of permissions to grant to all pages in this context. See browserContext.grantPermissions(permissions[, options]) for more details. Defaults to none.
  - Optionalpkg?: string
    
    Optional package name to launch instead of default Chrome for Android.
  - Optionalproxy?: { bypass?: string; password?: string; server: string; username?: string }
    
    Network proxy settings.
    
    Optionalbypass?: string
    
    Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
    
    Optionalpassword?: string
    
    Optional password to use if HTTP proxy requires authentication.
    
    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.
    
    Optionalusername?: string
    
    Optional username to use if HTTP proxy requires authentication.
  - OptionalrecordHar?: {
        content?: "embed" | "attach" | "omit";
        mode?: "full" | "minimal";
        omitContent?: boolean;
        path: string;
        urlFilter?: string | RegExp;
    }
    
    Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close([options]) for the HAR to be saved.
    
    Optionalcontent?: "embed" | "attach" | "omit"
    
    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.
    
    Optionalmode?: "full" | "minimal"
    
    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.
    
    OptionalomitContent?: boolean
    
    Optional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use content policy instead.
    
    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.
    
    OptionalurlFilter?: string | RegExp
    
    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.
  - OptionalrecordVideo?: {
        dir?: string;
        showActions?: {
            cursor?: "none" | "pointer";
            duration?: number;
            fontSize?: number;
            position?:
                | "top-left"
                | "top"
                | "top-right"
                | "bottom-left"
                | "bottom"
                | "bottom-right";
        };
        size?: { height: number; width: number };
    }
    
    Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close([options]) for videos to be saved.
    
    Optionaldir?: string
    
    Path to the directory to put videos into. If not specified, the videos will be stored in artifactsDir (see browserType.launch([options]) options).
    
    OptionalshowActions?: {
        cursor?: "none" | "pointer";
        duration?: number;
        fontSize?: number;
        position?:
            | "top-left"
            | "top"
            | "top-right"
            | "bottom-left"
            | "bottom"
            | "bottom-right";
    }
    
    If specified, enables visual annotations on interacted elements during video recording.
    
    Optionalcursor?: "none" | "pointer"
    
    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.
    
    Optionalduration?: number
    
    How long each annotation is displayed in milliseconds. Defaults to 500.
    
    OptionalfontSize?: number
    
    Font size of the action title in pixels. Defaults to 24.
    
    Optionalposition?: "top-left" | "top" | "top-right" | "bottom-left" | "bottom" | "bottom-right"
    
    Position of the action title overlay. Defaults to "top-right".
    
    Optionalsize?: { height: number; width: number }
    
    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.
    
    height: number
    
    Video frame height.
    
    width: number
    
    Video frame width.
  - OptionalreducedMotion?: "reduce" | "no-preference" | null
    
    Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See page.emulateMedia([options]) for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
  - Optionalscreen?: { height: number; width: number }
    
    Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
    
    height: number
    
    page height in pixels.
    
    width: number
    
    page width in pixels.
  - OptionalserviceWorkers?: "block" | "allow"
    
    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.
  - OptionalstrictSelectors?: boolean
    
    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.
  - OptionaltimezoneId?: string
    
    Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
  - OptionaluserAgent?: string
    
    Specific user agent to use in this context.
  - Optionalviewport?: { height: number; width: number } | null
    
    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 Promise<BrowserContext>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24092

longTap

longTap(
selector: AndroidSelector,
options?: { timeout?: number },
): Promise<void>
Performs a long tap on the widget defined by selector.
Parameters
- selector: AndroidSelector
  Selector to tap on.
- Optionaloptions: { timeout?: number }
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24462

model

model(): string
Device model.

Returns string
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24475

off

off(event: "close", listener: (androidDevice: AndroidDevice) => any): this
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: (androidDevice: AndroidDevice) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23979
off(event: "webview", listener: (androidWebView: AndroidWebView) => any): this
Removes an event listener added by on or addListener.
Parameters
- event: "webview"
- listener: (androidWebView: AndroidWebView) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23984

on

on(event: "close", listener: (androidDevice: AndroidDevice) => any): this
Emitted when the device connection gets closed.
Parameters
- event: "close"
- listener: (androidDevice: AndroidDevice) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23939
on(event: "webview", listener: (androidWebView: AndroidWebView) => any): this
Emitted when a new WebView instance is detected.
Parameters
- event: "webview"
- listener: (androidWebView: AndroidWebView) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23944

once

once(event: "close", listener: (androidDevice: AndroidDevice) => any): this
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "close"
- listener: (androidDevice: AndroidDevice) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23949
once(event: "webview", listener: (androidWebView: AndroidWebView) => any): this
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Parameters
- event: "webview"
- listener: (androidWebView: AndroidWebView) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23954

open

open(command: string): Promise<AndroidSocket>
Launches a process in the shell on the device and returns a socket to communicate with the launched process.
Parameters
- command: string
  Shell command to execute.
Returns Promise<AndroidSocket>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24481

pinchClose

pinchClose(
    selector: AndroidSelector,
    percent: number,
    options?: { speed?: number; timeout?: number },
): Promise<void>
Pinches the widget defined by selector in the closing direction.
Parameters
- selector: AndroidSelector
  Selector to pinch close.
- percent: number
  The size of the pinch as a percentage of the widget's size.
- Optionaloptions: { speed?: number; timeout?: number }
  - Optionalspeed?: number
    
    Optional speed of the pinch in pixels per second.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24491

pinchOpen

pinchOpen(
    selector: AndroidSelector,
    percent: number,
    options?: { speed?: number; timeout?: number },
): Promise<void>
Pinches the widget defined by selector in the open direction.
Parameters
- selector: AndroidSelector
  Selector to pinch open.
- percent: number
  The size of the pinch as a percentage of the widget's size.
- Optionaloptions: { speed?: number; timeout?: number }
  - Optionalspeed?: number
    
    Optional speed of the pinch in pixels per second.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24514

prependListener

prependListener(
event: "close",
listener: (androidDevice: AndroidDevice) => any,
): this
Emitted when the device connection gets closed.
Parameters
- event: "close"
- listener: (androidDevice: AndroidDevice) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23989
prependListener(
event: "webview",
listener: (androidWebView: AndroidWebView) => any,
): this
Emitted when a new WebView instance is detected.
Parameters
- event: "webview"
- listener: (androidWebView: AndroidWebView) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23994

press

press(
    selector: AndroidSelector,
    key: AndroidKey,
    options?: { timeout?: number },
): Promise<void>
Presses the specific key in the widget defined by selector.
Parameters
- selector: AndroidSelector
  Selector to press the key in.
- key: AndroidKey
  The key to press.
- Optionaloptions: { timeout?: number }
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24537

push

push(
    file: string | Buffer<ArrayBufferLike>,
    path: string,
    options?: { mode?: number },
): Promise<void>
Copies a file to the device.
Parameters
- file: string | Buffer<ArrayBufferLike>
  Either a path to the file, or file content.
- path: string
  Path to the file on the device.
- Optionaloptions: { mode?: number }
  - Optionalmode?: number
    
    Optional file mode, defaults to 644 (rw-r--r--).
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24553

removeListener

removeListener(
event: "close",
listener: (androidDevice: AndroidDevice) => any,
): this
Removes an event listener added by on or addListener.
Parameters
- event: "close"
- listener: (androidDevice: AndroidDevice) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23969
removeListener(
event: "webview",
listener: (androidWebView: AndroidWebView) => any,
): this
Removes an event listener added by on or addListener.
Parameters
- event: "webview"
- listener: (androidWebView: AndroidWebView) => any
Returns this
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:23974

screenshot

screenshot(options?: { path?: string }): Promise<Buffer<ArrayBufferLike>>
Returns the buffer with the captured screenshot of the device.
Parameters
- Optionaloptions: { path?: string }
  - Optionalpath?: string
    
    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<ArrayBufferLike>>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24564

scroll

scroll(
    selector: AndroidSelector,
    direction: "down" | "up" | "left" | "right",
    percent: number,
    options?: { speed?: number; timeout?: number },
): Promise<void>
Scrolls the widget defined by selector in the specified direction.
Parameters
- 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.
- Optionaloptions: { speed?: number; timeout?: number }
  - Optionalspeed?: number
    
    Optional speed of the scroll in pixels per second.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24584

serial

serial(): string
Device serial number.

Returns string
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24602

setDefaultTimeout

setDefaultTimeout(timeout: number): void
This setting will change the default maximum time for all the methods accepting timeout option.
Parameters
- timeout: number
  Maximum time in milliseconds
Returns void
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24610

shell

shell(command: string): Promise<Buffer<ArrayBufferLike>>
Executes a shell command on the device and returns its output.
Parameters
- command: string
  Shell command to execute.
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24616

swipe

swipe(
    selector: AndroidSelector,
    direction: "down" | "up" | "left" | "right",
    percent: number,
    options?: { speed?: number; timeout?: number },
): Promise<void>
Swipes the widget defined by selector in the specified direction.
Parameters
- 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.
- Optionaloptions: { speed?: number; timeout?: number }
  - Optionalspeed?: number
    
    Optional speed of the swipe in pixels per second.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24627

tap

tap(
selector: AndroidSelector,
options?: { duration?: number; timeout?: number },
): Promise<void>
Taps on the widget defined by selector.
Parameters
- selector: AndroidSelector
  Selector to tap on.
- Optionaloptions: { duration?: number; timeout?: number }
  - Optionalduration?: number
    
    Optional duration of the tap in milliseconds.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24648

wait

wait(
selector: AndroidSelector,
options?: { state?: "gone"; timeout?: number },
): Promise<void>
Waits for the specific selector to either appear or disappear, depending on the state.
Parameters
- selector: AndroidSelector
  Selector to wait for.
- Optionaloptions: { state?: "gone"; timeout?: number }
  - Optionalstate?: "gone"
    
    Optional state. Can be either:
    
    default - wait for element to be present.
    
    'gone' - wait for element to not be present.
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<void>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24671

waitForEvent

waitForEvent(
    event: "close",
    optionsOrPredicate?:
        | {
            predicate?: (
                androidDevice: AndroidDevice,
            ) => boolean | Promise<boolean>;
            signal?: AbortSignal;
            timeout?: number;
        }
        | ((androidDevice: AndroidDevice) => boolean | Promise<boolean>),
): Promise<AndroidDevice>
Emitted when the device connection gets closed.
Parameters
- event: "close"
- OptionaloptionsOrPredicate:
      | {
          predicate?: (
              androidDevice: AndroidDevice,
          ) => boolean | Promise<boolean>;
          signal?: AbortSignal;
          timeout?: number;
      }
      | ((androidDevice: AndroidDevice) => boolean | Promise<boolean>)
Returns Promise<AndroidDevice>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24691
waitForEvent(
    event: "webview",
    optionsOrPredicate?:
        | {
            predicate?: (
                androidWebView: AndroidWebView,
            ) => boolean | Promise<boolean>;
            signal?: AbortSignal;
            timeout?: number;
        }
        | ((androidWebView: AndroidWebView) => boolean | Promise<boolean>),
): Promise<AndroidWebView>
Emitted when a new WebView instance is detected.
Parameters
- event: "webview"
- OptionaloptionsOrPredicate:
      | {
          predicate?: (
              androidWebView: AndroidWebView,
          ) => boolean | Promise<boolean>;
          signal?: AbortSignal;
          timeout?: number;
      }
      | ((androidWebView: AndroidWebView) => boolean | Promise<boolean>)
Returns Promise<AndroidWebView>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24696

webView

webView(
selector: { pkg?: string; socketName?: string },
options?: { timeout?: number },
): Promise<AndroidWebView>
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.
Parameters
- selector: { pkg?: string; socketName?: string }
  - Optionalpkg?: string
    
    Optional Package identifier.
  - OptionalsocketName?: string
    
    Optional webview socket name.
- Optionaloptions: { timeout?: number }
  - Optionaltimeout?: number
    
    Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the androidDevice.setDefaultTimeout(timeout) method.
Returns Promise<AndroidWebView>
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24709

webViews

webViews(): AndroidWebView[]
Currently open WebViews.

Returns AndroidWebView[]
- Defined in node_modules/.pnpm/playwright-core@1.62.1/node_modules/playwright-core/types/types.d.ts:24732

Interface AndroidDevice

Index

Properties

Methods

Properties

input

Methods

[asyncDispose]

Returns Promise<void>

addListener

Parameters

Returns this

Parameters

Returns this

close

Returns Promise<void>

drag

Parameters

Optionalspeed?: number

Optionaltimeout?: number

Returns Promise<void>

fill

Parameters

Optionaltimeout?: number

Returns Promise<void>

fling

Parameters

Optionalspeed?: number

Optionaltimeout?: number

Returns Promise<void>

info

Parameters

Returns Promise<AndroidElementInfo>

installApk

Parameters

Optionalargs?: string[]

Returns Promise<void>

launchBrowser

Parameters

OptionalacceptDownloads?: boolean

Optionalargs?: string[]

OptionalbaseURL?: string

OptionalbypassCSP?: boolean

OptionalcolorScheme?: "light" | "dark" | "no-preference" | null

Optionalcontrast?: "no-preference" | "more" | null

OptionaldeviceScaleFactor?: number

OptionalextraHTTPHeaders?: { [key: string]: string }

OptionalforcedColors?: "none" | "active" | null

Optionalgeolocation?: { accuracy?: number; latitude: number; longitude: number }

Optionalaccuracy?: number

latitude: number

longitude: number

OptionalhasTouch?: boolean

OptionalhttpCredentials?: { origin?: string; password: string; send?: "always" | "unauthorized"; username: string;}

Optionalorigin?: string

password: string

Optionalsend?: "always" | "unauthorized"

username: string

OptionalignoreHTTPSErrors?: boolean

OptionalisMobile?: boolean

OptionaljavaScriptEnabled?: boolean

Optionallocale?: string

Optionallogger?: Logger

Deprecated

Optionaloffline?: boolean

Optionalpermissions?: string[]

Optionalpkg?: string

Optionalproxy?: { bypass?: string; password?: string; server: string; username?: string }

Optionalbypass?: string

Optionalpassword?: string

server: string

Optionalusername?: string

OptionalrecordHar?: { content?: "embed" | "attach" | "omit"; mode?: "full" | "minimal"; omitContent?: boolean; path: string; urlFilter?: string | RegExp;}

Optionalcontent?: "embed" | "attach" | "omit"

Optionalmode?: "full" | "minimal"

OptionalomitContent?: boolean

path: string

OptionalurlFilter?: string | RegExp

OptionalrecordVideo?: { dir?: string; showActions?: { cursor?: "none" | "pointer"; duration?: number; fontSize?: number; position?: | "top-left" | "top" | "top-right" | "bottom-left" | "bottom" | "bottom-right"; }; size?: { height: number; width: number };}

Optionaldir?: string

`Optional`speed?: number

`Optional`timeout?: number

`Optional`timeout?: number

`Optional`speed?: number

`Optional`timeout?: number

`Optional`args?: string[]

`Optional`acceptDownloads?: boolean

`Optional`args?: string[]

`Optional`baseURL?: string

`Optional`bypassCSP?: boolean

`Optional`colorScheme?: "light" | "dark" | "no-preference" | null

`Optional`contrast?: "no-preference" | "more" | null

`Optional`deviceScaleFactor?: number

`Optional`extraHTTPHeaders?: { [key: string]: string }

`Optional`forcedColors?: "none" | "active" | null

`Optional`geolocation?: { accuracy?: number; latitude: number; longitude: number }

`Optional`accuracy?: number

`Optional`hasTouch?: boolean

`Optional`httpCredentials?: {
origin?: string;
password: string;
send?: "always" | "unauthorized";
username: string;
}

`Optional`origin?: string

`Optional`send?: "always" | "unauthorized"

`Optional`ignoreHTTPSErrors?: boolean

`Optional`isMobile?: boolean

`Optional`javaScriptEnabled?: boolean

`Optional`locale?: string

`Optional`logger?: Logger

`Optional`offline?: boolean

`Optional`permissions?: string[]

`Optional`pkg?: string

`Optional`proxy?: { bypass?: string; password?: string; server: string; username?: string }

`Optional`bypass?: string

`Optional`password?: string

`Optional`username?: string

`Optional`recordHar?: {
content?: "embed" | "attach" | "omit";
mode?: "full" | "minimal";
omitContent?: boolean;
path: string;
urlFilter?: string | RegExp;
}

`Optional`content?: "embed" | "attach" | "omit"

`Optional`mode?: "full" | "minimal"

`Optional`omitContent?: boolean

`Optional`urlFilter?: string | RegExp

`Optional`recordVideo?: {
dir?: string;
showActions?: {
cursor?: "none" | "pointer";
duration?: number;
fontSize?: number;
position?:
| "top-left"
| "top"
| "top-right"
| "bottom-left"
| "bottom"
| "bottom-right";
};
size?: { height: number; width: number };
}

`Optional`dir?: string

`Optional`showActions?: {
cursor?: "none" | "pointer";
duration?: number;
fontSize?: number;
position?:
| "top-left"
| "top"
| "top-right"
| "bottom-left"
| "bottom"
| "bottom-right";
}

`Optional`cursor?: "none" | "pointer"

`Optional`duration?: number

`Optional`fontSize?: number

`Optional`position?: "top-left" | "top" | "top-right" | "bottom-left" | "bottom" | "bottom-right"

`Optional`size?: { height: number; width: number }

`Optional`reducedMotion?: "reduce" | "no-preference" | null

`Optional`screen?: { height: number; width: number }

`Optional`serviceWorkers?: "block" | "allow"

`Optional`strictSelectors?: boolean

`Optional`timezoneId?: string

`Optional`userAgent?: string

`Optional`viewport?: { height: number; width: number } | null

`Optional`timeout?: number

`Optional`speed?: number

`Optional`timeout?: number

`Optional`speed?: number

`Optional`timeout?: number

`Optional`timeout?: number

`Optional`mode?: number