netwerk/base/public/nsIPasswordManager.idl

   1
   2 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   3  *
   4  * ***** BEGIN LICENSE BLOCK *****
   5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version
   8  * 1.1 (the "License"); you may not use this file except in compliance with
   9  * the License. You may obtain a copy of the License at
  10  * http://www.mozilla.org/MPL/
  11  *
  12  * Software distributed under the License is distributed on an "AS IS" basis,
  13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  14  * for the specific language governing rights and limitations under the
  15  * License.
  16  *
  17  * The Original Code is mozilla.org code.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 1998
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41 #include "nsISimpleEnumerator.idl"
  42
  43 /**
  44  * An optional interface for clients accessing or removing
  45  * logins that were collected by the password manager
  46  *
  47  *
  48  */
  49
  50 [scriptable, uuid(173562F0-2173-11d5-A54C-0010A401EB10)]
  51 interface nsIPasswordManager : nsISupports
  52 {
  53   /**
  54    * Called to add an individual login to the list of saved logins
  55    *
  56    * @param aHost The host for which the login is being remembered
  57    * @param aUser The username portion of the login
  58    * @param aPassword The password portion of the login
  59    *
  60    */
  61   void addUser(in AUTF8String aHost, in AString aUser, in AString aPassword);
  62
  63   /**
  64    * Called to remove an individual login from the list of save logins
  65    *
  66    * @param aHost The host for which the login is being remembered
  67    * @param aUser The username portion of the login
  68    *
  69    */
  70   void removeUser(in AUTF8String aHost, in AString aUser);
  71
  72   /**
  73    * Called to add a host to the list of rejected hosts -- i.e., hosts for which
  74    * the do-you-want-to-save dialog does appear
  75    *
  76    * @param aHost The host for which the dialog is to not appear
  77    *
  78    */
  79   void addReject(in AUTF8String aHost);
  80
  81   /**
  82    * Called to remove a host from the list of rejected hosts -- i.e., hosts for which
  83    * the do-you-want-to-save dialog does not appear
  84    *
  85    * @param aHost The host for which the dialog is to not appear
  86    *
  87    */
  88   void removeReject(in AUTF8String aHost);
  89
  90   /**
  91    * Called to enumerate through each login in the password-manager list
  92    * The objects enumerated over are of type nsIPassword
  93    */
  94   readonly attribute nsISimpleEnumerator enumerator;
  95
  96   /**
  97    * Called to enumerate through each rejected site in the password-manager list
  98    * These are sites for which the user has indicated that he doesn't want passwords saved.
  99    * The objects enumerated over are of type nsIPassword, although the only member of
 100    * that object that is relevent is the host (the user and password members are ignored).
 101    */
 102   readonly attribute nsISimpleEnumerator rejectEnumerator;
 103 };