bixmlrpc.html

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· HTML 代码 · 共 825 行 · 第 1/2 页

 call is invoked.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.syncInvoke(<span class="methodArgument">sMethodName</span> [, <span class="methodArgument">oArg</span>])</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sMethodName</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The name of the method to call</td>
</tr>
<tr>
<td><code>oArg</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>One or more arguments that are passed to to the method.</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
<h3><a name="useService"></a>useService</h3>
<p>Tells the XLM-RPC client where the server is located</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.useService(<span class="methodArgument">oUri</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oUri</code></td>
<td><code class="type">
						<code><a href="BiUri.html">BiUri</a></code>
					</code></td>
<td class="optional-column"></td>
<td></td>
<td>The URI where to find the remote procedure</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h2>Static Method Details</h2>
<h3><a name="getJsType"></a>getJsType</h3>
<p>This takes a javascript value and returns the XML-RPC type name.<br>
				
				<br>
				
 Possible return valuse are:<br>
				
				<br>
				
 string<br>
				
 boolean<br>
				
 int<br>
				
 double<br>
				
 dateTime.iso8601<br>
				
 array<br>
				
 base64<br>
				
 struct<br>
				
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.getJsType(<span class="methodArgument">v</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>v</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The js value to get the type name for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="iso8601ToJsDate"></a>iso8601ToJsDate</h3>
<p>This takes a date string formatted according to ISO 8601 and returns a
 javascript Date object
 to ISO 8601</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.iso8601ToJsDate(<span class="methodArgument">s</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>s</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The string representing the date</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Date</code></p>
<h3><a name="jsDateToIso8601"></a>jsDateToIso8601</h3>
<p>This takes a javascript Date object and returns a string formatted according
 to ISO 8601</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.jsDateToIso8601(<span class="methodArgument">d</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>d</code></td>
<td><code class="type">Date</code></td>
<td class="optional-column"></td>
<td></td>
<td>The javascript date object</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">String</code></p>
<h3><a name="jsFieldToXmlMemberNode"></a>jsFieldToXmlMemberNode</h3>
<p>This creates a &lt;member&gt; element that is used with XML-RPC structs</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.jsFieldToXmlMemberNode(<span class="methodArgument">sName</span>, <span class="methodArgument">v</span>, <span class="methodArgument">doc</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sName</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The field name</td>
</tr>
<tr>
<td><code>v</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The javascript value</td>
</tr>
<tr>
<td><code>doc</code></td>
<td><code class="type">
						<code><a href="BiXmlDocument.html">BiXmlDocument</a></code>
					</code></td>
<td class="optional-column"></td>
<td></td>
<td>The document that will contain the
 									complete XML-RPC message</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Node</code></p>
<h3><a name="jsToXmlNode"></a>jsToXmlNode</h3>
<p>This encodes a javascript value as an XML node.</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.jsToXmlNode(<span class="methodArgument">v</span>, <span class="methodArgument">doc</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>v</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The javascript value</td>
</tr>
<tr>
<td><code>doc</code></td>
<td><code class="type">
						<code><a href="BiXmlDocument.html">BiXmlDocument</a></code>
					</code></td>
<td class="optional-column"></td>
<td></td>
<td>The document that will contain the
 									complete XML-RPC message</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Node</code></p>
<h3><a name="jsToXmlValueNode"></a>jsToXmlValueNode</h3>
<p>This creates a &lt;value&gt; element that contains the XML-RPC value</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.jsToXmlValueNode(<span class="methodArgument">v</span>, <span class="methodArgument">doc</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>v</code></td>
<td><code class="type">Object</code></td>
<td class="optional-column"></td>
<td></td>
<td>The javascript value</td>
</tr>
<tr>
<td><code>doc</code></td>
<td><code class="type">
						<code><a href="BiXmlDocument.html">BiXmlDocument</a></code>
					</code></td>
<td class="optional-column"></td>
<td></td>
<td>The document that will contain the
 									complete XML-RPC message</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Node</code></p>
<h3><a name="makeXmlRpcMessage"></a>makeXmlRpcMessage</h3>
<p>This returns an XML document containing the XML-RPC method call body</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.makeXmlRpcMessage(<span class="methodArgument">sMethodName</span>, <span class="methodArgument">args</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sMethodName</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The name of the method to call</td>
</tr>
<tr>
<td><code>args</code></td>
<td><code class="type">Array</code></td>
<td class="optional-column"></td>
<td></td>
<td>An array containing the arguments</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">
					<code><a href="BiXmlDocument.html">BiXmlDocument</a></code>
				</code></p>
<h3><a name="parseXmlRpcResponse"></a>parseXmlRpcResponse</h3>
<p>This takes an XML document and returns a javascript value. If there was an
 error a<code><a href="BiXmlRpcError.html">BiXmlRpcError</a></code> is thrown</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.parseXmlRpcResponse(<span class="methodArgument">doc</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>doc</code></td>
<td><code class="type">
						<code><a href="BiXmlDocument.html">BiXmlDocument</a></code>
					</code></td>
<td class="optional-column"></td>
<td></td>
<td>The xml document containing the method response</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
<h3><a name="xmlNodeToJs"></a>xmlNodeToJs</h3>
<p>Returns the javascript value that the XML node describes</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.xmlNodeToJs(<span class="methodArgument">n</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>n</code></td>
<td><code class="type">Node</code></td>
<td class="optional-column"></td>
<td></td>
<td>The XML node</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
<h3><a name="xmlValueNodeToJs"></a>xmlValueNodeToJs</h3>
<p>Decodes an RPC XML &lt;value&gt; element to a javascript value</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiXmlRpc.xmlValueNodeToJs(<span class="methodArgument">n</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>n</code></td>
<td><code class="type">Node</code></td>
<td class="optional-column"></td>
<td></td>
<td>The XML element that describes the value</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Object</code></p>
</body>
</html>