Interface nsIBackgroundTasksType

Determine if this instance is running background task mode and what, if any, task is active.

Hierarchy

Properties

isBackgroundTaskMode

Methods

AddRef QueryInterface Release backgroundTaskName overrideBackgroundTaskNameForTesting

Properties

Readonly isBackgroundTaskMode

isBackgroundTaskMode: boolean

True if and only if this invocation is running in background task mode.

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

backgroundTaskName

  • A non-empty task name if this invocation is running in background task mode, or null if this invocation is not running in background task mode.

    Returns string

overrideBackgroundTaskNameForTesting

  • Should only be used for testing. Set the background task name.

    Parameters

    • taskName: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc