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 new Relativity Lists API. It also discusses legacy functionality that you can migrate to the new Relativity Lists API. Use this information to plan your strategy for migrating your Relativity customizations. For more deprecation information, see Platform Architecture Changes.

    Notes:
  • We will be providing a toggle that you can use to enable the availability of the legacy List Page API, while you are migrating your current customizations to the new Relativity Lists APIs. This toggle will be available until an unspecified future release.
  • We will be providing a migration document in the future. It will be formatted similarly to Migrating applications to Relativity Forms.

This page contains the following information:

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 are deprecated or significantly modified with the release of the new Relativity Lists API.

API name Event Future release status Comments
Page Navigation API listPageChange(pageNavigationAPI) Remove This API will be deprecated.
New Item Button API newItemButtonInit(buttonAPI) Remove This API will be deprecated. The new Toolbar API will handle this functionality.
Cell Formatter API cellFormattersInit(cellFormatterApi) Change This API won't be an event-based API but will be a service API. The event will handle 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 will occur at the invocation of their interaction script, which is the global scope of their script.
Data Source Override API dataSourceInit(dataSourceAPI) Change This API won't be an event-based API but will be a service API. The data source will override should be registered when the interaction script is initialized.
View API viewChange(viewChangeAPI) Change This API event will be 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 will be 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 are deprecated or significantly modified with the release of the new Relativity Lists API.

API name Service name Future release status Comments
Promise API api.promise Remove This API will be deprecated because all modern browsers compatible with Relativity support promises.
Events API api.eventService Remove This API will be deprecated because the new Relativity Lists API architecture won't require 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 currently under development. It will be part of the convenienceApi provided by the new Relativity Lists API. It replaces the Common Utilities API.
Common Utilities API api.commonUtilities Change This API is currently under development. It will utilize many of the features available in the convenienceAPI object provided by the Relativity Forms API, and it passes an object similar to the convenienceApi object.
Modal API api.modalService Change This API will closely resemble Modal API in Relativity Forms.
Toolbar API api.toolbarService Change This API will support toolbar creation and toolbar modification.
CustomWidget API api.customWidgetService Change This API won't create a single widget and display it immediately. The updated Custom Widget API will be an extensible API that supports the creation of a widget type, which users can add to their dashboards. These widgets will support custom data sources and persistence.