BackgroundJob.Delete Method (String, String)

BackgroundJobDelete Method (String, String)

Changes state of a job with the specified jobId to the DeletedState. State change is only performed if current job state is equal to the fromState value.

Namespace: Hangfire
Assembly: Hangfire.Core (in Hangfire.Core.dll) Version: 1.5.0.0

Syntax

Copy

public static bool Delete(
	[NotNullAttribute] string jobId,
	[CanBeNullAttribute] string fromState
)

Public Shared Function Delete ( 
	<NotNullAttribute> jobId As String,
	<CanBeNullAttribute> fromState As String
) As Boolean

Parameters

jobId: Type: SystemString
Identifier of job, whose state is being changed.
fromState: Type: SystemString
Current state assertion, or null if unneeded.

Return Value

Type: Boolean
True, if state change succeeded, otherwise false.

Reference

BackgroundJob Class

Delete Overload

Hangfire Namespace

BackgroundJobClientExtensionsDelete(IBackgroundJobClient, String, String)