@openpolyfill/firefox-rdp

@openpolyfill/firefox-rdp / TabDescriptorFront

Class: TabDescriptorFront

Defined in: src/client.ts:311

A generic actor client: use call() or the methods proxy to invoke actor methods.

Extends

• ActorFront

Constructors

Constructor

new TabDescriptorFront(client, info, selected): TabDescriptorFront

Defined in: src/client.ts:312

Parameters

client

FirefoxRDP

info

TabInfo

selected

boolean

Returns

TabDescriptorFront

Overrides

ActorFront.constructor

Properties

actorId

readonly actorId: string

Defined in: src/client.ts:60

Inherited from

ActorFront.actorId

api

readonly api: Record<string, (…args) => Promise<unknown>>

Defined in: src/client.ts:52

Firefox-spec positional method calls; arguments are marshalled by Arg/Option templates.

Inherited from

ActorFront.api

client

readonly client: FirefoxRDP

Defined in: src/client.ts:59

Inherited from

ActorFront.client

form

form: Params | undefined

Defined in: src/client.ts:49

Most recent actor form, when supplied by the remote actor.

Inherited from

ActorFront.form

info

info: TabInfo

Defined in: src/client.ts:314

methods

readonly methods: Record<string, (params?) => Promise<RDPResponse>>

Defined in: src/client.ts:50

Inherited from

ActorFront.methods

selected

selected: boolean

Defined in: src/client.ts:315

spec?

protected optional spec?: ActorSpec

Defined in: src/client.ts:53

Inherited from

ActorFront.spec

Accessors

specTypeName

Get Signature

get specTypeName(): string | undefined

Defined in: src/client.ts:54

Returns

string | undefined

Inherited from

ActorFront.specTypeName

title

Get Signature

get title(): string | undefined

Defined in: src/client.ts:327

Returns

string | undefined

url

Get Signature

get url(): string | undefined

Defined in: src/client.ts:330

Returns

string | undefined

Methods

adoptFrom()

adoptFrom(other): this

Defined in: src/client.ts:190

Preserve listeners when a generic actor is upgraded to a specialized front.

Parameters

other

ActorFront

Returns

this

Inherited from

ActorFront.adoptFrom

call()

call(method, params?): Promise<RDPResponse>

Defined in: src/client.ts:109

Parameters

method

string

params?

Params = {String.fromCharCode(123)}{String.fromCharCode(125)}

Returns

Promise<RDPResponse>

Inherited from

ActorFront.call

dispatch()

dispatch(packet): void

Defined in: src/client.ts:208

Parameters

packet

RDPResponse

Returns

void

Inherited from

ActorFront.dispatch

getTarget()

getTarget(): Promise<TargetFront>

Defined in: src/client.ts:362

Returns

Promise<TargetFront>

getWatcher()

getWatcher(options?): Promise<WatcherFront>

Defined in: src/client.ts:334

Parameters

options?

isPopupDebuggingEnabled?

boolean

isServerTargetSwitchingEnabled?

boolean

Returns

Promise<WatcherFront>

goBack()

goBack(): Promise<void>

Defined in: src/client.ts:355

Returns

Promise<void>

goForward()

goForward(): Promise<void>

Defined in: src/client.ts:358

Returns

Promise<void>

invoke()

invoke(method, …args): Promise<unknown>

Defined in: src/client.ts:92

Call the named Firefox actor method with its original positional JS signature.

Parameters

method

string

args

…unknown[]

Returns

Promise<unknown>

Inherited from

ActorFront.invoke

isEvent()

isEvent(packet): boolean

Defined in: src/client.ts:202

Parameters

packet

RDPResponse

Returns

boolean

Inherited from

ActorFront.isEvent

listen()

listen(type, listener): this

Defined in: src/client.ts:114

Subscribe with Firefox’s native positional Front event signature.

Parameters

type

string

listener

(…args) => void

Returns

this

Inherited from

ActorFront.listen

navigateTo()

navigateTo(url, waitForLoad?): Promise<void>

Defined in: src/client.ts:349

Parameters

url

string

waitForLoad?

boolean = true

Returns

Promise<void>

off()

off(type, listener): this

Defined in: src/client.ts:176

Parameters

type

string

listener

PacketListener

Returns

this

Inherited from

ActorFront.off

on()

on(type, listener): this

Defined in: src/client.ts:168

Parameters

type

string

listener

PacketListener

Returns

this

Inherited from

ActorFront.on

once()

once(type, listener): this

Defined in: src/client.ts:181

Parameters

type

string

listener

PacketListener

Returns

this

Inherited from

ActorFront.once

registerEvents()

registerEvents(…types): this

Defined in: src/client.ts:163

Mark event packet types explicitly, even if no listener is currently attached.

Parameters

types

…string[]

Returns

this

Inherited from

ActorFront.registerEvents

reload()

reload(bypassCache?): Promise<void>

Defined in: src/client.ts:352

Parameters

bypassCache?

boolean = false

Returns

Promise<void>

unlisten()

unlisten(type, listener): this

Defined in: src/client.ts:122

Parameters

type

string

listener

(…args) => void

Returns

this

Inherited from

ActorFront.unlisten

update()

update(info, selected): void

Defined in: src/client.ts:322

Parameters

info

TabInfo

selected

boolean

Returns

void

useSpec()

useSpec(spec): this

Defined in: src/client.ts:85

Attach an actor spec to enable schema-based calls and automatic event routing.

Parameters

spec

ActorSpec

Returns

this

Inherited from

ActorFront.useSpec

waitFor()

waitFor(type, options?): Promise<RDPResponse>

Defined in: src/client.ts:128

Await one event, optionally with cancellation and timeout.

Parameters

type

string

options?

signal?

AbortSignal

timeoutMs?

number

Returns

Promise<RDPResponse>

Inherited from

ActorFront.waitFor