biwebservice2.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 137 行

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiWebService2" extends="BiEventTarget">
	<description>Construct a web service client. A <link class="BiWebService2">BiWebService2</link> object allows accessing web services through SOAP, based on a WSDL describing the services' interfaces. To use <link class="BiWebService2">BiWebService2,</link> first construct an object of this class. Then, call the object's useService method -- passing the URL to the WSDL describing the service and the service's name. Finally, call syncInvoke, asyncInvoke and callMethod to invoke service operations synchronously or asynchronously.</description>
	<arguments>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="useService">
			<description>Prepare this WebService2 object to operate a web service described in a WSDL document.</description>
			<arguments>
				<argument name="aWsdlUri">
					<description>URL to WSDL describing service desired to be accessed</description>
					<type>String</type>
				</argument>
				<argument name="aServiceName">
					<description>Name of service to access</description>
					<type>String</type>
				</argument>
				<argument name="aAsync">
					<description>If true, call will be asyncly processed; if false, call will return only                          after the WSDL is available and parsed.</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="syncInvoke">
			<description>Invoke a web-service operation synchronously. Return the invoked service's result, or throw an exception in case of an error or a service-returned fault. The function returns the operation's result if the operation doesn't include out parameters; it returns an object consisting of a field named 'result' storing the return value and additional fields for each out parameter if out parameters exist.</description>
			<arguments>
				<argument name="aOpName">
					<description>Name of operation to invoke</description>
					<type>String</type>
				</argument>
				<argument name="other">
					<description>Web service operation invocation parameters</description>
					<type>arguments</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="asyncInvoke">
			<description>Invoke a web-service operation asynchronously. Return a cookie which will be passed in the wscallcomplete event to identify the completed call.</description>
			<arguments>
				<argument name="aOpName">
					<description>Name of operation to invoke</description>
					<type>String</type>
				</argument>
				<argument name="other">
					<description>Web service operation invocation parameters</description>
					<type>arguments</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="callMethod">
			<description>Invoke a web-service operation either synchronously or asynchronously, depending on the value of this._async. For asynchronous invocations return value, see asyncInvoke. For synchronous invocations return value, see syncInvoke.</description>
			<arguments>
				<argument name="aOpName">
					<description>Name of operation to invoke</description>
					<type>String</type>
				</argument>
				<argument name="other">
					<description>Web service operation invocation parameters</description>
					<type>arguments</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="pushCallContext">
			<description>Push a call context object to the stack. This object will server as the call context of all subsequent calls until a call to popCallContext (or another call to pushCallContext)</description>
			<arguments>
				<argument name="aContext">
					<description>Context object to push.</description>
					<type>Object</type>
				</argument>
				<argument name="aAdditive">
					<description>Should fields of current call context be added to this call context? (unless named the 						same as existing fields)</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="popCallContext">
			<description>Pop a call context object from the stack.</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="async" get="true" set="true">
			<description>This property determines whether or not calls made by the web service using callMethod and service loading using useService without specifying an async flag is done asynchronously.</description>
			<type>Boolean</type>
		</property>
		<property name="wsdl" get="true">
			<description>Retrieve the WSDL object used to connect to the web service.</description>
			<type>
				<link class="BiWsdl">BiWsdl</link>    WSDL object used to connect to the web service.</type>
		</property>
		<property name="loaded" get="true">
			<description>Return a boolean indicating whether the service is loaded and ready for action or not.</description>
			<type>Boolean    Indication of whether the service is loaded and ready for action</type>
		</property>
	</properties>
	<events>
		<event name="serviceloaded">
			<description>Notifies that loading the WSDL used to describe the service represented by this                                  instance is complete. If the event has an 'err' member, this describes an error 			             which occurred during loading.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="callcomplete">
			<description>Notifies that an asynchronous web service operation invocation                                               was completed, either succesfuly or with errors.</description>
			<type>
				<link class="BiWsCallCompleteEvent">BiWsCallCompleteEvent</link>
			</type>
		</event>
	</events>
	<remarks>
	</remarks>
</class>