Relativity.API
Namespace with 32 public types
Classes
DelegateServiceUrisProvider
This implimentation of IProvideServiceUris allows for delegates to fetch the values one demand.
License`1
Class implementing License object of type T.
LicenseInfoBase
Base class defining license information object.
SanitizeHtmlContentResult
Result structure returned when Sanitizing HTML based input
Secret
Represents a secret in the Relativity Secret Store. The class is used for interacting with Secret Store using the methods in the ISecretStore interface.
StaticServiceUrisProvider
Implimentation of IProvideServiceUris that returns set values.
Enumerations
ExecutionIdentity
ExecutionIdentity specifies the conceptual role under which an IServicesMgr
should create a proxy. The ExecutionIdentity is intended to be used by
IServicesMgr-derived classes to select an appropriate AuthenticationType for
proxy creation.
Static Classes
ExtensionPointServiceFinder
This is a static provider to find interface for infrastructure infromation about the system.
Services
Static class used to access IServiceHelper.
Interfaces
IAgentHelper
Provides a mockable interface with helper methods to Agents to programmatically interact with Relativity. Inherits from IHelper.
IAPILog
Logging wrapper of Relativity.Logging
IAuthenticationMgr
Provides a mockable interface with methods to obtain the user specific information and authentication helper methods.
ICPHelper
Provides a mockable interface with helper methods allowing Custom Pages to programmatically interact with Relativity. Inherits from IHelper.
ICSRFManager
Helper to enforce CSRF(Cross Site Request Forgery) support.
IDBContext
Provides a mockable interface with many common helper methods to interact with a database in a Relativity instance.
Typically, you should be using the Services API to interact with Relativity, however the DBContext provides direct access to the databases when needed.
IEHHelper
Provides a mockable interface with helper methods to Object Type Event Handlers to programmatically interact with Relativity. Inherits from IHelper.
IHelper
Provides a mockable interface with helper methods to programmatically interact with Relativity from: Event Handlers, Custom Pages and Agents.
You can use these methods to create proxys to interact with the Services API, obtain database contexts to query\run SQL against a database
and obtain a URL helper to create links to pages within a Relativity Instance. To create reusable code within Relativity, it is suggested
that you pass down the generic Helper interaces such as this one into your data access layer project.
IInstanceSettingsBundle
A unified group of Instance Setting values. All values returned from this interface are
snapshots of the latest Instance Settings data. You should call this interface every
time you need to retrieve a value.
ILicenseMgr
Interface for LicenseManagerProxy class.
ILogFactory
Factory for getting loggers.
IMOHelper
Provides a mockable interface with helper methods to Mass Operation Event Handlers to programmatically interact with Relativity. Inherits from IHelper.
IMonitorSecurityEvents
This interface is used for writing security related events to the security monitor
IProvideServiceUris
This interface is used for finding the Uris to various endpoints inside the relativity infrastructure.
IProvideSystemTokens
ISecretStore
Provides synchronous and asynchronous methods for interacting with the Relativity Secret Store.
ISEHHelper
Interface for SEHHelper class - helper class for Statistics Event Handlers.
IServiceHelper
Provides a mockable interface with helper methods to Services to programmatically interact with Relativity. Inherits from IHelper.
IServicesMgr
Provides a mockable interface with methods to interact with the Services API.
IStringSanitizer
Sanitizes string input according to DB defined rules
IUrlHelper
Provides helper methods for manipulating custom page URLs.
IUserInfo
Provides a mockable interface with methods to obtain information about the currently logged in user.
IWebServerHelper
This interface provides an abstraction for rewriting Uris based on the infestructure.