diff options
Diffstat (limited to 'api/pl.treksoft.kvision.remote/-call-agent/remote-call.html')
| -rw-r--r-- | api/pl.treksoft.kvision.remote/-call-agent/remote-call.html | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.remote/-call-agent/remote-call.html b/api/pl.treksoft.kvision.remote/-call-agent/remote-call.html index 1da57940..939fcb8a 100644 --- a/api/pl.treksoft.kvision.remote/-call-agent/remote-call.html +++ b/api/pl.treksoft.kvision.remote/-call-agent/remote-call.html @@ -14,10 +14,74 @@ <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> +<a name="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))"></a> +<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="identifier">remoteCall</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/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, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/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, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/deserializer">deserializer</span><span class="symbol">:</span> <span class="identifier">DeserializationStrategy</span><span class="symbol"><</span><a href="remote-call.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/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, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/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, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/beforeSend">beforeSend</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> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlin.Any, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/transform">transform</span><span class="symbol">:</span> <span class="symbol">(</span><span class="keyword">dynamic</span><span class="symbol">)</span> <span class="symbol">-></span> <span class="keyword">dynamic</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><a href="remote-call.html#T"><span class="identifier">T</span></a><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="deserializer"></a> +<code>deserializer</code> - a deserializer for the result value</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><a name="transform"></a> +<code>transform</code> - a function to transform the result of the call</p> +<p><strong>Return</strong><br/> +a promise of the result</p> +<a name="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, 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="symbol"><</span><span class="identifier">V</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="identifier">remoteCall</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, 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, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)))/serializer">serializer</span><span class="symbol">:</span> <span class="identifier">SerializationStrategy</span><span class="symbol"><</span><a href="remote-call.html#V"><span class="identifier">V</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, 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> <a href="remote-call.html#V"><span class="identifier">V</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, 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, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, 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, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, 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="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> 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="serializer"></a> +<code>serializer</code> - for the data</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> +<a name="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))"></a> +<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="identifier">V</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="identifier">remoteCall</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/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, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/serializer">serializer</span><span class="symbol">:</span> <span class="identifier">SerializationStrategy</span><span class="symbol"><</span><a href="remote-call.html#V"><span class="identifier">V</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/data">data</span><span class="symbol">:</span> <a href="remote-call.html#V"><span class="identifier">V</span></a><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/deserializer">deserializer</span><span class="symbol">:</span> <span class="identifier">DeserializationStrategy</span><span class="symbol"><</span><a href="remote-call.html#T"><span class="identifier">T</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/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, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/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, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/beforeSend">beforeSend</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> null<span class="symbol">, </span><span class="identifier" id="pl.treksoft.kvision.remote.CallAgent$remoteCall(kotlin.String, kotlinx.serialization.SerializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.V)), pl.treksoft.kvision.remote.CallAgent.remoteCall.V, kotlinx.serialization.DeserializationStrategy((pl.treksoft.kvision.remote.CallAgent.remoteCall.T)), pl.treksoft.kvision.remote.HttpMethod, kotlin.String, kotlin.Function2((pl.treksoft.jquery.JQueryXHR, pl.treksoft.jquery.JQueryAjaxSettings, kotlin.Boolean)), kotlin.Function1((kotlin.Any, )))/transform">transform</span><span class="symbol">:</span> <span class="symbol">(</span><span class="keyword">dynamic</span><span class="symbol">)</span> <span class="symbol">-></span> <span class="keyword">dynamic</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><a href="remote-call.html#T"><span class="identifier">T</span></a><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="serializer"></a> +<code>serializer</code> - for the data</p> <p><a name="data"></a> <code>data</code> - data to be sent</p> +<p><a name="deserializer"></a> +<code>deserializer</code> - a deserializer for the result value</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><a name="transform"></a> +<code>transform</code> - a function to transform the result of the call</p> <p><strong>Return</strong><br/> a promise of the result</p> </BODY> |