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   * Opens the handler associated with the given resource.
  20   * If the caller does not have permission or no handler is set, we ask the
  21   * user to grant permission and pick a handler.
  22   *
  23   * @param aHander
  24   *        The interface describing the details of how this content should or
  25   *        can be handled.
  26   * @param aURI
  27   *        The URI of the resource that we are asking about.
  28   * @param aTriggeringPrincipal
  29   *        The principal making the request.
  30   * @param aBrowsingContext
  31   *        The browsing context where the load should happen.
  32   * @param aWasTriggeredExternally
  33   *        True if the load was tripped by an external app.
  34   */
  35   void handleURI(in nsIHandlerInfo aHandler,
  36            in nsIURI aURI,
  37            in nsIPrincipal aTriggeringPrincipal,
  38            in BrowsingContext aBrowsingContext,
  39            [optional] in bool aWasTriggeredExternally);
  40 };