# FirefoxRdpSession

[**@openpolyfill/firefox-addon-playwright-harness**](/docs/api/reference)

***

[@openpolyfill/firefox-addon-playwright-harness](/docs/api/reference/globals) / FirefoxRdpSession

# Class: FirefoxRdpSession

Defined in: [src/rdp.ts:249](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L249)

## Properties

### addonsActor

> `readonly` **addonsActor**: `string`

Defined in: [src/rdp.ts:259](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L259)

***

### chromeTarget

> **chromeTarget**: `TargetFront` \| `undefined`

Defined in: [src/rdp.ts:251](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L251)

***

### rdp

> `readonly` **rdp**: [`FirefoxRDP`](/docs/api/reference/interfaces/FirefoxRDP)

Defined in: [src/rdp.ts:258](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L258)

***

### targets

> `readonly` **targets**: `TargetFront`[] = `[]`

Defined in: [src/rdp.ts:250](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L250)

## Methods

### close()

> **close**(): `void`

Defined in: [src/rdp.ts:594](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L594)

#### Returns

`void`

***

### inspectedWindowEvaluation()

> **inspectedWindowEvaluation**(`addonId`, `browsingContextID`): `Promise`\<[`RdpInspectedWindowEvaluation`](/docs/api/reference/classes/RdpInspectedWindowEvaluation)\>

Defined in: [src/rdp.ts:541](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L541)

#### Parameters

##### addonId

`string`

##### browsingContextID

`number`

#### Returns

`Promise`\<[`RdpInspectedWindowEvaluation`](/docs/api/reference/classes/RdpInspectedWindowEvaluation)\>

***

### installExtension()

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

Defined in: [src/rdp.ts:344](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L344)

#### Parameters

##### path

`string`

##### onInstalled?

(`extensionId`) => `boolean` \| `void`

##### preserveExistingOnFailure?

`boolean` = `false`

#### Returns

`Promise`\<`InstalledExtension`\>

***

### installTemporaryAddon()

> **installTemporaryAddon**(`path`): `Promise`\<\{String.fromCharCode(123)} `actor`: `string`; `id`: `string`; \{String.fromCharCode(125)}\>

Defined in: [src/rdp.ts:306](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L306)

#### Parameters

##### path

`string`

#### Returns

`Promise`\<\{String.fromCharCode(123)} `actor`: `string`; `id`: `string`; \{String.fromCharCode(125)}\>

***

### isAddonEnabled()

> **isAddonEnabled**(`addonId`): `Promise`\<`boolean`\>

Defined in: [src/rdp.ts:425](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L425)

#### Parameters

##### addonId

`string`

#### Returns

`Promise`\<`boolean`\>

***

### listAddons()

> **listAddons**(): `Promise`\<`object`[]\>

Defined in: [src/rdp.ts:321](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L321)

#### Returns

`Promise`\<`object`[]\>

***

### refreshExtensionTargets()

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

Defined in: [src/rdp.ts:506](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L506)

#### Parameters

##### addonId

`string`

##### force?

`boolean` = `false`

#### Returns

`Promise`\<`void`\>

***

### reloadExtension()

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

Defined in: [src/rdp.ts:433](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L433)

#### 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](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L470)

#### 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](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L385)

#### Parameters

##### addonId

`string`

##### enabled

`boolean`

##### hasBackground?

`boolean` = `false`

#### Returns

`Promise`\<`void`\>

***

### uninstallAddon()

> **uninstallAddon**(`addonId`): `Promise`\<`void`\>

Defined in: [src/rdp.ts:495](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L495)

#### Parameters

##### addonId

`string`

#### Returns

`Promise`\<`void`\>

***

### waitForExtensionBackground()

> **waitForExtensionBackground**(`addonId`, `manifest`, `excludedConsoleActor?`): `Promise`\<\{String.fromCharCode(123)} `evaluator`: [`RdpEvaluation`](/docs/api/reference/classes/RdpEvaluation); `target`: `TargetFront`; \{String.fromCharCode(125)} \| `undefined`\>

Defined in: [src/rdp.ts:521](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L521)

#### Parameters

##### addonId

`string`

##### manifest

`Record`\<`string`, `unknown`\>

##### excludedConsoleActor?

`string`

#### Returns

`Promise`\<\{String.fromCharCode(123)} `evaluator`: [`RdpEvaluation`](/docs/api/reference/classes/RdpEvaluation); `target`: `TargetFront`; \{String.fromCharCode(125)} \| `undefined`\>

***

### waitForTarget()

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

Defined in: [src/rdp.ts:561](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L561)

#### Parameters

##### predicate

(`target`) => `boolean`

##### timeoutMs?

`number` = `10_000`

#### Returns

`Promise`\<`TargetFront`\>

***

### connect()

> `static` **connect**(`port`): `Promise`\<`FirefoxRdpSession`\>

Defined in: [src/rdp.ts:265](https://github.com/OpenPolyfill/FirefoxAddonPlaywrightHarness/blob/9532a852e3623332cfb2eacd964ebdb4045220e5/src/rdp.ts#L265)

#### Parameters

##### port

`number`

#### Returns

`Promise`\<`FirefoxRdpSession`\>