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 --- .../capture-monitoring-snapshot.html | 14 ++ .../-content-tracing/get-categories.html | 14 ++ .../-content-tracing/get-trace-buffer-usage.html | 14 ++ .../-content-tracing/index.html | 177 +++++++++++++++++++++ .../-content-tracing/start-monitoring.html | 14 ++ .../-content-tracing/start-recording.html | 14 ++ .../-content-tracing/stop-monitoring.html | 14 ++ .../-content-tracing/stop-recording.html | 14 ++ 8 files changed, 275 insertions(+) create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/capture-monitoring-snapshot.html create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/get-categories.html create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/get-trace-buffer-usage.html create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/index.html create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/start-monitoring.html create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/start-recording.html create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/stop-monitoring.html create mode 100644 api/pl.treksoft.kvision.electron/-content-tracing/stop-recording.html (limited to 'api/pl.treksoft.kvision.electron/-content-tracing') diff --git a/api/pl.treksoft.kvision.electron/-content-tracing/capture-monitoring-snapshot.html b/api/pl.treksoft.kvision.electron/-content-tracing/capture-monitoring-snapshot.html new file mode 100644 index 00000000..56187b08 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/capture-monitoring-snapshot.html @@ -0,0 +1,14 @@ + + + +ContentTracing.captureMonitoringSnapshot - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing / captureMonitoringSnapshot
+
+

captureMonitoringSnapshot

+ +abstract fun captureMonitoringSnapshot(resultFilePath: String, callback: (resultFilePath: String) -> Unit): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-content-tracing/get-categories.html b/api/pl.treksoft.kvision.electron/-content-tracing/get-categories.html new file mode 100644 index 00000000..de6113e0 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/get-categories.html @@ -0,0 +1,14 @@ + + + +ContentTracing.getCategories - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing / getCategories
+
+

getCategories

+ +abstract fun getCategories(callback: (categories: Array<String>) -> Unit): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-content-tracing/get-trace-buffer-usage.html b/api/pl.treksoft.kvision.electron/-content-tracing/get-trace-buffer-usage.html new file mode 100644 index 00000000..5754e69b --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/get-trace-buffer-usage.html @@ -0,0 +1,14 @@ + + + +ContentTracing.getTraceBufferUsage - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing / getTraceBufferUsage
+
+

getTraceBufferUsage

+ +abstract fun getTraceBufferUsage(callback: (value: Number, percentage: Number) -> Unit): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-content-tracing/index.html b/api/pl.treksoft.kvision.electron/-content-tracing/index.html new file mode 100644 index 00000000..a3882c58 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/index.html @@ -0,0 +1,177 @@ + + + +ContentTracing - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing
+
+

ContentTracing

+external interface ContentTracing : EventEmitter +

Functions

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

captureMonitoringSnapshot

+
+abstract fun captureMonitoringSnapshot(resultFilePath: String, callback: (resultFilePath: String) -> Unit): Unit
+

getCategories

+
+abstract fun getCategories(callback: (categories: Array<String>) -> Unit): Unit
+

getTraceBufferUsage

+
+abstract fun getTraceBufferUsage(callback: (value: Number, percentage: Number) -> Unit): Unit
+

startMonitoring

+
+abstract fun startMonitoring(options: StartMonitoringOptions, callback: Function<*>): Unit
+

startRecording

+
+abstract fun startRecording(options: StartRecordingOptions, callback: Function<*>): Unit
+

stopMonitoring

+
+abstract fun stopMonitoring(callback: Function<*>): Unit
+

stopRecording

+
+abstract fun stopRecording(resultFilePath: String, callback: (resultFilePath: String) -> Unit): 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/-content-tracing/start-monitoring.html b/api/pl.treksoft.kvision.electron/-content-tracing/start-monitoring.html new file mode 100644 index 00000000..19cd1793 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/start-monitoring.html @@ -0,0 +1,14 @@ + + + +ContentTracing.startMonitoring - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing / startMonitoring
+
+

startMonitoring

+ +abstract fun startMonitoring(options: StartMonitoringOptions, callback: Function<*>): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-content-tracing/start-recording.html b/api/pl.treksoft.kvision.electron/-content-tracing/start-recording.html new file mode 100644 index 00000000..0dd56c5e --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/start-recording.html @@ -0,0 +1,14 @@ + + + +ContentTracing.startRecording - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing / startRecording
+
+

startRecording

+ +abstract fun startRecording(options: StartRecordingOptions, callback: Function<*>): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-content-tracing/stop-monitoring.html b/api/pl.treksoft.kvision.electron/-content-tracing/stop-monitoring.html new file mode 100644 index 00000000..5e10ee51 --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/stop-monitoring.html @@ -0,0 +1,14 @@ + + + +ContentTracing.stopMonitoring - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing / stopMonitoring
+
+

stopMonitoring

+ +abstract fun stopMonitoring(callback: Function<*>): Unit + + diff --git a/api/pl.treksoft.kvision.electron/-content-tracing/stop-recording.html b/api/pl.treksoft.kvision.electron/-content-tracing/stop-recording.html new file mode 100644 index 00000000..ae4d591f --- /dev/null +++ b/api/pl.treksoft.kvision.electron/-content-tracing/stop-recording.html @@ -0,0 +1,14 @@ + + + +ContentTracing.stopRecording - kvision + + + +kvision / pl.treksoft.kvision.electron / ContentTracing / stopRecording
+
+

stopRecording

+ +abstract fun stopRecording(resultFilePath: String, callback: (resultFilePath: String) -> Unit): Unit + + -- cgit