WebBrowser

class WebBrowser(val sessionId: String, val httpRequestInfo: HttpRequestInfo, val kweb: Kweb)(source)

A conduit for communicating with a remote web browser, can be used to execute JavaScript and evaluate JavaScript expressions and retrieve the result.

Constructors

WebBrowser

constructor(sessionId: String, httpRequestInfo: HttpRequestInfo, kweb: Kweb)

Types

CatcherType

enum CatcherType : Enum<WebBrowser.CatcherType>

FuncDeclaration

data class FuncDeclaration(val js: String, val params: String)

OutboundMessageCatcher

data class OutboundMessageCatcher(var catcherType: WebBrowser.CatcherType, val functionList: MutableList<FunctionCall>)

Properties

doc

val doc: Document

gurl

val gurl: KVar<URL>

The absolute URL of the page, mapped to a io.mola.galimatias.URL for convenience.

htmlDocument

val htmlDocument: AtomicReference<Document?>

During page render, the initial HTML document will be available for modification as a JSoup Document in this AtomicReference.

httpRequestInfo

val httpRequestInfo: HttpRequestInfo

kweb

val kweb: Kweb

outboundMessageCatcher

val outboundMessageCatcher: ThreadLocal<WebBrowser.OutboundMessageCatcher?>

Allow us to catch outbound messages temporarily and only for this thread. This is used for immediate execution of event handlers, see Element.onImmediate

sessionId

val sessionId: String

url

val url: KVar<String>

The URL of the page, relative to the origin - so for the page http://foo/bar?baz#1, the value would be /bar?baz#1.

window

val window: Window

Functions

addCloseListener

fun addCloseListener(listener: () -> Unit): Int

batch

fun <R> batch(catchingType: WebBrowser.CatcherType, f: () -> R): R

callJsFunction

fun callJsFunction(jsBody: String, vararg args: JsonElement)

Calls a JavaScript function in the browser passing it the supplied parameters, which will be substituted into jsBody wherever a {} is present.

callJsFunctionWithCallback

fun callJsFunctionWithCallback(jsBody: String, callbackId: Int, callback: (JsonElement) -> Unit, vararg args: JsonElement)

Calls a JavaScript function that can return a value via a callback

callJsFunctionWithResult

suspend fun callJsFunctionWithResult(jsBody: String, vararg args: JsonElement): JsonElement

Calls a JavaScript function that can return a value, note that to do this jsBody MUST end with a return statement, eg:

catchOutbound

fun <R> catchOutbound(catchingType: WebBrowser.CatcherType, f: () -> R): Pair<List<FunctionCall>, R>

Execute a block of code in which any JavaScript sent to the browser during the execution of the block will be stored and returned by this function.

fun close()

generateId

fun generateId(): String

isCatchingOutbound

fun isCatchingOutbound(): WebBrowser.CatcherType?

Are outbound messages being cached for this thread (for example, because we're inside an immediateEvent callback block)?

onMessage

fun onMessage(customFunction: (data: JsonElement?) -> Unit)

removeCallback

fun removeCallback(callbackId: Int)

removeCloseListener

fun removeCloseListener(id: Int)

sendMessage

fun sendMessage(data: JsonElement? = null)