PlaywrightEx.BrowserContext (PlaywrightEx v0.9.0)

Advance the clock by jumping forward in time. Only fires due timers at most once. This is equivalent to user closing the laptop lid for a while and reopening it later, after given time..

clock_install(context_id, opts \\ [])

Install fake implementations for the other time-related functions (e.g. clock_fast_forward/2).

close(context_id, opts \\ [])

Closes the browser context.

cookies(context_id, opts \\ [])

Returns cookies from this browser context.

new_page(context_id, opts \\ [])

Creates a new page in the browser context.

register_selector_engine(context_id, opts \\ [])

Registers a custom selector engine.

set_storage_state(context_id, opts \\ [])

Clears the existing cookies and origin storage, then sets the new storage state.

storage_state(context_id, opts \\ [])

Returns storage state for this browser context, including cookies and origin storage.

update_subscription(context_id, opts \\ [])

Updates the subscription for browser-context events.

Types

add_cookies_opt()

@type add_cookies_opt() ::
  {:connection, GenServer.name()} | {:timeout, timeout()} | {:cookies, [term()]}

add_init_script_opt()

@type add_init_script_opt() ::
  {:connection, GenServer.name()} | {:timeout, timeout()} | {:source, binary()}

clear_cookies_opt()

@type clear_cookies_opt() ::
  {:connection, GenServer.name()}
  | {:timeout, timeout()}
  | {:domain, binary() | struct()}
  | {:name, binary() | struct()}
  | {:path, binary() | struct()}

clock_fast_forward_opt()

@type clock_fast_forward_opt() ::
  {:connection, GenServer.name()}
  | {:timeout, timeout()}
  | {:ticks, non_neg_integer() | binary()}

clock_install_opt()

@type clock_install_opt() ::
  {:connection, GenServer.name()}
  | {:timeout, timeout()}
  | {:time, non_neg_integer() | binary() | struct()}

close_opt()

@type close_opt() ::
  {:connection, GenServer.name()} | {:timeout, timeout()} | {:reason, binary()}

cookies_opt()

@type cookies_opt() ::
  {:connection, GenServer.name()} | {:timeout, timeout()} | {:urls, [binary()]}

new_page_opt()

@type new_page_opt() :: {:connection, GenServer.name()} | {:timeout, timeout()}

register_selector_engine_opt()

@type register_selector_engine_opt() ::
  {:connection, GenServer.name()}
  | {:timeout, timeout()}
  | {:selector_engine, keyword()}

set_storage_state_opt()

@type set_storage_state_opt() ::
  {:connection, GenServer.name()}
  | {:timeout, timeout()}
  | {:cookies, [term()]}
  | {:origins, [term()]}
  | {:credentials, [map()]}

storage_state_opt()

@type storage_state_opt() ::
  {:connection, GenServer.name()}
  | {:timeout, timeout()}
  | {:indexed_db, boolean()}
  | {:opfs, boolean()}
  | {:credentials, boolean()}

update_subscription_opt()

@type update_subscription_opt() ::
  {:connection, GenServer.name()}
  | {:timeout, timeout()}
  | {:event, term()}
  | {:enabled, boolean()}

Functions

add_cookies(context_id, opts \\ [])

