Class CrudApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto, TCrudControllerLogMessageActions>

Namespace

Whipstaff.AspNetCore

Assembly

Whipstaff.AspNetCore.dll

A generic controller supporting CRUD operations. Pre-defines CQRS activities along with Authorization and logging.

public abstract class CrudApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto, TCrudControllerLogMessageActions> : QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions> where TListQuery : IAuditableRequest<TListRequestDto, TListQueryResponse> where TListRequestDto : class, new() where TListQueryResponse : class where TViewQuery : IAuditableRequest<long, TViewQueryResponse?> where TViewQueryResponse : class where TAddCommand : IAuditableRequest<TAddRequestDto, TAddResponseDto?> where TDeleteCommand : IAuditableRequest<long, TDeleteResponseDto?> where TUpdateCommand : IAuditableRequest<TUpdateRequestDto, TUpdateResponseDto?> where TUpdateResponseDto : class? where TCrudControllerLogMessageActions : ICrudControllerLogMessageActions

Type Parameters

TListQuery

The type for the List Query.

TListRequestDto

The type for the Request DTO for the List Operation.

TListQueryResponse

The type for the Response DTO for the List Operation.

TViewQuery

The type for the View Query.

TViewQueryResponse

The type for the Response DTO for the View Operation.

TAddCommand

The type for the Add Command.

TAddRequestDto

The type for the Request DTO for the Add Operation.

TAddResponseDto

The type for the Response DTO for the Add Operation.

TDeleteCommand

The type for the Delete Command.

TDeleteResponseDto

The type for the Request DTO for the Delete Operation.

TUpdateCommand

The type for the Update Command.

TUpdateRequestDto

The type for the Request DTO for the Update Operation.

TUpdateResponseDto

The type for the Response DTO for the Update Operation.

TCrudControllerLogMessageActions

The type for the log message actions mapping class.

Inheritance

object

ControllerBase

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>

CrudApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto, TCrudControllerLogMessageActions>

Inherited Members

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.ListAsync(CancellationToken)

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.ViewAsync(long, CancellationToken)

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.GetListActionResultAsync(TListQueryResponse)

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.GetViewActionResultAsync(TViewQueryResponse)

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.GetListQueryAsync(TListRequestDto, ClaimsPrincipal, CancellationToken)

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.GetListPolicyAsync()

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.GetViewPolicyAsync()

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.GetViewQueryAsync(long, ClaimsPrincipal, CancellationToken)

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.AuthorizationService

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.Logger

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.LogMessageActionMappings

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.Mediator

QueryOnlyApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TCrudControllerLogMessageActions>.QueryFactory

ControllerBase.StatusCode(int)

ControllerBase.StatusCode(int, object)

ControllerBase.Content(string)

ControllerBase.Content(string, string)

ControllerBase.Content(string, string, Encoding)

ControllerBase.Content(string, MediaTypeHeaderValue)

ControllerBase.NoContent()

ControllerBase.Ok()

ControllerBase.Ok(object)

ControllerBase.Redirect(string)

ControllerBase.RedirectPermanent(string)

ControllerBase.RedirectPreserveMethod(string)

ControllerBase.RedirectPermanentPreserveMethod(string)

ControllerBase.LocalRedirect(string)

ControllerBase.LocalRedirectPermanent(string)

ControllerBase.LocalRedirectPreserveMethod(string)

ControllerBase.LocalRedirectPermanentPreserveMethod(string)

ControllerBase.RedirectToAction()

ControllerBase.RedirectToAction(string)

ControllerBase.RedirectToAction(string, object)

ControllerBase.RedirectToAction(string, string)

ControllerBase.RedirectToAction(string, string, object)

ControllerBase.RedirectToAction(string, string, string)

ControllerBase.RedirectToAction(string, string, object, string)

ControllerBase.RedirectToActionPreserveMethod(string, string, object, string)

ControllerBase.RedirectToActionPermanent(string)

ControllerBase.RedirectToActionPermanent(string, object)

ControllerBase.RedirectToActionPermanent(string, string)

ControllerBase.RedirectToActionPermanent(string, string, string)

