WebContents

open external class WebContents : EventEmitter

Types

Companion

object Companion

Functions

addListener

open fun addListener(event: String, listener: (event: Event) -> Unit): WebContents

open fun addListener(event: String, listener: (event: IpcMainEvent) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, params: ContextMenuParams) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, details: Details) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, input: Input) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, result: Result) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, webContents: WebContents) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, favicons: Array<String>) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, killed: Boolean) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, url: String) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, color: String?) -> Unit): WebContents

open fun addListener(event: String, listener: (event: IpcMainEvent, guestWebContents: WebContents) -> Unit): WebContents

open fun addListener(event: String, listener: (event: IpcMainEvent, moduleName: String) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, dirtyRect: Rectangle, image: NativeImage) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, webPreferences: WebPreferences, params: Record<String, String>) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, devices: Array<BluetoothDevice>, callback: (deviceId: String) -> Unit) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, channel: String, args: Any) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, preloadPath: String, error: Error) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, name: String, version: String) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, authenticationResponseDetails: AuthenticationResponseDetails, authInfo: AuthInfo, callback: (username: String, password: String) -> Unit) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, url: String, certificateList: Array<Certificate>, callback: (certificate: Certificate) -> Unit) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, level: Number, message: String, line: Number, sourceId: String) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, url: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, url: String, error: String, certificate: Certificate, callback: (isTrusted: Boolean) -> Unit) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, type: String, image: NativeImage, scale: Number, size: Size, hotspot: Point) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, url: String, isInPlace: Boolean, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, errorCode: Number, errorDescription: String, validatedURL: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun addListener(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun addListener(event: String, listener: (event: NewWindowEvent, url: String, frameName: String, disposition: String, options: BrowserWindowConstructorOptions, additionalFeatures: Array<String>, referrer: Referrer) -> Unit): WebContents

open fun addListener(event: String, listener: Function<*>): WebContents

open fun addListener(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun addListener(event: String, listener: (args: Any) -> Unit): EventEmitter

addWorkSpace

open fun addWorkSpace(path: String)

beginFrameSubscription

open fun beginFrameSubscription(callback: (image: NativeImage, dirtyRect: Rectangle) -> Unit)

open fun beginFrameSubscription(onlyDirty: Boolean, callback: (image: NativeImage, dirtyRect: Rectangle) -> Unit)

canGoBack

open fun canGoBack(): Boolean

canGoForward

open fun canGoForward(): Boolean

canGoToOffset

open fun canGoToOffset(offset: Number): Boolean

capturePage

open fun capturePage(rect: Rectangle = definedExternally): Promise<NativeImage>

clearHistory

open fun clearHistory()

closeDevTools

open fun closeDevTools()

copy

open fun copy()

copyImageAt

open fun copyImageAt(x: Number, y: Number)

cut

open fun cut()

decrementCapturerCount

open fun decrementCapturerCount(stayHidden: Boolean = definedExternally)

delete

open fun delete()

disableDeviceEmulation

open fun disableDeviceEmulation()

downloadURL

open fun downloadURL(url: String)

emit

open fun emit(event: Any, vararg args: Any): Boolean

open fun emit(event: String, vararg args: Any): Boolean

enableDeviceEmulation

open fun enableDeviceEmulation(parameters: Parameters)

endFrameSubscription

open fun endFrameSubscription()

eventNames

open fun eventNames(): Array<dynamic>

executeJavaScript

open fun executeJavaScript(code: String, userGesture: Boolean = definedExternally): Promise<Any>

executeJavaScriptInIsolatedWorld

open fun executeJavaScriptInIsolatedWorld(worldId: Number, scripts: Array<WebSource>, userGesture: Boolean = definedExternally): Promise<Any>

findInPage

open fun findInPage(text: String, options: FindInPageOptions = definedExternally): Number

focus

open fun focus()

getAllSharedWorkers

open fun getAllSharedWorkers(): Array<SharedWorkerInfo>

getFrameRate

open fun getFrameRate(): Number

getMaxListeners

open fun getMaxListeners(): Number

getOSProcessId

open fun getOSProcessId(): Number

getPrinters

open fun getPrinters(): Array<PrinterInfo>

getProcessId

open fun getProcessId(): Number

getTitle

open fun getTitle(): String

getType

open fun getType(): String

getURL

open fun getURL(): String

getUserAgent

open fun getUserAgent(): String

getWebRTCIPHandlingPolicy

open fun getWebRTCIPHandlingPolicy(): String

getZoomFactor

open fun getZoomFactor(): Number

getZoomLevel

open fun getZoomLevel(): Number

goBack

open fun goBack()

goForward

open fun goForward()

goToIndex

open fun goToIndex(index: Number)

goToOffset

open fun goToOffset(offset: Number)

incrementCapturerCount

open fun incrementCapturerCount(size: Size = definedExternally, stayHidden: Boolean = definedExternally)

insertCSS

open fun insertCSS(css: String, options: InsertCSSOptions = definedExternally): Promise<String>

insertText

open fun insertText(text: String): Promise<Unit>

inspectElement

open fun inspectElement(x: Number, y: Number)

inspectServiceWorker

open fun inspectServiceWorker()

inspectSharedWorker

open fun inspectSharedWorker()

inspectSharedWorkerById

open fun inspectSharedWorkerById(workerId: String)

invalidate

open fun invalidate()

isAudioMuted

open fun isAudioMuted(): Boolean

isBeingCaptured

open fun isBeingCaptured(): Boolean

isCrashed

open fun isCrashed(): Boolean

isCurrentlyAudible

open fun isCurrentlyAudible(): Boolean

isDestroyed

open fun isDestroyed(): Boolean

isDevToolsFocused

open fun isDevToolsFocused(): Boolean

isDevToolsOpened

open fun isDevToolsOpened(): Boolean

isFocused

open fun isFocused(): Boolean

isLoading

open fun isLoading(): Boolean

isLoadingMainFrame

open fun isLoadingMainFrame(): Boolean

isOffscreen

open fun isOffscreen(): Boolean

isPainting

open fun isPainting(): Boolean

isWaitingForResponse

open fun isWaitingForResponse(): Boolean

listenerCount

open fun listenerCount(type: Any): Number

open fun listenerCount(type: String): Number

listeners

open fun listeners(event: Any): Array<Function<*>>

open fun listeners(event: String): Array<Function<*>>

loadFile

open fun loadFile(filePath: String, options: LoadFileOptions = definedExternally): Promise<Unit>

loadURL

open fun loadURL(url: String, options: LoadURLOptions = definedExternally): Promise<Unit>

off

open fun off(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun off(event: String, listener: (args: Any) -> Unit): EventEmitter

open fun on(event: String, listener: (event: Event) -> Unit): WebContents

open fun on(event: String, listener: (event: IpcMainEvent) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, params: ContextMenuParams) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, details: Details) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, input: Input) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, result: Result) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, webContents: WebContents) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, favicons: Array<String>) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, killed: Boolean) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, url: String) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, color: String?) -> Unit): WebContents

