com.adobe.icc.external.dc.InvokeParams - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	com.adobe.icc.external.dc
Class	public class InvokeParams
Inheritance	InvokeParams EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Formal definition of DC invocation parameters.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataDebug : Boolean True if DC should be run in data debug mode (which means the ICC Data is dumped to the Flash Log on every push to the PDF and inactive letters can be reloaded).	InvokeParams
		dataUrl : String Get/set the URL to the XML file to be used as initial data.	InvokeParams
		ddkeMap : Map Get/set Data Dictionary Key Element (ddke) Map: map of key/value pairs (String to String) provided for key elements whose values are required in order to obtain an instance of the DD used by the letter.	InvokeParams
		debug : Boolean True if DC should be run in debug mode (which means, amongst other things, performance metrics are output and the "Load Letter" screen is displayed if a letter isn't specified in the usual parameters.	InvokeParams
		fbDebug : Boolean True if FormBridge should be run in debug mode.	InvokeParams
		hasInlineData : Boolean Read-only.	InvokeParams
		invokeUrl : String [read-only] The invocation URL (should be absolute) or null if this InvokeParams object wasn't constructed from one.	InvokeParams
		letterId : String The ID (GUID) of the letter to fill.	InvokeParams
		letterName : String The name (version-independent) of the letter to fill.	InvokeParams
		letterVersion : int The version of the letter to fill.	InvokeParams
		preview : Boolean True if DC is being invoked in preview mode; false otherwise.	InvokeParams
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		useLatest : Boolean True if the latest assets/modules are to be used for previewing the specified letter.	InvokeParams
		useTestData : Boolean True if the letter's test data should be used as the initial data.	InvokeParams
		xmlData : XML Get/set XML to be used as initial data.	InvokeParams
		xmlDataSpecified : Boolean True if XML data is specified in the URL (meaning at least one of xmlData or dataUrl is specified).	InvokeParams

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		InvokeParams(url:String = null) Determines the invocation parameters based on the specified URL.	InvokeParams
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		addKeyPair(key:String, value:String):void Adds an entry to the ddkeMap for the specified key/value pair.	InvokeParams
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		encode():String Encodes the invocation parameters into a string of URL parameters separated by '&' characters.	InvokeParams
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Provides a string representation of this class.	InvokeParams
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

	Constant		Defined By
		MIN_PUBLISHED_VERSION : int = 1 [static] Minimum published version of the Letter.	InvokeParams
		URLPARAM_DATA : String = "unknown" [static] URL parameter pre-defined key name for inline initial XML data.	InvokeParams
		URLPARAM_DATAURL : String = "unknown" [static] URL parameter pre-defined key name for initial XML data file location (internal or external to host, must be absolute).	InvokeParams
		URLPARAM_LETTERID : String = "unknown" [static] URL parameter pre-defined key name for letter ID (GUID).	InvokeParams
		URLPARAM_LETTERNAME : String = "unknown" [static] URL parameter pre-defined key name for letter name (version-independent).	InvokeParams
		URLPARAM_LETTERVERSION : String = "unknown" [static] URL parameter pre-defined key name for letter version (only applies, and is required for, the archived state).	InvokeParams
		URLPARAM_PREVIEW : String = "unknown" [static] URL parameter pre-defined key name for specifying preview mode.	InvokeParams
		URLPARAM_USELATEST : String = "unknown" [static] URL parameter pre-defined key name for using latest assets for previewing the specified letter.	InvokeParams
		URLPARAM_USETESTDATA : String = "unknown" [static] URL parameter pre-defined key name for using test data for specified letter.	InvokeParams

Property Detail

dataDebug

property

dataDebug:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if DC should be run in data debug mode (which means the ICC Data is dumped to the Flash Log on every push to the PDF and inactive letters can be reloaded).

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get dataDebug():Boolean
public function set dataDebug(value:Boolean):void

dataUrl

property

dataUrl:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Get/set the URL to the XML file to be used as initial data.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get dataUrl():String
public function set dataUrl(value:String):void

ddkeMap

property

ddkeMap:Map

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Get/set Data Dictionary Key Element (ddke) Map: map of key/value pairs (String to String) provided for key elements whose values are required in order to obtain an instance of the DD used by the letter.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get ddkeMap():Map
public function set ddkeMap(value:Map):void

debug

property

debug:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if DC should be run in debug mode (which means, amongst other things, performance metrics are output and the "Load Letter" screen is displayed if a letter isn't specified in the usual parameters.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get debug():Boolean
public function set debug(value:Boolean):void

fbDebug

property

fbDebug:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if FormBridge should be run in debug mode.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get fbDebug():Boolean
public function set fbDebug(value:Boolean):void

fbDebugValue

property

fbDebugValue:String

Implementation
icc_internal function get fbDebugValue():String
icc_internal function set fbDebugValue(value:String):void

hasInlineData

property

hasInlineData:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Read-only. Determines if the invocation parameters include inline data such as XML data or a Data Dictionary Key Element Map.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get hasInlineData():Boolean
public function set hasInlineData(value:Boolean):void

invokeUrl

property

invokeUrl:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The invocation URL (should be absolute) or null if this InvokeParams object wasn't constructed from one.

Implementation
public function get invokeUrl():String

letterId

property

letterId:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The ID (GUID) of the letter to fill. If specified, letterName, letterState and letterVersion are ignored.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get letterId():String
public function set letterId(value:String):void

letterName

property

letterName:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The name (version-independent) of the letter to fill.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get letterName():String
public function set letterName(value:String):void

letterVersion

property

letterVersion:int

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The version of the letter to fill.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get letterVersion():int
public function set letterVersion(value:int):void

preview

property

preview:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if DC is being invoked in preview mode; false otherwise.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get preview():Boolean
public function set preview(value:Boolean):void

useLatest

property

useLatest:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if the latest assets/modules are to be used for previewing the specified letter.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get useLatest():Boolean
public function set useLatest(value:Boolean):void

useTestData

property

useTestData:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if the letter's test data should be used as the initial data.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get useTestData():Boolean
public function set useTestData(value:Boolean):void

xmlData

property

xmlData:XML

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Get/set XML to be used as initial data. XML Data is passed-in as a URL-encoded string and is decoded into XML in this property.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get xmlData():XML
public function set xmlData(value:XML):void

xmlDataSpecified

property

xmlDataSpecified:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if XML data is specified in the URL (meaning at least one of xmlData or dataUrl is specified). This is only valid if the data does not require prior knowledge of the letter in order to be accessed. This means that the useTestData property has no baring on this property at all since using a letter's test data implies that the letter ID or name/state/version is always specified. Furthermore, the existence of Data Dictionary Key Element pairs (ddkeMap) has no influence on this property either.

Note: A value of true does not imply the specified data parameter provides existing and/or valid XML data.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get xmlDataSpecified():Boolean
public function set xmlDataSpecified(value:Boolean):void

Constructor Detail

InvokeParams

()

Constructor

public function InvokeParams(url:String = null)

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Determines the invocation parameters based on the specified URL. If the app is currently running in a Flash Debug Player, a URL parameter with the name 'debug' will be ignored. Otherwise, it'll be treated as a DDKE key/value pair.

Parameters

url:String (default = null) — The absolute url from which to extract the parameters. If null, defaults are used.

Method Detail

addKeyPair

()

method

public function addKeyPair(key:String, value:String):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Adds an entry to the ddkeMap for the specified key/value pair. If the key already exists, the existing value is overwritten with the specified value.

Parameters

	`key:String` — The name of the Data Dictionary Key Element.

	`value:String` — the value for the key.

encode

()

method

public function encode():String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Encodes the invocation parameters into a string of URL parameters separated by '&' characters.

Returns

String — URL parameter string representing the invocation parameters. If letterId is null, parameters related to the letter, such as useTestData, xmlData, and ddkeMap, are not output.

toString

()

method

override public function toString():String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Provides a string representation of this class. NOTE: This is meant for debugging, not encoding into a URL. Use the encode() method for that.

Returns

String — String representation of this class.

Constant Detail

MIN_PUBLISHED_VERSION

Constant

public static const MIN_PUBLISHED_VERSION:int = 1

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Minimum published version of the Letter.

URLPARAM_DATA

Constant

public static const URLPARAM_DATA:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for inline initial XML data.

URLPARAM_DATAURL

Constant

public static const URLPARAM_DATAURL:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for initial XML data file location (internal or external to host, must be absolute).

URLPARAM_LETTERID

Constant

public static const URLPARAM_LETTERID:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for letter ID (GUID). If specified, overrides letter name, state and version.

URLPARAM_LETTERNAME

Constant

public static const URLPARAM_LETTERNAME:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for letter name (version-independent).

URLPARAM_LETTERVERSION

Constant

public static const URLPARAM_LETTERVERSION:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for letter version (only applies, and is required for, the archived state).

URLPARAM_PREVIEW

Constant

public static const URLPARAM_PREVIEW:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for specifying preview mode.

URLPARAM_USELATEST

Constant

public static const URLPARAM_USELATEST:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for using latest assets for previewing the specified letter.

URLPARAM_USETESTDATA

Constant

public static const URLPARAM_USETESTDATA:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

URL parameter pre-defined key name for using test data for specified letter.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

dataDebug

dataUrl

ddkeMap

debug

fbDebug

fbDebugValue

hasInlineData

invokeUrl

letterId

letterName

letterVersion

preview

useLatest

useTestData

xmlData

xmlDataSpecified

InvokeParams

addKeyPair

encode

toString

MIN_PUBLISHED_VERSION

URLPARAM_DATA

URLPARAM_DATAURL

URLPARAM_LETTERID

URLPARAM_LETTERNAME

URLPARAM_LETTERVERSION

URLPARAM_PREVIEW

URLPARAM_USELATEST

URLPARAM_USETESTDATA