netwerk/base/public/nsIAuthPromptProvider.idl

   1 /* -*- Mode: idl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  *   Vladimir Vukicevic <vladimir@pobox.com>
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 [scriptable, uuid(bd9dc0fa-68ce-47d0-8859-6418c2ae8576)]
  41 interface nsIAuthPromptProvider : nsISupports
  42 {
  43     /**
  44      * Normal (non-proxy) prompt request.
  45      */
  46     const PRUint32 PROMPT_NORMAL        = 0;
  47
  48     /**
  49      * Proxy auth request.
  50      */
  51     const PRUint32 PROMPT_PROXY         = 1;
  52
  53     /**
  54      * Request a prompt interface for the given prompt reason;
  55      * @throws NS_ERROR_NOT_AVAILABLE if no prompt is allowed or
  56      * available for the given reason.
  57      *
  58      * @param aPromptReason   The reason for the auth prompt;
  59      *                        one of #PROMPT_NORMAL or #PROMPT_PROXY
  60      * @param iid             The desired interface, e.g.
  61      *                        NS_GET_IID(nsIAuthPrompt2).
  62      * @returns an nsIAuthPrompt2 interface, or throws NS_ERROR_NOT_AVAILABLE
  63      */
  64     void getAuthPrompt(in PRUint32 aPromptReason, in nsIIDRef iid,
  65                        [iid_is(iid),retval] out nsQIResult result);
  66 };