Lusid.Sdk.Client.IAsynchronousClient Interface Reference

Contract for Asynchronous RESTful API interactions. More...

Inheritance diagram for Lusid.Sdk.Client.IAsynchronousClient:

Public Member Functions
Task< ApiResponse< T > >	GetAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the GET http verb. More...
Task< ApiResponse< T > >	PostAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the POST http verb. More...
Task< ApiResponse< T > >	PutAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the PUT http verb. More...
Task< ApiResponse< T > >	DeleteAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the DELETE http verb. More...
Task< ApiResponse< T > >	HeadAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the HEAD http verb. More...
Task< ApiResponse< T > >	OptionsAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the OPTIONS http verb. More...
Task< ApiResponse< T > >	PatchAsync< T > (string path, RequestOptions options, IReadableConfiguration configuration=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	Executes a non-blocking call to some path using the PATCH http verb. More...

Detailed Description

Contract for Asynchronous RESTful API interactions.

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

Member Function Documentation

DeleteAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.IAsynchronousClient.DeleteAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = null,
		System.Threading.CancellationToken	cancellationToken = default(System.Threading.CancellationToken)
	)

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

Parameters

path	The relative path to invoke.
options	The request parameters to pass along to the client.
configuration	Per-request configurable settings.
cancellationToken	Cancellation Token to cancel the request.

Template Parameters

T	The return type.

Returns

A task eventually representing the response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

GetAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.IAsynchronousClient.GetAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = null,
		System.Threading.CancellationToken	cancellationToken = default(System.Threading.CancellationToken)
	)

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

Parameters

path	The relative path to invoke.
options	The request parameters to pass along to the client.
configuration	Per-request configurable settings.
cancellationToken	Cancellation Token to cancel the request.

Template Parameters

T	The return type.

Returns

A task eventually representing the response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

HeadAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.IAsynchronousClient.HeadAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = null,
		System.Threading.CancellationToken	cancellationToken = default(System.Threading.CancellationToken)
	)

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

Parameters

path	The relative path to invoke.
options	The request parameters to pass along to the client.
configuration	Per-request configurable settings.
cancellationToken	Cancellation Token to cancel the request.

Template Parameters

T	The return type.

Returns

A task eventually representing the response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

OptionsAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.IAsynchronousClient.OptionsAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = null,
		System.Threading.CancellationToken	cancellationToken = default(System.Threading.CancellationToken)
	)

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

Parameters

path	The relative path to invoke.
options	The request parameters to pass along to the client.
configuration	Per-request configurable settings.
cancellationToken	Cancellation Token to cancel the request.

Template Parameters

T	The return type.

Returns

A task eventually representing the response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

PatchAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.IAsynchronousClient.PatchAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = null,
		System.Threading.CancellationToken	cancellationToken = default(System.Threading.CancellationToken)
	)

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

Parameters

path	The relative path to invoke.
options	The request parameters to pass along to the client.
configuration	Per-request configurable settings.
cancellationToken	Cancellation Token to cancel the request.

Template Parameters

T	The return type.

Returns

A task eventually representing the response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

PostAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.IAsynchronousClient.PostAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = null,
		System.Threading.CancellationToken	cancellationToken = default(System.Threading.CancellationToken)
	)

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

Parameters

path	The relative path to invoke.
options	The request parameters to pass along to the client.
configuration	Per-request configurable settings.
cancellationToken	Cancellation Token to cancel the request.

Template Parameters

T	The return type.

Returns

A task eventually representing the response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

PutAsync< T >()

Task<ApiResponse<T> > Lusid.Sdk.Client.IAsynchronousClient.PutAsync< T >	(	string	path,
		RequestOptions	options,
		IReadableConfiguration	configuration = null,
		System.Threading.CancellationToken	cancellationToken = default(System.Threading.CancellationToken)
	)

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

Parameters

path	The relative path to invoke.
options	The request parameters to pass along to the client.
configuration	Per-request configurable settings.
cancellationToken	Cancellation Token to cancel the request.

Template Parameters

T	The return type.

Returns

A task eventually representing the response data, decorated with ApiResponse<T>

Implemented in Lusid.Sdk.Client.ApiClient.

---

The documentation for this interface was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Client/IAsynchronousClient.cs