Class: Selenium::WebDriver::BiDi::Protocol::Storage Private

Inherits:

Domain

• Object
• Domain
• Selenium::WebDriver::BiDi::Protocol::Storage

Defined in:

lib/selenium/webdriver/bidi/protocol/storage.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#module-storage

Defined Under Namespace

Classes: PartitionDescriptor

Constant Summary

PartitionKey =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey

Serialization::Record.define(
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'},
  source_origin: {wire_key: 'sourceOrigin', required: false, primitive: 'string'},
  extensible: true
)

CookieFilter =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagecookiefilter

Serialization::Record.define(
  name: {wire_key: 'name', required: false, primitive: 'string'},
  value: {wire_key: 'value', required: false, ref: 'Network::BytesValue'},
  domain: {wire_key: 'domain', required: false, primitive: 'string'},
  path: {wire_key: 'path', required: false, primitive: 'string'},
  size: {wire_key: 'size', required: false, primitive: 'integer'},
  http_only: {wire_key: 'httpOnly', required: false, primitive: 'boolean'},
  secure: {wire_key: 'secure', required: false, primitive: 'boolean'},
  same_site: {wire_key: 'sameSite', required: false, enum: 'Network::SAME_SITE'},
  expiry: {wire_key: 'expiry', required: false, primitive: 'integer'},
  extensible: true
)

BrowsingContextPartitionDescriptor =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagebrowsingcontextpartitiondescriptor

Serialization::Record.define(
  type: {fixed: 'context'},
  context: {wire_key: 'context', primitive: 'string'}
)

StorageKeyPartitionDescriptor =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagestoragekeypartitiondescriptor

Serialization::Record.define(
  type: {fixed: 'storageKey'},
  user_context: {wire_key: 'userContext', required: false, primitive: 'string'},
  source_origin: {wire_key: 'sourceOrigin', required: false, primitive: 'string'},
  extensible: true
)

GetCookiesParameters =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagegetcookiesparameters

Serialization::Record.define(
  filter: {wire_key: 'filter', required: false, ref: 'Storage::CookieFilter'},
  partition: {wire_key: 'partition', required: false, ref: 'Storage::PartitionDescriptor'}
)

GetCookiesResult =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagegetcookiesresult

Serialization::Record.define(
  cookies: {wire_key: 'cookies', ref: 'Network::Cookie', list: true},
  partition_key: {wire_key: 'partitionKey', ref: 'Storage::PartitionKey'}
)

PartialCookie =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagepartialcookie

Serialization::Record.define(
  name: {wire_key: 'name', primitive: 'string'},
  value: {wire_key: 'value', ref: 'Network::BytesValue'},
  domain: {wire_key: 'domain', primitive: 'string'},
  path: {wire_key: 'path', required: false, primitive: 'string'},
  http_only: {wire_key: 'httpOnly', required: false, primitive: 'boolean'},
  secure: {wire_key: 'secure', required: false, primitive: 'boolean'},
  same_site: {wire_key: 'sameSite', required: false, enum: 'Network::SAME_SITE'},
  expiry: {wire_key: 'expiry', required: false, primitive: 'integer'},
  extensible: true
)

SetCookieParameters =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagesetcookieparameters

Serialization::Record.define(
  cookie: {wire_key: 'cookie', ref: 'Storage::PartialCookie'},
  partition: {wire_key: 'partition', required: false, ref: 'Storage::PartitionDescriptor'}
)

SetCookieResult =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagesetcookieresult

Serialization::Record.define(
  partition_key: {wire_key: 'partitionKey', ref: 'Storage::PartitionKey'}
)

DeleteCookiesParameters =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagedeletecookiesparameters

Serialization::Record.define(
  filter: {wire_key: 'filter', required: false, ref: 'Storage::CookieFilter'},
  partition: {wire_key: 'partition', required: false, ref: 'Storage::PartitionDescriptor'}
)

DeleteCookiesResult =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#cddl-type-storagedeletecookiesresult

Serialization::Record.define(
  partition_key: {wire_key: 'partitionKey', ref: 'Storage::PartitionKey'}
)

Instance Method Summary

• #browsing_context_partition_descriptor ⇒ Object private
• #cookie_filter ⇒ Object private
• #delete_cookies(filter: Serialization::UNSET, partition: Serialization::UNSET) ⇒ Object private
• #get_cookies(filter: Serialization::UNSET, partition: Serialization::UNSET) ⇒ Object private
• #partial_cookie ⇒ Object private
• #partition_descriptor ⇒ Object private
• #set_cookie(cookie:, partition: Serialization::UNSET) ⇒ Object private
• #storage_key_partition_descriptor ⇒ Object private

Methods inherited from Domain

#initialize

Constructor Details

This class inherits a constructor from Selenium::WebDriver::BiDi::Protocol::Domain

Instance Method Details

#browsing_context_partition_descriptor ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 151

def browsing_context_partition_descriptor(**) = BrowsingContextPartitionDescriptor.new(**)

#cookie_filter ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 150

def cookie_filter(**) = CookieFilter.new(**)

#delete_cookies(filter: Serialization::UNSET, partition: Serialization::UNSET) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-storage-deleteCookies

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 159

def delete_cookies(filter: Serialization::UNSET, partition: Serialization::UNSET)
  params = DeleteCookiesParameters.new(filter: filter, partition: partition)
  execute(cmd: 'storage.deleteCookies', params: params, result: Storage::DeleteCookiesResult)
end

#get_cookies(filter: Serialization::UNSET, partition: Serialization::UNSET) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-storage-getCookies

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 167

def get_cookies(filter: Serialization::UNSET, partition: Serialization::UNSET)
  params = GetCookiesParameters.new(filter: filter, partition: partition)
  execute(cmd: 'storage.getCookies', params: params, result: Storage::GetCookiesResult)
end

#partial_cookie ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 154

def partial_cookie(**) = PartialCookie.new(**)

#partition_descriptor ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 153

def partition_descriptor = PartitionDescriptor

#set_cookie(cookie:, partition: Serialization::UNSET) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

See Also:

• https://www.selenium.dev/documentation/warnings/bidi-implementation/
• https://w3c.github.io/webdriver-bidi/#command-storage-setCookie

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 175

def set_cookie(cookie:, partition: Serialization::UNSET)
  params = SetCookieParameters.new(cookie: cookie, partition: partition)
  execute(cmd: 'storage.setCookie', params: params, result: Storage::SetCookieResult)
end

#storage_key_partition_descriptor ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/bidi/protocol/storage.rb', line 152

def storage_key_partition_descriptor(**) = StorageKeyPartitionDescriptor.new(**)