Class NotificationChannelsController

Namespace

KadicErp.WebApi.Controllers.Notifications

Assembly

KadicErp.WebApi.dll

[ApiController]
[Authorize]
[Route("api/notifications/channels")]
[Produces("application/json", new string[] { })]
public class NotificationChannelsController : ControllerBase

Inheritance

object

ControllerBase

NotificationChannelsController

Constructors

NotificationChannelsController(IMediator)

public NotificationChannelsController(IMediator mediator)

Parameters

mediator IMediator

Methods

ActivateChannel(Guid, CancellationToken)

[HttpPost("{id:guid}/activate")]
[Authorize(Policy = "NOTIFICATIONS_CHANNELS_ACTIVATE")]
[ProducesResponseType(204)]
public Task<ActionResult> ActivateChannel(Guid id, CancellationToken cancellationToken)

Parameters

id Guid

cancellationToken CancellationToken

Returns

Task<ActionResult>

CreateChannel(CreateNotificationChannelCommand, CancellationToken)

[HttpPost]
[Authorize(Policy = "NOTIFICATIONS_CHANNELS_CREATE")]
[ProducesResponseType(typeof(object), 201)]
[ProducesResponseType(400)]
public Task<ActionResult> CreateChannel(CreateNotificationChannelCommand command, CancellationToken cancellationToken)

Parameters

command CreateNotificationChannelCommand

cancellationToken CancellationToken

Returns

Task<ActionResult>

DeactivateChannel(Guid, CancellationToken)

[HttpPost("{id:guid}/deactivate")]
[Authorize(Policy = "NOTIFICATIONS_CHANNELS_DEACTIVATE")]
[ProducesResponseType(204)]
public Task<ActionResult> DeactivateChannel(Guid id, CancellationToken cancellationToken)

Parameters

id Guid

cancellationToken CancellationToken

Returns

Task<ActionResult>

GetChannelById(Guid, CancellationToken)

[HttpGet("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_CHANNELS_VIEW")]
[ProducesResponseType(typeof(NotificationChannelDto), 200)]
[ProducesResponseType(typeof(Error), 404)]
public Task<ActionResult<NotificationChannelDto>> GetChannelById(Guid id, CancellationToken cancellationToken)

Parameters

id Guid

cancellationToken CancellationToken

Returns

Task<ActionResult<NotificationChannelDto>>

GetChannels(PaginatorRequestDto, string?, bool?, CancellationToken)

[HttpGet]
[Authorize(Policy = "NOTIFICATIONS_CHANNELS_VIEW")]
[ProducesResponseType(typeof(PaginatorResponseDto<NotificationChannelListItemDto>), 200)]
public Task<ActionResult<PaginatorResponseDto<NotificationChannelListItemDto>>> GetChannels(PaginatorRequestDto paginatorRequest, string? channelType, bool? isActive, CancellationToken cancellationToken)

Parameters

paginatorRequest PaginatorRequestDto

channelType string

isActive bool?

cancellationToken CancellationToken

Returns

Task<ActionResult<PaginatorResponseDto<NotificationChannelListItemDto>>>

GetChannelsList(CancellationToken)

[HttpGet("list")]
[Authorize(Policy = "NOTIFICATIONS_CHANNELS_VIEW")]
[ProducesResponseType(typeof(IEnumerable<NotificationChannelListItemDto>), 200)]
public Task<ActionResult<IEnumerable<NotificationChannelListItemDto>>> GetChannelsList(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ActionResult<IEnumerable<NotificationChannelListItemDto>>>

UpdateChannel(Guid, UpdateChannelRequest, CancellationToken)

[HttpPut("{id:guid}")]
[Authorize(Policy = "NOTIFICATIONS_CHANNELS_UPDATE")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
public Task<ActionResult> UpdateChannel(Guid id, UpdateChannelRequest request, CancellationToken cancellationToken)

Parameters

id Guid

request UpdateChannelRequest

cancellationToken CancellationToken

Returns

Task<ActionResult>