class Playwright::Browser::NewContextOptions

Included Modules

Defined in:

playwright/browser.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(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::Browser::NewContextOptions::RecordHar = nil, record_video : Nil | Playwright::Browser::NewContextOptions::RecordVideo = nil, proxy : Nil | Playwright::Browser::NewContextOptions::Proxy = nil, storage_state : Nil | Playwright::BrowserContext::StorageState = 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 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 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 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 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 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_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 to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'per-context' } }).


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

Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'per-context' } }).


[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 storage_state : BrowserContext::StorageState | Nil #

Populates context with given storage state. This method can be used to initialize context with logged-in information obtained via browserContext.storageState([options]). Either a path to the file with saved storage, or an object with the following fields:


[View source]
def storage_state=(storage_state : BrowserContext::StorageState | Nil) #

Populates context with given storage state. This method can be used to initialize context with logged-in information obtained via browserContext.storageState([options]). Either a path to the file with saved storage, or an object with the following fields:


[View source]
def storage_state_path : Path | Nil #

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

[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]
def with_storage_state(path : Path) #

[View source]
def with_storage_state(state : BrowserContext::StorageState) #

[View source]