Defines operations offered by RSAPIClient.
Namespace: kCura.Relativity.Client
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The IRSAPIClient type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | APIOptions |
The instance of APIOptions associated with this proxy instance.
|
| AuthType |
Determines the authentication type to be used for the connection.
|
| EndpointUri |
The Uri this proxy instance will using to connect.
|
| Repositories |
Used to access the group of repositories.
|
Methods
| Name | Description | |
|---|---|---|
 | ConvertToScriptInputList |
ConvertToScriptInputList will take a List of RelativityScriptInputDetails objects, and put the ID and Value
into a List of RelativityScriptInput objects. The new list can be used when Executing the relativity script.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| MonitorProcessState |
Registers the current proxy to monitor and raise status events for a running process.
(Inherited from IProcessMonitorable.) |
| ValidateEndpoint |
Determines if the endpoint type the proxy was instantiated with is valid.
|
Events
| Name | Description | |
|---|---|---|
 | ProcessCancelled |
The ProcessCancelled event is raised when a running Process has been cancelled.
(Inherited from IProcessMonitorable.) |
| ProcessComplete |
The ProcessComplete event is raised when a running Process completes execution.
(Inherited from IProcessMonitorable.) |
| ProcessCompleteWithError |
The ProcessCompleteWithError event is raised when a running Process completes execution with an error.
(Inherited from IProcessMonitorable.) |
| ProcessFailure |
The ProcessFailure event is raised when a running Process has failed during execution.
(Inherited from IProcessMonitorable.) |
| ProcessProgress |
The ProcessProgress event is raised when there is a notable change in the progress of a running Process.
(Inherited from IProcessMonitorable.) |
| RSAPIClientServiceOperationFailed |
The RSAPIClientServiceOperationFailed event is raised when an error occurs attempting to perform an operation.
|
See Also