testCanvasLifecycle(lifecycleHandler, mockRenderContext)

Calls the canvas test framework to invoke a CanvasLifecycleHandler with the provided RenderContext.

Signature

public static Void testCanvasLifecycle(Canvas.CanvasLifecycleHandler lifecycleHandler,Canvas.RenderContext mockRenderContext)

Parameters

lifecycleHandler
Type: Canvas.CanvasLifecycleHandler
Specifies the CanvasLifecycleHandler implementation that you need to invoke.
mockRenderContext
Type: Canvas.RenderContext
Specifies the RenderContext information that you need to provide to the invoked CanvasLifecycleHandler. If null is provided for this parameter, the canvas framework will generate and use a default mock RenderContext.

Return Value

Type: Void

Usage

Use this method to invoke an implementation of Canvas.CanvasLifecycleHandler.onRender(renderContext) with a mock Canvas.RenderContext that you provide.

Example

The following example creates maps to represent mock application and environment context data and generates a test Canvas.RenderContext. This test RenderContext is then used to invoke a Canvas.CanvasLifecycleHandler.

// Set some application context data in a Map
Map<String,String> appValues = new Map<String,String>();
appValues.put(Canvas.Test.KEY_NAMESPACE,'alternateNamespace');
appValues.put(Canvas.Test.KEY_VERSION,'3.0');

// Set some environment context data in a MAp
Map<String,String> envValues = new Map<String,String>();
envValues.put(Canvas.Test.KEY_DISPLAY_LOCATION,'Chatter');
envValues.put(Canvas.Test.KEY_LOCATION_URL,'https://yourInstance.salesforce.com/_ui/core/chatter/ui/ChatterPage');

// Create a mock RenderContext using the test application and environment context data Maps
Canvas.RenderContext mock = Canvas.Test.mockRenderContext(appValues,envValues);

// Set some custom params on the mock RenderContext
mock.getEnvironmentContext().setParametersAsJSON('{\"param1\":1,\"boolParam\":true,\"stringParam\":\"test string\"}');

// Use the mock RenderContext to invoke a CanvasLifecycleHandler
Canvas.Test.testCanvasLifecycle(handler,mock)