`Runtime.callFunctionOn`

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

Domain: Runtime stable

Parameters

Name	Type	Description
`functionDeclaration`	`string`	Declaration of the function to call.
`objectId` (optional)	`RemoteObjectId`	Identifier of the object to call function on. Either objectId or executionContextId should be specified.
`arguments` (optional)	`array`	Call arguments. All call arguments must belong to the same JavaScript world as the target object.
`silent` (optional)	`boolean`	In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides `setPauseOnException` state.
`returnByValue` (optional)	`boolean`	Whether the result is expected to be a JSON object which should be sent by value. Can be overriden by `serializationOptions`.
`generatePreview` (optional)	`boolean`	Whether preview should be generated for the result.
`userGesture` (optional)	`boolean`	Whether execution should be treated as initiated by user in the UI.
`awaitPromise` (optional)	`boolean`	Whether execution should `await` for resulting value and return once awaited promise is resolved.
`executionContextId` (optional)	`ExecutionContextId`	Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.
`objectGroup` (optional)	`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.
`throwOnSideEffect` (optional)	`boolean`	Whether to throw an exception if side effect cannot be ruled out during evaluation.
`uniqueContextId` (optional)	`string`	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`.
`serializationOptions` (optional)	`SerializationOptions`	Specifies the result serialization. If provided, overrides `generatePreview` and `returnByValue`.

Returns

Name	Type	Description
`result`	`RemoteObject`	Call result.
`exceptionDetails`	`ExceptionDetails`	Exception details.

Example Request

{
  "id": 1,
  "method": "Runtime.callFunctionOn",
  "params": {
    "functionDeclaration": "function() { return this.toString(); }"
  }
}

Example Response

{
  "id": 1,
  "result": {
    "result": {
      "type": "string",
      "value": "Example Domain"
    },
    "exceptionDetails": "exceptionDetails-value"
  }
}

Usage in Node.js

const result = await send('Runtime.callFunctionOn', {"functionDeclaration": "function() { return this.toString(); }"});
console.log(result);
// {"result": {"type": "string", "value": "Example Domain"}, "exceptionDetails": "exceptionDetails-value"}