IVariableProvider - Bron voor Adobe ActionScript® 3 (AS3 Expression Manager) API

Pakket	com.adobe.solutions.exm.authoring.domain.variable
Interface	public interface IVariableProvider extends IEventDispatcher

Taalversie:

ActionScript 3.0

Productversie:

Expression Manager Building Block 10

Runtimeversies:

AIR (unsupported), Flash Player 10.2

The IVariableProvider interface serves as the entry point for variable-specific operations during expression authoring.

Openbare methoden

Overerfde openbare methoden verbergen

Overerfde openbare methoden weergeven

	Methode		Gedefinieerd door
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt.	IEventDispatcher
		dispatchEvent(event:Event):Boolean Verzendt een gebeurtenis naar de gebeurtenisstroom.	IEventDispatcher
		hasEventListener(type:String):Boolean Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis.	IEventDispatcher
		listVariables():String Fires an asynchronous operation for retrieving the list of all variables available for use inside expressions during authoring.	IVariableProvider
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Verwijdert een listener uit het object EventDispatcher.	IEventDispatcher
		searchVariables(searchTerm:String):String Fires an asynchronous operation for retrieving the list of available variables which match the given search term.	IVariableProvider
		willTrigger(type:String):Boolean Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis.	IEventDispatcher

Gebeurtenissen

Klik voor meer informatie over gebeurtenissen.

	Gebeurtenis		Overzicht	Gedefinieerd door
		variableProviderError	Dispatched when the provider encounters an error retrieving a list of variables.	IVariableProvider
		variableProviderEvent	Dispatched when the provider successfully retrieves a list of variables.	IVariableProvider

Methodedetails

listVariables

()

methode

public function listVariables():String

Taalversie:

ActionScript 3.0

Productversie:

Expression Manager Building Block 10

Runtimeversies:

AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the list of all variables available for use inside expressions during authoring. Returns immediately and causes the current object to later dispatch one of the following events:

If the operation completes successfuly, an event with name "variableProviderEvent" of type VariableProviderEvent. The 'variables' property of the event will be a reference to the list of available variables (IVariable objects). The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
If the operation errors out, an event with name "variableProviderError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.

Geretourneerde waarde

String — A unique request ID which calling code can use for correlating invocations of this method with events dispatched later.

searchVariables

()

methode

public function searchVariables(searchTerm:String):String

Taalversie:

ActionScript 3.0

Productversie:

Expression Manager Building Block 10

Runtimeversies:

AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the list of available variables which match the given search term. Returns immediately and causes the current object to later dispatch one of the following events:

If the operation completes successfuly, an event with name "variableProviderEvent" of type VariableProviderEvent. The 'variables' property of the event will be a reference to the list of matching variables (IVariable objects). The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
If the operation errors out, an event with name "variableProviderError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.

Parameters

searchTerm:String — The search term to be used for filtering variables.

Geretourneerde waarde

String — A unique request ID which calling code can use for correlating invocations of this method with events dispatched later.

Gebeurtenisdetails

variableProviderError

Gebeurtenis

Type gebeurtenisobject: com.adobe.solutions.exm.authoring.domain.RequestAwareErrorEvent

Taalversie:

ActionScript 3.0

Productversie:

Expression Manager Building Block 10

Runtimeversies:

AIR (unsupported), Flash Player 10.2

Dispatched when the provider encounters an error retrieving a list of variables.

variableProviderEvent

Gebeurtenis

Type gebeurtenisobject: com.adobe.solutions.exm.authoring.domain.variable.VariableProviderEvent

Taalversie:

ActionScript 3.0

Productversie:

Expression Manager Building Block 10

Runtimeversies:

AIR (unsupported), Flash Player 10.2

Dispatched when the provider successfully retrieves a list of variables.

Juridische kennisgeving | Online privacybeleid

IVariableProvider - AS3 Expression Manager

Klassen x

listVariables

searchVariables

variableProviderError

variableProviderEvent