Interface BrowserElement

Combined interface for browser elements.

interface BrowserElement {
    addNextPaintListener(
        listener: BrowserElementNextPaintEventCallback,
    ): void;
    clearMatch(): void;
    download(url: string, options?: BrowserElementDownloadOptions): DOMRequest;
    executeScript(
        script: string,
        options?: BrowserElementExecuteScriptOptions,
    ): DOMRequest;
    findAll(
        searchString: string,
        caseSensitivity: BrowserFindCaseSensitivity,
    ): void;
    findNext(direction: BrowserFindDirection): void;
    getActive(): boolean;
    getCanGoBack(): DOMRequest;
    getCanGoForward(): DOMRequest;
    getContentDimensions(): DOMRequest;
    getScreenshot(width: number, height: number, mimeType?: string): DOMRequest;
    getStructuredData(): DOMRequest;
    getVisible(): DOMRequest;
    getWebManifest(): DOMRequest;
    goBack(): void;
    goForward(): void;
    purgeHistory(): DOMRequest;
    reload(hardReload?: boolean): void;
    removeNextPaintListener(
        listener: BrowserElementNextPaintEventCallback,
    ): void;
    sendMouseEvent(
        type: string,
        x: number,
        y: number,
        button: number,
        clickCount: number,
        modifiers: number,
    ): void;
    sendTouchEvent(
        type: string,
        identifiers: number[],
        x: number[],
        y: number[],
        rx: number[],
        ry: number[],
        rotationAngles: number[],
        forces: number[],
        count: number,
        modifiers: number,
    ): void;
    setActive(active: boolean): void;
    setInputMethodActive(isActive: boolean): DOMRequest;
    setNFCFocus(isFocus: boolean): void;
    setVisible(visible: boolean): void;
    stop(): void;
    zoom(zoom: number): void;
}

Hierarchy (View Summary)

BrowserElementCommon
BrowserElementPrivileged
- BrowserElement

Methods

addNextPaintListener

addNextPaintListener(listener: BrowserElementNextPaintEventCallback): void
Adds a listener for the next paint event.
Parameters
- listener: BrowserElementNextPaintEventCallback
  The callback to invoke on the next paint.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.
Inherited from BrowserElementCommon.addNextPaintListener
- Defined in browser/browser-element.d.ts:91

clearMatch

clearMatch(): void
Clears the current search match.

Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.clearMatch
- Defined in browser/browser-element.d.ts:305

download

download(url: string, options?: BrowserElementDownloadOptions): DOMRequest
Downloads a file from a URL.
Parameters
- url: string
  The URL to download.
- Optionaloptions: BrowserElementDownloadOptions
  Download options.
Returns DOMRequest
A DOMRequest indicating success or failure.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.download
- Defined in browser/browser-element.d.ts:199

executeScript

executeScript(
script: string,
options?: BrowserElementExecuteScriptOptions,
): DOMRequest
Executes a script in the context of the browser element.
Parameters
- script: string
  The script source code.
- Optionaloptions: BrowserElementExecuteScriptOptions
  Options for execution.
Returns DOMRequest
A DOMRequest that resolves when execution is complete.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser, browser:universalxss
Inherited from BrowserElementPrivileged.executeScript
- Defined in browser/browser-element.d.ts:316

findAll

findAll(searchString: string, caseSensitivity: BrowserFindCaseSensitivity): void
Finds text within the content.
Parameters
- searchString: string
  The text to search for.
- caseSensitivity: BrowserFindCaseSensitivity
  Case sensitivity option.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.findAll
- Defined in browser/browser-element.d.ts:285

findNext

findNext(direction: BrowserFindDirection): void
Finds the next occurrence of the text.
Parameters
- direction: BrowserFindDirection
  Direction to search.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.findNext
- Defined in browser/browser-element.d.ts:297

getActive

getActive(): boolean
Gets the active state of the browser element.

Returns boolean
True if active, false otherwise.

Throws
NS_ERROR_NOT_AVAILABLE.
Inherited from BrowserElementCommon.getActive
- Defined in browser/browser-element.d.ts:83

getCanGoBack

getCanGoBack(): DOMRequest
Checks if it is possible to navigate back.

Returns DOMRequest
A DOMRequest resolving to a boolean.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.getCanGoBack
- Defined in browser/browser-element.d.ts:238

getCanGoForward

getCanGoForward(): DOMRequest
Checks if it is possible to navigate forward.

Returns DOMRequest
A DOMRequest resolving to a boolean.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.getCanGoForward
- Defined in browser/browser-element.d.ts:247

getContentDimensions

getContentDimensions(): DOMRequest
Retrieves the dimensions of the content.

Returns DOMRequest
A DOMRequest resolving to the dimensions.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.getContentDimensions
- Defined in browser/browser-element.d.ts:256

getScreenshot

getScreenshot(width: number, height: number, mimeType?: string): DOMRequest
Captures a screenshot of the browser element content.
Parameters
- width: number
  The width of the screenshot.
- height: number
  The height of the screenshot.
- OptionalmimeType: string
  The MIME type of the screenshot (optional).
Returns DOMRequest
A DOMRequest resolving to a Blob.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.getScreenshot
- Defined in browser/browser-element.d.ts:220

getStructuredData

getStructuredData(): DOMRequest
Retrieves structured data from the page (e.g., Microdata, Open Graph).

Returns DOMRequest
A DOMRequest resolving to the structured data.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.getStructuredData
- Defined in browser/browser-element.d.ts:328

getVisible

getVisible(): DOMRequest
Gets the visibility state of the browser element.

Returns DOMRequest
A DOMRequest that resolves to the visibility state.

