Click or drag to resize
IStateName Property
Gets the unique name of the state.

Namespace: Hangfire.States
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version:
string Name { get; }

Property Value

Type: String
Unique among other states string, that is ready for ordinal comparisons.

The state name is used to differentiate one state from another during the state change process. So all the implemented states should have a unique state name. Please use one-word names that start with a capital letter, in a past tense in English for your state names, for example:

  • Succeeded
  • Enqueued
  • Deleted
  • Failed
Note Notes to Implementers
The returning value should be hard-coded, no modifications of this property should be allowed to a user. Implementors should not add a public setter on this property.
See Also