diff options
| author | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2019-10-26 00:17:24 +0200 |
| commit | fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb (patch) | |
| tree | 911c8e9b208b9ba77f00531668d1d99b40fcb8e3 /api1/pl.treksoft.kvision.remote/-call-agent | |
| parent | 4f5db77ec2db6c87cb93ceb9f7ea9ab311247f17 (diff) | |
| download | kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.gz kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.tar.bz2 kvision-fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb.zip | |
API documentation for KVision 2.0.0
Diffstat (limited to 'api1/pl.treksoft.kvision.remote/-call-agent')
4 files changed, 132 insertions, 0 deletions
diff --git a/api1/pl.treksoft.kvision.remote/-call-agent/-init-.html b/api1/pl.treksoft.kvision.remote/-call-agent/-init-.html new file mode 100644 index 00000000..2a46f6df --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-call-agent/-init-.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CallAgent.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">CallAgent</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.remote.CallAgent$<init>()"></a> +<code><span class="identifier">CallAgent</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>An agent responsible for remote calls.</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.remote/-call-agent/index.html b/api1/pl.treksoft.kvision.remote/-call-agent/index.html new file mode 100644 index 00000000..bd9ab025 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-call-agent/index.html @@ -0,0 +1,65 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CallAgent - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="./index.html">CallAgent</a><br/> +<br/> +<h1>CallAgent</h1> +<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">CallAgent</span></code> +<p>An agent responsible for remote calls.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">CallAgent</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>An agent responsible for remote calls.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="json-rpc-call.html">jsonRpcCall</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">jsonRpcCall</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$jsonRpcCall(kotlin.String, kotlin.collections.List((kotlin.String)), pl.treksoft.kvision.remote.HttpMethod)/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$jsonRpcCall(kotlin.String, kotlin.collections.List((kotlin.String)), pl.treksoft.kvision.remote.HttpMethod)/data">data</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span><span class="symbol">></span> <span class="symbol">=</span> listOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$jsonRpcCall(kotlin.String, kotlin.collections.List((kotlin.String)), pl.treksoft.kvision.remote.HttpMethod)/method">method</span><span class="symbol">:</span> <span class="identifier">HttpMethod</span> <span class="symbol">=</span> HttpMethod.POST<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.js/-promise/index.html"><span class="identifier">Promise</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span></code> +<p>Makes an JSON-RPC call to the remote server.</p> +</td> +</tr> +<tr> +<td> +<p><a href="remote-call.html">remoteCall</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="identifier">remoteCall</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/data">data</span><span class="symbol">:</span> <span class="keyword">dynamic</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/method">method</span><span class="symbol">:</span> <span class="identifier">HttpMethod</span> <span class="symbol">=</span> HttpMethod.GET<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/contentType">contentType</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a> <span class="symbol">=</span> "application/json"<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/beforeSend">beforeSend</span><span class="symbol">:</span> <span class="symbol">(</span><span class="symbol">(</span><span class="identifier">JQueryXHR</span><span class="symbol">,</span> <span class="identifier">JQueryAjaxSettings</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">)</span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.js/-promise/index.html"><span class="identifier">Promise</span></a><span class="symbol"><</span><span class="keyword">dynamic</span><span class="symbol">></span></code> +<p>Makes a remote call to the remote server.</p> +</td> +</tr> +</tbody> +</table> +<h3>Extension Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html">createInstance</a></p> +</td> +<td> +<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html"><span class="identifier">Any</span></a><span class="symbol">?</span><span class="symbol">.</span><span class="identifier">createInstance</span><span class="symbol">(</span><span class="keyword">vararg</span> <span class="identifier" id="pl.treksoft.kvision.utils$createInstance(kotlin.Any, kotlin.Array((kotlin.Any)))/args">args</span><span class="symbol">:</span> <span class="keyword">dynamic</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../pl.treksoft.kvision.utils/kotlin.-any/create-instance.html#T"><span class="identifier">T</span></a></code> +<p>Helper function for creating JavaScript objects from dynamic constructors.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.remote/-call-agent/json-rpc-call.html b/api1/pl.treksoft.kvision.remote/-call-agent/json-rpc-call.html new file mode 100644 index 00000000..12ab8c4a --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-call-agent/json-rpc-call.html @@ -0,0 +1,24 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CallAgent.jsonRpcCall - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">CallAgent</a> / <a href="./json-rpc-call.html">jsonRpcCall</a><br/> +<br/> +<h1>jsonRpcCall</h1> +<a name="pl.treksoft.kvision.remote.CallAgent$jsonRpcCall(kotlin.String, kotlin.collections.List((kotlin.String)), pl.treksoft.kvision.remote.HttpMethod)"></a> +<code><span class="keyword">fun </span><span class="identifier">jsonRpcCall</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$jsonRpcCall(kotlin.String, kotlin.collections.List((kotlin.String)), pl.treksoft.kvision.remote.HttpMethod)/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$jsonRpcCall(kotlin.String, kotlin.collections.List((kotlin.String)), pl.treksoft.kvision.remote.HttpMethod)/data">data</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span><span class="symbol">></span> <span class="symbol">=</span> listOf()<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$jsonRpcCall(kotlin.String, kotlin.collections.List((kotlin.String)), pl.treksoft.kvision.remote.HttpMethod)/method">method</span><span class="symbol">:</span> <span class="identifier">HttpMethod</span> <span class="symbol">=</span> HttpMethod.POST<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.js/-promise/index.html"><span class="identifier">Promise</span></a><span class="symbol"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">></span></code> +<p>Makes an JSON-RPC call to the remote server.</p> +<h3>Parameters</h3> +<p><a name="url"></a> +<code>url</code> - an URL address</p> +<p><a name="data"></a> +<code>data</code> - data to be sent</p> +<p><a name="method"></a> +<code>method</code> - a HTTP method</p> +<p><strong>Return</strong><br/> +a promise of the result</p> +</BODY> +</HTML> diff --git a/api1/pl.treksoft.kvision.remote/-call-agent/remote-call.html b/api1/pl.treksoft.kvision.remote/-call-agent/remote-call.html new file mode 100644 index 00000000..136c3634 --- /dev/null +++ b/api1/pl.treksoft.kvision.remote/-call-agent/remote-call.html @@ -0,0 +1,28 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>CallAgent.remoteCall - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">CallAgent</a> / <a href="./remote-call.html">remoteCall</a><br/> +<br/> +<h1>remoteCall</h1> +<a name="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))"></a> +<code><span class="keyword">fun </span><span class="identifier">remoteCall</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/url">url</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/data">data</span><span class="symbol">:</span> <span class="keyword">dynamic</span> <span class="symbol">=</span> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/method">method</span><span class="symbol">:</span> <span class="identifier">HttpMethod</span> <span class="symbol">=</span> HttpMethod.GET<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/contentType">contentType</span><span class="symbol">:</span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a> <span class="symbol">=</span> "application/json"<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/beforeSend">beforeSend</span><span class="symbol">:</span> <span class="symbol">(</span><span class="symbol">(</span><span class="identifier">JQueryXHR</span><span class="symbol">,</span> <span class="identifier">JQueryAjaxSettings</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a><span class="symbol">)</span><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.js/-promise/index.html"><span class="identifier">Promise</span></a><span class="symbol"><</span><span class="keyword">dynamic</span><span class="symbol">></span></code> +<p>Makes a remote call to the remote server.</p> +<h3>Parameters</h3> +<p><a name="url"></a> +<code>url</code> - an URL address</p> +<p><a name="data"></a> +<code>data</code> - data to be sent</p> +<p><a name="method"></a> +<code>method</code> - a HTTP method</p> +<p><a name="contentType"></a> +<code>contentType</code> - a content type of the request</p> +<p><a name="beforeSend"></a> +<code>beforeSend</code> - a content type of the request</p> +<p><strong>Return</strong><br/> +a promise of the result</p> +</BODY> +</HTML> |