gecko/xpinstall/public/nsIXPInstallManager.idl

85 lines
3.8 KiB
Plaintext

/* ***** 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 the Mozilla XPInstall.
*
* The Initial Developer of the Original Code is Ben Goodger.
* Portions created by the Initial Developer are Copyright (C) 2004
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Ben Goodger <ben@mozilla.org>
*
* 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 nsIXPIProgressDialog;
interface nsIXPIInstallInfo;
/**
* Interface to XPInstallManager - manages download and install operations.
*/
[scriptable, uuid(83fdd52f-2d34-4e22-981d-cf3c4ae76faa)]
interface nsIXPInstallManager : nsISupports
{
/**
* Initiates a download and install operation of the supplied URLs
* and sends notifications to the supplied listener.
* @param aURLs array of XPI urls to download and install
* @param aURLCount number of XPI urls in aURLs
* @param aListener a listener to receive status notifications
*/
void initManagerFromChrome([array, size_is(aURLCount)] in wstring aURLs,
in unsigned long aURLCount,
in nsIXPIProgressDialog aListener);
/**
* Initiates a set of downloads and checks the supplied hashes after
* download. Just like initManagerFromChrome() in all other respects
* @param aURLs array of XPI urls to download and install
* @param aHashes array of hash strings to validate. The entire array
* or individual hashes can be null to indicate no
* checking. If supplied looks like "type:hash", like
* "md5:3232bc5624041c507db0965324188024".
* Supports the types in nsICryptoHash
* @param aURLCount number of XPI urls in aURLs and aHashes
* @param aListener a listener to receive status notifications
*/
void initManagerWithHashes([array, size_is(aURLCount)] in wstring aURLs,
[array, size_is(aURLCount)] in string aHashes,
in unsigned long aURLCount,
in nsIXPIProgressDialog aListener);
/**
* Initiates a set of downloads based on an install info object. Will
* display confirmation dialog as if the install info had been supplied
* by content.
* @param aInstallInfo The install info object providing install triggers
* and script context for the install.
*/
void initManagerWithInstallInfo(in nsIXPIInstallInfo aInstallInfo);
};