RetroZilla/mailnews/addrbook/public/nsILDAPPrefsService.idl
2015-10-20 23:03:22 -04:00

77 lines
3.1 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) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Srilatha Moturi <srilatha@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of 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 "nsILDAPURL.idl"
#include "nsILDAPService.idl"
#include "nsIPrefBranch.idl"
/**
* this service implements migrating ldap prefs from 4.x format
* to mozilla format.
*/
[scriptable, uuid(5a4911e0-44cd-11d5-9074-0010a4b26cda)]
interface nsILDAPPrefsService: nsISupports {
/**
* Convert 4.x ldap prefs to mozilla format
* hostname, dn, scope, port are converted to uri
* Also converts the autocompletion preference from 4.x format
* (ldap_2.servers.<server-name>.autocomplete.enabled)
* to mozilla format (ldap_2.servers.directoryServer)
*/
void migrate();
/**
* This will create an array with entries
* "ldap_2.servers.<server-name>"
* Each entry in the array is unique.
*
* @param aPrefBranch prefBranch object.
* @param aCount Receives the number of elements in the array.
* @param aChildArray Receives the array with "ldap_2.servers.<server-name>".
*
* @return NS_OK The preference list was successfully retrieved.
* @return Other The preference(s) do not exist or an error occurred.
*/
void getServerList(in nsIPrefBranch aPrefBranch,
out unsigned long aCount,
[array, size_is(aCount), retval] out string aChildArray);
};