ComponentPluginV6 Template

An Apex plugin class is an Apex class that implements specific Overcast interfaces. When registered in an Overcast Component, it will be loaded and executed at runtime, allowing custom code to be executed in the Overcast Component execution pipeline.

This document provides a standard template for all Overcast Components. Refer to the API documentation for specific method information.

The class and all methods must be global so Overcast can load and run the plugin.

Any override methods that you will not implement may be removed. Empty override methods are not necessary.

// This class is used by component <component name>.
// <add description>
global class MyPlugin extends overcast.ComponentPluginV6 {
    private overcast.Logger logger;

    global override void setLogger(overcast.Logger logger) {
        this.logger = logger;
    }

    global override void beforeScenarioCall(
        Id recordId,
        Map<String, Object> referenceFieldValues,
        Map<String, Object> importParameters,
        Map<String, Object> settings
    ) {
    }

    global override void afterScenarioCall(
        Map<String, Object> returnedData, 
        overcast.ComponentDefinition.Component cmp, 
        Map<String, Object> settings
    ) {
    }

    global override void afterComponentMetadataLoaded(Id recordId, overcast.ComponentDefinition.Component cmp) {
    }

    global override Boolean onScenarioException(Exception ex, Map<String, Object> retData) {
        return true;
    }

    global override void afterReferenceValuesLoaded(
        Id recordId,
        String componentName,
        Map<String, Map<String, Object>> referenceValues, 
        Map<String, List<Map<String, Object>>> referenceChildValues
    ) {
    }

    global override void onBackendMessageReceived(String backendMessage) {
    }

    global override void afterStoredDataLoaded(Map<string, object> storedData, Map<string, object> slpData) {
    }
}