Microsoft.JSInterop

Provides convenience methods to produce a .

Creates a new instance of .

The reference type to track. An instance of .

Wraps a JS interop argument, indicating that the value should not be serialized as JSON but instead should be passed as a reference. To avoid leaking memory, the reference must later be disposed by JS code or by .NET code.

The type of the value to wrap.

Initializes a new instance of .

The value to pass by reference.

Gets the object instance represented by this wrapper.

Stops tracking this object reference, allowing it to be garbage collected (if there are no other references to it). Once the instance is disposed, it can no longer be used in interop calls from JavaScript code.

Represents a reference to a JavaScript object whose functions can be invoked synchronously.

Invokes the specified JavaScript function synchronously.

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Represents an instance of a JavaScript runtime to which calls may be dispatched.

Invokes the specified JavaScript function synchronously.

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Represents a reference to a JavaScript object.

Invokes the specified JavaScript function asynchronously. will apply timeouts to this operation based on the value configured in . To dispatch a call with a different, or no timeout, consider using .

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Invokes the specified JavaScript function asynchronously.

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. A cancellation token to signal the cancellation of the operation. Specifying this parameter will override any default cancellations such as due to timeouts () from being applied. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Represents an instance of a JavaScript runtime to which calls may be dispatched.

Invokes the specified JavaScript function asynchronously. will apply timeouts to this operation based on the value configured in . To dispatch a call with a different timeout, or no timeout, consider using .

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Invokes the specified JavaScript function asynchronously.

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. A cancellation token to signal the cancellation of the operation. Specifying this parameter will override any default cancellations such as due to timeouts () from being applied. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Represents a reference to a JavaScript object whose functions can be invoked synchronously without JSON marshalling.

Invokes the JavaScript function registered with the specified identifier.

The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The result of the function invocation.

Invokes the JavaScript function registered with the specified identifier.

The type of the first argument. The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The first argument. The result of the function invocation.

Invokes the JavaScript function registered with the specified identifier.

The type of the first argument. The type of the second argument. The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The first argument. The second argument. The result of the function invocation.

Invokes the JavaScript function registered with the specified identifier.

The type of the first argument. The type of the second argument. The type of the third argument. The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The first argument. The second argument. The third argument. The result of the function invocation.

Represents an instance of a JavaScript runtime to which calls may be dispatched without JSON marshalling. Not all JavaScript runtimes support this capability. Currently it is only supported on WebAssembly and for security reasons, will never be supported for .NET code that runs on the server. This is an advanced mechanism that should only be used in performance-critical scenarios.

Invokes the JavaScript function registered with the specified identifier.

The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The result of the function invocation.

Invokes the JavaScript function registered with the specified identifier.

The type of the first argument. The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The first argument. The result of the function invocation.

Invokes the JavaScript function registered with the specified identifier.

The type of the first argument. The type of the second argument. The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The first argument. The second argument. The result of the function invocation.

Invokes the JavaScript function registered with the specified identifier.

The type of the first argument. The type of the second argument. The type of the third argument. The .NET type corresponding to the function's return value type. The identifier used when registering the target function. The first argument. The second argument. The third argument. The result of the function invocation.

Implements functionality for .

Inititializes a new instance.

The used for invoking JS interop calls. The unique identifier.

Implements functionality for .

The unique identifier assigned to this instance.

Inititializes a new instance.

The used for invoking JS interop calls. The unique identifier.

Provides methods that receive incoming calls from JS to .NET.

Receives a call from JS to .NET, locating and invoking the specified method.

The . The . A JSON representation of the parameters. A JSON representation of the return value, or null.

Receives a call from JS to .NET, locating and invoking the specified method asynchronously.

The . The . A JSON representation of the parameters. A JSON representation of the return value, or null.

Receives notification that a call from .NET to JS has finished, marking the associated as completed.

All exceptions from are caught are delivered via JS interop to the JavaScript side when it requests confirmation, as the mechanism to call relies on using JS->.NET interop. This overload is meant for directly triggering completion callbacks for .NET -> JS operations without going through JS interop, so the callsite for this method is responsible for handling any possible exception generated from the arguments passed in as parameters. The . The serialized arguments for the callback completion. This method can throw any exception either from the argument received or as a result of executing any callback synchronously upon completion.

Information about a JSInterop call from JavaScript to .NET.

Initializes a new instance of .

The name of the assembly containing the method. The identifier of the method to be invoked. The object identifier for instance method calls. The call identifier.

Gets the name of the assembly containing the method. Only one of or may be specified.

Gets the identifier of the method to be invoked. This is the value specified in the .

Gets the object identifier for instance method calls. Only one of or may be specified.

Gets the call identifier. This value is when the client does not expect a value to be returned.

Result of a .NET invocation that is returned to JavaScript.

Constructor for a failed invocation.

The that caused the failure. The error kind.

Constructor for a successful invocation.

The result.

