Splunk.Module.DispatchingModule
onJobDone()
The onJobDone() event handler provides global notification that the current job has completed.
This method is typically used to call getResults(), because the results entity is not available until the job has finished.
Note: By default, this method is not implemented and is intended to be overridden.
Synopsis
onJobDone( event )
Parameters
| event | Object | A jQuery event object passed to the handler. |
Return Value
Undefined
Example
onJobDone: function(event) {
if (this.getInferredEntityName()=="results") {
this.getResults();
}
},
See Also
onJobProgress()
onJobStatusChange()
onJobProgress()
The onJobProgress () event handler provides global job progress notifications.
Note: By default, this method is not implemented and is intended to be overridden.
Synopsis
onJobProgress( event )
Parameters
| event | String | A jQuery event object. |
Return Value
Undefined
Example
onJobProgress: function() {
var search = this.getContext().get("search");
var count = this.getEntityCount(search);
this.setCountHeader(count, search.job.isDone());
},
See Also
onJobProgress()
onJobStatusChange()
onJobStatusChange()
The onJobStatusChange() event handler provides global notification of job status changes.
This method is typically used to call reset(), if a job is canceled.
Synopsis
onJobStatusChange( event, status)
Parameters
| event | Object | A jQuery event object. |
| status | String | Job status: (Default) "cancel" = call reset(). |
Return Value
Undefined
Example
onJobStatusChange: function(event, status) {
if (status == 'cancel') {
this.reset();
}
}
See Also
requiresTransformedResults()
The requiresTransformedResults() method checks if the current module requires transformed results.
Synopsis
transform = requiresTransformedResults()
Return Value
| Boolean | Module requires transformed results indication: true = Module requires transformed results. false = (Default) Module does not require transformed results. |
Example
requiresTransformedResults: function() {return true},
| Splunk.Module | ModuleController |
This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9
Download manual
Feedback submitted, thanks!