dom/chrome-webidl/LoadURIOptions.webidl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   3  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 interface ContentSecurityPolicy;
   6 interface Principal;
   7 interface URI;
   8 interface InputStream;
   9 interface ReferrerInfo;
  10
  11 /**
  12  * This dictionary holds load arguments for docshell loads.
  13  */
  14 [GenerateInit]
  15 dictionary LoadURIOptions {
  16   /**
  17    * The principal that initiated the load.
  18    */
  19   Principal? triggeringPrincipal = null;
  20
  21   /**
  22    * The CSP to be used for the load. That is *not* the CSP that will
  23    * be applied to subresource loads within that document but the CSP
  24    * for the document load itself. E.g. if that CSP includes
  25    * upgrade-insecure-requests, then the new top-level load will
  26    * be upgraded to HTTPS.
  27    */
  28   ContentSecurityPolicy? csp = null;
  29
  30   /**
  31    * Flags modifying load behaviour.  This parameter is a bitwise
  32    * combination of the load flags defined in nsIWebNavigation.idl.
  33    */
  34    long loadFlags = 0;
  35
  36   /**
  37    * The referring info of the load.  If this argument is null, then the
  38    * referrer URI and referrer policy will be inferred internally.
  39    */
  40    ReferrerInfo? referrerInfo = null;
  41
  42   /**
  43    * If the URI to be loaded corresponds to a HTTP request, then this stream is
  44    * appended directly to the HTTP request headers.  It may be prefixed
  45    * with additional HTTP headers.  This stream must contain a "\r\n"
  46    * sequence separating any HTTP headers from the HTTP request body.
  47    */
  48   InputStream? postData = null;
  49
  50   /**
  51    * If the URI corresponds to a HTTP request, then any HTTP headers
  52    * contained in this stream are set on the HTTP request.  The HTTP
  53    * header stream is formatted as:
  54    *     ( HEADER "\r\n" )*
  55    */
  56    InputStream? headers = null;
  57
  58   /**
  59    * Set to indicate a base URI to be associated with the load. Note
  60    * that at present this argument is only used with view-source aURIs
  61    * and cannot be used to resolve aURI.
  62    */
  63   URI? baseURI = null;
  64
  65   /**
  66    * Set to indicate that the URI to be loaded was triggered by a user
  67    * action. (Mostly used in the context of Sec-Fetch-User).
  68    */
  69   boolean hasValidUserGestureActivation = false;
  70
  71
  72   /**
  73   * The SandboxFlags of the entity thats
  74   * responsible for causing the load.
  75   */
  76   unsigned long triggeringSandboxFlags = 0;
  77
  78   /**
  79   * The window id and storage access status of the window of the
  80   * context that triggered the load. This is used to allow self-initiated
  81   * same-origin navigations to propagate their "has storage access" bit
  82   * to the next Document.
  83   */
  84   unsigned long long triggeringWindowId = 0;
  85   boolean triggeringStorageAccess = false;
  86
  87   /**
  88    * The RemoteType of the entity that's responsible for the load. Defaults to
  89    * the current process.
  90    *
  91    * When starting a load in a content process, `triggeringRemoteType` must be
  92    * either unset, or match the current remote type.
  93    */
  94   UTF8String? triggeringRemoteType;
  95
  96   /**
  97    * If non-0, a value to pass to nsIDocShell::setCancelContentJSEpoch
  98    * when initiating the load.
  99    */
 100   long cancelContentJSEpoch = 0;
 101
 102   /**
 103    * If this is passed, it will control which remote type is used to finish this
 104    * load. Ignored for non-`about:` loads.
 105    *
 106    * NOTE: This is _NOT_ defaulted to `null`, as `null` is the value for
 107    * `NOT_REMOTE_TYPE`, and we need to determine the difference between no
 108    * `remoteTypeOverride` and a `remoteTypeOverride` of `NOT_REMOTE_TYPE`.
 109    */
 110   UTF8String? remoteTypeOverride;
 111
 112   /**
 113    * Whether the search/URL term was without an explicit scheme.
 114    */
 115   boolean wasSchemelessInput = false;
 116 };