Package | mx.rpc.soap.mxml |
Class | public dynamic class WebService |
Inheritance | WebService WebService AbstractWebService AbstractService Proxy Object |
Implements | IMXMLSupport, IMXMLObject |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The <mx:WebService> tag accepts the following tag attributes:
<mx:WebService Properties concurrency="multiple|single|last" destination="No default." id="No default." serviceName="No default." showBusyCursor="false|true" makeObjectsBindable="false|true" useProxy="false|true" wsdl="No default." Events fault="No default." result="No default." />
An <mx:WebService> tag can have multiple <mx:operation> tags, which have the following tag attributes:
<mx:operation Properties concurrency="multiple|single|last" name=No default, required. resultFormat="object|xml|e4x" makeObjectsBindable="false|true" Events fault=No default. result=No default. />An <mx:Operation> tag contains an <mx:request> tag. To specify an XML structure in an <mx:request> tag, you must set the value of the tag's
format
attribute to "xml"
. Otherwise, the body is converted into Objects.
Property | Defined By | ||
---|---|---|---|
channelSet : ChannelSet
Provides access to the ChannelSet used by the service. | AbstractService | ||
concurrency : String
Value that indicates how to handle multiple calls to the same service. | WebService | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
convertParametersHandler : Function
An optional function, primarily intended for framework developers who need to install
a function to get called with the parameters passed to each webservice operation invocation. | AbstractWebService | ||
convertResultHandler : Function
An optional function, primarily intended for framework developers who need to install
a hook to process the results of an operation before notifying the result handlers. | AbstractWebService | ||
description : String
The description of the service for the currently active port. | AbstractWebService | ||
destination : String [override]
The destination of the service. | AbstractWebService | ||
endpointURI : String
The location of the WebService. | AbstractWebService | ||
headers : Array [read-only]
Returns the array of SOAPHeaders registered for the WebService. | AbstractWebService | ||
httpHeaders : Object
Custom HTTP headers to be sent to the SOAP endpoint. | AbstractWebService | ||
makeObjectsBindable : Boolean
When this value is true, anonymous objects returned are forced to
bindable objects. | AbstractWebService | ||
managers : Array
The managers property stores a list of data managers which modify the
behavior of this service. | AbstractService | ||
operations : Object
The Operations array is usually only set by the MXML compiler if you
create a service using an MXML tag. | AbstractService | ||
port : String
Specifies the port within the WSDL document that this WebService should
use. | AbstractWebService | ||
protocol : String Deprecated: Property protocol is deprecated. Please use an appropriate channel from your services configuration file (DefaultHTTP or DefaultHTTPS for instance); when useProxy is false set your URL to use the right protocol [write-only]
Deprecated, use the appropriate destination instead, or if using a url, use DefaultHTTP or DefaultHTTPS. | WebService | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
ready : Boolean [read-only]
Specifies whether the WebService is ready to make requests. | AbstractWebService | ||
requestTimeout : int
Provides access to the request timeout in seconds for sent messages. | AbstractService | ||
rootURL : String
The URL that the WebService should use when computing relative URLs. | AbstractWebService | ||
service : String
Specifies the service within the WSDL document that this WebService
should use. | AbstractWebService | ||
serviceName : String Deprecated: Please Use destination | WebService | ||
showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | WebService | ||
useProxy : Boolean
Specifies whether to use the Flex proxy service. | AbstractWebService | ||
wsdl : String
The location of the WSDL document for this WebService. | WebService | ||
xmlSpecialCharsFilter : Function
Custom function to be used to escape XML special characters before
encoding any simple content. | AbstractWebService |
Method | Defined By | ||
---|---|---|---|
WebService(destination:String = null)
Creates a new WebService component. | WebService | ||
Adds a header that will be applied to all operations of this web service. | AbstractWebService | ||
addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
Add a header that will be applied to all operations of this WebService. | AbstractWebService | ||
Returns a Boolean value that indicates whether the WebService is ready to
load a WSDL (does it have a valid destination or wsdl specified). | WebService | ||
Clears the headers that applied to all operations. | AbstractWebService | ||
Disconnects the service's network connection and removes any pending
request responders. | AbstractService | ||
Returns a header if a match is found based on QName, localName, and URI. | AbstractWebService | ||
[override]
Returns an Operation of the given name. | WebService | ||
Indicates whether an object has a specified property defined. | Object | ||
Called to initialize the service. | AbstractService | ||
Called automatically by the MXML compiler if the WebService is setup using a tag. | WebService | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Instructs the WebService to download the WSDL document. | WebService | ||
Logs the user out of the destination. | AbstractService | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes the header with the given QName from all operations. | AbstractWebService | ||
Sets the credentials for the destination accessed by the service when using Data Services on the server side. | AbstractService | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
[override]
The username and password to authenticate a user when accessing
the webservice. | AbstractWebService | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Represents an instance of WebService as a String, describing
important properties such as the destination id and the set of
channels assigned. | WebService | ||
Returns the primitive value of the specified object. | Object |
concurrency | property |
concurrency:String
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Value that indicates how to handle multiple calls to the same service. The default value is multiple. The following values are permitted:
public function get concurrency():String
public function set concurrency(value:String):void
protocol | property |
protocol:String
[write-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Deprecated, use the appropriate destination instead, or if using a url, use DefaultHTTP
or DefaultHTTPS
.
The deprecated behavior will simply update the destination if the default is being used.
public function set protocol(value:String):void
serviceName | property |
serviceName:String
public function get serviceName():String
public function set serviceName(value:String):void
showBusyCursor | property |
showBusyCursor:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
If true
, a busy cursor is displayed while a service is executing. The default
value is false
.
public function get showBusyCursor():Boolean
public function set showBusyCursor(value:Boolean):void
WebService | () | Constructor |
public function WebService(destination:String = null)
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new WebService component.
Parametersdestination:String (default = null ) — The destination of the WebService, which should
match a destination name in the services-config.xml file. If
unspecified, the WebService component uses the DefaultHTTP destination.
|
getOperation | () | method |
override public function getOperation(name:String):AbstractOperation
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns an Operation of the given name. If the Operation wasn't
created beforehand, a new mx.rpc.soap.mxml.Operation
is
created during this call. Operations are usually accessible by simply
naming them after the service variable
(myService.someOperation
), but if your Operation name
happens to match a defined method on the service
(like setCredentials
), you can use this method to get the
Operation instead.
Parameters
name:String — Name of the Operation.
|
AbstractOperation — Operation that executes for this name.
|
initialized | () | method |
public function initialized(document:Object, id:String):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Called automatically by the MXML compiler if the WebService is setup using a tag. If you create the WebService through ActionScript you may want to call this method yourself as it is useful for validating any arguments.
Parameters
document:Object — the MXML document on which this WebService lives
| |
id:String — the id of this WebService within the document
|