Interface nsICaptivePortalServiceType

Service used for captive portal detection. The service is only active in the main process. It is also available in the content process, but only to mirror the captive portal state from the main process.

Hierarchy

Properties

lastChecked state

Methods

AddRef QueryInterface Release recheckCaptivePortal

Properties

Readonly lastChecked

lastChecked: number

Returns the time difference between NOW and the last time a request was completed in milliseconds.

Readonly state

state: number

Returns the state of the captive portal.

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

recheckCaptivePortal

  • Called from XPCOM to trigger a captive portal recheck. A network request will only be performed if no other checks are currently ongoing. Will not do anything if called in the content process.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc