From eeb8fdf8f890daeed907a6d0591ea6fae8421860 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 6 Mar 2019 13:53:58 +0100 Subject: API documentation for KVision 0.0.28 --- .../-protocol/index.html | 233 +++++++++++++++++++++ .../-protocol/intercept-buffer-protocol.html | 14 ++ .../-protocol/intercept-file-protocol.html | 14 ++ .../-protocol/intercept-http-protocol.html | 14 ++ .../-protocol/intercept-stream-protocol.html | 14 ++ .../-protocol/intercept-string-protocol.html | 14 ++ .../-protocol/is-protocol-handled.html | 14 ++ .../-protocol/register-buffer-protocol.html | 14 ++ .../-protocol/register-file-protocol.html | 14 ++ .../-protocol/register-http-protocol.html | 14 ++ .../-protocol/register-service-worker-schemes.html | 14 ++ .../-protocol/register-standard-schemes.html | 14 ++ .../-protocol/register-stream-protocol.html | 14 ++ .../-protocol/register-string-protocol.html | 14 ++ .../-protocol/unintercept-protocol.html | 14 ++ .../-protocol/unregister-protocol.html | 14 ++ 16 files changed, 443 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-protocol/index.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/intercept-buffer-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/intercept-file-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/intercept-http-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/intercept-stream-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/intercept-string-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/is-protocol-handled.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/register-buffer-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/register-file-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/register-http-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/register-service-worker-schemes.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/register-standard-schemes.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/register-stream-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/register-string-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/unintercept-protocol.html create mode 100644 api/pl.treksoft.kvision.electron/-protocol/unregister-protocol.html (limited to 'api/pl.treksoft.kvision.electron/-protocol') diff --git a/api/pl.treksoft.kvision.electron/-protocol/index.html b/api/pl.treksoft.kvision.electron/-protocol/index.html new file mode 100644 index 00000000..d433f32a --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-protocol/index.html @@ -0,0 +1,233 @@ + + + +Protocol - kvision + + + +kvision / pl.treksoft.kvision.electron / Protocol
+
+

Protocol

+external interface Protocol : EventEmitter +

Functions

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

