Interface AndroidDevice

event: "close"

listener: ((androidDevice: AndroidDevice) => void)

• • (androidDevice: AndroidDevice): void

  • Parameters

    • androidDevice: AndroidDevice

    Returns void

event: "webview"

listener: ((androidWebView: AndroidWebView) => void)

• • (androidWebView: AndroidWebView): void

  • Parameters

    • androidWebView: AndroidWebView

    Returns void

selector: AndroidSelector

dest: {
    x: number;
    y: number;
}

• x: number

• y: number

Optional options: {
    speed?: number;
    timeout?: number;
}

• Optional speed?: number

  Optional speed of the drag in pixels per second.

• Optional timeout?: 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.

selector: AndroidSelector

text: string

Optional options: {
    timeout?: number;
}

• Optional timeout?: 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.

selector: AndroidSelector

direction: "up" | "down" | "left" | "right"

Optional options: {
    speed?: number;
    timeout?: number;
}

• Optional speed?: number

  Optional speed of the fling in pixels per second.

• Optional timeout?: 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.

selector: AndroidSelector

file: string | Buffer

Optional options: {
    args?: string[];
}

• Optional args?: string[]

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

Optional options: {
    acceptDownloads?: boolean;
    args?: string[];
    baseURL?: string;
    bypassCSP?: boolean;
    colorScheme?: null | "light" | "dark" | "no-preference";
    command?: string;
    deviceScaleFactor?: number;
    extraHTTPHeaders?: {
        [key: string]: string;
    };
    forcedColors?: null | "none" | "active";
    geolocation?: {
        accuracy?: number;
        latitude: number;
        longitude: number;
    };
    hasTouch?: boolean;
    httpCredentials?: {
        password: string;
        username: string;
    };
    ignoreHTTPSErrors?: boolean;
    isMobile?: boolean;
    javaScriptEnabled?: boolean;
    locale?: string;
    logger?: Logger;
    offline?: boolean;
    permissions?: string[];
    proxy?: {
        bypass?: string;
        password?: string;
        server: string;
        username?: string;
    };
    recordHar?: {
        content?: "omit" | "embed" | "attach";
        mode?: "full" | "minimal";
        omitContent?: boolean;
        path: string;
        urlFilter?: string | RegExp;
    };
    recordVideo?: {
        dir: string;
        size?: {
            height: number;
            width: number;
        };
    };
    reducedMotion?: null | "no-preference" | "reduce";
    screen?: {
        height: number;
        width: number;
    };
    serviceWorkers?: "allow" | "block";
    strictSelectors?: boolean;
    timezoneId?: string;
    userAgent?: string;
    videoSize?: {
        height: number;
        width: number;
    };
    videosPath?: string;
    viewport?: null | {
        height: number;
        width: number;
    };
}

• Optional acceptDownloads?: boolean

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

• Optional args?: string[]

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

• Optional baseURL?: 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. 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

• Optional bypassCSP?: boolean

  Toggles bypassing page's Content-Security-Policy.

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

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

• Optional command?: string

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

• Optional deviceScaleFactor?: number

  Specify device scale factor (can be thought of as dpr). Defaults to 1.

• Optional extraHTTPHeaders?: {
      [key: string]: string;
  }

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

  • [key: string]: string

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

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

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

  • Optional accuracy?: number

    Non-negative accuracy value. Defaults to 0.

  • latitude: number

    Latitude between -90 and 90.

  • longitude: number

    Longitude between -180 and 180.

• Optional hasTouch?: boolean

  Specifies if viewport supports touch events. Defaults to false.

• Optional httpCredentials?: {
      password: string;
      username: string;
  }

  Credentials for HTTP authentication.

  • password: string

  • username: string

• Optional ignoreHTTPSErrors?: boolean

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

• Optional isMobile?: boolean

  Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not supported in Firefox.

• Optional javaScriptEnabled?: boolean

  Whether or not to enable JavaScript in the context. Defaults to true.

• Optional locale?: 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.

• Optional logger?: Logger

  Logger sink for Playwright logging.

• Optional offline?: boolean

  Whether to emulate network being offline. Defaults to false.

• Optional permissions?: string[]

  A list of permissions to grant to all pages in this context. See browserContext.grantPermissions(permissions[, options]) for more details.

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

  Network proxy settings.

  • Optional bypass?: string

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

  • Optional password?: 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.

  • Optional username?: string

    Optional username to use if HTTP proxy requires authentication.

