Provides a mockable interface with helper methods to Object Type Event Handlers to programmatically interact with Relativity. Inherits from IHelper.
Namespace: Relativity.API
Assembly: Relativity.API (in Relativity.API.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The IEHHelper type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
![]() | GetActiveCaseID |
Gets the current Workspace ArtifactID where the Event Handler was called.
|
![]() | GetAuthenticationManager |
Provides a mockable interface with methods to obtain the user specific information and authentication helper methods.
|
![]() | GetDBContext |
Gets a database context for Workspace ArtifactID provided.
(Inherited from IHelper.) |
![]() | GetGuid |
Retrieves the GUID of a Relativity artifact based on the specified workspace ID and artifact ID (value is cached)
(Inherited from IHelper.) |
![]() | GetInstanceSettingBundle |
Gets a helper object for reading Instance Settings.
(Inherited from IHelper.) |
![]() | GetLoggerFactory |
Gets a factory to return a logger that can be used to log application messages to a central system.
(Inherited from IHelper.) |
![]() | GetSchemalessResourceDataBasePrepend |
Retrieves the resource database name based on the machine configuration
(Inherited from IHelper.) |
![]() | GetSecretStore |
Gets a helper object for interacting with the Relativity Secret Store.
(Inherited from IHelper.) |
![]() | GetServicesManager |
Gets a Service Manager object that helps connect to RSAPI.
(Inherited from IHelper.) |
![]() | GetStringSanitizer |
Gets an instance String Sanitizer
(Inherited from IHelper.) |
![]() | GetUrlHelper |
Gets a URL helper object that helps build urls to custom pages.
(Inherited from IHelper.) |
![]() | ResourceDBPrepend() |
Retrieves the prepend for resource database transactions
(Inherited from IHelper.) |
![]() | ResourceDBPrepend(IDBContext) |
Retrieves the prepend for resource database transactions
(Inherited from IHelper.) |
See Also