 | BackgroundJobClientExtensions Class |
Provides extension methods for the IBackgroundJobClient
interface to simplify the creation of fire-and-forget jobs, delayed
jobs, continuations and other background jobs in well-known states.
Also allows to re-queue and delete existing background jobs.
Inheritance HierarchyNamespace: Hangfire
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0
SyntaxThe BackgroundJobClientExtensions type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | ChangeState |
Changes state of a job with the given jobId to
the specified one.
|
| ContinueWith(IBackgroundJobClient, String, ExpressionAction) | |
| ContinueWith(IBackgroundJobClient, String, ExpressionAction, JobContinuationOptions) | |
| ContinueWith(IBackgroundJobClient, String, ExpressionAction, IState) | |
| ContinueWith(IBackgroundJobClient, String, ExpressionAction, IState, JobContinuationOptions) | |
| ContinueWithT(IBackgroundJobClient, String, ExpressionActionT) | |
| ContinueWithT(IBackgroundJobClient, String, ExpressionActionT, JobContinuationOptions) | |
| ContinueWithT(IBackgroundJobClient, String, ExpressionActionT, IState) | |
| ContinueWithT(IBackgroundJobClient, String, ExpressionActionT, IState, JobContinuationOptions) | |
| Create(IBackgroundJobClient, ExpressionAction, IState) |
Creates a new background job based on a specified static method
within a given state.
|
| CreateT(IBackgroundJobClient, ExpressionActionT, IState) |
Creates a new background job based on a specified instance method
within a given state.
|
| Delete(IBackgroundJobClient, String) |
Changes state of a job with the specified jobId
to the DeletedState.
|
| Delete(IBackgroundJobClient, String, String) |
Changes state of a job with the specified jobId
to the DeletedState. If fromState value
is not null, state change will be performed only if the current state name
of a job equal to the given value.
|
| Enqueue(IBackgroundJobClient, ExpressionAction) |
Creates a background job based on a specified static method
call expression and places it into its actual queue.
Please, see the QueueAttribute to learn how to
place the job on a non-default queue.
|
| EnqueueT(IBackgroundJobClient, ExpressionActionT) |
Creates a background job based on a specified instance method
call expression and places it into its actual queue.
Please, see the QueueAttribute to learn how to
place the job on a non-default queue.
|
| Requeue(IBackgroundJobClient, String) |
Changes state of a job with the specified jobId
to the EnqueuedState.
|
| Requeue(IBackgroundJobClient, String, String) |
Changes state of a job with the specified jobId
to the EnqueuedState. If fromState value
is not null, state change will be performed only if the current state name
of a job equal to the given value.
|
| Schedule(IBackgroundJobClient, ExpressionAction, DateTimeOffset) |
Creates a new background job based on a specified method call expression
and schedules it to be enqueued at the specified moment of time.
|
| Schedule(IBackgroundJobClient, ExpressionAction, TimeSpan) |
Creates a new background job based on a specified static method
call expression and schedules it to be enqueued after a given delay.
|
| ScheduleT(IBackgroundJobClient, ExpressionActionT, DateTimeOffset) |
Creates a new background job based on a specified method expression and schedules
it to be enqueued at the specified moment.
|
| ScheduleT(IBackgroundJobClient, ExpressionActionT, TimeSpan) |
Creates a new background job based on a specified instance method
call expression and schedules it to be enqueued after a given delay.
|
See Also