Application Framework Reference

Splunk API

dispatchJob()

The dispatchJob() method handles job dispatch requests, dispatching a search job and flattening intentions as needed, if the job is not already dispatched.

Note: This method is called by pushContextToChildren() in modules derived from AbstractModule and should not be called directly.

Synopsis

results = dispatchJob( onSuccess , onFailure ), group)

Parameters

onSuccess	`Object`	(Optional) Function to call on successful operation.
onFailure	`Object`	(Optional) Function to call on unsuccessful operation.
group	`String`	(Optional) group identifier for UI to display `last refreshed` text at the top of the appropriate group hierarchy.

Return Value

Boolean

Job dispatch status:

True = Search job successfully dispatched.

False = Search job is already dispatched.

Example

  search.dispatchJob(this._fireDispatchSuccessHandler.bind(this),

  this._fireDispatchFailHandler.bind(this),

  this.getGroupName());