Interface ISynchronousClient

Contract for Synchronous RESTful API interactions.

This interface allows consumers to provide a custom API accessor client.

Namespace: Telerik.CallHome.OpenAPI.Client
Assembly: Telerik.Windows.Controls.dll

Syntax

public interface ISynchronousClient

Methods

Delete<T>(String, RequestOptions, IReadableConfiguration)

Executes a blocking call to some path using the DELETE http verb.

Declaration
ApiResponse<T> Delete<T>(string path, RequestOptions options, IReadableConfiguration configuration = null)
Parameters
System.String path

The relative path to invoke.
RequestOptions options

The request parameters to pass along to the client.
IReadableConfiguration configuration

Per-request configurable settings.
Returns
ApiResponse<T>

The response data, decorated with ApiResponse<T>
Type Parameters
T

The return type.

Get<T>(String, RequestOptions, IReadableConfiguration)

Executes a blocking call to some path using the GET http verb.

Declaration
ApiResponse<T> Get<T>(string path, RequestOptions options, IReadableConfiguration configuration = null)
Parameters
System.String path

The relative path to invoke.
RequestOptions options

The request parameters to pass along to the client.
IReadableConfiguration configuration

Per-request configurable settings.
Returns
ApiResponse<T>

The response data, decorated with ApiResponse<T>
Type Parameters
T

The return type.

Head<T>(String, RequestOptions, IReadableConfiguration)

Executes a blocking call to some path using the HEAD http verb.

Declaration
ApiResponse<T> Head<T>(string path, RequestOptions options, IReadableConfiguration configuration = null)
Parameters
System.String path

The relative path to invoke.
RequestOptions options

The request parameters to pass along to the client.
IReadableConfiguration configuration

Per-request configurable settings.
Returns
ApiResponse<T>

The response data, decorated with ApiResponse<T>
Type Parameters
T

The return type.

Options<T>(String, RequestOptions, IReadableConfiguration)

Executes a blocking call to some path using the OPTIONS http verb.

Declaration
ApiResponse<T> Options<T>(string path, RequestOptions options, IReadableConfiguration configuration = null)
Parameters
System.String path

The relative path to invoke.
RequestOptions options

The request parameters to pass along to the client.
IReadableConfiguration configuration

Per-request configurable settings.
Returns
ApiResponse<T>

The response data, decorated with ApiResponse<T>
Type Parameters
T

The return type.

Patch<T>(String, RequestOptions, IReadableConfiguration)

Executes a blocking call to some path using the PATCH http verb.

Declaration
ApiResponse<T> Patch<T>(string path, RequestOptions options, IReadableConfiguration configuration = null)
Parameters
System.String path

The relative path to invoke.
RequestOptions options

The request parameters to pass along to the client.
IReadableConfiguration configuration

Per-request configurable settings.
Returns
ApiResponse<T>

The response data, decorated with ApiResponse<T>
Type Parameters
T

The return type.

Post<T>(String, RequestOptions, IReadableConfiguration)

Executes a blocking call to some path using the POST http verb.

Declaration
ApiResponse<T> Post<T>(string path, RequestOptions options, IReadableConfiguration configuration = null)
Parameters
System.String path

The relative path to invoke.
RequestOptions options

The request parameters to pass along to the client.
IReadableConfiguration configuration

Per-request configurable settings.
Returns
ApiResponse<T>

The response data, decorated with ApiResponse<T>
Type Parameters
T

The return type.

Put<T>(String, RequestOptions, IReadableConfiguration)

Executes a blocking call to some path using the PUT http verb.

Declaration
ApiResponse<T> Put<T>(string path, RequestOptions options, IReadableConfiguration configuration = null)
Parameters
System.String path

The relative path to invoke.
RequestOptions options

The request parameters to pass along to the client.
IReadableConfiguration configuration

Per-request configurable settings.
Returns
ApiResponse<T>

The response data, decorated with ApiResponse<T>
Type Parameters
T

The return type.

Extension Methods