JsonRpc.InvokeWithParameterObjectAsync Method

Reference

Definition

Namespace:: StreamJsonRpc

Assembly:: StreamJsonRpc.dll

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmane8f73\StreamJsonRpc.1.5.68

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman5d493\StreamJsonRpc.2.0.208

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmana13ca\StreamJsonRpc.2.1.74

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman29ef6\StreamJsonRpc.2.2.53

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmanc61ca\StreamJsonRpc.2.3.112

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman810ce\StreamJsonRpc.2.4.48

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmanb9d67\StreamJsonRpc.2.5.46

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman90a9c\StreamJsonRpc.2.6.121

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman01f82\StreamJsonRpc.2.7.76

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmaned549\StreamJsonRpc.2.8.28

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmanada9c\StreamJsonRpc.2.9.85

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman64817\StreamJsonRpc.1.3.23

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

InvokeWithParameterObjectAsync(String, Object, CancellationToken)	Invokes a given method on a JSON-RPC server.
InvokeWithParameterObjectAsync(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)	Invokes a given method on a JSON-RPC server.
InvokeWithParameterObjectAsync<TResult>(String, Object, CancellationToken)	Invokes a given method on a JSON-RPC server.
InvokeWithParameterObjectAsync<TResult>(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)	Invokes a given method on a JSON-RPC server.

InvokeWithParameterObjectAsync(String, Object, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task InvokeWithParameterObjectAsync (string targetName, object argument = default, System.Threading.CancellationToken cancellationToken = default);

public System.Threading.Tasks.Task InvokeWithParameterObjectAsync (string targetName, object? argument = default, System.Threading.CancellationToken cancellationToken = default);

member this.InvokeWithParameterObjectAsync : string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function InvokeWithParameterObjectAsync (targetName As String, Optional argument As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

argument: Object

An object whose properties match the names of parameters on the target method. Must be serializable using the selected IJsonRpcMessageFormatter.

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

Returns

Task

A task that completes when the server method executes and returns the result.

Exceptions

OperationCanceledException

Result task fails with this exception if the communication channel ends before the result gets back from the server.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception.

RemoteMethodNotFoundException

Result task fails with this exception if the targetName method has not been registered on the server.

ArgumentNullException

If targetName is null.

ObjectDisposedException

If this instance of JsonRpc has been disposed.

RemoteTargetNotSetException

Result task fails with this exception if the server has no target object.

Applies to

InvokeWithParameterObjectAsync(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task InvokeWithParameterObjectAsync (string targetName, object? argument, System.Collections.Generic.IReadOnlyDictionary<string,Type>? argumentDeclaredTypes, System.Threading.CancellationToken cancellationToken);

member this.InvokeWithParameterObjectAsync : string * obj * System.Collections.Generic.IReadOnlyDictionary<string, Type> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function InvokeWithParameterObjectAsync (targetName As String, argument As Object, argumentDeclaredTypes As IReadOnlyDictionary(Of String, Type), cancellationToken As CancellationToken) As Task

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

argument: Object

An object whose properties match the names of parameters on the target method. Must be serializable using the selected IJsonRpcMessageFormatter.

argumentDeclaredTypes: IReadOnlyDictionary<String,Type>

A dictionary of Type objects that describe how each entry in the IReadOnlyDictionary<TKey,TValue> provided in argument is expected by the server to be typed. If specified, this must have exactly the same set of keys as argument and contain no null values.

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

Returns

Task

A task that completes with the response from the JSON-RPC server.

Applies to

InvokeWithParameterObjectAsync<TResult>(String, Object, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task<TResult> InvokeWithParameterObjectAsync<TResult> (string targetName, object argument = default, System.Threading.CancellationToken cancellationToken = default);

public System.Threading.Tasks.Task<TResult> InvokeWithParameterObjectAsync<TResult> (string targetName, object? argument = default, System.Threading.CancellationToken cancellationToken = default);

member this.InvokeWithParameterObjectAsync : string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>

Public Function InvokeWithParameterObjectAsync(Of TResult) (targetName As String, Optional argument As Object = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TResult)

Type Parameters

TResult

Type of the method result.

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

argument: Object

An object whose properties match the names of parameters on the target method. Must be serializable using the selected IJsonRpcMessageFormatter.

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

Returns

Task<TResult>

A task that completes when the server method executes and returns the result.

Exceptions

OperationCanceledException

Result task fails with this exception if the communication channel ends before the result gets back from the server.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception.

RemoteMethodNotFoundException

Result task fails with this exception if the targetName method has not been registered on the server.

ArgumentNullException

If targetName is null.

ObjectDisposedException

If this instance of JsonRpc has been disposed.

RemoteTargetNotSetException

Result task fails with this exception if the server has no target object.

Applies to

InvokeWithParameterObjectAsync<TResult>(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task<TResult> InvokeWithParameterObjectAsync<TResult> (string targetName, object? argument, System.Collections.Generic.IReadOnlyDictionary<string,Type>? argumentDeclaredTypes, System.Threading.CancellationToken cancellationToken);

member this.InvokeWithParameterObjectAsync : string * obj * System.Collections.Generic.IReadOnlyDictionary<string, Type> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>

Public Function InvokeWithParameterObjectAsync(Of TResult) (targetName As String, argument As Object, argumentDeclaredTypes As IReadOnlyDictionary(Of String, Type), cancellationToken As CancellationToken) As Task(Of TResult)

Type Parameters

TResult

Type of the method result.

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

argument: Object

An object whose properties match the names of parameters on the target method. Must be serializable using the selected IJsonRpcMessageFormatter.

argumentDeclaredTypes: IReadOnlyDictionary<String,Type>

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

Returns

Task<TResult>

A task that completes with the response from the JSON-RPC server.

Applies to

Share via

JsonRpc.InvokeWithParameterObjectAsync Method

Definition

Overloads

InvokeWithParameterObjectAsync(String, Object, CancellationToken)

Parameters

Returns

Exceptions

Applies to

InvokeWithParameterObjectAsync(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)

Parameters

Returns

Applies to

InvokeWithParameterObjectAsync<TResult>(String, Object, CancellationToken)

Type Parameters

Parameters

Returns

Exceptions

Applies to

InvokeWithParameterObjectAsync<TResult>(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)

Type Parameters

Parameters

Returns

Applies to

Additional resources