class Playwright::BrowserType::LaunchPersistentContextOptions

Included Modules

Defined in:

playwright/browsertype.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(headless : Bool | Nil = nil, executable_path : Path | Nil = nil, args : Nil | Array(String) = nil, ignore_default_args : Nil | String = nil, proxy : Nil | Playwright::BrowserType::LaunchPersistentContextOptions::Proxy = nil, downloads_path : Path | Nil = nil, chromium_sandbox : Bool | Nil = nil, handle_sigint : Bool | Nil = nil, handle_sigterm : Bool | Nil = nil, handle_sighup : Bool | Nil = nil, timeout : Int32 | Nil = nil, env : Nil | String = nil, devtools : Bool | Nil = nil, slow_mo : Int32 | Nil = nil, accept_downloads : Bool | Nil = nil, ignore_https_errors : Bool | Nil = nil, bypass_csp : Bool | Nil = nil, viewport : Nil | Playwright::Page::ViewPort = nil, user_agent : Nil | String = nil, device_scale_factor : Int32 | Nil = nil, is_mobile : Bool | Nil = nil, has_touch : Bool | Nil = nil, java_script_enabled : Bool | Nil = nil, timezone_id : Nil | String = nil, geolocation : Nil | Playwright::Geolocation = nil, locale : Nil | String = nil, permissions : Nil | Array(String) = nil, extra_http_headers : Nil | Hash(String, String) = nil, offline : Bool | Nil = nil, http_credentials : Nil | Playwright::BrowserContext::HTTPCredentials = nil, color_scheme : Playwright::ColorScheme | Nil = nil, logger : Playwright::Logger | Nil = nil, record_har : Nil | Playwright::BrowserType::LaunchPersistentContextOptions::RecordHar = nil, record_video : Nil | Playwright::BrowserType::LaunchPersistentContextOptions::RecordVideo = nil) #

[View source]

Instance Method Detail

def accept_downloads : Bool | Nil #

Whether to automatically download all the attachments. Defaults to false where all the downloads are canceled.


[View source]
def accept_downloads=(accept_downloads : Bool | Nil) #

Whether to automatically download all the attachments. Defaults to false where all the downloads are canceled.


[View source]
def args : Array(String) | Nil #

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


[View source]
def args=(args : Array(String) | Nil) #

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


[View source]
def bypass_csp : Bool | Nil #

Toggles bypassing page's Content-Security-Policy.


[View source]
def bypass_csp=(bypass_csp : Bool | Nil) #

Toggles bypassing page's Content-Security-Policy.


[View source]
def chromium_sandbox : Bool | Nil #

Enable Chromium sandboxing. Defaults to true.


[View source]
def chromium_sandbox=(chromium_sandbox : Bool | Nil) #

Enable Chromium sandboxing. Defaults to true.


[View source]
def color_scheme : ColorScheme | Nil #

Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulateMedia(params) for more details. Defaults to 'light'.


[View source]
def color_scheme=(color_scheme : ColorScheme | Nil) #

Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulateMedia(params) for more details. Defaults to 'light'.


[View source]
def device_scale_factor : Int32 | Nil #

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


[View source]
def device_scale_factor=(device_scale_factor : Int32 | Nil) #

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


[View source]
def devtools : Bool | Nil #

Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option is true, the #headless option will be set false.


[View source]
def devtools=(devtools : Bool | Nil) #

Chromium-only Whether to auto-open a Developer Tools panel for each tab. If this option is true, the #headless option will be set false.


[View source]
def downloads_path : Path | Nil #

If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed.


[View source]
def downloads_path=(downloads_path : Path | Nil) #

If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed.


[View source]
def env : String | Nil #

Specify environment variables that will be visible to the browser. Defaults to process.env.


[View source]
def env=(env : String | Nil) #

Specify environment variables that will be visible to the browser. Defaults to process.env.


[View source]
def executable_path : Path | Nil #

Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to the current working directory. BEWARE: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk.


[View source]
def executable_path=(executable_path : Path | Nil) #

Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to the current working directory. BEWARE: Playwright is only guaranteed to work with the bundled Chromium, Firefox or WebKit, use at your own risk.


[View source]
def extra_http_headers : Hash(String, String) | Nil #

An object containing additional HTTP headers to be sent with every request. All header values must be strings.


[View source]
def extra_http_headers=(extra_http_headers : Hash(String, String) | Nil) #

