Interface nsIBackgroundTasksRunnerType

Hierarchy

Methods

AddRef QueryInterface Release removeDirectoryInDetachedProcess runInDetachedProcess

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

removeDirectoryInDetachedProcess

  • Runs removeDirectory background task. toolkit.background_tasks.remove_directory.testing.sleep_ms can be set to make it wait for the given milliseconds for testing purpose.

    See BackgroundTask_removeDirectory.sys.mjs for details about the arguments.

    Parameters

    • aParentDirPath: string
    • aChildDirName: string
    • aSecondsToWait: string
    • aOtherFoldersSuffix: string
    • aMetricsId: string

    Returns void

runInDetachedProcess

  • Runs a background process in an independent detached process. Any process opened by this function can outlive the main process.

    This function is thread-safe.

    XXX: The use of base::LaunchApp can make a zombie process on Unix. See bug 1802559.

    Parameters

    • aTaskName: string

      The name of the background task. (BackgroundTask_{name}.sys.mjs)

    • aCommandLine: invalid

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc