Classic List Page API deprecation

Review this page to learn about how deprecated functionality in the classic List Page API maps to features available in the newer Relativity Lists API. It also discusses legacy functionality that you can migrate to the Relativity Lists API. Use this information to plan your strategy for migrating your Relativity customizations. See these posts in the developer group for more information:

• August 2022 developer group announcement
• April 2025 developer group announcement

For migration guidance, see Migrating a Classic List Page Interaction Script to Relativity.Lists.

Initializer API

Relativity Lists doesn't require packaging interaction scripts as a module or an IFFE. These scripts are standard JavaScript. You can also assume that the Interaction API exists in the global scope. Previously, interaction scripts were required to be in a RequireJS module that returned an initializer function, which executed in way that passed the object containing the service APIs to an interaction script.

Event-based APIs

The following table lists event-based APIs that were deprecated or significantly modified with the release of the Relativity Lists API.

API name	Event	Change or removal	Comments
Page Navigation API	listPageChange(pageNavigationAPI)	Remove	This API has been deprecated.
New Item Button API	newItemButtonInit(buttonAPI)	Remove	This API has been deprecated. The new Toolbar API handles this functionality.
Cell Formatter API	cellFormattersInit(cellFormatterApi)	Change	This API is no longer an event-based API but is now a service API. The event handles the registration of the cell formatter, rather than an event occurring when an action is performed in the application. The registration of the cell formatters occurs at the invocation of their interaction script, which is the global scope of their script.
Data Source Override API	dataSourceInit(dataSourceAPI)	Change	This API is no longer an event-based API but is now a service API. The data source it overrides should be registered when the interaction script is initialized.
View API	viewChange(viewChangeAPI)	Change	This API event has been renamed onViewChange. The addition of the on prefix in its name standardizes and clearly identifies it as event-based API.
Widget Menu Customization API	widgetMenuCreate(widgetMenuAPI)	Change	This API event has been renamed onWidgetMenuCreate. The addition of the on prefix in its name standardizes and clearly identifies it as event-based API.

General service APIs

The following table lists general service APIs that were deprecated or significantly modified with the release of the Relativity Lists API.

API name	Service name	Change or removal	Comments
Promise API	api.promise	Remove	This API has been deprecated because all modern browsers compatible with Relativity support promises.
Events API	api.eventService	Remove	This API has been deprecated because the Relativity Lists API architecture doesn't require the Visualization Event Manager (VEM) component used in the classic List Page API to handle communication between the different features in Relativity.
Kepler Provider API	api.keplerProviderService	Remove	This API is now part of ConvenienceApi.RelativityHttpClient provided by the new Relativity Lists API. It replaces the Common Utilities API.
Common Utilities API	api.commonUtilities	Change	This API has been replaced by ConvenienceApi.RelativityHttpClient. It utilizes many of the features available in the ConvenienceAPI provided by the Relativity Forms API. "commonConstantsAndObjects" is no longer provided.
Modal API	api.modalService	Change	This API closely resembles Modal API in Relativity Forms.
Toolbar API	api.toolbarService	Change	This API supports toolbar creation and toolbar modification.
CustomWidget API	api.customWidgetService	Change	This API no longer creates a single widget and displays it immediately. The updated Custom Widget API is an extensible API that supports the creation of a widget type, which users can add to their dashboards. These widgets support custom data sources and persistence.