Interface nsIBrowserType

Hierarchy

Properties

contentPartitionedPrincipal contentPrincipal csp isNavigating isRemoteBrowser mayEnableCharacterEncodingMenu permanentKey referrerInfo

Methods

AddRef QueryInterface Release beforeChangeRemoteness closeBrowser dropLinks finishChangeRemoteness prepareToChangeRemoteness swapBrowsers updateForLocationChange updateForStateChange updateWebNavigationForLocationChange

Properties

Readonly contentPartitionedPrincipal

contentPartitionedPrincipal: nsIPrincipal

Readonly contentPrincipal

contentPrincipal: nsIPrincipal

Readonly csp

csp: nsIContentSecurityPolicy

isNavigating

isNavigating: boolean

Whether or not the browser is in the process of an nsIWebNavigation navigation method.

Readonly isRemoteBrowser

isRemoteBrowser: boolean

A browser can change from remote to non-remote and vice versa. For example, when navigating from an in-process chrome page to a web page, this value would change from false to true.

mayEnableCharacterEncodingMenu

mayEnableCharacterEncodingMenu: boolean

Whether or not the character encoding menu may be enabled.

Readonly permanentKey

permanentKey: any

The browser's permanent key. This was added temporarily for Session Store, and will be removed in bug 1716788.

Readonly referrerInfo

referrerInfo: nsIReferrerInfo

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

beforeChangeRemoteness

  • Called immediately before changing remoteness

    Returns void

closeBrowser

  • Close the browser (usually means to remove a tab).

    Returns void

dropLinks

  • Called by the child to inform the parent that links are dropped into content area.

    Parameters

    • links: invalid

      a flat array of url, name, and type for each link

    • triggeringPrincipal: nsIPrincipal

      a principal that initiated loading of the dropped links

    Returns void

finishChangeRemoteness

  • Called immediately after changing remoteness.

    If this method returns true, Gecko will assume frontend handled resuming the load, and will not attempt to resume the load itself.

    Parameters

    • aPendingSwitchId: uint64_t

    Returns bool

prepareToChangeRemoteness

  • Called to perform any async tasks which must be completed before changing remoteness. Gecko will wait for the returned promise to resolve before performing the process switch.

    Returns any

swapBrowsers

  • Swapping of frameloaders are usually initiated from a frameloader owner or other components operating on frameloader owners. This is done by calling swapFrameLoaders at MozFrameLoaderOwner webidl interface.

    This function aimed to provide the other way around - if the swapping is initiated from frameloader itself or other platform level components, it uses this interface to delegate the swapping request to frameloader owners and ask them to re-initiate frameloader swapping, so that frameloader owners such as xul:browser can setup their properties and / or listeners properly on swapping.

    Parameters

    • aOtherBrowser: nsIBrowser

    Returns void

updateForLocationChange

  • Called by Gecko to update the browser when a location change occurs.

    Parameters

    • aLocation: nsIURI

      the new location

    • aCharset: string

      the character set of the document

    • aMayEnableCharacterEncodingMenu: boolean

      whether or not the content encoding menu may be enabled

    • aDocumentURI: nsIURI

      the URI of the new document

    • aTitle: string

      the title of the new doucment

    • aContentPrincipal: nsIPrincipal

      the security principal of the new document

    • aContentPartitionedPrincipal: nsIPrincipal

      the security principal for the new document's storage

    • aCSP: nsIContentSecurityPolicy

      the content security policy of the new document

    • aReferrerInfo: nsIReferrerInfo

      the referrer info of the new document

    • aIsSynthetic: boolean

      whether or not the document is synthetic

    • aHasRequestContextID: boolean

      whether or not the the request context has a value (true) or null should be used (false)

    • aRequestContextID: uint64_t

      the request context ID

    • aContentType: string

      the content type of the document

    Returns void

updateForStateChange

  • Called by Gecko to update the browser when its state changes.

    Parameters

    • aCharset: string

      the new character set of the document

    • aDocumentURI: nsIURI

      the URI of the current document

    • aContentType: string

      the content type of the document

    Returns void

updateWebNavigationForLocationChange

  • Called by Gecko to update the nsIWebNavigation when a location change occurs.

    Parameters

    • aCanGoBack: boolean

      whether or not the nsIWebNavigation can go backwards in history

    • aCanGoForward: boolean

      whether or not the nsIWebNavigation can go forward in history

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc