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.
Namespace: Relativity.API
Assembly: Relativity.API (in Relativity.API.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The IHelper type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| GetDBContext |
Gets a database context for Workspace ArtifactID provided.
|
| GetGuid |
Retrieves the GUID of a Relativity artifact based on the specified workspace ID and artifact ID (value is cached)
|
| GetInstanceSettingBundle |
Gets a helper object for reading Instance Settings.
|
| GetLoggerFactory |
Gets a factory to return a logger that can be used to log application messages to a central system.
|
| GetSchemalessResourceDataBasePrepend |
Retrieves the resource database name based on the machine configuration
|
| GetSecretStore |
Gets a helper object for interacting with the Relativity Secret Store.
|
| GetServicesManager |
Gets a Service Manager object that helps connect to RSAPI.
|
| GetStringSanitizer |
Gets an instance String Sanitizer
|
| GetUrlHelper |
Gets a URL helper object that helps build urls to custom pages.
|
| ResourceDBPrepend() |
Retrieves the prepend for resource database transactions
|
| ResourceDBPrepend(IDBContext) |
Retrieves the prepend for resource database transactions
|
See Also