uriloader/exthandler/nsIContentDispatchChooser.idl

   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
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6
   7 interface nsIHandlerInfo;
   8 interface nsIPrincipal;
   9 interface nsIURI;
  10 webidl BrowsingContext;
  11
  12 /**
  13  * This is used to ask a user what they would like to do with a given piece of
  14  * content.
  15  */
  16 [scriptable, uuid(456ca3b2-02be-4f97-89a2-08c08d3ad88f)]
  17 interface nsIContentDispatchChooser : nsISupports {
  18  /**
  19   * This request is passed to the helper app dialog because Gecko can not
  20   * handle content of this type.
  21   */
  22   const unsigned long REASON_CANNOT_HANDLE = 0;
  23
  24  /**
  25   * Asks the user what to do with the content.
  26   *
  27   * @param aHander
  28   *        The interface describing the details of how this content should or
  29   *        can be handled.
  30   * @param aURI
  31   *        The URI of the resource that we are asking about.
  32   * @param aTriggeringPrincipal
  33   *        The principal making the request.
  34   * @param aBrowsingContext
  35   *        The browsing context where the load should happen.
  36   * @param aReason
  37   *        The reason why we are asking (see above).
  38   */
  39   void ask(in nsIHandlerInfo aHandler,
  40            in nsIURI aURI,
  41            in nsIPrincipal aTriggeringPrincipal,
  42            in BrowsingContext aBrowsingContext,
  43            in unsigned long aReason);
  44 };
  45