From a81c549e277d1a07e87cf8e2eecf89662deda323 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 23 Dec 2018 01:32:27 +0100 Subject: API documentation for KVision 0.0.22 --- api/index-outline.html | 719 ++++++++++++++++++++++--------------------------- 1 file changed, 319 insertions(+), 400 deletions(-) (limited to 'api/index-outline.html') diff --git a/api/index-outline.html b/api/index-outline.html index 93f59472..e78d6a3f 100644 --- a/api/index-outline.html +++ b/api/index-outline.html @@ -90,8 +90,8 @@ -AjaxOptions(url: String, preprocessData: (dynamic) -> dynamic, beforeSend: (JQueryXHR) -> dynamic = null, data: dynamic = null, httpType: HttpType = HttpType.GET, dataType: DataType = DataType.JSON, minLength: Int = 0, cache: Boolean = true, clearOnEmpty: Boolean = true, clearOnError: Boolean = true, emptyRequest: Boolean = false, requestDelay: Int = AJAX_REQUEST_DELAY, restoreOnError: Boolean = false)
-val beforeSend: (JQueryXHR) -> dynamic
+AjaxOptions(url: String? = null, preprocessData: (dynamic) -> dynamic = null, beforeSend: (JQueryXHR, dynamic) -> dynamic = null, data: dynamic = null, httpType: HttpType = HttpType.GET, dataType: DataType = DataType.JSON, minLength: Int = 0, cache: Boolean = true, clearOnEmpty: Boolean = true, clearOnError: Boolean = true, emptyRequest: Boolean = false, requestDelay: Int = AJAX_REQUEST_DELAY, restoreOnError: Boolean = false, preserveSelected: Boolean = false, processData: Boolean = false)
+val beforeSend: (JQueryXHR, dynamic) -> dynamic
val cache: Boolean
val clearOnEmpty: Boolean
val clearOnError: Boolean
@@ -101,9 +101,11 @@ val httpType: HttpType
val minLength: Int
val preprocessData: (dynamic) -> dynamic
+val preserveSelected: Boolean
+val processData: Boolean
val requestDelay: Int
val restoreOnError: Boolean
-val url: String
+val url: String?
@@ -462,8 +464,8 @@ CallAgent()
-fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
-fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
+fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
+fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
@@ -1812,23 +1814,6 @@ -enum class HttpMethod
- enum class HttpType
-open class JoobyRemoteAgent<T : Any> : RemoteAgent
- -open expect class JoobyServiceManager<T : Any> : ServiceManager
- -data class JsonRpcRequest
+data class KFile
-data class JsonRpcResponse
+interface KFilesFormControl : FormControl
-data class KFile
+open class KVController
-interface KFilesFormControl : FormControl
+open class KVRemoteAgent<T : Any> : RemoteAgent
-open class KVController
+open actual class KVServer
-open expect class KVServer
+open actual class KVServiceManager<T : Any>
@@ -2252,7 +2208,7 @@ LoginService()
-fun login(credentials: Credentials?): Deferred<Boolean>
+suspend fun login(credentials: Credentials?): Boolean
val loginAgent: CallAgent
@@ -2599,7 +2555,63 @@ interface RemoteAgent
-expect interface Request
+open class RemoteSelect<T : Any> : SimplePanel, StringFormControl
+ +open class RemoteSelectInput<T : Any> : SelectInput
+ +actual interface Request
typealias ResString = String
enum class Resize
-enum class RpcHttpMethod
- enum class Sandbox
-interface ServiceManager
+enum class Side
-enum class Side
+enum class SideTabSize
@@ -3115,64 +3118,6 @@ -open class SpringRemoteAgent<T : Any> : RemoteAgent
- -open expect class SpringServiceManager<T : Any> : ServiceManager
- open class StackPanel : SimplePanel
+enum class TabPosition
+ @@ -4024,7 +3984,7 @@ -expect fun Date.toStringF(format: String = "YYYY-MM-DD HH:mm:ss"): String
+expect fun Date.toStringF(format: String = KV_DATE_FORMAT): String
@@ -4077,7 +4037,7 @@ -expect fun String.toDateF(format: String = "YYYY-MM-DD HH:mm:ss"): Date
+expect fun String.toDateF(format: String = KV_DATE_FORMAT): Date
@@ -5751,8 +5711,8 @@ -AjaxOptions(url: String, preprocessData: (dynamic) -> dynamic, beforeSend: (JQueryXHR) -> dynamic = null, data: dynamic = null, httpType: HttpType = HttpType.GET, dataType: DataType = DataType.JSON, minLength: Int = 0, cache: Boolean = true, clearOnEmpty: Boolean = true, clearOnError: Boolean = true, emptyRequest: Boolean = false, requestDelay: Int = AJAX_REQUEST_DELAY, restoreOnError: Boolean = false)
-val beforeSend: (JQueryXHR) -> dynamic
+AjaxOptions(url: String? = null, preprocessData: (dynamic) -> dynamic = null, beforeSend: (JQueryXHR, dynamic) -> dynamic = null, data: dynamic = null, httpType: HttpType = HttpType.GET, dataType: DataType = DataType.JSON, minLength: Int = 0, cache: Boolean = true, clearOnEmpty: Boolean = true, clearOnError: Boolean = true, emptyRequest: Boolean = false, requestDelay: Int = AJAX_REQUEST_DELAY, restoreOnError: Boolean = false, preserveSelected: Boolean = false, processData: Boolean = false)
+val beforeSend: (JQueryXHR, dynamic) -> dynamic
val cache: Boolean
val clearOnEmpty: Boolean
val clearOnError: Boolean
@@ -5762,9 +5722,11 @@ val httpType: HttpType
val minLength: Int
val preprocessData: (dynamic) -> dynamic
+val preserveSelected: Boolean
+val processData: Boolean
val requestDelay: Int
val restoreOnError: Boolean
-val url: String
+val url: String?
@@ -5799,6 +5761,62 @@ +open class RemoteSelect<T : Any> : SimplePanel, StringFormControl
+ +open class RemoteSelectInput<T : Any> : SelectInput
+ open class Select : SimplePanel, StringFormControl
+external fun decodeURIComponent(encodedURI: String): String
fun AjaxOptions.toJs(emptyOption: Boolean): dynamic
@@ -7614,6 +7635,24 @@ +enum class SideTabSize
+ open class SimplePanel : Widget, Container
+enum class TabPosition
+ @@ -7781,8 +7835,8 @@ CallAgent()
-fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
-fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
+fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
+fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
@@ -7802,80 +7856,7 @@ const val HTTP_UNAUTHORIZED: Int
-enum class HttpMethod
- -open class JoobyRemoteAgent<T : Any> : RemoteAgent
- -open expect class JoobyServiceManager<T : Any> : ServiceManager
- -data class JsonRpcRequest
+open class KVController
-data class JsonRpcResponse
+open class KVRemoteAgent<T : Any> : RemoteAgent
-open class KVController
+open actual class KVServer
-open expect class KVServer
+open actual class KVServiceManager<T : Any>
@@ -7951,7 +7959,7 @@ LoginService()
-fun login(credentials: Credentials?): Deferred<Boolean>
+suspend fun login(credentials: Credentials?): Boolean
val loginAgent: CallAgent
@@ -7965,7 +7973,7 @@ -expect class Profile
+data actual class Profile
interface RemoteAgent
-expect interface Request
-enum class RpcHttpMethod
- +actual interface Request
class SecurityException : Exception
-interface ServiceManager
- class SpringContext
-open class SpringRemoteAgent<T : Any> : RemoteAgent
- -open expect class SpringServiceManager<T : Any> : ServiceManager
- -fun <ERROR CLASS>.addPathPatternsFromServices(services: List<SpringServiceManager<*>>): Unit
-fun <RESP> Request?.async(block: (Request) -> RESP): Deferred<RESP>
-fun <RESP> async(block: () -> RESP): Deferred<RESP>
-fun <RESP> Request?.asyncAuth(block: (Request, <ERROR CLASS>, Profile) -> RESP): Deferred<RESP>
-fun <RESP> asyncAuth(block: (Profile) -> RESP): Deferred<RESP>
-fun <RESP> Request?.asyncSession(block: (Request, <ERROR CLASS>) -> RESP): Deferred<RESP>
+fun <ERROR CLASS>.addPathPatternsFromServices(services: List<KVServiceManager<*>>): Unit
+fun <RESP> Request.withProfile(block: (Profile) -> RESP): RESP
+fun <RESP> withProfile(block: (Profile) -> RESP): RESP
fun <ERROR CLASS>.writeJSON(json: String): Unit
@@ -8397,6 +8315,7 @@ +expect val KV_DATE_FORMAT: String
java.util.Date
@@ -8419,7 +8338,7 @@ -expect fun String.toDateF(format: String = "YYYY-MM-DD HH:mm:ss"): Date
+expect fun String.toDateF(format: String = KV_DATE_FORMAT): Date
-- cgit