xpinstall/public/nsIXPInstallManager.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the Mozilla XPInstall.
  15  *
  16  * The Initial Developer of the Original Code is Ben Goodger.
  17  * Portions created by the Initial Developer are Copyright (C) 2004
  18  * the Initial Developer. All Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *      Ben Goodger <ben@mozilla.org>
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsISupports.idl"
  38
  39 interface nsIXPIProgressDialog;
  40 interface nsIXPIInstallInfo;
  41
  42 /**
  43  * Interface to XPInstallManager - manages download and install operations.
  44  */
  45 [scriptable, uuid(83fdd52f-2d34-4e22-981d-cf3c4ae76faa)]
  46 interface nsIXPInstallManager : nsISupports
  47 {
  48     /**
  49      * Initiates a download and install operation of the supplied URLs
  50      * and sends notifications to the supplied listener.
  51      * @param aURLs     array of XPI urls to download and install
  52      * @param aURLCount number of XPI urls in aURLs
  53      * @param aListener a listener to receive status notifications
  54      */
  55     void initManagerFromChrome([array, size_is(aURLCount)] in wstring aURLs,
  56                                in unsigned long aURLCount,
  57                                in nsIXPIProgressDialog aListener);
  58     /**
  59      * Initiates a set of downloads and checks the supplied hashes after
  60      * download. Just like initManagerFromChrome() in all other respects
  61      * @param aURLs     array of XPI urls to download and install
  62      * @param aHashes   array of hash strings to validate. The entire array
  63      *                  or individual hashes can be null to indicate no
  64      *                  checking. If supplied looks like "type:hash", like
  65      *                  "md5:3232bc5624041c507db0965324188024".
  66      *                  Supports the types in nsICryptoHash
  67      * @param aURLCount number of XPI urls in aURLs and aHashes
  68      * @param aListener a listener to receive status notifications
  69      */
  70     void initManagerWithHashes([array, size_is(aURLCount)] in wstring aURLs,
  71                                [array, size_is(aURLCount)] in string aHashes,
  72                                in unsigned long aURLCount,
  73                                in nsIXPIProgressDialog aListener);
  74
  75     /**
  76      * Initiates a set of downloads based on an install info object. Will
  77      * display confirmation dialog as if the install info had been supplied
  78      * by content.
  79      * @param aInstallInfo The install info object providing install triggers
  80      *                     and script context for the install.
  81      */
  82     void initManagerWithInstallInfo(in nsIXPIInstallInfo aInstallInfo);
  83 };
  84