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 --- .../-auto-updater/add-listener.html | 23 +++ .../-auto-updater/check-for-updates.html | 14 ++ .../-auto-updater/get-feed-u-r-l.html | 14 ++ .../-auto-updater/index.html | 172 +++++++++++++++++++++ .../-auto-updater/on.html | 23 +++ .../-auto-updater/once.html | 23 +++ .../-auto-updater/quit-and-install.html | 14 ++ .../-auto-updater/remove-listener.html | 23 +++ .../-auto-updater/set-feed-u-r-l.html | 14 ++ 9 files changed, 320 insertions(+) create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/add-listener.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/check-for-updates.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/get-feed-u-r-l.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/index.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/on.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/once.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/quit-and-install.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/remove-listener.html create mode 100644 api1/pl.treksoft.kvision.electron/-auto-updater/set-feed-u-r-l.html (limited to 'api1/pl.treksoft.kvision.electron/-auto-updater') diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/add-listener.html b/api1/pl.treksoft.kvision.electron/-auto-updater/add-listener.html new file mode 100644 index 00000000..0d814d34 --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/add-listener.html @@ -0,0 +1,23 @@ + + + +AutoUpdater.addListener - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / addListener
+
+

addListener

+ +abstract fun addListener(event: String, listener: Function<*>): AutoUpdater
+ +abstract fun addListener(event: String, listener: (Error) -> Unit): AutoUpdater
+ +abstract fun addListener(event: String, listener: Function<*>): AutoUpdater
+ +

