Packagecom.adobe.rtc.addin
Classpublic class AddInLauncher
InheritanceAddInLauncher Inheritance flash.events.EventDispatcher

This class is used to launch a specific URL in the addin. You pass it an addin name, minimum version and location to download it from, and it downloads it and installs it if necessary. It then tells the addin to load the specified URL.
AddInLauncher properly deals with the following situations:
  1. addin not installed - it will try to install it before launching the url.
  2. addin installed but old (its version is < minVersion) - it will try to install a new addin before launching the url
  3. addin installed and has version >= minVersion - it will just launch the url in the addin
  4. If the version that gets installed in 1 or 2 is still < than the minVersion, a FAIL event will be dispatched.

See also

Peldi Guilizzoni

Public Properties
 PropertyDefined by
  addInLocation : String
pass "default" to use express install, or an URL if you're hosting your own installer
AddInLauncher
  addInName : String
the name of the executable to launch (for instance "connectaddin6x0")
AddInLauncher
  minVersion : String
the minimum version of the AddIn required
AddInLauncher
Protected Properties
 PropertyDefined by
  _addin : ProductManager
AddInLauncher
  _addInLocalConnection : AddInLocalConnection
AddInLauncher
  _addInLocation : String = "default"
AddInLauncher
  _addInName : String
AddInLauncher
  _minVersion : String
AddInLauncher
Public Methods
 MethodDefined by
  
AddInLauncher(p_minVersion:String, p_addInName:String, p_addInLocation:String = "default")
Constructor - pass the minimum version required and the name of the executable to launch (for instance "connectaddin6x0")
AddInLauncher
  
openInAddIn(p_urlToOpen:String):void
Main entry point.
AddInLauncher
Protected Methods
 MethodDefined by
  
compareVersions(p_installed:String, p_required:String):Boolean
AddInLauncher
Events
 EventSummaryDefined by
  
fail
Dispatched when the AddIn launch fails.AddInLauncher
  
launch
Dispatched when the AddIn is launched.AddInLauncher
Public Constants
 ConstantDefined by
  DEFAULT : String = "default"
[static]
AddInLauncher
Property detail
_addinproperty
protected var _addin:ProductManager
_addInLocalConnectionproperty 
protected var _addInLocalConnection:AddInLocalConnection
_addInLocationproperty 
protected var _addInLocation:String = "default"
addInLocationproperty 
addInLocation:String  [read-write]

pass "default" to use express install, or an URL if you're hosting your own installer

Implementation
    public function get addInLocation():String
    public function set addInLocation(value:String):void
_addInNameproperty 
protected var _addInName:String
addInNameproperty 
addInName:String  [read-write]

the name of the executable to launch (for instance "connectaddin6x0")

Implementation
    public function get addInName():String
    public function set addInName(value:String):void
_minVersionproperty 
protected var _minVersion:String
minVersionproperty 
minVersion:String  [read-write]

the minimum version of the AddIn required

Implementation
    public function get minVersion():String
    public function set minVersion(value:String):void
Constructor detail
AddInLauncher()constructor
public function AddInLauncher(p_minVersion:String, p_addInName:String, p_addInLocation:String = "default")

Constructor - pass the minimum version required and the name of the executable to launch (for instance "connectaddin6x0")

Parameters
p_minVersion:String
 
p_addInName:String
 
p_addInLocation:String (default = "default")
Method detail
compareVersions()method
protected function compareVersions(p_installed:String, p_required:String):BooleanParameters
p_installed:String
 
p_required:String

Returns
Boolean
openInAddIn()method 
public function openInAddIn(p_urlToOpen:String):void

Main entry point. Launches the specified url in the addin after downloading and installing it if necessary.

Parameters
p_urlToOpen:String
Event detail
failevent 
Event object type: com.adobe.rtc.events.AddInLauncherEvent

Dispatched when the AddIn launch fails.

launchevent  
Event object type: com.adobe.rtc.events.AddInLauncherEvent

Dispatched when the AddIn is launched.

Constant detail
DEFAULTconstant
public static const DEFAULT:String = "default"



2008-2010 Adobe Systems Incorporated. All rights reserved.

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/addin/AddInLauncher.html