Class ApiClient
- Namespace
- GroupeIsa.Neos.Designer.UIAbstractions.API
- Assembly
- GroupeIsa.Neos.Designer.UIAbstractions.dll
Represents a client that consume API in a UIView.
public static class ApiClient
- Inheritance
-
ApiClient
- Inherited Members
Methods
DeleteAsync(ApiDeleteRequest)
Send a DELETE request.
public static Task<IApiResponse> DeleteAsync(ApiDeleteRequest request)
Parameters
request
ApiDeleteRequestA 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.
public static Task DownloadFileAsync(string path)
Parameters
path
stringPath.
Returns
- Task
A task that represents the asynchronous operation.
GetAllAsync<T>(ApiGetAllRequest)
Send a GET request to get items.
public static Task<IApiGetAllResponse<T>> GetAllAsync<T>(ApiGetAllRequest request)
Parameters
request
ApiGetAllRequestThe 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.
public static Task<IApiDataResponse<T>> GetAsync<T>(ApiGetRequest request)
Parameters
request
ApiGetRequestA 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.
PostAsync<T>(ApiPostRequest)
Send a POST request.
public static Task<IApiDataResponse<T>> PostAsync<T>(ApiPostRequest request)
Parameters
request
ApiPostRequestA 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.
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.
PutAsync<T>(ApiPutRequest<T>)
Send a PUT request.
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.