+ interceptBufferProtocol +	+`abstract fun interceptBufferProtocol(scheme: String, handler: (request: InterceptBufferProtocolRequest, callback: (<ERROR CLASS>?) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ interceptFileProtocol +	+`abstract fun interceptFileProtocol(scheme: String, handler: (request: InterceptFileProtocolRequest, callback: (filePath: String) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ interceptHttpProtocol +	+`abstract fun interceptHttpProtocol(scheme: String, handler: (request: InterceptHttpProtocolRequest, callback: (redirectRequest: RedirectRequest) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ interceptStreamProtocol +	+`abstract fun interceptStreamProtocol(scheme: String, handler: (request: InterceptStreamProtocolRequest, callback: (dynamic) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ interceptStringProtocol +	+`abstract fun interceptStringProtocol(scheme: String, handler: (request: InterceptStringProtocolRequest, callback: (data: String?) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ isProtocolHandled +	+`abstract fun isProtocolHandled(scheme: String, callback: (Error) -> Unit): Unit`
+ registerBufferProtocol +	+`abstract fun registerBufferProtocol(scheme: String, handler: (request: RegisterBufferProtocolRequest, callback: (dynamic) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ registerFileProtocol +	+`abstract fun registerFileProtocol(scheme: String, handler: (request: RegisterFileProtocolRequest, callback: (filePath: String?) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ registerHttpProtocol +	+`abstract fun registerHttpProtocol(scheme: String, handler: (request: RegisterHttpProtocolRequest, callback: (redirectRequest: RedirectRequest) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ registerServiceWorkerSchemes +	+`abstract fun registerServiceWorkerSchemes(schemes: Array<String>): Unit`
+ registerStandardSchemes +	+`abstract fun registerStandardSchemes(schemes: Array<String>, options: RegisterStandardSchemesOptions? = definedExternally): Unit`
+ registerStreamProtocol +	+`abstract fun registerStreamProtocol(scheme: String, handler: (request: RegisterStreamProtocolRequest, callback: (dynamic) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ registerStringProtocol +	+`abstract fun registerStringProtocol(scheme: String, handler: (request: RegisterStringProtocolRequest, callback: (data: String?) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit`
+ uninterceptProtocol +	+`abstract fun uninterceptProtocol(scheme: String, completion: (Error) -> Unit = definedExternally): Unit`
+ unregisterProtocol +	+`abstract fun unregisterProtocol(scheme: String, completion: (Error) -> Unit = definedExternally): Unit`

Inherited Functions

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

+ addListener +	+`open fun addListener(event: String, listener: Function<*>): EventEmitter`
+ emit +	+`open fun emit(event: String, vararg args: Any): Boolean`
+ eventNames +	+`open fun eventNames(): Array<String>`
+ getMaxListeners +	+`open fun getMaxListeners(): Number`
+ listenerCount +	+`open fun listenerCount(type: String): Number`
+ listeners +	+`open fun listeners(event: String): Array<Function<*>>`
+ on +	+`open fun on(event: String, listener: Function<*>): EventEmitter`
+ once +	+`open fun once(event: String, listener: Function<*>): EventEmitter`
+ prependListener +	+`open fun prependListener(event: String, listener: Function<*>): EventEmitter`
+ prependOnceListener +	+`open fun prependOnceListener(event: String, listener: Function<*>): EventEmitter`
+ removeAllListeners +	+`open fun removeAllListeners(event: String? = definedExternally): EventEmitter`
+ removeListener +	+`open fun removeListener(event: String, listener: Function<*>): EventEmitter`
+ setMaxListeners +	+`open fun setMaxListeners(n: Number): EventEmitter`

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api/pl.treksoft.kvision.electron/-protocol/intercept-buffer-protocol.html b/api/pl.treksoft.kvision.electron/-protocol/intercept-buffer-protocol.html new file mode 100644 index 00000000..a11e7798 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-protocol/intercept-buffer-protocol.html @@ -0,0 +1,14 @@ + + + +Protocol.interceptBufferProtocol - kvision + + + +kvision / pl.treksoft.kvision.electron / Protocol / interceptBufferProtocol
+
+

interceptBufferProtocol

+ +

abstract fun interceptBufferProtocol(scheme: String, handler: (request: InterceptBufferProtocolRequest, callback: (<ERROR CLASS>?) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit

+ + diff --git a/api/pl.treksoft.kvision.electron/-protocol/intercept-file-protocol.html b/api/pl.treksoft.kvision.electron/-protocol/intercept-file-protocol.html new file mode 100644 index 00000000..a60cbb91 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-protocol/intercept-file-protocol.html @@ -0,0 +1,14 @@ + + + +Protocol.interceptFileProtocol - kvision + + + +kvision / pl.treksoft.kvision.electron / Protocol / interceptFileProtocol
+
+

interceptFileProtocol

+ +

abstract fun interceptFileProtocol(scheme: String, handler: (request: InterceptFileProtocolRequest, callback: (filePath: String) -> Unit) -> Unit, completion: (Error) -> Unit = definedExternally): Unit

+ + diff --git a/api/pl.treksoft.kvision.electron/-protocol/intercept-http-protocol.html b/api/pl.treksoft.kvision.electron/-protocol/intercept-http-protocol.html new file mode 100644 index 00000000..4f8d9fd0 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-protocol/intercept-http-protocol.html @@ -0,0 +1,14 @@ + + + +Protocol.interceptHttpProtocol - kvision + + + +kvision / pl.treksoft.kvision.electron / Protocol / interceptHttpProtocol
+
+

interceptHttpProtocol

+ +

abstract fun interceptHttpProtocol(scheme: String, handler: (request: InterceptHttpProtocolRequest, callback: (redirectRequest: RedirectRequest) -> Unit) -> Unit, completion: (Error) -> Unit = definedExte