pl.wendigo.chrome.api.runtime / CallFunctionOnRequest

CallFunctionOnRequest

data class CallFunctionOnRequest (source)

Represents request frame that can be used with Runtime#callFunctionOn operation call.

Calls function with given declaration on the given object. Object group of the result is inherited from the target object.

Link
Runtime#callFunctionOn method documentation.

See Also

RuntimeOperations.callFunctionOn

Constructors

<init>

CallFunctionOnRequest(functionDeclaration: String, objectId: RemoteObjectId? = null, arguments: List<CallArgument>? = null, silent: Boolean? = null, returnByValue: Boolean? = null, generatePreview: Boolean? = null, userGesture: Boolean? = null, awaitPromise: Boolean? = null, executionContextId: ExecutionContextId? = null, objectGroup: String? = null)

Represents request frame that can be used with Runtime#callFunctionOn operation call.

Properties

arguments

val arguments: List<CallArgument>?

Call arguments. All call arguments must belong to the same JavaScript world as the target object.

awaitPromise

val awaitPromise: Boolean?

Whether execution should await for resulting value and return once awaited promise is resolved.

executionContextId

val executionContextId: ExecutionContextId?

Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.

functionDeclaration

val functionDeclaration: String

Declaration of the function to call.

generatePreview

val generatePreview: Boolean?

Whether preview should be generated for the result.

objectGroup

val objectGroup: String?

Symbolic group name that can be used to release multiple objects. If objectGroup is not specified and objectId is, objectGroup will be inherited from object.

objectId

val objectId: RemoteObjectId?

Identifier of the object to call function on. Either objectId or executionContextId should be specified.

returnByValue

val returnByValue: Boolean?

Whether the result is expected to be a JSON object which should be sent by value.

silent

val silent: Boolean?

In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.

userGesture

val userGesture: Boolean?

Whether execution should be treated as initiated by user in the UI.