Packaged interface
Namespace: overcast
Extends ComponentPluginV3
The ComponentPluginV4 interface provides a way for Overcast Components to execute custom code.
See the Overcast Component Plugin Template for the full implementation example.
The class and method visibility must be global so the Overcast managed package can call it.
(ComponentPlugin) beforeScenarioCall(recordId, referenceFieldValues, importParameters, settings)
(ComponentPlugin) afterScenarioCall(returnedData, cmp, settings)
(ComponentPluginV2) afterComponentMetadataLoaded(recordId, cmp)
(ComponentPluginV2) afterReferenceValuesLoaded(recordId, componentName, referenceValues)
(ComponentPluginV2) onScenarioException(ex, retData)
(ComponentPluginV3) afterReferenceValuesLoaded(recordId, componentName, referenceValues, referenceChildValues)
onBackendMessageReceived(backendMessage)
Allows custom processing of the message from the backend. This is useful for parsing custom backend system error messages that are nested in the response body. Overcast cannot handle these kind of messages directly because they are custom and can differ from API to API.
To throw an exception intentionally from this method, create a new instance of overcast.ComponentFrameworkUtility.ComponentPluginException. Any other exception type thrown from this method will be treated as an unhandled exception and an error will be shown to the user.
The same instance of this class is used to call both beforeScenarioCall(), afterScenarioCall() and onBackendMessageReceived() so state can be maintained between calls in class properties.
Requires the Integration Scenario Apex class to implement overcast.Realtime.ScenarioExtension.
The method visibility must be global.
Signature
void onBackendMessageReceived(String backendMessage)
Parameters
backendMessage
Type: String
The raw response from the backend system.
Return Value
Type: void