Class library reference

The class library reference explains the classes, interfaces, value types, and other members that are included in the Relativity SDK. These members provide access to system functionality and serve as the foundation for building Relativity applications.

This page contains the following information:

To view detailed member information, click one of the following namespaces.

Agents API

Namespace Description
kCura.Agent Contains all the base functionality needed to get an agent instance working correctly in a system.
kCura.Agent.CustomAttributes Contains custom attributes that are used to set up metadata for agent instances.

Analytics Index Manager API

Namespace Description
Analytics.Conceptual.DataContracts Contains the data objects for interacting with Relativity Analytics indexes.
Analytics.Conceptual.DataContracts.Exception Contains the exceptions that can be raised when you interact with Relativity Analytics indexes.
Analytics.Conceptual.Service.Interfaces Contains the interface with the methods for interacting with Relativity Analytics indexes.

API Helpers

Namespace Description
Relativity.API Contains all the base functionality needed to establish a client and set database connections for agents, event handlers, and custom pages.

Audit APIs

Namespace Description
Relativity.Audit.Services.Interface.Metrics Contains an interface exposing the method used to retrieve the total count and sizes of audits through the Audit Metrics service.
Relativity.Audit.Services.Interface.Metrics.Models Contains the classes used for retrieving audit information through the Audit Metrics service.
Relativity.Audit.Services.Interface.Pivot Contains an interface exposing the method used to run pivot queries on audit data through the Audit Pivot service.
Relativity.Audit.Services.Interface.Pivot.Models Contains the classes used to run pivot queries on audit data through the Audit Pivot service.
Relativity.Audit.Services.Interface.Query Contains an interface exposing the method used to query for an audit record through the Audit Query service.
Relativity.Audit.Services.Interface.Query.Models.AuditObjectManagerUI Contains the AuditQueryOptions class.
Relativity.Audit.Services.Interface.Query.Models.AuditQuery Contains the classes used to query for an audit record through the Audit Query service.
Relativity.Audit.Services.Interface.Revert Contains an interface exposing the methods used to revert audit actions through the Audit Revert service.
Relativity.Audit.Services.Interface.Revert.Models Contains the classes used to revert audit actions through the Audit Revert service.
Relativity.Audit.Services.Interface.ReviewerStatistics Contains an interface exposing the methods used to run audit reports on reviewer statistics through the Reviewer Statistics service.
Relativity.Audit.Services.Interface.ReviewerStatistics.Models Contains the classes used to run audit reports on reviewer statistics through the Reviewer Statistics service.

Custom Pages API

Namespace Description
Relativity.CustomPages Provides the framework for managing custom pages within the Relativity system.

Document Viewer Services API

Namespace Description
Relativity.DocumentViewer.Services Contains classes, enumerations, and an interface used for converting documents to viewer types supported by Relativity, including native, image, production, and transcript types.

Event Handlers API

Namespace Description
kCura.EventHandler Contains base and fundamental classes that define events and event handlers.
kCura.EventHandler.CustomAttributes Contains attribute classes for identifying attribute definitions in metadata quickly and easily.
kCura.EventHandler.PostExecuteAction Contains classes that define the behavior to occur after execution of an action ends.
kCura.MassOperationHandlers Contains the base class that defines mass operation events and event handlers.

Imaging API

Namespace Description
Relativity.Imaging.Services.Interfaces Contains interfaces, classes, and enumerations used for imaging files.

Import API

Namespace Description
kCura.Relativity.DataReaderClient Contains classes for creating, executing, and monitoring import jobs.
kCura.Relativity.ImportAPI Contains all the base functionality needed to create custom import utilities for documents, images, production sets, and Relativity Dynamic Objects (RDOs).
kCura.Relativity.ImportAPI.Data Contains classes that represent a subset of the Relativity objects that are available when using the Import API.
kCura.Relativity.ImportAPI.Enumeration Provides enumerated types that define various field properties and upload parameters.
Relativity.DataExchange Contains classes and an interface used for updating import and export application configuration settings. It also contains related exception classes.
Relativity.DataExchange.Io Contains classes and interfaces used to identify file types through the File Type Identifier service.

Integration Points API

Namespace Description
Relativity.IntegrationPoints.Contracts Contains classes and interfaces for building a data source provider and deploying the provider in its own application domain.
Relativity.IntegrationPoints.Contracts.Internals Contains internal interfaces, exceptions, and settings classes.
Relativity.IntegrationPoints.Contracts.Models Contains classes and enumerations for mapping data from source fields to workspace fields.
Relativity.IntegrationPoints.Contracts.Provider Contains interfaces for batching and importing unique identifiers on data fields and the data stored in those fields.
Relativity.IntegrationPoints.SourceProviderInstaller Contains classes and delegates for registering a data source provider with Relativity and uninstalling a provider from a workspace.
Relativity.IntegrationPoints.Services.Interfaces.Private
(Related reference content is unavailable.)
Contains interfaces that your provider class must implement. The methods on these interfaces control the batching and importing of unique identifiers for data entries. They also control batching and importing the actual data.

Kepler API

Namespace Description
Relativity.Kepler.Exceptions Contains exception types that a Kepler Service can throw.
Relativity.Kepler.Logging Contains an interface for obtaining logging and diagnostic information about a Kepler service.
Relativity.Kepler.Security Contains classes used for the underlying structure of authentication and credentials.
Relativity.Kepler.Serialization Contains classes that Kepler services use for serialization and deserialization.
Relativity.Kepler.Services Contains classes, interfaces, and enumerations used to build Kepler services.
Relativity.Kepler.Status Contains an interface with methods for retrieving the status of a Kepler service.
Relativity.Kepler.Transport Contains classes and interfaces used to manage Kepler streams and HTTP responses.
Relativity.Kepler.Utility Contains utility classes used to extract languages.
Relativity.Services.Exceptions Contains exception types that a Kepler Service can throw.
Relativity.Services.ServiceProxy Contains classes that control and provide functionality for proxies.

Processing API

Namespace Description
Relativity.Processing.Services Contains classes for automating processing workflows.
Relativity.Processing.Services.Interfaces.DTOs Contains classes and enumerations used to work with processing filters.

Productions API

Namespace Description
Relativity.Productions.Services Contains classes for automating production workflows.

Search Terms Report Services API

Namespace Description
Relativity.SearchTermsReport.Interfaces Contains classes, enumerations, and interfaces for managing search terms reports.

Structured Analytics API

Namespace Description
Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics Contains the interface with methods used for executing analysis jobs on structured analytics sets.
Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models Contains classes used for errors and operation results.
Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.Status Contains classes used to represent status contracts.