CallFunctionOnParameter

@Serializable
data class CallFunctionOnParameter(val functionDeclaration: String, val objectId: String? = null, val arguments: List<Runtime.CallArgument>? = null, val silent: Boolean? = null, val returnByValue: Boolean? = null, val generatePreview: Boolean? = null, val userGesture: Boolean? = null, val awaitPromise: Boolean? = null, val executionContextId: Int? = null, val objectGroup: String? = null, val throwOnSideEffect: Boolean? = null, val uniqueContextId: String? = null, val serializationOptions: Runtime.SerializationOptions? = null)

Constructors

Link copied to clipboard
constructor(functionDeclaration: String, objectId: String? = null, arguments: List<Runtime.CallArgument>? = null, silent: Boolean? = null, returnByValue: Boolean? = null, generatePreview: Boolean? = null, userGesture: Boolean? = null, awaitPromise: Boolean? = null, executionContextId: Int? = null, objectGroup: String? = null, throwOnSideEffect: Boolean? = null, uniqueContextId: String? = null, serializationOptions: Runtime.SerializationOptions? = null)

Properties

Link copied to clipboard

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

Link copied to clipboard
val awaitPromise: Boolean? = null

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

Link copied to clipboard
val executionContextId: Int? = null

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

Link copied to clipboard

Declaration of the function to call.

Link copied to clipboard

Whether preview should be generated for the result.

Link copied to clipboard
val objectGroup: String? = null

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.

Link copied to clipboard
val objectId: String? = null

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

Link copied to clipboard
val returnByValue: Boolean? = null

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

Link copied to clipboard

Specifies the result serialization. If provided, overrides generatePreview and returnByValue.

Link copied to clipboard
val silent: Boolean? = null

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

Link copied to clipboard

Whether to throw an exception if side effect cannot be ruled out during evaluation.

Link copied to clipboard
val uniqueContextId: String? = null

An alternative way to specify the execution context to call function on. Compared to contextId that may be reused across processes, this is guaranteed to be system-unique, so it can be used to prevent accidental function call in context different than intended (e.g. as a result of navigation across process boundaries). This is mutually exclusive with executionContextId.

Link copied to clipboard
val userGesture: Boolean? = null

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