ISchedulerInterrupt Method (String, CancellationToken)

Quartz.NET 3.0 API Documentation
Request the cancellation, within this Scheduler instance, of the identified executing job instance.

Namespace:  Quartz
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax
C#
Copy
Task<bool> Interrupt(
	string fireInstanceId,
	CancellationToken cancellationToken = null
)

Parameters

fireInstanceId
Type: SystemString
the unique identifier of the job instance to be interrupted (see FireInstanceId)
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation instruction.

Return Value

Type: TaskBoolean
true if the identified job instance was found and interrupted.
Remarks
This method is not cluster aware. That is, it will only interrupt instances of the identified InterruptableJob currently executing in this Scheduler instance, not across the entire cluster.
See Also

Reference

IScheduler Interface
Interrupt Overload
Quartz Namespace
ISchedulerGetCurrentlyExecutingJobs(CancellationToken)
IJobExecutionContextFireInstanceId
ISchedulerInterrupt(JobKey, CancellationToken)