An object containing additional HTTP headers to be sent with every request. All header values must be strings.


[View source]
def geolocation : Geolocation | Nil #

[View source]
def geolocation=(geolocation : Geolocation | Nil) #

[View source]
def handle_sighup : Bool | Nil #

Close the browser process on SIGHUP. Defaults to true.


[View source]
def handle_sighup=(handle_sighup : Bool | Nil) #

Close the browser process on SIGHUP. Defaults to true.


[View source]
def handle_sigint : Bool | Nil #

Close the browser process on Ctrl-C. Defaults to true.


[View source]
def handle_sigint=(handle_sigint : Bool | Nil) #

Close the browser process on Ctrl-C. Defaults to true.


[View source]
def handle_sigterm : Bool | Nil #

Close the browser process on SIGTERM. Defaults to true.


[View source]
def handle_sigterm=(handle_sigterm : Bool | Nil) #

Close the browser process on SIGTERM. Defaults to true.


[View source]
def has_touch : Bool | Nil #

Specifies if viewport supports touch events. Defaults to false.


[View source]
def has_touch=(has_touch : Bool | Nil) #

Specifies if viewport supports touch events. Defaults to false.


[View source]
def headless : Bool | Nil #

Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true unless the #devtools option is true.


[View source]
def headless=(headless : Bool | Nil) #

Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true unless the #devtools option is true.


[View source]
def http_credentials : BrowserContext::HTTPCredentials | Nil #

Credentials for HTTP authentication.


[View source]
def http_credentials=(http_credentials : BrowserContext::HTTPCredentials | Nil) #

Credentials for HTTP authentication.


[View source]
def ignore_default_args : String | Nil #

If true, then do not use any of the default arguments. If an array is given, then filter out the given default arguments. Dangerous option; use with care. Defaults to false.


[View source]
def ignore_default_args=(ignore_default_args : String | Nil) #

If true, then do not use any of the default arguments. If an array is given, then filter out the given default arguments. Dangerous option; use with care. Defaults to false.


[View source]
def ignore_https_errors : Bool | Nil #

Whether to ignore HTTPS errors during navigation. Defaults to false.


[View source]
def ignore_https_errors=(ignore_https_errors : Bool | Nil) #

Whether to ignore HTTPS errors during navigation. Defaults to false.


[View source]
def is_mobile : Bool | Nil #

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


[View source]
def is_mobile=(is_mobile : Bool | Nil) #

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


[View source]
def java_script_enabled : Bool | Nil #

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


[View source]
def java_script_enabled=(java_script_enabled : Bool | Nil) #

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


[View source]
def locale : String | Nil #

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.


[View source]
def locale=(locale : String | Nil) #

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.


[View source]
def logger : Logger | Nil #

Logger sink for Playwright logging.


[View source]
def logger=(logger : Logger | Nil) #

Logger sink for Playwright logging.


[View source]
def offline : Bool | Nil #

Whether to emulate network being offline. Defaults to false.


[View source]
def offline=(offline : Bool | Nil) #

Whether to emulate network being offline. Defaults to false.


[View source]
def permissions : Array(String) | Nil #

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


[View source]
def permissions=(permissions : Array(String) | Nil) #

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


[View source]
def proxy : Proxy | Nil #

Network proxy settings.


[View source]
def proxy=(proxy : Proxy | Nil) #

Network proxy settings.


[View source]
def record_har : RecordHar | Nil #

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.


[View source]
def record_har=(record_har : RecordHar | Nil) #

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.


[View source]
def record_video : RecordVideo | Nil #

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.


[View source]
def record_video=(record_video : RecordVideo | Nil) #

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.


[View source]
def slow_mo : Int32 | Nil #

Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.


[View source]
def slow_mo=(slow_mo : Int32 | Nil) #

Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.


[View source]
def timeout : Int32 | Nil #

Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.


[View source]
def timeout=(timeout : Int32 | Nil) #

Maximum time in milliseconds to wait for the browser instance to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.


[View source]
def timezone_id : String | Nil #

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


[View source]
def timezone_id=(timezone_id : String | Nil) #

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


[View source]
def user_agent : String | Nil #

Specific user agent to use in this context.


[View source]
def user_agent=(user_agent : String | Nil) #

Specific user agent to use in this context.


[View source]
def viewport : Page::ViewPort | Nil #

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


[View source]
def viewport=(viewport : Page::ViewPort | Nil) #

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


[View source]