@openpolyfill/firefox-addon-playwright-harness

@openpolyfill/firefox-addon-playwright-harness / FirefoxRdpSession

Class: FirefoxRdpSession

Defined in: src/rdp.ts:249

Properties

addonsActor

readonly addonsActor: string

Defined in: src/rdp.ts:259

chromeTarget

chromeTarget: TargetFront | undefined

Defined in: src/rdp.ts:251

rdp

readonly rdp: FirefoxRDP

Defined in: src/rdp.ts:258

targets

readonly targets: TargetFront[] = []

Defined in: src/rdp.ts:250

Methods

close()

close(): void

Defined in: src/rdp.ts:594

Returns

void

inspectedWindowEvaluation()

inspectedWindowEvaluation(addonId, browsingContextID): Promise<RdpInspectedWindowEvaluation>

Defined in: src/rdp.ts:541

Parameters

addonId

string

browsingContextID

number

Returns

Promise<RdpInspectedWindowEvaluation>

installExtension()

installExtension(path, onInstalled?, preserveExistingOnFailure?): Promise<InstalledExtension>

Defined in: src/rdp.ts:344

Parameters

path

string

onInstalled?

(extensionId) => boolean | void

preserveExistingOnFailure?

boolean = false

Returns

Promise<InstalledExtension>

installTemporaryAddon()

installTemporaryAddon(path): Promise<{ actor: string; id: string; }>

Defined in: src/rdp.ts:306

Parameters

path

string

Returns

Promise<{ actor: string; id: string; }>

isAddonEnabled()

isAddonEnabled(addonId): Promise<boolean>

Defined in: src/rdp.ts:425

Parameters

addonId

string

Returns

Promise<boolean>

listAddons()

listAddons(): Promise<object[]>

Defined in: src/rdp.ts:321

Returns

Promise<object[]>

refreshExtensionTargets()

refreshExtensionTargets(addonId, force?): Promise<void>

Defined in: src/rdp.ts:506

Parameters

addonId

string

force?

boolean = false

Returns

Promise<void>

reloadExtension()

reloadExtension(addonId, path, wasEnabled, previousConsoleActor?): Promise<InstalledExtension>

Defined in: src/rdp.ts:433

Parameters

addonId

string

path

string

wasEnabled

boolean

previousConsoleActor?

string

Returns

Promise<InstalledExtension>

restoreInstalledExtension()

restoreInstalledExtension(addonId, sourcePath, fallbackManifest): Promise<InstalledExtension | undefined>

Defined in: src/rdp.ts:470

Parameters

addonId

string

sourcePath

string

fallbackManifest

Record<string, unknown>

Returns

Promise<InstalledExtension | undefined>

setAddonEnabled()

setAddonEnabled(addonId, enabled, hasBackground?): Promise<void>

Defined in: src/rdp.ts:385

Parameters

addonId

string

enabled

boolean

hasBackground?

boolean = false

Returns

Promise<void>

uninstallAddon()

uninstallAddon(addonId): Promise<void>

Defined in: src/rdp.ts:495

Parameters

addonId

string

Returns

Promise<void>

waitForExtensionBackground()

waitForExtensionBackground(addonId, manifest, excludedConsoleActor?): Promise<{ evaluator: RdpEvaluation; target: TargetFront; } | undefined>

Defined in: src/rdp.ts:521

Parameters

addonId

string

manifest

Record<string, unknown>

excludedConsoleActor?

string

Returns

Promise<{ evaluator: RdpEvaluation; target: TargetFront; } | undefined>

waitForTarget()

waitForTarget(predicate, timeoutMs?): Promise<TargetFront>

Defined in: src/rdp.ts:561

Parameters

predicate

(target) => boolean

timeoutMs?

number = 10_000

Returns

Promise<TargetFront>

connect()

static connect(port): Promise<FirefoxRdpSession>

Defined in: src/rdp.ts:265

Parameters

port

number

Returns

Promise<FirefoxRdpSession>