ControllerBase.RedirectToActionPermanent(string, string, object)

ControllerBase.RedirectToActionPermanent(string, string, object, string)

ControllerBase.RedirectToActionPermanentPreserveMethod(string, string, object, string)

ControllerBase.RedirectToRoute(string)

ControllerBase.RedirectToRoute(object)

ControllerBase.RedirectToRoute(string, object)

ControllerBase.RedirectToRoute(string, string)

ControllerBase.RedirectToRoute(string, object, string)

ControllerBase.RedirectToRoutePreserveMethod(string, object, string)

ControllerBase.RedirectToRoutePermanent(string)

ControllerBase.RedirectToRoutePermanent(object)

ControllerBase.RedirectToRoutePermanent(string, object)

ControllerBase.RedirectToRoutePermanent(string, string)

ControllerBase.RedirectToRoutePermanent(string, object, string)

ControllerBase.RedirectToRoutePermanentPreserveMethod(string, object, string)

ControllerBase.RedirectToPage(string)

ControllerBase.RedirectToPage(string, object)

ControllerBase.RedirectToPage(string, string)

ControllerBase.RedirectToPage(string, string, object)

ControllerBase.RedirectToPage(string, string, string)

ControllerBase.RedirectToPage(string, string, object, string)

ControllerBase.RedirectToPagePermanent(string)

ControllerBase.RedirectToPagePermanent(string, object)

ControllerBase.RedirectToPagePermanent(string, string)

ControllerBase.RedirectToPagePermanent(string, string, string)

ControllerBase.RedirectToPagePermanent(string, string, object, string)

ControllerBase.RedirectToPagePreserveMethod(string, string, object, string)

ControllerBase.RedirectToPagePermanentPreserveMethod(string, string, object, string)

ControllerBase.File(byte[], string)

ControllerBase.File(byte[], string, bool)

ControllerBase.File(byte[], string, string)

