| Package | com.adobe.gravity.framework |
| Interface | public interface IBundleContext extends IEventDispatcher |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
BundleContext.currentContext.
Propriétés publiques
| Propriété | Défini par | ||
|---|---|---|---|
| bundle : IBundle [lecture seule] Retrieve the current bundle. | IBundleContext | ||
| properties : Object [lecture seule] The properties (read-only) for the given bundle. | IBundleContext | ||
Méthodes publiques
Masquer les méthodes publiques héritées
Afficher les méthodes publiques héritées| Méthode | Défini par | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | IEventDispatcher | |
Create a filter object from the given filter objects. | IBundleContext | ||
Create a filter object from the given filter objects. | IBundleContext | ||
Create a filter object that inverts the sense of provided filter (if the provided filter returns true, the returned filter would return false, and vice-versa). | IBundleContext | ||
|
Distribue un événement dans le flux d’événements. | IEventDispatcher | |
Retrieve all defined bundles. | IBundleContext | ||
Get the bundle with the specified id. | IBundleContext | ||
Get the service object for the specified service reference. | IBundleContext | ||
Get a service reference for a service. | IBundleContext | ||
Get all service references of the given class matching the specified filter. | IBundleContext | ||
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | IEventDispatcher | |
installBundlesFromURL(bundleManifestLocation:String, allowCodeImport:Boolean = false, autoStart:Boolean = true):com.adobe.gravity.utility.async:IToken
Install all bundles in the specified bundle manifest. | IBundleContext | ||
installBundlesFromXML(bundleManifest:XML, allowCodeImport:Boolean = false, autoStart:Boolean = true, baseUrl:String = null):com.adobe.gravity.utility.async:IToken
Install all bundles in the specified bundle manifest. | IBundleContext | ||
Register a service object implementing the given classes. | IBundleContext | ||
|
Supprime un écouteur de l’objet EventDispatcher. | IEventDispatcher | |
Release a service retrieved by getService. | IBundleContext | ||
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | IEventDispatcher | |
Evénements
| Evénement | Synthèse | Défini par | ||
|---|---|---|---|---|
| Dispatched when a bundle has been installed. | IBundleContext | |||
| Dispatched when a bundle is has been resolved. | IBundleContext | |||
| Dispatched when a bundle is about to be resolved. | IBundleContext | |||
| Dispatched when a bundle has been started. | IBundleContext | |||
| Dispatched when a bundle is about to be started. | IBundleContext | |||
| Dispatched when a bundle has been stopped. | IBundleContext | |||
| Dispatched when a bundle is about to be stopped. | IBundleContext | |||
| Dispatched when a bundle has been uninstalled. | IBundleContext | |||
| Dispatched when a bundle is about to be uninstalled. | IBundleContext | |||
| Dispatched when a bundle has been updated. | IBundleContext | |||
| Dispatched when a bundle is about to be updated. | IBundleContext | |||
| Dispatched when the properties of a service have been modified. | IBundleContext | |||
| Dispatched when a service has been registered. | IBundleContext | |||
| Dispatched when a service is going to be unregistered. | IBundleContext | |||
Détails de la propriété
bundle | propriété |
bundle:IBundle [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Retrieve the current bundle.
Implémentation
public function get bundle():IBundleproperties | propriété |
properties:Object [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
The properties (read-only) for the given bundle.
Implémentation
public function get properties():ObjectDétails de la méthode
createFilter | () | méthode |
public function createFilter(... filters):IFilter| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Create a filter object from the given filter objects. The filter will match only when all given filters match. A SyntaxError will be thrown if a filter specified as a String or XML is not a valid filter. TBD: multiple examples are desperately needed here, because this is terribly opaque.
Paramètres
... filters — One or more filter objects. A filter is either an implementation of IFilter, a String, XML, or an Object.
|
IFilter — An IFilter instance that will perform the specified filtering.
|
createFilterMatchAny | () | méthode |
public function createFilterMatchAny(... filters):IFilter| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Create a filter object from the given filter objects. The filter will match when one or more of the given filters match. A SyntaxError will be thrown if a filter specified as a String or XML is not a valid filter. TBD: multiple examples are desperately needed here, because this is terribly opaque.
Paramètres
... filters — One or more filter objects. A filter is either an implementation of IFilter, a String, XML, or an Object.
|
IFilter — An IFilter instance that will perform the specified filtering.
|
createFilterMatchInverse | () | méthode |
public function createFilterMatchInverse(filter:IFilter):IFilter| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Create a filter object that inverts the sense of provided filter (if the provided filter returns true, the returned filter would return false, and vice-versa). TBD: examples are needed here.
Paramètres
filter:IFilter — The filter to invert.
|
IFilter — An IFilter instance that will match if and only if the provided filter does not match.
|
getAllBundles | () | méthode |
public function getAllBundles():Array| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Retrieve all defined bundles.
Valeur renvoyéeArray — An Array of IBundle instances.
|
getBundle | () | méthode |
public function getBundle(id:int):IBundle| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Get the bundle with the specified id.
Paramètres
id:int — The identifier for the desired bundle.
|
IBundle — The requested bundle.
|
getService | () | méthode |
public function getService(reference:IServiceReference):com.adobe.gravity.utility.async:IToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Get the service object for the specified service reference. This method is asynchronous; you must add a success and fault handlers to the returned IToken to retrieve the requested service or deal with any errors that occurred during service retrieval.
NOTE: A bundle may register a single service object under multiple classes. This means that in some implementations it may be possible to cast a returned service object to one of the other classes or interfaces implemented by that service object if you happen to know what those classes or interfaces are for that particular bundle. This is NOT a supported use-case, and some implementations may explicitly prevent this by injecting a proxy. If multiple interfaces should be visible on a single service object, an aggregating interface that extends all the desired interfaces should be created and the service object should be requested by that aggregating interface.
public function getSomeService():void
{
var context:IBundleContext = BundleContext.currentContext;
var reference:IServiceReference = context.getServiceReference(IFancyService);
if (reference == null)
throw new NoSuchServiceError();
var token:IToken = context.getService(reference);
token.addSuccessHandler(doSomethingWithTheFancyService);
token.addFailureHandler(doSomethingToIndicateAProblem);
}
public function doSomethingWithTheFancyService(service:IFancyService):void
{
service.doFancyOperation();
}
public function doSomethingToIndicateAProblem(error:Error):void
{
// deal with the error here
}
Paramètres
reference:IServiceReference — An IServiceReference for the desired service. The getServiceReference functions can be used to retrieve a service reference.
|
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. If the service retrieval is successful, the service object will be passed into the result handler. In other words, the result handler should take a single object of the service interface type.
|
getServiceReference | () | méthode |
public function getServiceReference(clazz:Class):IServiceReference| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Get a service reference for a service. If there is more than one service for the specified class, the service with the highest ranking will be returned. If there are multiple services with the highest rank, the service that was registered first will be returned. If there are no services for the specified class, null is returned.
Paramètres
clazz:Class — The service class.
|
IServiceReference — The service reference for the (first) service implementing the given service class, or null if there is no such service.
|
getServiceReferences | () | méthode |
public function getServiceReferences(clazz:Class, filter:IFilter = null):Array| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Get all service references of the given class matching the specified filter.
Paramètres
clazz:Class — The service class.
| |
filter:IFilter (default = null) |
Array — An array of IServiceReference objects for all the services implementing the given service contract and matching the filter.
|
installBundlesFromURL | () | méthode |
public function installBundlesFromURL(bundleManifestLocation:String, allowCodeImport:Boolean = false, autoStart:Boolean = true):com.adobe.gravity.utility.async:IToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Install all bundles in the specified bundle manifest.
Paramètres
bundleManifestLocation:String — The location of the bundle manifest.
| |
allowCodeImport:Boolean (default = false) | |
autoStart:Boolean (default = true) |
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. If the manifest load was successful, an Array containing a set of IBundle objects for the bundles from the manifest file will be passed into the result handler.
|
installBundlesFromXML | () | méthode |
public function installBundlesFromXML(bundleManifest:XML, allowCodeImport:Boolean = false, autoStart:Boolean = true, baseUrl:String = null):com.adobe.gravity.utility.async:IToken| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Install all bundles in the specified bundle manifest.
Paramètres
bundleManifest:XML — The bundle manifest XML.
| |
allowCodeImport:Boolean (default = false) | |
autoStart:Boolean (default = true) | |
baseUrl:String (default = null) |
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. If the manifest load was successful, an Array containing a set of IBundle objects for the bundles from the manifest file will be passed into the result handler.
|
registerService | () | méthode |
public function registerService(classes:Array, service:Object, properties:Object):IServiceRegistration| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Register a service object implementing the given classes.
NOTE: A bundle may register a single service object under multiple classes. This means that in some implementations it may be possible to cast a returned service object to one of the other classes or interfaces implemented by that service object if you happen to know what those classes or interfaces are for that particular bundle. This is NOT a supported use-case, and some implementations may explicitly prevent this by injecting a proxy. If multiple interfaces should be visible on a single service object, an aggregating interface that extends all the desired interfaces should be created and the service object should be requested by that aggregating interface.
Paramètres
classes:Array — An array of Class objects indicating the classes implemented by the service.
| |
service:Object — Either the service object itself, or an implementation of IServiceFactory. If the object is not an IServiceFactory and is not an instance of all the classes in the classes array, an exception (TODO: specify which exception) will be thrown.
| |
properties:Object — Name-value metadata for the service, can be used as criteria in filters when selecting a service.
|
IServiceRegistration — An IServiceRegistration that can be used to manage the service.
|
Eléments de l’API associés
ungetService | () | méthode |
public function ungetService(reference:IServiceReference):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Release a service retrieved by getService.
Paramètres
reference:IServiceReference — The service reference for the service to be released.
|
Boolean — If the bundle's usage count for the service was already zero, false is returned. Otherwise, true is returned.
|
Détails de l’événement
bundleInstalled | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_INSTALLED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle has been installed.
A bundle has been installed.bundleResolved | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_RESOLVED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle is has been resolved.
A bundle has been resolved.bundleResolving | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_RESOLVING| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle is about to be resolved.
A bundle is about to be resolved.bundleStarted | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_STARTED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle has been started.
A bundle has been started.bundleStarting | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_STARTING| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle is about to be started.
A bundle is about to be started.bundleStopped | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_STOPPED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle has been stopped.
A bundle has been stopped.bundleStopping | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_STOPPING| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle is about to be stopped.
A bundle is about to be stopped.bundleUninstalled | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_UNINSTALLED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle has been uninstalled.
A bundle has been uninstalled.bundleUninstalling | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_UNINSTALLING| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle is about to be uninstalled.
A bundle is about to be uninstalled.bundleUpdated | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_UPDATED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle has been updated.
A bundle has been updated.bundleUpdating | Evénement |
Type d’objet d’événement:
propriété BundleEvent.type =
com.adobe.gravity.framework.BundleEventpropriété BundleEvent.type =
com.adobe.gravity.framework.BundleEvent.BUNDLE_UPDATING| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a bundle is about to be updated.
A bundle is about to be updated.serviceModified | Evénement |
Type d’objet d’événement:
propriété ServiceEvent.type =
com.adobe.gravity.framework.ServiceEventpropriété ServiceEvent.type =
com.adobe.gravity.framework.ServiceEvent.SERVICE_MODIFIED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when the properties of a service have been modified.
The serviceModified event type indicates that the properties of the service have been modified.serviceRegistered | Evénement |
Type d’objet d’événement:
propriété ServiceEvent.type =
com.adobe.gravity.framework.ServiceEventpropriété ServiceEvent.type =
com.adobe.gravity.framework.ServiceEvent.SERVICE_REGISTERED| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a service has been registered.
The serviceRegistered event type indicates that the service has been registered.serviceUnregistering | Evénement |
Type d’objet d’événement:
propriété ServiceEvent.type =
com.adobe.gravity.framework.ServiceEventpropriété ServiceEvent.type =
com.adobe.gravity.framework.ServiceEvent.SERVICE_UNREGISTERING| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Versions du moteur d’exécution: | AIR 1.1, Flash Player 9 |
Dispatched when a service is going to be unregistered.
The serviceUnregistering event type indicates that the service is in the process of being unregistered.Tue Jun 12 2018, 09:30 AM Z