Packagepotomac.bundle
Classpublic class BundleInstallDescriptor
InheritanceBundleInstallDescriptor Inheritance Object

A parameter object containing the options necessary when installing bundles.

WARNING: Using the url property of a BundleInstallDescriptor allows bundles to be loaded from a domain other than the one which served the main applications. Currently, all Potomac bundles are loaded into the primary ApplicationDomain and SecurityDomain. Extreme care should be taken when using the url property to ensure that the bundles are trusted.


Public Properties
 PropertyDefined By
  bundleID : String
[read-only] The bundle ID.
BundleInstallDescriptor
  preload : Boolean
[read-only] True if the bundle should be preloaded (loaded at immediately after installation).
BundleInstallDescriptor
  url : String
[read-only] The bundle url or null.
BundleInstallDescriptor
Public Methods
 MethodDefined By
  
BundleInstallDescriptor(bundleID:String, preload:Boolean = false, url:String = null)
Creates a descriptor.
BundleInstallDescriptor
Property Detail
bundleIDproperty
bundleID:String  [read-only]

The bundle ID.


Implementation
    public function get bundleID():String
preloadproperty 
preload:Boolean  [read-only]

True if the bundle should be preloaded (loaded at immediately after installation).


Implementation
    public function get preload():Boolean
urlproperty 
url:String  [read-only]

The bundle url or null. When null, the bundle is assumed to be located in a 'bundles' directory located in the location where the main application was served.

WARNING: When specifying a url value you may potentially allow a bundle from another domain to be loaded into your application. Currently, all Potomac bundles are loaded in the same ApplicationDomain and SecurityDomain. Extreme care should be taken to ensure that all bundles loaded this way are trusted.


Implementation
    public function get url():String
Constructor Detail
BundleInstallDescriptor()Constructor
public function BundleInstallDescriptor(bundleID:String, preload:Boolean = false, url:String = null)

Creates a descriptor.

Parameters
bundleID:String — The id of the bundle to install.
 
preload:Boolean (default = false) — The url of the bundle if the bundle does not exist in the standard location.
 
url:String (default = null)




Fri Sep 10 2010, 10:44 AM -04:00