Application Framework Reference

Splunk API

isCanceled()

The isCanceled() method checks if the current job has been canceled.

Synopsis

status = isCanceled()

Return Value

Boolean

Job canceled status:

true = Job is canceled.

false = Job is not canceled.

Example

var context = this.getContext();
var search = context.get('search');
if (search.job.isCanceled()) {
   console.log('job is cancelled!');
} else {
   console.log('job is active!');
}
 

See Also

isDone()
isEventStreaming()
isFinalized()
isPaused()
isPreviewable()
isRealTimeSearch()
isRunning()
isSaved()

See Also

isDone()
isEventStreaming()
isFinalized()
isPaused()
isPreviewable()
isRealTimeSearch()
isRunning()
isSaved()