uriloader/prefetch/nsIPrefetchService.idl
author Tyler Kabaker <kabakert@msu.edu>
Sun, 16 Jan 2022 21:09:07 +0000
changeset 604640 fd384d84f3d05d364a74fa6967e416767c8e8759
parent 483498 1f630fcaad787a8a8b2402481bcbc8d253090c92
permissions -rw-r--r--
Bug 1747402 - Added check for when time value is less than zero in getFormattedTimeStatus. r=mtigley Differential Revision: https://phabricator.services.mozilla.com/D136065

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"
#include "nsIContentPolicy.idl"

interface nsIURI;
interface nsISimpleEnumerator;
interface nsIReferrerInfo;

webidl Node;

[scriptable, uuid(422a1807-4e7f-463d-b8d7-ca2ceb9b5d53)]
interface nsIPrefetchService : nsISupports
{
    /**
     * Enqueue a request to prefetch the specified URI.
     *
     * @param aURI the URI of the document to prefetch
     * @param aReferrerInfo the referrerInfo of the request
     * @param aSource the DOM node (such as a <link> tag) that requested this
     *        fetch, or null if the prefetch was not requested by a DOM node.
     * @param aExplicit the link element has an explicit prefetch link type
     */
    void prefetchURI(in nsIURI aURI,
                     in nsIReferrerInfo aReferrerInfo,
                     in Node aSource,
                     in boolean aExplicit);

    /**
     * Start a preload of the specified URI.
     *
     * @param aURI the URI of the document to preload
     * @param aReferrerInfo the referrerInfo of the request
     * @param aSource the DOM node (such as a <link> tag) that requested this
     *        fetch, or null if the prefetch was not requested by a DOM node.
     * @param aPolicyType content policy to be used for this load.
     */
    void preloadURI(in nsIURI aURI,
                    in nsIReferrerInfo aReferrerInfo,
                    in Node aSource,
                    in nsContentPolicyType aPolicyType);

    /**
     * Find out if there are any prefetches running or queued
     */
    boolean hasMoreElements();

    /**
     * Cancel prefetch or preload for a Node.
     */
    void cancelPrefetchPreloadURI(in nsIURI aURI, in Node aSource);
};