Throws
NS_ERROR_NOT_AVAILABLE.
Inherited from BrowserElementCommon.getVisible
- Defined in browser/browser-element.d.ts:67

getWebManifest

getWebManifest(): DOMRequest
Retrieves the Web Manifest of the page.

Returns DOMRequest
A DOMRequest resolving to the manifest.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.getWebManifest
- Defined in browser/browser-element.d.ts:337

goBack

goBack(): void
Navigates back in the session history.

Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.goBack
- Defined in browser/browser-element.d.ts:163

goForward

goForward(): void
Navigates forward in the session history.

Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.goForward
- Defined in browser/browser-element.d.ts:171

purgeHistory

purgeHistory(): DOMRequest
Purges the session history.

Returns DOMRequest
A DOMRequest indicating success or failure.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.purgeHistory
- Defined in browser/browser-element.d.ts:208

reload

reload(hardReload?: boolean): void
Reloads the current page.
Parameters
- OptionalhardReload: boolean
  Whether to perform a hard reload (bypassing cache).
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.reload
- Defined in browser/browser-element.d.ts:180

removeNextPaintListener

removeNextPaintListener(listener: BrowserElementNextPaintEventCallback): void
Removes a listener for the next paint event.
Parameters
- listener: BrowserElementNextPaintEventCallback
  The callback to remove.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.
Inherited from BrowserElementCommon.removeNextPaintListener
- Defined in browser/browser-element.d.ts:99

sendMouseEvent

sendMouseEvent(
    type: string,
    x: number,
    y: number,
    button: number,
    clickCount: number,
    modifiers: number,
): void
Sends a mouse event to the browser element content.
Parameters
- type: string
  The type of mouse event (e.g., "mousedown", "mouseup").
- x: number
  The x coordinate.
- y: number
  The y coordinate.
- button: number
  The button pressed.
- clickCount: number
  The number of clicks.
- modifiers: number
  Modifier keys pressed.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.sendMouseEvent
- Defined in browser/browser-element.d.ts:118

sendTouchEvent

sendTouchEvent(
    type: string,
    identifiers: number[],
    x: number[],
    y: number[],
    rx: number[],
    ry: number[],
    rotationAngles: number[],
    forces: number[],
    count: number,
    modifiers: number,
): void
Sends a touch event to the browser element content.
Parameters
- type: string
  The type of touch event.
- identifiers: number[]
  Array of touch identifiers.
- x: number[]
  Array of x coordinates.
- y: number[]
  Array of y coordinates.
- rx: number[]
  Array of radius-x values.
- ry: number[]
  Array of radius-y values.
- rotationAngles: number[]
  Array of rotation angles.
- forces: number[]
  Array of force values.
- count: number
  Number of touches.
- modifiers: number
  Modifier keys.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE. Requires "TouchEvent::PrefEnabled" to be true.

Permissions
browser
Inherited from BrowserElementPrivileged.sendTouchEvent
- Defined in browser/browser-element.d.ts:144

setActive

setActive(active: boolean): void
Sets the active state of the browser element.
Parameters
- active: boolean
  Whether the element should be active.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.
Inherited from BrowserElementCommon.setActive
- Defined in browser/browser-element.d.ts:75

setInputMethodActive

setInputMethodActive(isActive: boolean): DOMRequest
Sets whether the input method is active.
Parameters
- isActive: boolean
  Whether the input method should be active.
Returns DOMRequest
A DOMRequest indicating success or failure.

Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser, input-manage
Inherited from BrowserElementPrivileged.setInputMethodActive
- Defined in browser/browser-element.d.ts:266

setNFCFocus

setNFCFocus(isFocus: boolean): void
Sets whether NFC events should be focused on this element.
Parameters
- isFocus: boolean
  Whether to focus NFC events.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser, nfc-manager
Inherited from BrowserElementPrivileged.setNFCFocus
- Defined in browser/browser-element.d.ts:275

setVisible

setVisible(visible: boolean): void
Sets the visibility of the browser element.
Parameters
- visible: boolean
  Whether the element should be visible.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.
Inherited from BrowserElementCommon.setVisible
- Defined in browser/browser-element.d.ts:59

stop

stop(): void
Stops loading the current page.

Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.stop
- Defined in browser/browser-element.d.ts:188

zoom

zoom(zoom: number): void
Sets the zoom factor.
Parameters
- zoom: number
  The zoom factor.
Returns void
Throws
NS_ERROR_NOT_AVAILABLE.

Permissions
browser
Inherited from BrowserElementPrivileged.zoom
- Defined in browser/browser-element.d.ts:229

Interface BrowserElement

Hierarchy (View Summary)

Index

Methods

Methods

addNextPaintListener

Parameters

Returns void

Throws

clearMatch

Returns void

Throws

Permissions

download

Parameters

Returns DOMRequest

Throws

Permissions

executeScript

Parameters

Returns DOMRequest

Throws

Permissions

findAll

Parameters

Returns void

Throws

Permissions

findNext

Parameters

Returns void

Throws

Permissions

getActive

Returns boolean

Throws

getCanGoBack

Returns DOMRequest

Throws

Permissions

getCanGoForward

Returns DOMRequest

Throws

Permissions

getContentDimensions

Returns DOMRequest

Throws

Permissions

getScreenshot

Parameters

Returns DOMRequest

Throws

Permissions

getStructuredData

Returns DOMRequest

Throws

Permissions

getVisible

Returns DOMRequest

Throws

getWebManifest

Returns DOMRequest

Throws

Permissions

goBack

Returns void

Throws

Permissions

goForward

Returns void

Throws

Permissions

purgeHistory

Returns DOMRequest

Throws

Permissions

reload

Parameters

Returns void

Throws