toolkit/mozapps/extensions/amIWebInstaller.idl
author Dave Townsend <dtownsend@oxymoronical.com>
Thu, 29 Apr 2010 13:11:23 -0700
changeset 41549 f746d2eca19927e140dbe5fb3eb955d503e5b64b
child 41584 16f9f777d64d640c2aa1cef9fe47a9a6f0941f19
permissions -rw-r--r--
Bug 553169: Implement the basic extension manager API and platform integration. r=robstrong

/* ***** 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 Extension Manager.
 *
 * The Initial Developer of the Original Code is
 * the Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2009
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Dave Townsend <dtownsend@oxymoronical.com>
 *
 * 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 nsIDOMWindowInternal;
interface nsIVariant;
interface amIInstallCallback;
interface nsIURI;

/**
 * This interface is used to allow webpages to start installing add-ons.
 */
[scriptable, uuid(4fdf4f84-73dc-4857-9bbe-84895e8afd5d)]
interface amIWebInstaller : nsISupports
{
  /**
   * Checks if installation is enabled for a webpage.
   *
   * @param   mimetype
   *          The mimetype for the add-on to be installed
   * @param   referer
   *          The URL of the webpage trying to install an add-on
   * @return  true if installation is enabled
   */
  boolean isInstallEnabled(in AString mimetype, in nsIURI referer);

  /**
   * Installs an array of add-ons at the request of a webpage
   *
   * @param   mimetype
   *          The mimetype for the add-ons
   * @param   window
   *          The window installing the add-ons
   * @param   referer
   *          The URI for the webpage installing the add-ons
   * @param   uris
   *          The URIs of add-ons to be installed
   * @param   hashes
   *          The hashes for the add-ons to be installed
   * @param   names
   *          The names for the add-ons to be installed
   * @param   icons
   *          The icons for the add-ons to be installed
   * @param   callback
   *          An optional callback to notify about installation success and
   *          failure
   * @param   installCount
   *          An optional argument including the number of add-ons to install
   * @return  true if the installation was successfully started
   */
  boolean installAddonsFromWebpage(in AString mimetype,
                                   in nsIDOMWindowInternal window,
                                   in nsIURI referer,
                                   [array, size_is(installCount)] in wstring uris,
                                   [array, size_is(installCount)] in wstring hashes,
                                   [array, size_is(installCount)] in wstring names,
                                   [array, size_is(installCount)] in wstring icons,
                                   [optional] in amIInstallCallback callback,
                                   [optional] in PRUint32 installCount);
};