• Optional recordHar?: {
      content?: "omit" | "embed" | "attach";
      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() for the HAR to be saved.

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

    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.

  • Optional mode?: "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.

  • Optional omitContent?: 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.

  • Optional urlFilter?: 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.

• Optional recordVideo?: {
      dir: string;
      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() for videos to be saved.

  • dir: string

    Path to the directory to put videos into.

  • Optional size?: {
        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.

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

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

• Optional screen?: {
      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.

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

  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.

• Optional strictSelectors?: 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). See [Locator] to learn more about the strict mode.

• Optional timezoneId?: string

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

• Optional userAgent?: string

  Specific user agent to use in this context.

• Optional videoSize?: {
      height: number;
      width: number;
  }

  Deprecated

  Use recordVideo instead.

  • height: number

    Video frame height.

  • width: number

    Video frame width.

• Optional videosPath?: string

  Deprecated

  Use recordVideo instead.

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

  Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. null disables the default viewport.

selector: AndroidSelector

Optional options: {
    timeout?: number;
}

• Optional timeout?: 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.

event: "close"

listener: ((androidDevice: AndroidDevice) => void)

• • (androidDevice: AndroidDevice): void

  • Parameters

    • androidDevice: AndroidDevice

    Returns void

event: "webview"

listener: ((androidWebView: AndroidWebView) => void)

• • (androidWebView: AndroidWebView): void

  • Parameters

    • androidWebView: AndroidWebView

    Returns void

event: "close"

listener: ((androidDevice: AndroidDevice) => void)

• • (androidDevice: AndroidDevice): void

  • Parameters

    • androidDevice: AndroidDevice

    Returns void

event: "webview"

listener: ((androidWebView: AndroidWebView) => void)

• • (androidWebView: AndroidWebView): void

  • Parameters

    • androidWebView: AndroidWebView

    Returns void

event: "close"

listener: ((androidDevice: AndroidDevice) => void)

• • (androidDevice: AndroidDevice): void

  • Parameters

    • androidDevice: AndroidDevice

    Returns void

event: "webview"

listener: ((androidWebView: AndroidWebView) => void)

• • (androidWebView: AndroidWebView): void

  • Parameters

    • androidWebView: AndroidWebView

    Returns void

command: string

selector: AndroidSelector

percent: number

Optional options: {
    speed?: number;
    timeout?: number;
}

• Optional speed?: number

  Optional speed of the pinch in pixels per second.

• Optional timeout?: 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.

selector: AndroidSelector

percent: number

Optional options: {
    speed?: number;
    timeout?: number;
}

• Optional speed?: number

  Optional speed of the pinch in pixels per second.

• Optional timeout?: 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.

event: "close"

listener: ((androidDevice: AndroidDevice) => void)

• • (androidDevice: AndroidDevice): void

  • Parameters

    • androidDevice: AndroidDevice

    Returns void

event: "webview"

listener: ((androidWebView: AndroidWebView) => void)

• • (androidWebView: AndroidWebView): void

  • Parameters

    • androidWebView: AndroidWebView

    Returns void

selector: AndroidSelector

key: AndroidKey

Optional options: {
    timeout?: number;
}

• Optional timeout?: 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.

file: string | Buffer

path: string

Optional options: {
    mode?: number;
}

• Optional mode?: number

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

event: "close"

listener: ((androidDevice: AndroidDevice) => void)

• • (androidDevice: AndroidDevice): void

  • Parameters

    • androidDevice: AndroidDevice

    Returns void

event: "webview"

listener: ((androidWebView: AndroidWebView) => void)

• • (androidWebView: AndroidWebView): void

  • Parameters

    • androidWebView: AndroidWebView

    Returns void

Optional options: {
    path?: string;
}

• Optional path?: 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.

selector: AndroidSelector

direction: "up" | "down" | "left" | "right"

percent: number

Optional options: {
    speed?: number;
    timeout?: number;
}

• Optional speed?: number

  Optional speed of the scroll in pixels per second.

• Optional timeout?: 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.

timeout: number

command: string

selector: AndroidSelector

direction: "up" | "down" | "left" | "right"

percent: number

Optional options: {
    speed?: number;
    timeout?: number;
}

• Optional speed?: number

  Optional speed of the swipe in pixels per second.

• Optional timeout?: 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.

selector: AndroidSelector

Optional options: {
    duration?: number;
    timeout?: number;
}

• Optional duration?: number

  Optional duration of the tap in milliseconds.

• Optional timeout?: 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.

selector: AndroidSelector

Optional options: {
    state?: "gone";
    timeout?: number;
}

• Optional state?: "gone"

  Optional state. Can be either:

  • default - wait for element to be present.
  • 'gone' - wait for element to not be present.

• Optional timeout?: 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.

event: "close"

Optional optionsOrPredicate: {
    predicate?: ((androidDevice: AndroidDevice) => boolean | Promise<boolean>);
    timeout?: number;
} | ((androidDevice: AndroidDevice) => boolean | Promise<boolean>)

event: "webview"

Optional optionsOrPredicate: {
    predicate?: ((androidWebView: AndroidWebView) => boolean | Promise<boolean>);
    timeout?: number;
} | ((androidWebView: AndroidWebView) => boolean | Promise<boolean>)

selector: {
    pkg?: string;
    socketName?: string;
}

• Optional pkg?: string

  Optional Package identifier.

• Optional socketName?: string

  Optional webview socket name.

Optional options: {
    timeout?: number;
}

• Optional timeout?: 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.