IConnectionService - Adobe ActionScript® 3 (AS3 ADEp-Handbücher) API-Referenz

Paket	ga.util
Schnittstelle	public interface IConnectionService
Umsetzer	Wrapper, WrapperHostBase

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

The interface implemented by guide wrappers used to communicate with a client such as Workspace.

Öffentliche Methoden

	Methode		Definiert von
		connectionClosed():void The connection was closed.	IConnectionService
		connectionOpened(success:Boolean):void The connection was made, if success=false, the connection attempt failed	IConnectionService
		getActiveData(callback:Function = null):String Return the form's Active data, either from the Guide or the PDF.	IConnectionService
		getData():String Return the form's data	IConnectionService
		getDraftData(callback:Function = null):String Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active.	IConnectionService
		getFieldValue(som:String):Object Returns a field's value as an Object	IConnectionService
		getProperty(property:String):Object Return the requested property.	IConnectionService
		setData(data:String):void Set the data into the form - returns false if failed.	IConnectionService
		setFieldValue(som:String, value:Object):Boolean Sets a field's value, returns success true or false	IConnectionService
		setProperty(property:String, value:Object):Boolean Set the property, returns false if the operation failed	IConnectionService
		submitData():Boolean Performs the submit action based on the value of the Submit From option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0.	IConnectionService
		submitDataWithCB(callback:Function):Boolean Submits the data to the server - return true if the submit was performed - returns false if validations fail	IConnectionService

Methodendetails

connectionClosed

()

Methode

public function connectionClosed():void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

The connection was closed.

connectionOpened

()

Methode

public function connectionOpened(success:Boolean):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

The connection was made, if success=false, the connection attempt failed

Parameter

success:Boolean — the status of the open request

getActiveData

()

Methode

public function getActiveData(callback:Function = null):String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Return the form's Active data, either from the Guide or the PDF. PDF requires a callback.

Parameter

callback:Function (default = null) — the function to be called when an asynchronous operation is required to retrieve the data, as when the PDF is active.

Rückgabewerte

String — String

getData

()

Methode

public function getData():String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Return the form's data

Rückgabewerte

String — String

getDraftData

()

Methode

public function getDraftData(callback:Function = null):String

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Return the guides draft data including state information (Data is retrieved from the PDF if PDF is active. PDF requires a callback).

Parameter

callback:Function (default = null) — the function to be called when an asynchronous operation is required to retrieve the data, as when the PDF is active.

Rückgabewerte

String — String

getFieldValue

()

Methode

public function getFieldValue(som:String):Object

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Returns a field's value as an Object

Parameter

som:String — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")

Rückgabewerte

Object — Object

getProperty

()

Methode

public function getProperty(property:String):Object

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Return the requested property. Sypported properties are: showSubmitButton = "true"|"false"

Parameter

property:String — the name of the property to retieve a value from

Rückgabewerte

Object — Object

setData

()

Methode

public function setData(data:String):void

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Set the data into the form - returns false if failed. Throws an exception if the data is not valid XML.

Parameter

data:String — the content to be used as the current data

setFieldValue

()

Methode

public function setFieldValue(som:String, value:Object):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Sets a field's value, returns success true or false

Parameter

	`som:String` — the identifier of the field to retrieve the data from. eg. "EntityRoot.Client[1].Address.City" or for xfa - #som("form1.subform[1].Address.City")

	`value:Object` — the value to assign to the targeted item

Rückgabewerte

Boolean — Boolean

setProperty

()

Methode

public function setProperty(property:String, value:Object):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Set the property, returns false if the operation failed

Parameter

	`property:String` — the name of the property to retieve a value from

	`value:Object` — the value to set the provided property with. Object types must match

Rückgabewerte

Boolean — Boolean

submitData

()

Methode

public function submitData():Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Performs the submit action based on the value of the Submit From option in the Guide Design perspective within Adobe Digital Enterprise Platform Document Services - Workbench 10.0. This method returns true if the submission performs successfully.

SubmitFrom option	Behavior
Guide	Submits the Guide data to the Document Server.
PDF	Displays the PDF rendition of the Guide. A user then clicks the appropriate submit button on the PDF form.
Printed Form	Displays the PDF rendition of the Guide. A user then prints the PDF and submits the form manually.
Hosted Application	The submit button does not display on the last panel of the Guide. This option transfer control of the Guide submission to the hosting application. In this case, a user clicks a button within the hosting application, for example the Complete button within Adobe Digital Enterprise Platform Document Services - Workspace 10.0, to submit the Guide data.

Rückgabewerte

Boolean — Boolean

submitDataWithCB

()

Methode

public function submitDataWithCB(callback:Function):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Adobe Digital Enterprise Platform Document Services - Handbücher 9 SP2

Laufzeitversionen:

AIR 1.0, Flash Player 10.2

Submits the data to the server - return true if the submit was performed - returns false if validations fail

Parameter

callback:Function — the function to be called when the submit is an asynchronous operation (default)

Rückgabewerte

Boolean — Boolean

Rechtliche Hinweise | Onlinedatenschutzerklärung

IConnectionService - AS3 ADEp-Handbücher

Klassen x

connectionClosed

connectionOpened

getActiveData

getData

getDraftData

getFieldValue

getProperty

setData

setFieldValue

setProperty

submitData

submitDataWithCB