docshell/base/nsILoadInfo.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: ft=cpp tw=78 sw=2 et ts=2 sts=2 cin
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 interface nsIPrincipal;
  10 /**
  11  * An nsILoadOwner represents per-load information about who started the load.
  12  */
  13 [scriptable, builtinclass, uuid(046db047-a1c1-4519-8ec7-99f3054bc9ac)]
  14 interface nsILoadInfo : nsISupports
  15 {
  16   /**
  17    * loadingPrincipal is the principal that started the load.  Will
  18    * never be null.
  19    */
  20   readonly attribute nsIPrincipal loadingPrincipal;
  21
  22   /**
  23    * A C++-friendly version of loadingPrincipal.
  24    */
  25   [noscript, notxpcom, nostdcall, binaryname(LoadingPrincipal)]
  26   nsIPrincipal binaryLoadingPrincipal();
  27
  28   /**
  29    * If forceInheritPrincipal is true, the data coming from the channel should
  30    * use loadingPrincipal for its principal, even when the data is loaded over
  31    * http:// or another protocol that would normally use a URI-based principal.
  32    * This attribute will never be true when loadingSandboxed is true.
  33    */
  34   [infallible] readonly attribute boolean forceInheritPrincipal;
  35
  36   /**
  37    * If loadingSandboxed is true, the data coming from the channel is
  38    * being loaded sandboxed, so it should have a nonce origin and
  39    * hence should use a NullPrincipal.
  40    */
  41   [infallible] readonly attribute boolean loadingSandboxed;
  42 };