Gets the that caused the failure.

Gets the error kind.

Gets the result of a successful invocation.

if the invocation succeeded, otherwise .

Describes the type of result expected from a JS interop call.

Indicates that the returned value is not treated in a special way.

Indicates that the returned value is to be treated as a JS object reference.

Represents errors that occur during an interop call from .NET to JavaScript.

Constructs an instance of .

The exception message.

Constructs an instance of .

The exception message. The inner exception.

Invokes the specified JavaScript function synchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. JSON-serializable arguments.

Abstract base class for an in-process JavaScript runtime.

Initializes a new instance of .

Invokes the specified JavaScript function synchronously.

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Performs a synchronous function invocation.

The identifier for the function to invoke. A JSON representation of the arguments. A JSON representation of the result.

Performs a synchronous function invocation.

The identifier for the function to invoke. A JSON representation of the arguments. The type of result expected from the invocation. The instance ID of the target JS object. A JSON representation of the result.

Extensions for .

Invokes the specified JavaScript function synchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. JSON-serializable arguments.

Identifies a .NET method as allowing invocation from JavaScript code. Any method marked with this attribute may receive arbitrary parameter values from untrusted callers. All inputs should be validated carefully.

Gets the identifier for the method. The identifier must be unique within the scope of an assembly. If not set, the identifier is taken from the name of the method. In this case the method name must be unique within the assembly.

Constructs an instance of without setting an identifier for the method.

Constructs an instance of using the specified identifier.

An identifier for the method, which must be unique within the scope of the assembly.

Extensions for .

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. JSON-serializable arguments. A that represents the asynchronous invocation operation.

Invokes the specified JavaScript function asynchronously. will apply timeouts to this operation based on the value configured in . To dispatch a call with a different timeout, or no timeout, consider using .

The . The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Invokes the specified JavaScript function asynchronously.

The JSON-serializable return type. The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. A cancellation token to signal the cancellation of the operation. Specifying this parameter will override any default cancellations such as due to timeouts () from being applied. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. A cancellation token to signal the cancellation of the operation. Specifying this parameter will override any default cancellations such as due to timeouts () from being applied. JSON-serializable arguments. A that represents the asynchronous invocation operation.

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. The duration after which to cancel the async operation. Overrides default timeouts (). JSON-serializable arguments. A that represents the asynchronous invocation operation.

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function someScope.someFunction on the target instance. The duration after which to cancel the async operation. Overrides default timeouts (). JSON-serializable arguments. A that represents the asynchronous invocation operation.

Abstract base class for a JavaScript runtime.

Initializes a new instance of .

Gets the used to serialize and deserialize interop payloads.

Gets or sets the default timeout for asynchronous JavaScript calls.

Invokes the specified JavaScript function asynchronously. will apply timeouts to this operation based on the value configured in . To dispatch a call with a different, or no timeout, consider using .

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Invokes the specified JavaScript function asynchronously.

The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. A cancellation token to signal the cancellation of the operation. Specifying this parameter will override any default cancellations such as due to timeouts () from being applied. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Begins an asynchronous function invocation.

The identifier for the function invocation, or zero if no async callback is required. The identifier for the function to invoke. A JSON representation of the arguments.

Begins an asynchronous function invocation.

The identifier for the function invocation, or zero if no async callback is required. The identifier for the function to invoke. A JSON representation of the arguments. The type of result expected from the invocation. The instance ID of the target JS object.

Completes an async JS interop call from JavaScript to .NET

The . The .

Stops tracking the specified .NET object reference. This may be invoked either by disposing a DotNetObjectRef in .NET code, or via JS interop by calling "dispose" on the corresponding instance in JavaScript code

The ID of the .

Extensions for .

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. JSON-serializable arguments. A that represents the asynchronous invocation operation.

Invokes the specified JavaScript function asynchronously. will apply timeouts to this operation based on the value configured in . To dispatch a call with a different timeout, or no timeout, consider using .

The . The JSON-serializable return type. An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Invokes the specified JavaScript function asynchronously.

The JSON-serializable return type. The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. A cancellation token to signal the cancellation of the operation. Specifying this parameter will override any default cancellations such as due to timeouts () from being applied. JSON-serializable arguments. An instance of obtained by JSON-deserializing the return value.

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. A cancellation token to signal the cancellation of the operation. Specifying this parameter will override any default cancellations such as due to timeouts () from being applied. JSON-serializable arguments. A that represents the asynchronous invocation operation.

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. The duration after which to cancel the async operation. Overrides default timeouts (). JSON-serializable arguments. A that represents the asynchronous invocation operation.

Invokes the specified JavaScript function asynchronously.

The . An identifier for the function to invoke. For example, the value "someScope.someFunction" will invoke the function window.someScope.someFunction. The duration after which to cancel the async operation. Overrides default timeouts (). JSON-serializable arguments. A that represents the asynchronous invocation operation.