Class: Selenium::WebDriver::BiDi::Protocol::WebExtension Private

Inherits:

Domain

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

Defined in:

rb/lib/selenium/webdriver/bidi/protocol/web_extension.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-webExtension

Defined Under Namespace

Classes: ExtensionData, Moz

Constant Summary

InstallParameters =

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-webextensioninstallparameters

Serialization::Record.define(
  extension_data: {wire_key: 'extensionData', ref: 'WebExtension::ExtensionData'},
  extensible: true
)

ExtensionPath =

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-webextensionextensionpath

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

ExtensionArchivePath =

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-webextensionextensionarchivepath

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

ExtensionBase64Encoded =

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-webextensionextensionbase64encoded

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

InstallResult =

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-webextensioninstallresult

Serialization::Record.define(extension: {wire_key: 'extension', primitive: 'string'})

UninstallParameters =

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-webextensionuninstallparameters

Serialization::Record.define(extension: {wire_key: 'extension', primitive: 'string'})

MozListExtensionsResult =

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/

Serialization::Record.define(
  extensions: {wire_key: 'extensions', ref: 'WebExtension::MozExtensionInfo', list: true}
)

MozExtensionInfo =

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/

Serialization::Record.define(
  id: {wire_key: 'id', primitive: 'string'},
  name: {wire_key: 'name', primitive: 'string'},
  version: {wire_key: 'version', primitive: 'string'},
  manifest_version: {wire_key: 'manifestVersion', primitive: 'integer'},
  is_active: {wire_key: 'isActive', primitive: 'boolean'},
  is_system: {wire_key: 'isSystem', primitive: 'boolean'},
  hidden: {wire_key: 'hidden', primitive: 'boolean'},
  temporarily_installed: {wire_key: 'temporarilyInstalled', primitive: 'boolean'},
  source_url: {wire_key: 'sourceURL', required: false, nullable: true, primitive: 'string'},
  policy: {wire_key: 'policy', required: false, nullable: true, ref: 'WebExtension::MozExtensionPolicyInfo'}
)

MozExtensionPolicyInfo =

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/

Serialization::Record.define(
  uuid: {wire_key: 'uuid', primitive: 'string'},
  base_url: {wire_key: 'baseURL', primitive: 'string'},
  extension_url: {wire_key: 'extensionURL', primitive: 'string'},
  background_scripts: {wire_key: 'backgroundScripts', list: true}
)

Instance Method Summary

• #extension_archive_path ⇒ Object private
• #extension_base64_encoded ⇒ Object private
• #extension_data ⇒ Object private
• #extension_path ⇒ Object private
• #install(extension_data:) ⇒ Object private
• #moz ⇒ Object private
• #uninstall(extension:) ⇒ Object private

Methods inherited from Domain

#initialize

Constructor Details

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

Instance Method Details

#extension_archive_path ⇒ 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 'rb/lib/selenium/webdriver/bidi/protocol/web_extension.rb', line 122

def extension_archive_path(**) = ExtensionArchivePath.new(**)

#extension_base64_encoded ⇒ 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 'rb/lib/selenium/webdriver/bidi/protocol/web_extension.rb', line 123

def extension_base64_encoded(**) = ExtensionBase64Encoded.new(**)

#extension_data ⇒ 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 'rb/lib/selenium/webdriver/bidi/protocol/web_extension.rb', line 120

def extension_data = ExtensionData

#extension_path ⇒ 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 'rb/lib/selenium/webdriver/bidi/protocol/web_extension.rb', line 121

def extension_path(**) = ExtensionPath.new(**)

#install(extension_data:) ⇒ 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-webExtension-install

# File 'rb/lib/selenium/webdriver/bidi/protocol/web_extension.rb', line 129

def install(extension_data:)
  params = InstallParameters.new(extension_data: extension_data)
  execute(cmd: 'webExtension.install', params: params, result: WebExtension::InstallResult)
end

#moz ⇒ 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 'rb/lib/selenium/webdriver/bidi/protocol/web_extension.rb', line 124

def moz = Moz.new(connection)

#uninstall(extension:) ⇒ 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-webExtension-uninstall

# File 'rb/lib/selenium/webdriver/bidi/protocol/web_extension.rb', line 137

def uninstall(extension:)
  params = UninstallParameters.new(extension: extension)
  execute(cmd: 'webExtension.uninstall', params: params)
end