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

92 lines
3.8 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 Netscape are Copyright (C) 2002
* Netscape Communications Corporation. 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"
/**
* An optional interface for obtaining fields of
* logins that were collected by the password manager
*/
interface nsIFile;
[scriptable, uuid(dc2ff152-85cb-474e-b4c2-86a3d48cf4d0)]
interface nsIPasswordManagerInternal : nsISupports
{
/**
* A Call to find a login in the password manager list that matches the
* specified parameters. If any input parameter is null, it is
* not tested for when looking for the match.
*
* @param aHostURI The uri part of a login to search for, or null
* @param aUsername The username part of a login to search for, or null
* @param aPassword The password part of a login to search for, or null
* @param aHostURIFound The uri found in the login
* @param aUsernameFound The username found in the login
* @param aPasswordFound The password found in the login
*/
void findPasswordEntry
(in AUTF8String aHostURI, in AString aUsername, in AString aPassword,
out AUTF8String aHostURIFound, out AString aUsernameFound, out AString aPasswordFound);
/**
* Called to add an individual login to the list of saved logins.
* All parameters are clear text.
*
* @param aKey The key for which the login is being remembered (often the page URI)
* @param aUser The username portion of the login
* @param aPassword The password portion of the login
* @param aUserFieldName The name of the field that contained the username
* @param aPassFieldName The name of the field that contained the password
*/
void addUserFull(in AUTF8String aKey,
in AString aUser,
in AString aPassword,
in AString aUserFieldName,
in AString aPassFieldName);
/**
* Reads logins from a Mozilla Password Manager file, augmenting the current
* in-memory set. If a duplicate entry is encountered, the data from the file
* being read replaces that currently held.
*
* @param aPasswordFile The file to read logins from.
*/
void readPasswords(in nsIFile aPasswordFile);
};