ControllerBase.File(byte[], string, string, bool)

ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(byte[], string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(byte[], string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(Stream, string)

ControllerBase.File(Stream, string, bool)

ControllerBase.File(Stream, string, string)

ControllerBase.File(Stream, string, string, bool)

ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(Stream, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(Stream, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(string, string)

ControllerBase.File(string, string, bool)

ControllerBase.File(string, string, string)

ControllerBase.File(string, string, string, bool)

ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.File(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.PhysicalFile(string, string)

ControllerBase.PhysicalFile(string, string, bool)

ControllerBase.PhysicalFile(string, string, string)

ControllerBase.PhysicalFile(string, string, string, bool)

ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.PhysicalFile(string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue)

ControllerBase.PhysicalFile(string, string, string, DateTimeOffset?, EntityTagHeaderValue, bool)

ControllerBase.Unauthorized()

ControllerBase.Unauthorized(object)

ControllerBase.NotFound()

ControllerBase.NotFound(object)

ControllerBase.BadRequest()

ControllerBase.BadRequest(object)

ControllerBase.BadRequest(ModelStateDictionary)

ControllerBase.UnprocessableEntity()

ControllerBase.UnprocessableEntity(object)

ControllerBase.UnprocessableEntity(ModelStateDictionary)

ControllerBase.Conflict()

ControllerBase.Conflict(object)

ControllerBase.Conflict(ModelStateDictionary)

ControllerBase.Problem(string, string, int?, string, string)

ControllerBase.ValidationProblem(ValidationProblemDetails)

ControllerBase.ValidationProblem(ModelStateDictionary)

ControllerBase.ValidationProblem()

ControllerBase.ValidationProblem(string, string, int?, string, string, ModelStateDictionary)

ControllerBase.Created()

ControllerBase.Created(string, object)

ControllerBase.Created(Uri, object)

ControllerBase.CreatedAtAction(string, object)

ControllerBase.CreatedAtAction(string, object, object)

ControllerBase.CreatedAtAction(string, string, object, object)

ControllerBase.CreatedAtRoute(string, object)

ControllerBase.CreatedAtRoute(object, object)

ControllerBase.CreatedAtRoute(string, object, object)

ControllerBase.Accepted()

ControllerBase.Accepted(object)

ControllerBase.Accepted(Uri)

ControllerBase.Accepted(string)

ControllerBase.Accepted(string, object)

ControllerBase.Accepted(Uri, object)

ControllerBase.AcceptedAtAction(string)

ControllerBase.AcceptedAtAction(string, string)

ControllerBase.AcceptedAtAction(string, object)

ControllerBase.AcceptedAtAction(string, string, object)

ControllerBase.AcceptedAtAction(string, object, object)

ControllerBase.AcceptedAtAction(string, string, object, object)

ControllerBase.AcceptedAtRoute(object)

ControllerBase.AcceptedAtRoute(string)

ControllerBase.AcceptedAtRoute(string, object)

ControllerBase.AcceptedAtRoute(object, object)

ControllerBase.AcceptedAtRoute(string, object, object)

ControllerBase.Challenge()

ControllerBase.Challenge(params string[])

ControllerBase.Challenge(AuthenticationProperties)

ControllerBase.Challenge(AuthenticationProperties, params string[])

ControllerBase.Forbid()

ControllerBase.Forbid(params string[])

ControllerBase.Forbid(AuthenticationProperties)

ControllerBase.Forbid(AuthenticationProperties, params string[])

ControllerBase.SignIn(ClaimsPrincipal)

ControllerBase.SignIn(ClaimsPrincipal, string)

ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties)

ControllerBase.SignIn(ClaimsPrincipal, AuthenticationProperties, string)

ControllerBase.SignOut()

ControllerBase.SignOut(AuthenticationProperties)

ControllerBase.SignOut(params string[])

ControllerBase.SignOut(AuthenticationProperties, params string[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, params Expression<Func<TModel, object>>[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, Func<ModelMetadata, bool>)

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, params Expression<Func<TModel, object>>[])

ControllerBase.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, Func<ModelMetadata, bool>)

ControllerBase.TryUpdateModelAsync(object, Type, string)

ControllerBase.TryUpdateModelAsync(object, Type, string, IValueProvider, Func<ModelMetadata, bool>)

ControllerBase.TryValidateModel(object)

ControllerBase.TryValidateModel(object, string)

ControllerBase.HttpContext

ControllerBase.Request

ControllerBase.Response

ControllerBase.RouteData

ControllerBase.ModelState

ControllerBase.ControllerContext

ControllerBase.MetadataProvider

ControllerBase.ModelBinderFactory

ControllerBase.Url

ControllerBase.ObjectValidator

ControllerBase.ProblemDetailsFactory

ControllerBase.User

ControllerBase.Empty

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ControllerBaseExtensions.GetAddActionAsync<TAddRequestDto, TAddResponseDto, TAddCommand>(ControllerBase, ILogger, IMediator, IAuthorizationService, TAddRequestDto, Action<ILogger, string, Exception?>, string, Func<TAddResponseDto, Task<ActionResult<TAddResponseDto>>>, Func<TAddRequestDto, ClaimsPrincipal, CancellationToken, Task<TAddCommand>>, CancellationToken)

ControllerBaseExtensions.GetApiListActionAsync<TListRequestDto, TListResponseDto, TListQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TListRequestDto, Action<ILogger, string, Exception?>, string, Func<TListResponseDto, Task<ActionResult<TListResponseDto>>>, Func<TListRequestDto, ClaimsPrincipal, CancellationToken, Task<TListQuery>>, CancellationToken)

ControllerBaseExtensions.GetApiListActionFlexibleAsync<TListRequestDto, TListResponseDto, TListQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TListRequestDto, Action<ILogger, string, Exception?>, string, Func<TListResponseDto, Task<ActionResult<TListResponseDto>>>, Func<TListRequestDto, ClaimsPrincipal, CancellationToken, Task<TListQuery>>, CancellationToken)

ControllerBaseExtensions.GetApiViewActionAsync<TViewRequestDto, TViewResponseDto, TViewQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TViewRequestDto, Action<ILogger, string, Exception?>, string, Func<TViewResponseDto, Task<ActionResult<TViewResponseDto>>>, Func<TViewRequestDto, ClaimsPrincipal, CancellationToken, Task<TViewQuery>>, CancellationToken)

ControllerBaseExtensions.GetDeleteActionAsync<TDeleteResponseDto, TDeleteCommand>(ControllerBase, ILogger, IMediator, IAuthorizationService, long, Action<ILogger, string, Exception?>, string, Func<TDeleteResponseDto, Task<ActionResult<TDeleteResponseDto>>>, Func<long, ClaimsPrincipal, CancellationToken, Task<TDeleteCommand>>, CancellationToken)

ControllerBaseExtensions.GetUpdateActionAsync<TUpdateRequestDto, TUpdateResponseDto, TUpdateCommand>(ControllerBase, ILogger, IMediator, IAuthorizationService, long, TUpdateRequestDto, Action<ILogger, string, Exception?>, string, Func<TUpdateResponseDto, Task<ActionResult<TUpdateResponseDto>>>, Func<TUpdateRequestDto, ClaimsPrincipal, CancellationToken, Task<TUpdateCommand>>, CancellationToken)

ControllerBaseExtensions.GetViewActionAsync<TViewRequestDto, TViewResponseDto, TViewQuery>(ControllerBase, ILogger, IMediator, IAuthorizationService, TViewRequestDto, Action<ILogger, string, Exception?>, string, Func<TViewResponseDto, Task<IActionResult>>, Func<TViewRequestDto, ClaimsPrincipal, CancellationToken, Task<TViewQuery>>, CancellationToken)

Constructors

CrudApiController(IAuthorizationService, ILogger<CrudApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto, TCrudControllerLogMessageActions>>, IMediator, IAuditableCommandFactory<TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto>, IAuditableQueryFactory<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse>, TCrudControllerLogMessageActions)

Initializes a new instance of the CrudApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto, TCrudControllerLogMessageActions> class.

protected CrudApiController(IAuthorizationService authorizationService, ILogger<CrudApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto, TCrudControllerLogMessageActions>> logger, IMediator mediator, IAuditableCommandFactory<TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto> commandFactory, IAuditableQueryFactory<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse> queryFactory, TCrudControllerLogMessageActions logMessageActions)

Parameters

authorizationService IAuthorizationService

The authorization service for validating access.

logger ILogger<CrudApiController<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse, TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto, TCrudControllerLogMessageActions>>

The logger object.

mediator IMediator

The mediatr object to publish CQRS messages to.

commandFactory IAuditableCommandFactory<TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto>

The factory for generating Command messages.

queryFactory IAuditableQueryFactory<TListQuery, TListRequestDto, TListQueryResponse, TViewQuery, TViewQueryResponse>

The factory for generating Query messages.

logMessageActions TCrudControllerLogMessageActions

Log Message Actions for the logging events in the controller.

Properties

CommandFactory

Gets the Command Factory used for creating Commands to pass through the mediator.

protected IAuditableCommandFactory<TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto> CommandFactory { get; }

Property Value

IAuditableCommandFactory<TAddCommand, TAddRequestDto, TAddResponseDto, TDeleteCommand, TDeleteResponseDto, TUpdateCommand, TUpdateRequestDto, TUpdateResponseDto>

Methods

DeleteAsync(long, CancellationToken)

Operation to Delete an entity.

[HttpDelete("{id:long}")]
public Task<ActionResult<TDeleteResponseDto>> DeleteAsync(long id, CancellationToken cancellationToken)

Parameters

id long

Unique ID of the entity to be deleted.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ActionResult<TDeleteResponseDto>>

A Task<TResult> representing the result of the asynchronous operation.

GetAddActionResultAsync(TAddResponseDto)

Gets the Action Result for the Add operation.

protected abstract Task<ActionResult<TAddResponseDto>> GetAddActionResultAsync(TAddResponseDto result)

Parameters

result TAddResponseDto

The Response DTO from the CQRS operation.

Returns

Task<ActionResult<TAddResponseDto>>

A Task<TResult> representing the result of the asynchronous operation.

GetAddCommandAsync(TAddRequestDto, ClaimsPrincipal, CancellationToken)

Gets the CQRS Command for the Add operation.

protected abstract Task<TAddCommand> GetAddCommandAsync(TAddRequestDto addRequestDto, ClaimsPrincipal claimsPrincipal, CancellationToken cancellationToken)

Parameters

addRequestDto TAddRequestDto

The Add Request DTO.

claimsPrincipal ClaimsPrincipal

The claims principal of the user requesting the add.

cancellationToken CancellationToken

The cancellation token for the request.

Returns

Task<TAddCommand>

Command for performing an Add.

GetAddPolicyAsync()

Gets the authorization policy for the Add operation.

protected abstract Task<string> GetAddPolicyAsync()

Returns

Task<string>

A Task<TResult> representing the result of the asynchronous operation.

GetDeleteActionResultAsync(TDeleteResponseDto)

Gets the Action Result for the Delete operation.

protected abstract Task<ActionResult<TDeleteResponseDto>> GetDeleteActionResultAsync(TDeleteResponseDto result)

Parameters

result TDeleteResponseDto

The Response DTO from the CQRS operation.

Returns

Task<ActionResult<TDeleteResponseDto>>

A Task<TResult> representing the result of the asynchronous operation.

GetDeleteCommandAsync(long, ClaimsPrincipal, CancellationToken)

Gets the CQRS Delete Command.

protected abstract Task<TDeleteCommand> GetDeleteCommandAsync(long id, ClaimsPrincipal claimsPrincipal, CancellationToken cancellationToken)

Parameters

id long

Unique Id for the entity to delete.

claimsPrincipal ClaimsPrincipal

Claims Principal of the user requesting deletion.

cancellationToken CancellationToken

Cancellation token for the request.

Returns

Task<TDeleteCommand>

Command for performing a delete.

GetDeletePolicyAsync()

Gets the authorization policy for the Delete operation.

protected abstract Task<string> GetDeletePolicyAsync()

Returns

Task<string>

A Task<TResult> representing the result of the asynchronous operation.

GetUpdateActionResultAsync(TUpdateResponseDto?)

Gets the Action Result for the Update operation.

protected abstract Task<ActionResult<TUpdateResponseDto>> GetUpdateActionResultAsync(TUpdateResponseDto? result)

Parameters

result TUpdateResponseDto

The Response DTO from the CQRS operation.

Returns

Task<ActionResult<TUpdateResponseDto>>

A Task<TResult> representing the result of the asynchronous operation.

GetUpdateCommandAsync(TUpdateRequestDto, ClaimsPrincipal, CancellationToken)

Gets the CQRS update command for the request.

protected abstract Task<TUpdateCommand> GetUpdateCommandAsync(TUpdateRequestDto updateRequestDto, ClaimsPrincipal claimsPrincipal, CancellationToken cancellationToken)

Parameters

updateRequestDto TUpdateRequestDto

The Update request DTO.

claimsPrincipal ClaimsPrincipal

The claims principal of the user requesting the update.

cancellationToken CancellationToken

The cancellation token for the request.

Returns

Task<TUpdateCommand>

CQRS Update Command.

GetUpdatePolicyAsync()

Gets the authorization policy for the Update operation.

protected abstract Task<string> GetUpdatePolicyAsync()

Returns

Task<string>

A Task<TResult> representing the result of the asynchronous operation.

PostAsync(TAddRequestDto, CancellationToken)

Operation to create an Entity.

[HttpPost]
public Task<ActionResult<TAddResponseDto>> PostAsync(TAddRequestDto addRequestDto, CancellationToken cancellationToken)

Parameters

addRequestDto TAddRequestDto

The Request DTO for the Add Operation.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ActionResult<TAddResponseDto>>

A Task<TResult> representing the result of the asynchronous operation.

PutAsync(long, TUpdateRequestDto, CancellationToken)

Operation to update an entity.

[HttpPut("{id:long}")]
public Task<ActionResult<TUpdateResponseDto>> PutAsync(long id, TUpdateRequestDto updateRequestDto, CancellationToken cancellationToken)

Parameters

id long

Unique Id of the entity.

updateRequestDto TUpdateRequestDto

The Request DTO of the Update operation.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ActionResult<TUpdateResponseDto>>

A Task<TResult> representing the result of the asynchronous operation.