Interface nsIRemoteTabType

Hierarchy

Properties

browsingContext contentProcessId hasLayers hasPresented osPid priorityHint renderLayers tabId

Methods

AddRef QueryInterface Release createAboutBlankContentViewer deprioritize maybeCancelContentJSExecution notifyResolutionChanged preserveLayers transmitPermissionsForPrincipal

Properties

Readonly browsingContext

browsingContext: BrowsingContext

The toplevel BrowsingContext loaded in this remote tab.

Readonly contentProcessId

contentProcessId: uint64_t

Readonly hasLayers

hasLayers: boolean

True if layers are being rendered and the compositor has reported receiving them.

Readonly hasPresented

hasPresented: boolean

True if we've previously received layers for this tab when switching to it.

Readonly osPid

osPid: int32_t

The OS level process Id of the related child process.

priorityHint

priorityHint: boolean

When set to true, this priority hint indicates that the content processes of this tab should be set to a higher process priority.

renderLayers

renderLayers: boolean

When set to true, this tells the child to paint and upload layers to the compositor. When set to false, previous layers are cleared from the compositor, but only if preserveLayers is also set to false.

Readonly tabId

tabId: uint64_t

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

createAboutBlankContentViewer

  • Similar to nsIDocShell.createAboutBlankContentViewer but on a remote frame. The docShell must not yet have navigated away from the initial about:blank document when this method is called.

    Parameters

    • aPrincipal: nsIPrincipal

      the principal to use for the new document.

    • aPartitionedPrincipal: nsIPrincipal

      the partitioned principal to use for the new document.

    Returns void

deprioritize

  • Adjusts the tab's active state in the process priority manager, allowing its process to be given a lower priority.

    Returns void

maybeCancelContentJSExecution

  • Interrupt content scripts if possible/needed to allow chrome scripts in the content process to run (in particular, to allow navigating through browser history.

    Parameters

    • aNavigationType: nsIRemoteTab_NavigationType
    • aCancelContentJSOptions: any

    Returns void

notifyResolutionChanged

  • Notify the remote tab that the resolution has changed.

    Returns void

preserveLayers

  • As an optimisation, setting the docshell's active state to inactive also triggers a layer invalidation to free up some potentially unhelpful memory usage. Calling preserveLayers will cause the layers to be preserved even for inactive docshells.

    Parameters

    • aPreserveLayers: boolean

    Returns void

transmitPermissionsForPrincipal

  • Ensures that the content process which has this remote tab has all of the permissions required to load a document with the given principal.

    Parameters

    • aPrincipal: nsIPrincipal

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc