Class HangfireJobsController

Namespace

KadicErp.WebApi.Controllers.Admin

Assembly

KadicErp.WebApi.dll

[ApiController]
[Authorize]
[Route("api/admin/hangfire-jobs")]
[Produces("application/json", new string[] { })]
public sealed class HangfireJobsController : ControllerBase

Inheritance

object

ControllerBase

HangfireJobsController

Constructors

HangfireJobsController(IMediator)

public HangfireJobsController(IMediator mediator)

Parameters

mediator IMediator

Methods

GetAll(CancellationToken)

List all Hangfire job configurations.

[HttpGet]
[Authorize(Policy = "HANGFIRE_JOBS_VIEW")]
[ProducesResponseType(typeof(List<HangfireJobConfigurationDto>), 200)]
public Task<ActionResult<List<HangfireJobConfigurationDto>>> GetAll(CancellationToken ct)

Parameters

ct CancellationToken

Returns

Task<ActionResult<List<HangfireJobConfigurationDto>>>

Trigger(string)

Immediately enqueue a recurring job for execution.

[HttpPost("{jobName}/trigger")]
[Authorize(Policy = "HANGFIRE_JOBS_TRIGGER")]
[ProducesResponseType(204)]
[ProducesResponseType(404)]
public ActionResult Trigger(string jobName)

Parameters

jobName string

Returns

ActionResult

Update(string, UpdateHangfireJobRequest, CancellationToken)

Update cron expression and enabled state for a job. Applies to Hangfire immediately.

[HttpPut("{jobName}")]
[Authorize(Policy = "HANGFIRE_JOBS_MANAGE")]
[ProducesResponseType(typeof(HangfireJobConfigurationDto), 200)]
[ProducesResponseType(404)]
public Task<ActionResult<HangfireJobConfigurationDto>> Update(string jobName, UpdateHangfireJobRequest request, CancellationToken ct)

Parameters

jobName string

request UpdateHangfireJobRequest

ct CancellationToken

Returns

Task<ActionResult<HangfireJobConfigurationDto>>