gecko-dev/netwerk/base/public/nsIAuthPromptProvider.idl

66 lines
2.5 KiB
Plaintext

/* -*- Mode: idl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Vladimir Vukicevic <vladimir@pobox.com>
* Portions created by the Initial Developer are Copyright (C) 2004
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIAuthPrompt;
[scriptable, uuid(129d3bd5-8a26-4b0b-b8a0-19fdea029196)]
interface nsIAuthPromptProvider : nsISupports
{
/**
* Normal (non-proxy) prompt request.
*/
const PRUint32 PROMPT_NORMAL = 0;
/**
* Proxy auth request.
*/
const PRUint32 PROMPT_PROXY = 1;
/**
* Request a nsIAuthPrompt interface for the given prompt reason;
* @throws NS_ERROR_NOT_AVAILABLE if no prompt is allowed or
* available for the given reason.
*
* @param aPromptReason The reason for the auth prompt;
* one of @PROMPT_NORMAL or @PROMPT_PROXY
* @returns a nsIAuthPrompt interface, or throws NS_ERROR_NOT_AVAILABLE
*/
nsIAuthPrompt getAuthPrompt(in PRUint32 aPromptReason);
};