Struct CallFunctionOnParams

pub struct CallFunctionOnParams {

    pub function_declaration: String,
    pub object_id: Option<RemoteObjectId>,
    pub arguments: Option<Vec<CallArgument>>,
    pub silent: Option<bool>,
    pub return_by_value: Option<bool>,
    pub generate_preview: Option<bool>,
    pub user_gesture: Option<bool>,
    pub await_promise: Option<bool>,
    pub execution_context_id: Option<ExecutionContextId>,
    pub object_group: Option<String>,
    pub throw_on_side_effect: Option<bool>,
    pub unique_context_id: Option<String>,
    pub serialization_options: Option<SerializationOptions>,
}

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

Fields

function_declaration: String

Declaration of the function to call.

object_id: Option<RemoteObjectId>

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

arguments: Option<Vec<CallArgument>>

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

silent: Option<bool>

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

return_by_value: Option<bool>

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

generate_preview: Option<bool>

Whether preview should be generated for the result.

user_gesture: Option<bool>

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

await_promise: Option<bool>

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

execution_context_id: Option<ExecutionContextId>

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

object_group: Option<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.

throw_on_side_effect: Option<bool>

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

unique_context_id: Option<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.

serialization_options: Option<SerializationOptions>

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

Implementations

impl CallFunctionOnParams

pub fn new(function_declaration: impl Into<String>) -> Self

impl CallFunctionOnParams

pub fn builder() -> CallFunctionOnParamsBuilder

impl CallFunctionOnParams

pub const IDENTIFIER: &'static str = "Runtime.callFunctionOn"

Trait Implementations

impl Clone for CallFunctionOnParams

fn clone(&self) -> CallFunctionOnParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Command for CallFunctionOnParams

type Response = CallFunctionOnReturns

The type of the response this request triggers on the chromium server

fn response_from_value(response: Value) -> Result<Self::Response, Error>

deserialize the response from json

impl Debug for CallFunctionOnParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallFunctionOnParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EvaluateParams> for CallFunctionOnParams

fn from(params: EvaluateParams) -> CallFunctionOnParams

Converts to this type from the input type.

impl<T: Into<String>> From<T> for CallFunctionOnParams

fn from(url: T) -> Self

Converts to this type from the input type.

impl Method for CallFunctionOnParams

fn identifier(&self) -> MethodId

The whole string identifier for this method like: DOM.removeNode

fn domain_name(&self) -> Cow<'static, str>

The name of the domain this method belongs to: DOM

fn method_name(&self) -> Cow<'static, str>

The standalone identifier of the method inside the domain: removeNode

fn split(&self) -> (Cow<'static, str>, Cow<'static, str>)

Tuple of (domain_name, method_name) : (DOM, removeNode)

impl MethodType for CallFunctionOnParams

fn method_id() -> MethodId

where Self: Sized,

The identifier for this event’s method field

impl PartialEq for CallFunctionOnParams

fn eq(&self, other: &CallFunctionOnParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CallFunctionOnParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CallFunctionOnParams