Interface ICrudApi<T, TKey, TReadAllResult, TReadAllParams>

Namespace

Apizr.Requesting

Assembly

Apizr.dll

The crud api interface

public interface ICrudApi<T, in TKey, TReadAllResult, in TReadAllParams> where T : class

Type Parameters

T

The entity type

TKey

The entity's crud key type

TReadAllResult

The "ReadAll" query result type

TReadAllParams

ReadAll query parameters type

Methods

Create(T)

Send a Create request with a T payload

[Post("")]
Task<T> Create(T payload)

Parameters

payload T

The payload

Returns

Task<T>

Create(T, IApizrRequestOptions)

Send a Create request with a T payload, passing a Polly context and a cancellation token through the request

[Post("")]
Task<T> Create(T payload, IApizrRequestOptions options)

Parameters

payload T

The payload

options IApizrRequestOptions

The request options

Returns

Task<T>

Delete(TKey)

Send a Delete request with a key param

[Delete("/{key}")]
Task Delete(TKey key)

Parameters

key TKey

The key

Returns

Task

Delete(TKey, IApizrRequestOptions)

Send a Delete request with a key param

[Delete("/{key}")]
Task Delete(TKey key, IApizrRequestOptions options)

Parameters

key TKey

The key

options IApizrRequestOptions

The request options

Returns

Task

Read(TKey)

Send a Read request with a key param

[Get("/{key}")]
Task<T> Read(TKey key)

Parameters

key TKey

The key

Returns

Task<T>

Read(TKey, IApizrRequestOptions)

Send a Read request with a key param

[Get("/{key}")]
Task<T> Read(TKey key, IApizrRequestOptions options)

Parameters

key TKey

The key

options IApizrRequestOptions

The request options

Returns

Task<T>

ReadAll()

Send a ReadAll request

[Get("")]
Task<TReadAllResult> ReadAll()

Returns

Task<TReadAllResult>

ReadAll(IApizrRequestOptions)

Send a ReadAll request

[Get("")]
Task<TReadAllResult> ReadAll(IApizrRequestOptions options)

Parameters

options IApizrRequestOptions

The request options

Returns

Task<TReadAllResult>

ReadAll(TReadAllParams)

Send a ReadAll request with some query params used as cache key

[Get("")]
Task<TReadAllResult> ReadAll(TReadAllParams readAllParams)

Parameters

readAllParams TReadAllParams

Query params used as cache key

Returns

Task<TReadAllResult>

ReadAll(TReadAllParams, IApizrRequestOptions)

Send a ReadAll request with some query params used as cache key

[Get("")]
Task<TReadAllResult> ReadAll(TReadAllParams readAllParams, IApizrRequestOptions options)

Parameters

readAllParams TReadAllParams

Query params used as cache key

options IApizrRequestOptions

The request options

Returns

Task<TReadAllResult>

SafeCreate(T)

Send a Create request with a T payload

[Post("")]
Task<IApiResponse<T>> SafeCreate(T payload)

Parameters

payload T

The payload

Returns

Task<IApiResponse<T>>

SafeCreate(T, IApizrRequestOptions)

Send a Create request with a T payload, passing a Polly context and a cancellation token through the request

[Post("")]
Task<IApiResponse<T>> SafeCreate(T payload, IApizrRequestOptions options)

Parameters

payload T

The payload

options IApizrRequestOptions

The request options

Returns

Task<IApiResponse<T>>

SafeDelete(TKey)

Send a Delete request with a key param

[Delete("/{key}")]
Task<IApiResponse> SafeDelete(TKey key)

Parameters

key TKey

The key

Returns

Task<IApiResponse>

SafeDelete(TKey, IApizrRequestOptions)

Send a Delete request with a key param

[Delete("/{key}")]
Task<IApiResponse> SafeDelete(TKey key, IApizrRequestOptions options)

Parameters

key TKey

The key

options IApizrRequestOptions

The request options

Returns

Task<IApiResponse>

SafeRead(TKey)

Send a Read request with a key param

[Get("/{key}")]
Task<IApiResponse<T>> SafeRead(TKey key)

Parameters

key TKey

The key

Returns

Task<IApiResponse<T>>

SafeRead(TKey, IApizrRequestOptions)

Send a Read request with a key param

[Get("/{key}")]
Task<IApiResponse<T>> SafeRead(TKey key, IApizrRequestOptions options)

Parameters

key TKey

The key

options IApizrRequestOptions

The request options

Returns

Task<IApiResponse<T>>

SafeReadAll()

Send a ReadAll request

[Get("")]
Task<IApiResponse<TReadAllResult>> SafeReadAll()

Returns

Task<IApiResponse<TReadAllResult>>

SafeReadAll(IApizrRequestOptions)

Send a ReadAll request

[Get("")]
Task<IApiResponse<TReadAllResult>> SafeReadAll(IApizrRequestOptions options)

Parameters

options IApizrRequestOptions

The request options

Returns

Task<IApiResponse<TReadAllResult>>

SafeReadAll(TReadAllParams)

Send a ReadAll request with some query params used as cache key

[Get("")]
Task<IApiResponse<TReadAllResult>> SafeReadAll(TReadAllParams readAllParams)

Parameters

readAllParams TReadAllParams

Query params used as cache key

Returns

Task<IApiResponse<TReadAllResult>>

SafeReadAll(TReadAllParams, IApizrRequestOptions)

Send a ReadAll request with some query params used as cache key

[Get("")]
Task<IApiResponse<TReadAllResult>> SafeReadAll(TReadAllParams readAllParams, IApizrRequestOptions options)

Parameters

readAllParams TReadAllParams

Query params used as cache key

options IApizrRequestOptions

The request options

Returns

Task<IApiResponse<TReadAllResult>>

SafeUpdate(TKey, T)

Send an Update request with a key and a payload

[Put("/{key}")]
Task<IApiResponse> SafeUpdate(TKey key, T payload)

Parameters

key TKey

The key

payload T

The payload

Returns

Task<IApiResponse>

SafeUpdate(TKey, T, IApizrRequestOptions)

Send an Update request with a key and a payload

[Put("/{key}")]
Task<IApiResponse> SafeUpdate(TKey key, T payload, IApizrRequestOptions options)

Parameters

key TKey

The key

payload T

The payload

options IApizrRequestOptions

The request options

Returns

Task<IApiResponse>

Update(TKey, T)

Send an Update request with a key and a payload

[Put("/{key}")]
Task Update(TKey key, T payload)

Parameters

key TKey

The key

payload T

The payload

Returns

Task

Update(TKey, T, IApizrRequestOptions)

Send an Update request with a key and a payload

[Put("/{key}")]
Task Update(TKey key, T payload, IApizrRequestOptions options)

Parameters

key TKey

The key

payload T

The payload

options IApizrRequestOptions

The request options

Returns

Task