ICPHelper Interface

Relativity API
Provides a mockable interface with helper methods allowing Custom Pages to programmatically interact with Relativity. Inherits from IHelper.

Namespace:  Relativity.API
Assembly:  Relativity.API (in Relativity.API.dll) Version: 588f15fd7550dbf54835f3417a0142d4ea37dbb5

public interface ICPHelper : IHelper, 

The ICPHelper type exposes the following members.


Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGetActiveCaseID
Get's the active Workspace ArtifactID.
Public methodGetAuthenticationManager
Provides a mockable interface with methods to obtain the user specific information and authentication helper methods.
Public methodGetCSRFManager
Gets a ICSRFManager to enforce CSRF(Cross Site Request Forgery) support.
Public methodGetDBContext
Gets a database context for Workspace ArtifactID provided.
(Inherited from IHelper.)
Public methodGetGuid
Retrieves the GUID of a Relativity artifact based on the specified workspace ID and artifact ID (value is cached)
(Inherited from IHelper.)
Public methodGetInstanceSettingBundle
Gets a helper object for reading Instance Settings.
(Inherited from IHelper.)
Public methodGetLoggerFactory
Gets a factory to return a logger that can be used to log application messages to a central system.
(Inherited from IHelper.)
Public methodGetSchemalessResourceDataBasePrepend
Retrieves the resource database name based on the machine configuration
(Inherited from IHelper.)
Public methodGetSecretStore
Gets a helper object for interacting with the Relativity Secret Store.
(Inherited from IHelper.)
Public methodGetServicesManager
Gets a Service Manager object that helps connect to RSAPI.
(Inherited from IHelper.)
Public methodGetStringSanitizer
Gets an instance String Sanitizer
(Inherited from IHelper.)
Public methodGetUrlHelper
Gets a URL helper object that helps build urls to custom pages.
(Inherited from IHelper.)
Public methodResourceDBPrepend
Retrieves the prepend for resource database transactions
(Inherited from IHelper.)
Public methodResourceDBPrepend(IDBContext)
Retrieves the prepend for resource database transactions
(Inherited from IHelper.)
See Also