Click or drag to resize
IBackgroundJobClient Interface
Provides methods for creating all the types of background jobs and changing their states.

Namespace: Hangfire
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0
Syntax
public interface IBackgroundJobClient

The IBackgroundJobClient type exposes the following members.

Methods
  NameDescription
Public methodChangeState
Attempts to change a state of a background job with a given identifier to a specified one.
Public methodCreate
Creates a new background job in a specified state.
Top
Extension Methods
  NameDescription
Public Extension MethodChangeState
Changes state of a job with the given jobId to the specified one.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWith(String, ExpressionAction)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWith(String, ExpressionAction, IState)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWith(String, ExpressionAction, JobContinuationOptions)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWith(String, ExpressionAction, IState, JobContinuationOptions)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWithT(String, ExpressionActionT)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWithT(String, ExpressionActionT, IState)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWithT(String, ExpressionActionT, JobContinuationOptions)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodContinueWithT(String, ExpressionActionT, IState, JobContinuationOptions)Overloaded. (Defined by BackgroundJobClientExtensions.)
Public Extension MethodCreate(ExpressionAction, IState)Overloaded.
Creates a new background job based on a specified static method within a given state.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodCreateT(ExpressionActionT, IState)Overloaded.
Creates a new background job based on a specified instance method within a given state.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodDelete(String)Overloaded.
Changes state of a job with the specified jobId to the DeletedState.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodDelete(String, String)Overloaded.
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.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodEnqueue(ExpressionAction)Overloaded.
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.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodEnqueueT(ExpressionActionT)Overloaded.
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.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodRequeue(String)Overloaded.
Changes state of a job with the specified jobId to the EnqueuedState.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodRequeue(String, String)Overloaded.
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.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodSchedule(ExpressionAction, TimeSpan)Overloaded.
Creates a new background job based on a specified static method call expression and schedules it to be enqueued after a given delay.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodSchedule(ExpressionAction, DateTimeOffset)Overloaded.
Creates a new background job based on a specified method call expression and schedules it to be enqueued at the specified moment of time.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodScheduleT(ExpressionActionT, TimeSpan)Overloaded.
Creates a new background job based on a specified instance method call expression and schedules it to be enqueued after a given delay.
(Defined by BackgroundJobClientExtensions.)
Public Extension MethodScheduleT(ExpressionActionT, DateTimeOffset)Overloaded.
Creates a new background job based on a specified method expression and schedules it to be enqueued at the specified moment.
(Defined by BackgroundJobClientExtensions.)
Top
Remarks

Please see the BackgroundJobClient class for details regarding the implementation.

See Also