open fun on(event: String, listener: (event: IpcMainEvent, guestWebContents: WebContents) -> Unit): WebContents

open fun on(event: String, listener: (event: IpcMainEvent, moduleName: String) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, dirtyRect: Rectangle, image: NativeImage) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, webPreferences: WebPreferences, params: Record<String, String>) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, devices: Array<BluetoothDevice>, callback: (deviceId: String) -> Unit) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, channel: String, args: Any) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, preloadPath: String, error: Error) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, name: String, version: String) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, authenticationResponseDetails: AuthenticationResponseDetails, authInfo: AuthInfo, callback: (username: String, password: String) -> Unit) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, url: String, certificateList: Array<Certificate>, callback: (certificate: Certificate) -> Unit) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, level: Number, message: String, line: Number, sourceId: String) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, url: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, url: String, error: String, certificate: Certificate, callback: (isTrusted: Boolean) -> Unit) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, type: String, image: NativeImage, scale: Number, size: Size, hotspot: Point) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, url: String, isInPlace: Boolean, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, errorCode: Number, errorDescription: String, validatedURL: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun on(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun on(event: String, listener: (event: NewWindowEvent, url: String, frameName: String, disposition: String, options: BrowserWindowConstructorOptions, additionalFeatures: Array<String>, referrer: Referrer) -> Unit): WebContents

open fun on(event: String, listener: Function<*>): WebContents

open fun on(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun on(event: String, listener: (args: Any) -> Unit): EventEmitter

once

open fun once(event: String, listener: (event: Event) -> Unit): WebContents

open fun once(event: String, listener: (event: IpcMainEvent) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, params: ContextMenuParams) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, details: Details) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, input: Input) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, result: Result) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, webContents: WebContents) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, favicons: Array<String>) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, killed: Boolean) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, url: String) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, color: String?) -> Unit): WebContents

