xpcom/components/nsIComponentManager.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /**
   7  * The nsIComponentManager interface.
   8  */
   9
  10 #include "nsISupports.idl"
  11
  12 interface nsIFile;
  13 interface nsIFactory;
  14 interface nsIArray;
  15 interface nsIUTF8StringEnumerator;
  16
  17 [scriptable, builtinclass, uuid(d604ffc3-1ba3-4f6c-b65f-1ed4199364c3)]
  18 interface nsIComponentManager : nsISupports
  19 {
  20     /**
  21      * getClassObject
  22      *
  23      * Returns the factory object that can be used to create instances of
  24      * CID aClass
  25      *
  26      * @param aClass The classid of the factory that is being requested
  27      */
  28     void getClassObject(in nsCIDRef aClass,
  29                         in nsIIDRef aIID,
  30                         [iid_is(aIID),retval] out nsQIResult result);
  31
  32     /**
  33      * getClassObjectByContractID
  34      *
  35      * Returns the factory object that can be used to create instances of
  36      * CID aClass
  37      *
  38      * @param aClass The classid of the factory that is being requested
  39      */
  40     void getClassObjectByContractID(in string aContractID,
  41                                     in nsIIDRef aIID,
  42                                     [iid_is(aIID),retval] out nsQIResult result);
  43
  44
  45    /**
  46      * createInstance
  47      *
  48      * Create an instance of the CID aClass and return the interface aIID.
  49      *
  50      * @param aClass : ClassID of object instance requested
  51      * @param aIID : IID of interface requested
  52      */
  53     [noscript]
  54     void createInstance(in nsCIDRef aClass,
  55                         in nsIIDRef aIID,
  56                         [iid_is(aIID),retval] out nsQIResult result);
  57
  58     /**
  59      * createInstanceByContractID
  60      *
  61      * Create an instance of the CID that implements aContractID and return the
  62      * interface aIID.
  63      *
  64      * @param aContractID : aContractID of object instance requested
  65      * @param aIID : IID of interface requested
  66      */
  67     [noscript]
  68     void createInstanceByContractID(in string aContractID,
  69                                     in nsIIDRef aIID,
  70                                     [iid_is(aIID),retval] out nsQIResult result);
  71
  72     /**
  73      * addBootstrappedManifestLocation
  74      *
  75      * Adds a bootstrapped manifest location on runtime.
  76      *
  77      * @param aLocation : A directory where chrome.manifest resides,
  78      *                    or an XPI with it on the root.
  79      */
  80     void addBootstrappedManifestLocation(in nsIFile aLocation);
  81
  82     /**
  83      * removeBootstrappedManifestLocation
  84      *
  85      * Removes a bootstrapped manifest location on runtime.
  86      *
  87      * @param aLocation : A directory where chrome.manifest resides,
  88      *                    or an XPI with it on the root.
  89      */
  90     void removeBootstrappedManifestLocation(in nsIFile aLocation);
  91
  92     /**
  93      * getManifestLocations
  94      *
  95      * Get an array of nsIURIs of all registered and builtin manifest locations.
  96      */
  97     nsIArray getManifestLocations();
  98
  99     /**
 100      * Returns a list of JSM URLs which are used to create components. This
 101      * should only be used in automation.
 102      *
 103      * TODO: Remove this once m-c and c-c migrations finish (bug 1881887).
 104      */
 105     nsIUTF8StringEnumerator getComponentJSMs();
 106
 107     /**
 108      * Returns a list of ESM URLs which are used to create components. This
 109      * should only be used in automation.
 110      */
 111     nsIUTF8StringEnumerator getComponentESModules();
 112 };
 113
 114
 115 %{ C++
 116 #ifdef MOZILLA_INTERNAL_API
 117 #include "nsComponentManagerUtils.h"
 118 #endif
 119 %} C++