From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-call-agent/-init-.html | 15 +++++ .../-call-agent/index.html | 65 ++++++++++++++++++++++ .../-call-agent/json-rpc-call.html | 24 ++++++++ .../-call-agent/remote-call.html | 28 ++++++++++ 4 files changed, 132 insertions(+) create mode 100644 api1/pl.treksoft.kvision.remote/-call-agent/-init-.html create mode 100644 api1/pl.treksoft.kvision.remote/-call-agent/index.html create mode 100644 api1/pl.treksoft.kvision.remote/-call-agent/json-rpc-call.html create mode 100644 api1/pl.treksoft.kvision.remote/-call-agent/remote-call.html (limited to 'api1/pl.treksoft.kvision.remote/-call-agent') 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 @@ + + + +CallAgent.<init> - kvision + + + +kvision / pl.treksoft.kvision.remote / CallAgent / <init>
+
+

<init>

+ +CallAgent() +

An agent responsible for remote calls.

+ + 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 @@ + + + +CallAgent - kvision + + + +kvision / pl.treksoft.kvision.remote / CallAgent
+
+

CallAgent

+open class CallAgent +

An agent responsible for remote calls.

Constructors

+ + + + + + + +

<init>

+CallAgent() +

An agent responsible for remote calls.

Functions

+ + + + + + + + + + + +

+ jsonRpcCall +	+`fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: HttpMethod = HttpMethod.POST): Promise<String>` + Makes an JSON-RPC call to the remote server. +
+ remoteCall +	+`fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null): Promise<dynamic>` + Makes a remote call to the remote server. +

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + 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 @@ + + + +CallAgent.jsonRpcCall - kvision + + + +kvision / pl.treksoft.kvision.remote / CallAgent / jsonRpcCall
+
+

jsonRpcCall

+ +

fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: HttpMethod = HttpMethod.POST): Promise<String>

Makes an JSON-RPC call to the remote server.

Parameters

+url - an URL address

+data - data to be sent

+method - a HTTP method

Return
+a promise of the result

+ + 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 @@ + + + +CallAgent.remoteCall - kvision + + + +kvision / pl.treksoft.kvision.remote / CallAgent / remoteCall
+
+

remoteCall

+ +

fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: ((JQueryXHR, JQueryAjaxSettings) -> Boolean)? = null): Promise<dynamic>

Makes a remote call to the remote server.

Parameters

+url - an URL address

+data - data to be sent

+method - a HTTP method

+contentType - a content type of the request

+beforeSend - a content type of the request

Return
+a promise of the result

+ + -- cgit