 | ScheduledState Class |
Defines the intermediate state of a background job when it is placed
on a schedule to be moved to the EnqueuedState in the future
by DelayedJobScheduler background process.
Inheritance HierarchyNamespace: Hangfire.States
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0
SyntaxThe ScheduledState type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ScheduledState(DateTime) |
Initializes a new instance of the ScheduledState
class with the specified date/time in UTC format when a job should
be moved to the EnqueuedState.
|
| ScheduledState(TimeSpan) |
Initializes a new instance of the ScheduledState class
with the specified time interval after which a job should be moved to
the EnqueuedState.
|
Properties| Name | Description | |
|---|---|---|
 | EnqueueAt |
Gets a date/time when a background job should be enqueued.
|
| IgnoreJobLoadException |
Gets whether transition to this state should ignore job de-serialization
exceptions.
|
| IsFinal |
Gets if the current state is a final one.
|
| Name |
Gets the unique name of the state.
|
| Reason |
Gets the human-readable reason of a state transition.
|
| ScheduledAt |
Gets a date/time when the current state instance was created.
|
Methods| Name | Description | |
|---|---|---|
| SerializeData |
Gets a serialized representation of the current state.
|
Fields
RemarksBackground job in ScheduledState is referred as delayed job.
Examples
The following example demonstrates the creation of a background job that will
be processed after two hours. Please see BackgroundJob.Schedule
and BackgroundJobClientExtensions.Schedule
method overloads for simpler API.
C#
var client = new BackgroundJobClient(); var state = new ScheduledState(TimeSpan.FromHours(2)); client.Create(() => Console.WriteLine("Hello!"), state);
Thread SafetyAny public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also