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

114 lines
5.2 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; 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
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* 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 nsIPrompt;
/**
* @status UNDER_REVIEW
*/
[scriptable, uuid(358089f9-ee4b-4711-82fd-bcd07fc62061)]
interface nsIAuthPrompt : nsISupports
{
const PRUint32 SAVE_PASSWORD_NEVER = 0;
const PRUint32 SAVE_PASSWORD_FOR_SESSION = 1;
const PRUint32 SAVE_PASSWORD_PERMANENTLY = 2;
/**
* Puts up a text input dialog with OK and Cancel buttons.
* Note: prompt uses separate args for the "in" and "out" values of the
* input field, whereas the other functions use a single inout arg.
* @param dialogText The title for the dialog.
* @param text The text to display in the dialog.
* @param passwordRealm The "realm" the password belongs to: e.g.
* ldap://localhost/dc=test
* @param savePassword One of the SAVE_PASSWORD_* options above.
* @param defaultText The default text to display in the text input box.
* @param result The value entered by the user if OK was
* selected.
* @return true for OK, false for Cancel
*/
boolean prompt(in wstring dialogTitle,
in wstring text,
in wstring passwordRealm,
in PRUint32 savePassword,
in wstring defaultText,
out wstring result);
/**
* Puts up a username/password dialog with OK and Cancel buttons.
* Puts up a password dialog with OK and Cancel buttons.
* @param dialogText The title for the dialog.
* @param text The text to display in the dialog.
* @param passwordRealm The "realm" the password belongs to: e.g.
* ldap://localhost/dc=test
* @param savePassword One of the SAVE_PASSWORD_* options above.
* @param user The username entered in the dialog.
* @param pwd The password entered by the user if OK was
* selected.
* @return true for OK, false for Cancel
*/
boolean promptUsernameAndPassword(in wstring dialogTitle,
in wstring text,
in wstring passwordRealm,
in PRUint32 savePassword,
inout wstring user,
inout wstring pwd);
/**
* Puts up a password dialog with OK and Cancel buttons.
* @param dialogText The title for the dialog.
* @param text The text to display in the dialog.
* @param passwordRealm The "realm" the password belongs to: e.g.
* ldap://localhost/dc=test. If a username is
* specified (http://user@site.com) it will be used
* when matching existing logins or saving new ones.
* If no username is specified, only password-only
* logins will be matched or saved.
* @param savePassword One of the SAVE_PASSWORD_* options above.
* @param pwd The password entered by the user if OK was
* selected.
* @return true for OK, false for Cancel
*/
boolean promptPassword(in wstring dialogTitle,
in wstring text,
in wstring passwordRealm,
in PRUint32 savePassword,
inout wstring pwd);
};