Application Framework Reference

Module API

setChildContextFreshness()

The setChildContextFreshness() method marks the freshness of the context held by child modules, permitting the calling module to validate or invalidate child freshness without traversing the module tree.

Note: This module should not be overridden.

Synopsis

results = setChildContextFreshness( contextStatus )

Parameters

contextStatus

Boolean

Status to set child module contexts to:

True = Mark context as fresh.

False = Mark context as stale.

Return Value

Undefined

Example

pushContextToChildren: function(explicitContext) {
    this.withEachChild(function(child) {
        child.baseContext = childContext;
        child.setLoadState(Splunk.util.moduleLoadStates.HAS_CONTEXT);
        child.onContextChange();
        child.pushContextToChildren();
        if (!child.isPageLoadComplete()) {
            child.markPageLoadComplete();
        }
    });
    this.setChildContextFreshness(true);
},