kotlin-electron/electron.core/PowerMonitor

PowerMonitor

external interface PowerMonitor : EventEmitter(source)

Properties

lockScreenEvent

abstract val lockScreenEvent: EventInstance<JsTuple>

abstract val onAcEvent: EventInstance<JsTuple>

abstract val onBatteryEvent: EventInstance<JsTuple>

abstract var onBatteryPower: Boolean

A boolean property. True if the system is on battery power.

abstract val resumeEvent: EventInstance<JsTuple>

abstract val shutdownEvent: EventInstance<JsTuple>

speedLimitChangeEvent

abstract val speedLimitChangeEvent: EventInstance<JsTuple>

abstract val suspendEvent: EventInstance<JsTuple>

thermalStateChangeEvent

abstract val thermalStateChangeEvent: EventInstance<JsTuple>

unlockScreenEvent

abstract val unlockScreenEvent: EventInstance<JsTuple>

userDidBecomeActiveEvent

abstract val userDidBecomeActiveEvent: EventInstance<JsTuple>

userDidResignActiveEvent

abstract val userDidResignActiveEvent: EventInstance<JsTuple>

Functions

fun addListener(type: EventType, listener: EventListener)

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

fun eventNames(): Array<EventType>

getCurrentThermalState

abstract fun getCurrentThermalState(): PowerMonitorGetCurrentThermalStateResult

The system's current thermal state. Can be unknown, nominal, fair, serious, or critical.

getMaxListeners

fun getMaxListeners(): Double

getSystemIdleState

abstract fun getSystemIdleState(idleThreshold: Double): PowerMonitorGetSystemIdleStateResult

The system's current idle state. Can be active, idle, locked or unknown.

getSystemIdleTime

abstract fun getSystemIdleTime(): Double

Idle time in seconds

isOnBatteryPower

abstract fun isOnBatteryPower(): Boolean

Whether the system is on battery power.

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

fun listeners(type: EventType): Array<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)

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

removeAllListeners

fun removeAllListeners(type: EventType)

fun removeListener(type: EventType, listener: EventListener)

setMaxListeners

fun setMaxListeners(n: Number)