@spec add_cookies(PlaywrightEx.guid(), [
  add_cookies_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, any()} | {:error, any()}

Adds cookies into this browser context.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-add-cookies

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:cookies (list of term/0) - Required. Adds cookies into this browser context. All pages within this context will have these cookies installed.

add_init_script(context_id, opts \\ [])

@spec add_init_script(PlaywrightEx.guid(), [
  add_init_script_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, any()} | {:error, any()}

Adds a script which would be evaluated in one of the following scenarios:

Whenever a page is created in the browser context or is navigated.
Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is evaluated in the context of the newly attached frame.

The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-add-init-script

Script Execution Order Is Not Defined

The order of evaluation of multiple scripts installed via PlaywrightEx.BrowserContext.add_init_script/2 and PlaywrightEx.Page.add_init_script/2 is not defined.

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:source (String.t/0) - Required. Raw JavaScript code to be evaluated in all pages before any scripts run.

clear_cookies(context_id, opts \\ [])

@spec clear_cookies(PlaywrightEx.guid(), [
  clear_cookies_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, any()} | {:error, any()}

Removes cookies from this browser context.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-clear-cookies

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:domain - Only removes cookies with the given domain.
:name - Only removes cookies with the given name.
:path - Only removes cookies with the given path.

clock_fast_forward(context_id, opts \\ [])

@spec clock_fast_forward(PlaywrightEx.guid(), [
  clock_fast_forward_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, any()} | {:error, any()}

Advance the clock by jumping forward in time. Only fires due timers at most once. This is equivalent to user closing the laptop lid for a while and reopening it later, after given time..

Reference: https://playwright.dev/docs/api/class-clock#clock-fast-forward

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:ticks - Required. Time to advance, in milliseconds or in ss / mm:ss / hh:mm:ss string format.

clock_install(context_id, opts \\ [])

@spec clock_install(PlaywrightEx.guid(), [
  clock_install_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, any()} | {:error, any()}

Install fake implementations for the other time-related functions (e.g. clock_fast_forward/2).

Reference: https://playwright.dev/docs/api/class-clock#clock-install

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:time - Optional base time to install, as milliseconds since epoch, an ISO8601 datetime, or a string accepted by Playwright.

close(context_id, opts \\ [])

@spec close(PlaywrightEx.guid(), [close_opt() | PlaywrightEx.unknown_opt()]) ::
  {:ok, any()} | {:error, any()}

Closes the browser context.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-close

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:reason (String.t/0) - The reason to be reported to the operations interrupted by the context closure.

cookies(context_id, opts \\ [])

@spec cookies(PlaywrightEx.guid(), [cookies_opt() | PlaywrightEx.unknown_opt()]) ::
  {:ok, [map()]} | {:error, any()}

Returns cookies from this browser context.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-cookies

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:urls (list of String.t/0) - If specified, returns cookies for the given URLs. The default value is [].

new_page(context_id, opts \\ [])

@spec new_page(PlaywrightEx.guid(), [new_page_opt() | PlaywrightEx.unknown_opt()]) ::
  {:ok, %{guid: PlaywrightEx.guid(), main_frame: %{guid: PlaywrightEx.guid()}}}
  | {:error, any()}

Creates a new page in the browser context.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-new-page

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).

register_selector_engine(context_id, opts \\ [])

@spec register_selector_engine(PlaywrightEx.guid(), [
  register_selector_engine_opt() | PlaywrightEx.unknown_opt()
]) :: {:ok, any()} | {:error, any()}

Registers a custom selector engine.

Reference: https://playwright.dev/docs/api/class-selectors#selectors-register

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:selector_engine (non-empty keyword/0) - Required.
- :name (String.t/0) - Required. Name that is used in selectors as a prefix.
- :source (String.t/0) - Required. Script that evaluates to a selector engine instance.

set_storage_state(context_id, opts \\ [])

@spec set_storage_state(PlaywrightEx.guid(), [
  set_storage_state_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, any()} | {:error, any()}

Clears the existing cookies and origin storage, then sets the new storage state.

Origin entries may contain local storage, IndexedDB, and opfs entries. Each OPFS entry has a path, a "file" or "directory" type, and optional base64 content for files. The storage state may also contain virtual WebAuthn credentials.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-set-storage-state

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:cookies (list of term/0) - List of cookies to set as the current cookies on the context. Defaults to an empty list to clear all cookies on the context. The default value is [].
:origins (list of term/0) - List of origins and their local storage to set as the current local storage data on the context. Defaults to an empty list to clear all local storage on the context. The default value is [].
:credentials (list of map/0) - List of virtual WebAuthn credentials to restore into the context.

storage_state(context_id, opts \\ [])

@spec storage_state(PlaywrightEx.guid(), [
  storage_state_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, map()} | {:error, any()}

Returns storage state for this browser context, including cookies and origin storage.

Origin storage can include local storage, IndexedDB, the origin private file system, and virtual WebAuthn credentials according to the selected options.

Reference: https://playwright.dev/docs/api/class-browsercontext#browser-context-storage-state

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:indexed_db (boolean/0) - Set to true to include IndexedDB in the storage state snapshot. If your application uses IndexedDB to store authentication tokens, like Firebase Authentication, enable this. The default value is false.
:opfs (boolean/0) - Set to true to include the origin private file system in the storage state snapshot. The default value is false.
:credentials (boolean/0) - Set to true to include virtual WebAuthn credentials in the storage state snapshot. The default value is false.

update_subscription(context_id, opts \\ [])

@spec update_subscription(PlaywrightEx.guid(), [
  update_subscription_opt() | PlaywrightEx.unknown_opt()
]) ::
  {:ok, any()} | {:error, any()}

Updates the subscription for browser-context events.

Playwright 1.63 adds the :dialog_closed event, emitted after a JavaScript dialog is accepted, dismissed, or otherwise closed.

Reference: https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/client/browserContext.ts

Options

:connection (term/0) - The Connection process name. Defaults to PlaywrightEx.Supervisor.Connection. The default value is PlaywrightEx.Supervisor.Connection.
:timeout (timeout/0) - Required. Maximum time for the operation (milliseconds).
:event - Required.
:enabled (boolean/0) - The default value is true.