Application Framework Reference

Module API

requiresDispatch()

The requiresDispatch() method indicates whether or not the module requires a context with dispatched search to function correctly.

Subclass this module to change the behavior to depend on your specific configuration.

Synopsis

dispatch = requiresDispatch( search )

Parameters

search

Object

Splunk.Search object to be dispatched.

Return Value

Boolean

Module requires context with dispatched search indication:

True = Module does not require a context.

False = (Default) Module requires a context.

Example

requiresDispatch: function() {return true;},
 

See Also

requiresAsynchronousLoading()
someChildrenRequireDispatch()