 | SucceededState Class |
Defines the final state of a background job when a Worker
performed an enqueued job without any exception thrown during the performance.
Inheritance HierarchyNamespace: Hangfire.States
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0
SyntaxThe SucceededState type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | IgnoreJobLoadException |
Gets whether transition to this state should ignore job de-serialization
exceptions.
|
| IsFinal |
Gets if the current state is a final one.
|
| Latency |
Gets the total number of milliseconds passed from a job
creation time till the start of the performance.
|
| Name |
Gets the unique name of the state.
|
| PerformanceDuration |
Gets the total milliseconds elapsed from a processing start.
|
| Reason |
Gets the human-readable reason of a state transition.
|
| Result |
Gets the value returned by a job method.
|
| SucceededAt |
Gets a date/time when the current state instance was created.
|
Methods| Name | Description | |
|---|---|---|
 | SerializeData |
Gets a serialized representation of the current state.
|
Fields
RemarksAll the transitions to the Succeeded state are internal for the Worker background process. You can't create background jobs using this state, and can't change state to Succeeded.
This state is used in a user code primarily in state change filters (TODO: add a link) to add custom logic during state transitions.
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