kotlin-electron/electron.core/AutoUpdater

AutoUpdater

external interface AutoUpdater : EventEmitter(source)

Properties

beforeQuitForUpdateEvent

abstract val beforeQuitForUpdateEvent: EventInstance<Tuple>

checkingForUpdateEvent

abstract val checkingForUpdateEvent: EventInstance<Tuple>

abstract val errorEvent: EventInstance<Tuple1<JsError>>

updateAvailableEvent

abstract val updateAvailableEvent: EventInstance<Tuple>

updateDownloadedEvent

abstract val updateDownloadedEvent: EventInstance<Tuple5<Event<*>, String, String, Date, String>>

updateNotAvailableEvent

abstract val updateNotAvailableEvent: EventInstance<Tuple>

Functions

fun addListener(type: EventType, listener: EventListener)

checkForUpdates

abstract fun checkForUpdates()

Asks the server whether there is an update. You must call setFeedURL before using this API.

fun emit(type: EventType, vararg args: Any?): Boolean

fun eventNames(): ReadonlyArray<EventType>

abstract fun getFeedURL(): String

The current update feed URL.

getMaxListeners

fun getMaxListeners(): Double

fun listenerCount(type: EventType, listener: EventListener): Double

fun listeners(type: EventType): ReadonlyArray<EventListener>

fun off(type: EventType, listener: EventListener)

fun on(type: EventType, listener: EventListener)

fun once(type: EventType, listener: EventListener)

prependListener

fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

abstract fun quitAndInstall()

Restarts the app and installs the update after it has been downloaded. It should only be called after update-downloaded has been emitted.

fun rawListeners(type: EventType): ReadonlyArray<EventListener>

removeAllListeners

fun removeAllListeners(type: EventType)

fun removeListener(type: EventType, listener: EventListener)

abstract fun setFeedURL(options: FeedURLOptions)

Sets the url and initialize the auto updater.

setMaxListeners

fun setMaxListeners(n: Number)