bixmlrpc.xml

ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiXmlRpc" extends="BiEventTarget">
	<description>This is a class that implements an XML-RPC client. The XML-RPC
 specifcation can be found at <link href="http://www.xmlrpc.com/spec">http://www.xmlrpc.com/spec</link>.
 For more info and XML-RPC server implementations see
 <link href="http://www.xmlrpc.com/">http://www.xmlrpc.com/</link>.</description>
	<arguments>
		<argument name="oUri" optional="true">
			<description>Optional URI where the XMP-RPC server resides</description>
			<type>
				<link class="BiUri">BiUri</link>/String</type>
		</argument>
	</arguments>
	<staticMethods>
		<method name="getJsType">
			<description>This takes a javascript value and returns the XML-RPC type name.<br>
				</br>
				<br>
				</br>
 Possible return valuse are:<br>
				</br>
				<br>
				</br>
 string<br>
				</br>
 boolean<br>
				</br>
 int<br>
				</br>
 double<br>
				</br>
 dateTime.iso8601<br>
				</br>
 array<br>
				</br>
 base64<br>
				</br>
 struct<br>
				</br>
			</description>
			<arguments>
				<argument name="v">
					<description>The js value to get the type name for</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="jsDateToIso8601">
			<description>This takes a javascript Date object and returns a string formatted according
 to ISO 8601</description>
			<arguments>
				<argument name="d">
					<description>The javascript date object</description>
					<type>Date</type>
				</argument>
			</arguments>
			<returns>
				<type>String</type>
			</returns>
		</method>
		<method name="iso8601ToJsDate">
			<description>This takes a date string formatted according to ISO 8601 and returns a
 javascript Date object
 to ISO 8601</description>
			<arguments>
				<argument name="s">
					<description>The string representing the date</description>
					<type>String</type>
				</argument>
			</arguments>
			<returns>
				<type>Date</type>
			</returns>
		</method>
		<method name="xmlNodeToJs">
			<description>Returns the javascript value that the XML node describes</description>
			<arguments>
				<argument name="n">
					<description>The XML node</description>
					<type>Node</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="xmlValueNodeToJs">
			<description>Decodes an RPC XML &lt;value&gt; element to a javascript value</description>
			<arguments>
				<argument name="n">
					<description>The XML element that describes the value</description>
					<type>Node</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="jsToXmlNode">
			<description>This encodes a javascript value as an XML node.</description>
			<arguments>
				<argument name="v">
					<description>The javascript value</description>
					<type>Object</type>
				</argument>
				<argument name="doc">
					<description>The document that will contain the
 									complete XML-RPC message</description>
					<type>
						<link class="BiXmlDocument">BiXmlDocument</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Node</type>
			</returns>
		</method>
		<method name="jsToXmlValueNode">
			<description>This creates a &lt;value&gt; element that contains the XML-RPC value</description>
			<arguments>
				<argument name="v">
					<description>The javascript value</description>
					<type>Object</type>
				</argument>
				<argument name="doc">
					<description>The document that will contain the
 									complete XML-RPC message</description>
					<type>
						<link class="BiXmlDocument">BiXmlDocument</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Node</type>
			</returns>
		</method>
		<method name="jsFieldToXmlMemberNode">
			<description>This creates a &lt;member&gt; element that is used with XML-RPC structs</description>
			<arguments>
				<argument name="sName">
					<description>The field name</description>
					<type>String</type>
				</argument>
				<argument name="v">
					<description>The javascript value</description>
					<type>Object</type>
				</argument>
				<argument name="doc">
					<description>The document that will contain the
 									complete XML-RPC message</description>
					<type>
						<link class="BiXmlDocument">BiXmlDocument</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Node</type>
			</returns>
		</method>
		<method name="makeXmlRpcMessage">
			<description>This returns an XML document containing the XML-RPC method call body</description>
			<arguments>
				<argument name="sMethodName">
					<description>The name of the method to call</description>
					<type>String</type>
				</argument>
				<argument name="args">
					<description>An array containing the arguments</description>
					<type>Array</type>
				</argument>
			</arguments>
			<returns>
				<type>
					<link class="BiXmlDocument">BiXmlDocument</link>
				</type>
			</returns>
		</method>
		<method name="parseXmlRpcResponse">
			<description>This takes an XML document and returns a javascript value. If there was an
 error a<link class="BiXmlRpcError">BiXmlRpcError</link> is thrown</description>
			<arguments>
				<argument name="doc">
					<description>The xml document containing the method response</description>
					<type>
						<link class="BiXmlDocument">BiXmlDocument</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
	</staticMethods>
	<staticFields>
		<field name="MAX_INT">
			<description>The max value for a 4 byte integer</description>
			<type>Number</type>
		</field>
	</staticFields>
	<methods>
		<method name="useService">
			<description>Tells the XLM-RPC client where the server is located</description>
			<arguments>
				<argument name="oUri">
					<description>The URI where to find the remote procedure</description>
					<type>
						<link class="BiUri">BiUri</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="callMethod">
			<description>Calls the method with the given name and arguments. If the XML-RPC client
 is using synchronous loading the thread is halted until a response is received
 from the server. If using <link>async</link> loading use the <link>load</link>
 event to get the <link>result</link>. Arguments 1 to n are passed to the
 XML-RPC method. If a method call is already in progress it will be aborted
 before this new call is invoked.</description>
			<arguments>
				<argument name="sMethodName">
					<description>The name of the method to call</description>
					<type>String</type>
				</argument>
				<argument name="oArg" optional="true">
					<description>One or more arguments that are passed to to the method.</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="syncInvoke">
			<description>Calls the method with the given name and arguments. This uses synchronous
 loading and will therefore lock the js thread while it is waiting for the
 reply from the server. Arguments 1 to n are passed to the
 XML-RPC method. If the server generated an error a<link class="BiXmlRpcError">BiXmlRpcError</link> is thrown.
 If a method call is already in progress it will be aborted before this new
 call is invoked.</description>
			<arguments>
				<argument name="sMethodName">
					<description>The name of the method to call</description>
					<type>String</type>
				</argument>
				<argument name="oArg" optional="true">
					<description>One or more arguments that are passed to to the method.</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>Object</type>
			</returns>
		</method>
		<method name="asyncInvoke">
			<description>Calls the method with the given name and arguments. This uses asynchronous
 loading and to get the result listen to the callcomplete event. Arguments 1
 to n are passed to the XML-RPC method. If a method call is already in progress
 it will be aborted before this new call is invoked.</description>
			<arguments>
				<argument name="sMethodName">
					<description>The name of the method to call</description>
					<type>String</type>
				</argument>
				<argument name="oArg" optional="true">
					<description>One or more arguments that are passed to to the method.</description>
					<type>Object</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
	</methods>
	<properties>
		<property name="uri" get="true" set="true">
			<description>The URI where to find the remote procedure</description>
			<type>
				<link class="BiUri">BiUri</link>
			</type>
		</property>
		<property name="async" get="true" set="true">
			<description>Whether to use asynchronous method call. If this is <code>false</code> then
 the call to <link>callMethod</link> returns instantly. When using
 asynchronous calling use the <link>result</link> event for the call back</description>
			<type>Boolean</type>
		</property>
		<property name="user" get="true" set="true">
			<description>The user name to pass to the server when calling the remote procedure</description>
			<type>String</type>
		</property>
		<property name="password" get="true" set="true">
			<description>The password to pass to the server when calling the remote procedure</description>
			<type>String</type>
		</property>
		<property name="loading" get="true">
			<description>Returns true if the XMP-RPC is currently loading the reply from the server</description>
			<type>Boolean</type>
		</property>
		<property name="loaded" get="true">
			<description>Returns true if the XMP-RPC has finished loading the reply from the server</description>
			<type>Boolean</type>
		</property>
		<property name="xmlLoader" get="true">
			<description>This returns the XML loader that was used in the last method call</description>
			<type>
				<link class="BiXmlLoader">BiXmlLoader</link>
			</type>
		</property>
		<property name="result" get="true">
			<description>Returns the result value. This is only available during the load event.
 If there was an error receiving the result from the server an exception is
 thrown.</description>
			<type>Object</type>
		</property>
	</properties>
	<events>
		<event name="load">
			<description>This event is fired when a method call
 								response is received from the server.</description>
			<type>
				<link class="BiEvent">BiEvent</link>
			</type>
		</event>
		<event name="callcomplete">
			<description>This event is fired when
 													a method call is complete.</description>
			<type>
				<link class="BiXmlRpcCallCompleteEvent">BiXmlRpcCallCompleteEvent</link>
			</type>
		</event>
	</events>
	<remarks>The struct type is represented by the Object type<br>
		</br>
		<br>
		</br>
             The base64 type is represented by the<link class="BiBase64">BiBase64</link> class.<br>
		</br>
		<br>
		</br>
 			To ensure that a number is encoded as a double you can use
 		<link class="BiXmlRpcDouble">BiXmlRpcDouble</link>.<br>
		</br>
		<br>
		</br>
             If you want to ensure that a number is encoded
             as an int you can either use<link class="BiXmlRpcInt">BiXmlRpcInt</link> or make sure that the
             the number does not have any decimals (using Math.floor,
             Math.ceil or Math.round).<br>
		</br>
		<br>
		</br>
             The XML-RPC client only supports one call at a time. If a call
             is in progress and another call is made the first one is aborted.</remarks>
</class>