JsonRpc.InvokeWithParameterObjectAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
InvokeWithParameterObjectAsync(String, Object, CancellationToken) |
Вызывает заданный метод на сервере JSON-RPC. |
InvokeWithParameterObjectAsync(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken) |
Вызывает заданный метод на сервере JSON-RPC. |
InvokeWithParameterObjectAsync<TResult>(String, Object, CancellationToken) |
Вызывает заданный метод на сервере JSON-RPC. |
InvokeWithParameterObjectAsync<TResult>(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken) |
Вызывает заданный метод на сервере JSON-RPC. |
InvokeWithParameterObjectAsync(String, Object, CancellationToken)
Вызывает заданный метод на сервере JSON-RPC.
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
Параметры
- targetName
- String
Имя вызываемого метода. Не должен иметь значение NULL или быть пустым.
- argument
- Object
Объект, свойства которого соответствуют именам параметров в целевом методе. Должен быть сериализуемым с помощью выбранного .IJsonRpcMessageFormatter
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
Возвращаемое значение
Задача, которая завершается после выполнения метода сервера и возвращает результат.
Исключения
Задача "Результат" завершается сбоем, если канал связи заканчивается до возвращения результата с сервера.
Задача результатов завершается сбоем с этим исключением, если метод сервера создает исключение.
Задача "Результат" завершается сбоем с этим исключением, если targetName
метод не зарегистрирован на сервере.
Если targetName
значение равно NULL.
Если этот экземпляр JsonRpc удален.
Задача результатов завершается ошибкой, если сервер не имеет целевого объекта.
Применяется к
InvokeWithParameterObjectAsync(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)
Вызывает заданный метод на сервере JSON-RPC.
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
Параметры
- targetName
- String
Имя вызываемого метода. Не должен иметь значение NULL или быть пустым.
- argument
- Object
Объект, свойства которого соответствуют именам параметров в целевом методе. Должен быть сериализуемым с помощью выбранного .IJsonRpcMessageFormatter
- argumentDeclaredTypes
- IReadOnlyDictionary<String,Type>
Словарь Type объектов, описывающих, как ожидается тип каждой IReadOnlyDictionary<TKey,TValue> записи в предоставленной строке argument
сервером.
Если этот параметр указан, он должен иметь точно такой же набор ключей, что argument
и не null
содержать значений.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
Возвращаемое значение
Задача, которая завершается ответом с сервера JSON-RPC.
Применяется к
InvokeWithParameterObjectAsync<TResult>(String, Object, CancellationToken)
Вызывает заданный метод на сервере JSON-RPC.
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)
Параметры типа
- TResult
Тип результата метода.
Параметры
- targetName
- String
Имя вызываемого метода. Не должен иметь значение NULL или быть пустым.
- argument
- Object
Объект, свойства которого соответствуют именам параметров в целевом методе. Должен быть сериализуемым с помощью выбранного .IJsonRpcMessageFormatter
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
Возвращаемое значение
Задача, которая завершается после выполнения метода сервера и возвращает результат.
Исключения
Задача "Результат" завершается сбоем, если канал связи заканчивается до возвращения результата с сервера.
Задача результатов завершается сбоем с этим исключением, если метод сервера создает исключение.
Задача "Результат" завершается сбоем с этим исключением, если targetName
метод не зарегистрирован на сервере.
Если targetName
значение равно NULL.
Если этот экземпляр JsonRpc удален.
Задача результатов завершается ошибкой, если сервер не имеет целевого объекта.
Применяется к
InvokeWithParameterObjectAsync<TResult>(String, Object, IReadOnlyDictionary<String,Type>, CancellationToken)
Вызывает заданный метод на сервере JSON-RPC.
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)
Параметры типа
- TResult
Тип результата метода.
Параметры
- targetName
- String
Имя вызываемого метода. Не должен иметь значение NULL или быть пустым.
- argument
- Object
Объект, свойства которого соответствуют именам параметров в целевом методе. Должен быть сериализуемым с помощью выбранного .IJsonRpcMessageFormatter
- argumentDeclaredTypes
- IReadOnlyDictionary<String,Type>
Словарь Type объектов, описывающих, как ожидается тип каждой IReadOnlyDictionary<TKey,TValue> записи в предоставленной строке argument
сервером.
Если этот параметр указан, он должен иметь точно такой же набор ключей, что argument
и не null
содержать значений.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
Возвращаемое значение
Задача, которая завершается ответом с сервера JSON-RPC.