gecko-dev/netwerk/base/public/nsIPasswordManager.idl
2004-04-18 22:01:16 +00:00

104 lines
3.7 KiB
Plaintext

/* -*- Mode: C++; 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
* 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"
#include "nsISimpleEnumerator.idl"
/**
* An optional interface for clients accessing or removing
* logins that were collected by the password manager
*
*
*/
[scriptable, uuid(173562F0-2173-11d5-A54C-0010A401EB10)]
interface nsIPasswordManager : nsISupports
{
/**
* Called to add an individual login to the list of saved logins
*
* @param aHost The host for which the login is being remembered
* @param aUser The username portion of the login
* @param aPassword The password portion of the login
*
*/
void addUser(in AUTF8String aHost, in AString aUser, in AString aPassword);
/**
* Called to remove an individual login from the list of save logins
*
* @param aHost The host for which the login is being remembered
* @param aUser The username portion of the login
*
*/
void removeUser(in AUTF8String aHost, in AString aUser);
/**
* Called to add a host to the list of rejected hosts -- i.e., hosts for which
* the do-you-want-to-save dialog does appear
*
* @param aHost The host for which the dialog is to not appear
*
*/
void addReject(in AUTF8String aHost);
/**
* Called to remove a host from the list of rejected hosts -- i.e., hosts for which
* the do-you-want-to-save dialog does not appear
*
* @param aHost The host for which the dialog is to not appear
*
*/
void removeReject(in AUTF8String aHost);
/**
* Called to enumerate through each login in the password-manager list
* The objects enumerated over are of type nsIPassword
*/
readonly attribute nsISimpleEnumerator enumerator;
/**
* Called to enumerate through each rejected site in the password-manager list
* These are sites for which the user has indicated that he doesn't want passwords saved.
* The objects enumerated over are of type nsIPassword, although the only member of
* that object that is relevent is the host (the user and password members are ignored).
*/
readonly attribute nsISimpleEnumerator rejectEnumerator;
};