Executing Custom Code

You can configure extensions to execute custom code at specific application lifecycle events. Your code has access to the full IReviewInterfaceApi when executing.

This page contains the following information:

• Custom code execution
• Custom code example
• Available application lifecycle events

Custom code execution

To execute custom code in an extension, return an IExtensionConfig object that contains the lifecycle property. This property defines handlers that run when specific application lifecycle events fire.

Custom code example

import type { IExtensionParameters, IExtensionConfig, IReviewInterfaceApi } from 'reviewapi';

export default function(parameters: IExtensionParameters): IExtensionConfig {
  return {
    id: 'relativity.examples.customcode',
    name: 'Custom Code Example Extension',
    lifecycle: {
      ready: (api: IReviewInterfaceApi) => {
        console.log('The application is ready.');
        // Your custom code has access to the full API here.
      },
    },
  };
}

Available application lifecycle events

For functional and performance reasons, choose the appropriate lifecycle event when writing your extension. See IExtensionLifecycle for lifecycle event reference content.

Each lifecycle event handler receives the IReviewInterfaceApi as a parameter, giving your custom code full access to the API.