puppeteer/new-docs/puppeteer.protocol.runtime.callfunctiononrequest.md
2020-07-13 14:01:35 +01:00

2.7 KiB

Home > puppeteer > Protocol > Runtime > CallFunctionOnRequest

Protocol.Runtime.CallFunctionOnRequest interface

Signature:

export interface CallFunctionOnRequest 

Properties

Property Type Description
arguments CallArgument[] Call arguments. All call arguments must belong to the same JavaScript world as the target object.
awaitPromise boolean Whether execution should await for resulting value and return once awaited promise is resolved.
executionContextId ExecutionContextId Specifies execution context which global object will be used to call function on. Either executionContextId or objectId should be specified.
functionDeclaration string Declaration of the function to call.
generatePreview boolean Whether preview should be generated for the result.
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 RemoteObjectId Identifier of the object to call function on. Either objectId or executionContextId should be specified.
returnByValue boolean Whether the result is expected to be a JSON object which should be sent by value.
silent boolean In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
userGesture boolean Whether execution should be treated as initiated by user in the UI.