| BackgroundJobClientExtensionsRequeue Method (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.
Namespace: HangfireAssembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0
Syntax public static bool Requeue(
[NotNullAttribute] this IBackgroundJobClient client,
[NotNullAttribute] string jobId,
[CanBeNullAttribute] string fromState
)
<ExtensionAttribute>
Public Shared Function Requeue (
<NotNullAttribute> client As IBackgroundJobClient,
<NotNullAttribute> jobId As String,
<CanBeNullAttribute> fromState As String
) As Boolean
Parameters
- client
- Type: HangfireIBackgroundJobClient
An instance of IBackgroundJobClient implementation. - jobId
- Type: SystemString
Identifier of job, whose state is being changed. - fromState
- Type: SystemString
Current state assertion, or null if unneeded.
Return Value
Type:
BooleanTrue, if state change succeeded, otherwise false.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IBackgroundJobClient. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also