open fun once(event: String, listener: (event: IpcMainEvent, guestWebContents: WebContents) -> Unit): WebContents

open fun once(event: String, listener: (event: IpcMainEvent, moduleName: String) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, dirtyRect: Rectangle, image: NativeImage) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, webPreferences: WebPreferences, params: Record<String, String>) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, devices: Array<BluetoothDevice>, callback: (deviceId: String) -> Unit) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, channel: String, args: Any) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, preloadPath: String, error: Error) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, name: String, version: String) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, authenticationResponseDetails: AuthenticationResponseDetails, authInfo: AuthInfo, callback: (username: String, password: String) -> Unit) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, url: String, certificateList: Array<Certificate>, callback: (certificate: Certificate) -> Unit) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, level: Number, message: String, line: Number, sourceId: String) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, url: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, url: String, error: String, certificate: Certificate, callback: (isTrusted: Boolean) -> Unit) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, type: String, image: NativeImage, scale: Number, size: Size, hotspot: Point) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, url: String, isInPlace: Boolean, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, errorCode: Number, errorDescription: String, validatedURL: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun once(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun once(event: String, listener: (event: NewWindowEvent, url: String, frameName: String, disposition: String, options: BrowserWindowConstructorOptions, additionalFeatures: Array<String>, referrer: Referrer) -> Unit): WebContents

open fun once(event: String, listener: Function<*>): WebContents

open fun once(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun once(event: String, listener: (args: Any) -> Unit): EventEmitter

openDevTools

open fun openDevTools(options: OpenDevToolsOptions = definedExternally)

paste

open fun paste()

pasteAndMatchStyle

open fun pasteAndMatchStyle()

prependListener

open fun prependListener(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun prependListener(event: String, listener: (args: Any) -> Unit): EventEmitter

prependOnceListener

open fun prependOnceListener(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun prependOnceListener(event: String, listener: (args: Any) -> Unit): EventEmitter

open fun print(options: WebContentsPrintOptions = definedExternally, callback: (success: Boolean, failureReason: String) -> Unit = definedExternally)

printToPDF

open fun printToPDF(options: PrintToPDFOptions): Promise<Buffer>

rawListeners

open fun rawListeners(event: Any): Array<Function<*>>

open fun rawListeners(event: String): Array<Function<*>>

redo

open fun redo()

reload

open fun reload()

reloadIgnoringCache

open fun reloadIgnoringCache()

removeAllListeners

open fun removeAllListeners(event: Any = definedExternally): EventEmitter

open fun removeAllListeners(event: String = definedExternally): EventEmitter

removeInsertedCSS

open fun removeInsertedCSS(key: String): Promise<Unit>

removeListener

open fun removeListener(event: String, listener: (event: Event) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: IpcMainEvent) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, params: ContextMenuParams) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, details: Details) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, input: Input) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, result: Result) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, webContents: WebContents) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, favicons: Array<String>) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, killed: Boolean) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, url: String) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, color: String?) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: IpcMainEvent, guestWebContents: WebContents) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: IpcMainEvent, moduleName: String) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, dirtyRect: Rectangle, image: NativeImage) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, webPreferences: WebPreferences, params: Record<String, String>) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, devices: Array<BluetoothDevice>, callback: (deviceId: String) -> Unit) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, channel: String, args: Any) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, preloadPath: String, error: Error) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, name: String, version: String) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, authenticationResponseDetails: AuthenticationResponseDetails, authInfo: AuthInfo, callback: (username: String, password: String) -> Unit) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, url: String, certificateList: Array<Certificate>, callback: (certificate: Certificate) -> Unit) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, level: Number, message: String, line: Number, sourceId: String) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, url: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, url: String, error: String, certificate: Certificate, callback: (isTrusted: Boolean) -> Unit) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, type: String, image: NativeImage, scale: Number, size: Size, hotspot: Point) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, url: String, isInPlace: Boolean, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, errorCode: Number, errorDescription: String, validatedURL: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents

open fun removeListener(event: String, listener: (event: Event, url: String, httpResponseCode: Number, httpStatusText: String, isMainFrame: Boolean, frameProcessId: Number, frameRoutingId: Number) -> Unit): WebContents