ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.gravity.framework 

IBundle  - AS3 ADEP Client Component

Packagecom.adobe.gravity.framework
Interfacepublic interface IBundle

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The IBundle interface represents a single physical component.



Public Properties
 PropertyDefined By
  bundleId : int
[read-only] The identifier for this specific bundle.
IBundle
  domain : String
[read-only] If the bundle is shared, the name of the shared domain.
IBundle
  location : String
[read-only] The location from which the bundle was retrieved.
IBundle
  parentDomain : String
[read-only] If this bundle uses a shared parent domain, the name of the shared parent.
IBundle
  properties : Object
[read-only] The static properties of this bundle, as declared in the bundle descriptor.
IBundle
  registeredServices : Array
[read-only] An array of IServiceReference interfaces for all the services that have been registered by this bundle, both declaratively and programmatically.
IBundle
  servicesInUse : Array
[read-only] An array of IServiceReference interfaces for all the services that are being used by this bundle.
IBundle
  state : int
[read-only] The state of the bundle.
IBundle
Public Methods
 MethodDefined By
  
Start the bundle.
IBundle
  
Stop the bundle.
IBundle
  
Uninstall the bundle.
IBundle
Property Detail

bundleId

property
bundleId:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The identifier for this specific bundle. This is assigned at runtime by the framework and may be different on each run.



Implementation
    public function get bundleId():int

domain

property 
domain:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

If the bundle is shared, the name of the shared domain. Otherwise null.



Implementation
    public function get domain():String

location

property 
location:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The location from which the bundle was retrieved.



Implementation
    public function get location():String

parentDomain

property 
parentDomain:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

If this bundle uses a shared parent domain, the name of the shared parent. Otherwise null.



Implementation
    public function get parentDomain():String

properties

property 
properties:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The static properties of this bundle, as declared in the bundle descriptor.



Implementation
    public function get properties():Object

registeredServices

property 
registeredServices:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

An array of IServiceReference interfaces for all the services that have been registered by this bundle, both declaratively and programmatically.



Implementation
    public function get registeredServices():Array

servicesInUse

property 
servicesInUse:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

An array of IServiceReference interfaces for all the services that are being used by this bundle.



Implementation
    public function get servicesInUse():Array

state

property 
state:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

The state of the bundle. Will be one of the constants in the BundleConstants class.



Implementation
    public function get state():int

Related API Elements

Method Detail

start

()method
public function start():com.adobe.gravity.utility.async:IToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Start the bundle. The bundle will not immediately be started on return; the returned token can be used to add success or failure handlers to be executed when the bundle has successfully started or to handle a fault during the bundle start process.

Returns
com.adobe.gravity.utility.async:IToken — A token that success or failure handlers may be added to. Note that null will never be returned from this call.

stop

()method 
public function stop():com.adobe.gravity.utility.async:IToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Stop the bundle. The bundle will not immediately be stopped on return; the returned token can be used to add success or failure handlers to be executed when the bundle has successfully stopped or to handle a fault during the bundle stop process.

Returns
com.adobe.gravity.utility.async:IToken — A token that success or failure handlers may be added to. Note that null will never be returned from this call.

uninstall

()method 
public function uninstall():com.adobe.gravity.utility.async:IToken

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Uninstall the bundle. The bundle will not immediately be uninstalled on return; the returned token can be used to add success and failure handlers to be executed when the bundle has successfully been uninstalled or to handle a fault during the bundle uninstall process.

Returns
com.adobe.gravity.utility.async:IToken — A token that success or failure handlers may be added to. Note that null will never be returned from this call.