Class ApiClient

Namespace

GroupeIsa.Neos.Designer.UIAbstractions.API

Assembly

GroupeIsa.Neos.Designer.UIAbstractions.dll

Represents a client that consume API in a UIView.

[ExcludeFromCodeCoverage]
public class ApiClient

Inheritance

object

ApiClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ApiClient()

Initializes a new instance of the ApiClient class.

protected ApiClient()

Methods

DeleteAsync(ApiDeleteRequest)

Send a DELETE request.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task<IApiResponse> DeleteAsync(ApiDeleteRequest request)

Parameters

request ApiDeleteRequest

A ApiGetRequest that contains arguments of the request.

Returns

Task<IApiResponse>

A task that represents the asynchronous operation. The task result is a IApiResponse that contains the API response.

DownloadFileAsync(string)

Downloads a file.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task DownloadFileAsync(string path)

Parameters

path string

Path.

Returns

Task

A task that represents the asynchronous operation.

GetAllAsync<T>(ApiGetAllRequest)

Send a GET request to get items.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task<IApiGetAllResponse<T>> GetAllAsync<T>(ApiGetAllRequest request)

Parameters

request ApiGetAllRequest

The ApiGetAllRequest that contains arguments of the request.

Returns

Task<IApiGetAllResponse<T>>

A task that represents the asynchronous operation. The task result is a IApiGetAllResponse<T> that contains the API response.

Type Parameters

T

The item type.

GetAsync<T>(ApiGetRequest)

Send a GET request to get an item.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task<IApiDataResponse<T>> GetAsync<T>(ApiGetRequest request)

Parameters

request ApiGetRequest

A ApiGetRequest that contains arguments of the request.

Returns

Task<IApiDataResponse<T>>

A task that represents the asynchronous operation. The task result is a IApiDataResponse<T> that contains the API response.

Type Parameters

T

The item type.

GetByteArrayAsync(string)

Sends a GET request and return the response body as a byte array.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task<byte[]> GetByteArrayAsync(string path)

Parameters

path string

Path.

Returns

Task<byte[]>

A task that represents the asynchronous operation. The task result is a byte array.

PostAsync<T>(ApiPostRequest)

Send a POST request.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task<IApiDataResponse<T>> PostAsync<T>(ApiPostRequest request)

Parameters

request ApiPostRequest

A ApiPostRequest that contains arguments of the request.

Returns

Task<IApiDataResponse<T>>

A task that represents the asynchronous operation. The task result is a IApiDataResponse<T> that contains the API response.

Type Parameters

T

The data requested type.

PostAsync<T>(ApiPostRequest<T>)

Send a POST request.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task<IApiDataResponse<T>> PostAsync<T>(ApiPostRequest<T> request)

Parameters

request ApiPostRequest<T>

A ApiPostRequest<T> that contains arguments of the request.

Returns

Task<IApiDataResponse<T>>

A task that represents the asynchronous operation. The task result is a IApiDataResponse<T> that contains the API response.

Type Parameters

T

The item type.

PrintFileAsync(string)

Prints a file.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task PrintFileAsync(string path)

Parameters

path string

Path.

Returns

Task

A task that represents the asynchronous operation.

PutAsync<T>(ApiPutRequest<T>)

Send a PUT request.

[SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Transpilation abstraction")]
public static Task<IApiDataResponse<T>> PutAsync<T>(ApiPutRequest<T> request)

Parameters

request ApiPutRequest<T>

A ApiPutRequest<T> that contains arguments of the request.

Returns

Task<IApiDataResponse<T>>

A task that represents the asynchronous operation. The task result is a IApiDataResponse<T> that contains the API response.

Type Parameters

T

The item type.