netwerk/base/public/nsIAuthPromptCallback.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozilla.org Necko code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Christian Biesinger <cbiesinger@web.de>.
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *  Google Inc.
  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 interface nsIAuthInformation;
  41
  42 /**
  43  * Interface for callback methods for the asynchronous nsIAuthPrompt2 method.
  44  * Callers MUST call exactly one method if nsIAuthPrompt2::promptPasswordAsync
  45  * returns successfully. They MUST NOT call any method on this interface before
  46  * promptPasswordAsync returns.
  47  */
  48 [scriptable, uuid(bdc387d7-2d29-4cac-92f1-dd75d786631d)]
  49 interface nsIAuthPromptCallback : nsISupports
  50 {
  51   /**
  52    * Authentication information is available.
  53    *
  54    * @param aContext
  55    *        The context as passed to promptPasswordAsync
  56    * @param aAuthInfo
  57    *        Authentication information. Must be the same object that was passed
  58    *        to promptPasswordAsync.
  59    *
  60    * @note  Any exceptions thrown from this method should be ignored.
  61    */
  62   void onAuthAvailable(in nsISupports aContext,
  63                        in nsIAuthInformation aAuthInfo);
  64
  65   /**
  66    * Notification that the prompt was cancelled.
  67    *
  68    * @param aContext
  69    *        The context that was passed to promptPasswordAsync.
  70    * @param userCancel
  71    *        If false, this prompt was cancelled by calling the
  72    *        the cancel method on the nsICancelable; otherwise,
  73    *        it was cancelled by the user.
  74    */
  75   void onAuthCancelled(in nsISupports aContext, in boolean userCancel);
  76 };
  77