abstract fun addListener(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater

+ +abstract fun addListener(event: String, listener: Function<*>): AutoUpdater +

Overrides EventEmitter.addListener

+ + diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/check-for-updates.html b/api1/pl.treksoft.kvision.electron/-auto-updater/check-for-updates.html new file mode 100644 index 00000000..151fb51d --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/check-for-updates.html @@ -0,0 +1,14 @@ + + + +AutoUpdater.checkForUpdates - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / checkForUpdates
+
+

checkForUpdates

+ +abstract fun checkForUpdates(): Unit + + diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/get-feed-u-r-l.html b/api1/pl.treksoft.kvision.electron/-auto-updater/get-feed-u-r-l.html new file mode 100644 index 00000000..c9b34213 --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/get-feed-u-r-l.html @@ -0,0 +1,14 @@ + + + +AutoUpdater.getFeedURL - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / getFeedURL
+
+

getFeedURL

+ +abstract fun getFeedURL(): String + + diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/index.html b/api1/pl.treksoft.kvision.electron/-auto-updater/index.html new file mode 100644 index 00000000..4031a414 --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/index.html @@ -0,0 +1,172 @@ + + + +AutoUpdater - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater
+
+

AutoUpdater

+external interface AutoUpdater : EventEmitter +

Functions

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

+ addListener +	+`abstract fun addListener(event: String, listener: Function<>): AutoUpdater` +`abstract fun addListener(event: String, listener: (Error) -> Unit): AutoUpdater` +`abstract fun addListener(event: String, listener: Function<>): AutoUpdater` +`abstract fun addListener(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater` +`abstract fun addListener(event: String, listener: Function<*>): AutoUpdater`
+ checkForUpdates +	+`abstract fun checkForUpdates(): Unit`
+ getFeedURL +	+`abstract fun getFeedURL(): String`
+ on +	+`abstract fun on(event: String, listener: Function<>): AutoUpdater` +`abstract fun on(event: String, listener: (Error) -> Unit): AutoUpdater` +`abstract fun on(event: String, listener: Function<>): AutoUpdater` +`abstract fun on(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater` +`abstract fun on(event: String, listener: Function<*>): AutoUpdater`
+ once +	+`abstract fun once(event: String, listener: Function<>): AutoUpdater` +`abstract fun once(event: String, listener: (Error) -> Unit): AutoUpdater` +`abstract fun once(event: String, listener: Function<>): AutoUpdater` +`abstract fun once(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater` +`abstract fun once(event: String, listener: Function<*>): AutoUpdater`
+ quitAndInstall +	+`abstract fun quitAndInstall(): Unit`
+ removeListener +	+`abstract fun removeListener(event: String, listener: Function<>): AutoUpdater` +`abstract fun removeListener(event: String, listener: (Error) -> Unit): AutoUpdater` +`abstract fun removeListener(event: String, listener: Function<>): AutoUpdater` +`abstract fun removeListener(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater` +`abstract fun removeListener(event: String, listener: Function<*>): AutoUpdater`
+ setFeedURL +	+`abstract fun setFeedURL(options: FeedURLOptions): Unit`

Inherited Functions

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

+ 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<*>>`
+ 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`
+ 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/api1/pl.treksoft.kvision.electron/-auto-updater/on.html b/api1/pl.treksoft.kvision.electron/-auto-updater/on.html new file mode 100644 index 00000000..c610eaf9 --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/on.html @@ -0,0 +1,23 @@ + + + +AutoUpdater.on - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / on
+
+

on

+ +abstract fun on(event: String, listener: Function<*>): AutoUpdater
+ +abstract fun on(event: String, listener: (Error) -> Unit): AutoUpdater
+ +abstract fun on(event: String, listener: Function<*>): AutoUpdater
+ +

abstract fun on(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater

+ +abstract fun on(event: String, listener: Function<*>): AutoUpdater +

Overrides EventEmitter.on

+ + diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/once.html b/api1/pl.treksoft.kvision.electron/-auto-updater/once.html new file mode 100644 index 00000000..a5f65c7b --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/once.html @@ -0,0 +1,23 @@ + + + +AutoUpdater.once - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / once
+
+

once

+ +abstract fun once(event: String, listener: Function<*>): AutoUpdater
+ +abstract fun once(event: String, listener: (Error) -> Unit): AutoUpdater
+ +abstract fun once(event: String, listener: Function<*>): AutoUpdater
+ +

abstract fun once(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater

+ +abstract fun once(event: String, listener: Function<*>): AutoUpdater +

Overrides EventEmitter.once

+ + diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/quit-and-install.html b/api1/pl.treksoft.kvision.electron/-auto-updater/quit-and-install.html new file mode 100644 index 00000000..7465bcdb --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/quit-and-install.html @@ -0,0 +1,14 @@ + + + +AutoUpdater.quitAndInstall - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / quitAndInstall
+
+

quitAndInstall

+ +abstract fun quitAndInstall(): Unit + + diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/remove-listener.html b/api1/pl.treksoft.kvision.electron/-auto-updater/remove-listener.html new file mode 100644 index 00000000..bec51a0b --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/remove-listener.html @@ -0,0 +1,23 @@ + + + +AutoUpdater.removeListener - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / removeListener
+
+

removeListener

+ +abstract fun removeListener(event: String, listener: Function<*>): AutoUpdater
+ +abstract fun removeListener(event: String, listener: (Error) -> Unit): AutoUpdater
+ +abstract fun removeListener(event: String, listener: Function<*>): AutoUpdater
+ +

abstract fun removeListener(event: String, listener: (event: Event, releaseNotes: String, releaseName: String, releaseDate: Date, updateURL: String) -> Unit): AutoUpdater

+ +abstract fun removeListener(event: String, listener: Function<*>): AutoUpdater +

Overrides EventEmitter.removeListener

+ + diff --git a/api1/pl.treksoft.kvision.electron/-auto-updater/set-feed-u-r-l.html b/api1/pl.treksoft.kvision.electron/-auto-updater/set-feed-u-r-l.html new file mode 100644 index 00000000..4b53255b --- /dev/null +++ b/api1/pl.treksoft.kvision.electron/-auto-updater/set-feed-u-r-l.html @@ -0,0 +1,14 @@ + + + +AutoUpdater.setFeedURL - kvision + + + +kvision / pl.treksoft.kvision.electron / AutoUpdater / setFeedURL
+
+

setFeedURL

+ +abstract fun setFeedURL(options: FeedURLOptions): Unit + + -- cgit