RecurringJobAttribute

Marks a class as a recurring Hangfire job. RegisterRecurringJobs discovers IRecurringJob implementations carrying it and schedules each one against its RunAsync method. It does nothing on a class that does not implement the interface, since the scan never looks at one.

Usage

using AlmightyShogun.Hangfire.RecurringJobs;

[RecurringJob("cleanup-expired-sessions", "0 */6 * * *")]
public sealed class CleanupExpiredSessionsJob : IRecurringJob
{
    public Task RunAsync(CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }
}

Parameters

jobId: string
Identifier the schedule is stored under, unique across the application. Changing it on a job that has already run leaves the old schedule in storage under the old id.

cronExpression: string
Cron expression the schedule uses. It is parsed while the host starts, so a malformed expression stops the application rather than leaving a job that never fires.

TimeZone: string?
Time zone identifier the cron expression is evaluated in, such as Europe/Amsterdam. Without it the schedule is UTC, so "run at 3am" drifts by an hour under daylight saving.
Default: null

Queue: string?
Hangfire queue the job is enqueued on. Omit it for the default queue; naming one no server listens on leaves the job enqueued and never processed.
Default: null

Enabled: bool
Whether the job is scheduled at all. Leaving it alone defers to the configuration section's EnabledByDefault, while stating either way ignores that. A parked job is still validated and still claims its job id.
Default: true

Type signature

[AttributeUsage(AttributeTargets.Class, Inherited = false)]
public sealed class RecurringJobAttribute(
    string jobId,
    string cronExpression
) : Attribute;