kCura.Relativity.Client Namespace

Thrown when there is an unsuccessful API operation.

Provides a session token and WorkspaceID for creating a connection to Relativity.

A Key Value pair to pass additional parameters to API.

Options for exporting a Relativity Application

Options for installing a Relativity Application

Represents an item in a Relativity workspace.

ArtifactManagerProxy is used to perform CRUD and other operations on objects in Relativity.

Provides the capability for programmatically applying client-side overrides to configuration settings for the ArtifactManagerProxy.

Represents a request for an operation to be performed on an Artifact in a workspace.

Specifies the method of authentication used for this connection.

Determines the authentication type to be used for the connection.

This exception thrown when the API experiences a fatal error processing during a call to ExecuteBatch.

Specifies that bearer token authentication will be used to authenticate the connection.

Use a BooleanCondition to query for items by comparing a Boolean Field against a True/False value.

Contains information about a cancelled transfer.

Use the CASearch Condition to execute a CAsearch.

The CertificateFindValueInvalidException is thrown when there is a mismatch between the server-defined CertificateFindValue and the user-supplied CertificateFindValue.

The CertificateFindValueNotSuppliedException is thrown when no CertificateFindValue is supplied, but the requested Uri and Authentication Type values require it.

The CertificateFindValueNotSuppliedException is thrown when no CertificateFindValue is supplied, but all requested EndpointType values require it.

Represents a Choice used as a value for Single or Multiple Choice fields in Relativity.

A Composite Condition can be used to define AND and OR conditions that combine other Conditions together.

Defines a static set of constant values.

Constants used in APIParameter keys.

Constants used in place of a field name, which direct the Services API to return a special set of fields.

Constants related to Documents

Constants related to Groups

Constants used for the GroupType property

Constants related to Tabs

Constants used for the TabDisplay property

Constants related to Users

Constants used for the DataFocus property

A CreateCommand can be passed into the ExecuteBatch() method, representing a Create call.

Represents a Credential used as a value for Single or Multiple Credential fields in Relativity.

This exception will be thrown when the API experiences a serious problem during a CRUD (Create, Read, Update, or Delete) operation.

Use a DateTimeCondition in a Query to test a DateTime field against a DateTime value.

Use a DecimalCondition to test a Decimal field against a numeric value.

A DeleteCommand can be passed into the ExecuteBatch() method, representing a Delete call.

Options for deleting large numbers of documents.

Contains information about a successfully completed download.

Provides response from a download operation.

The DownloadURLRequest class is used to request the URL for download a file from a file field.

The DownloadURLResponse class provides a response to include the URL for downloading a file.

Use the dtSearch Condition to execute a dtSearch.

Describes a custom object.

Thrown when attempting to download from a file field or document with no associated file.

This exception is thrown when the endpoint connection fails during the construction of the RSAPIClient.

This exception is thrown when the endpoint connection fails during the construction of the ArtifactManagerProxy and FileTransferProxy.

This class contains extension methods for Event Handlers; it should not be used directly.

Describes the results of the operation passed to the ExecuteBatch method call.

Contains information about a failed transfer.

The Field class represents the name and value of a field on a Relativity object.

Base class for Field Conditions

The FieldNotFoundException is thrown when an attempt is made to read a non-existent field from an artifact.

Use a FileCondition in a Query to test a File field against a file name.

Provides the size and location of a file.

Provides the size and location of a file.

Provides information about a file to download or clear.

Thrown when the number of bytes written to disk does not match what was specified in the UploadRequest.

Generic fault thrown for a variety of reasons during a file transfer.

Performs operations on file fields in Relativity, including downloading, clearing, and uploading files.

The FileTransferSettings object is passed to the constructor of FileTransferProxy. It provides the configuration settings that take precedence over values supplied in an app.config file. For example, you may want to use this object for configuration overrides when using an Event Handler.

Represents a file used when creating Relational Fields.

Specifies that integrated Windows authentication will be used to authenticate the connection.

Thrown when an invalid field id is given in TargetField.

Thrown when an invalid object id is given in TargetField.

Thrown when an invalid workspace id is given in TargetField.

IsSetCondition, used to translate a query from the F# Query Parser to a Query condition.

Represents a Keyboard Short. Keyboard shortcuts allow you to edit and navigate in the Core Reviewer Interface. Using keyboard shortcuts, you can change viewer modes, populate choices, save edits, cancel edits, and move between and within documents.

Thrown when the call to Login fails.

Contains data describing a MassCreate operation, and can be passed into the ExecuteBatch() method.

This exception will be thrown when a problem occurs during the execution of a MassEdit operation.

Provides the results of a MassCreate operation and its status.

Options for mass deletion.

Contains data describing a MassEdit operation, and can be passed into the ExecuteBatch() method.

This exception will be thrown when a problem occurs during the execution of a MassEdit operation.

Provides the results of a MassEdit operation and its status.

Thrown when the specified field id could not be found.

Use a MonthOfCondition in a Query to compare DateTime against a string value that becomes enumerated over MonthOf|1 through MonthOf|12.

Use a MultiChoiceCondition in a Query to test a MultiChoice field against an array of Choice ArtifactID values

Describes the value and behavior used to update a MultiChoice field.

Use a MultiLineStringCondition in a Query to test against a field containing newline-delimited strings.

Describes the value and behavior used to update a MultiRelativityApplication field.

Describes the value and behavior update (Remove, Add, or Replace) used to update certain MultiObject fields.

The NoConnectionRetriesAvailableException is thrown when there are no more available retries for a particular service.

Thrown when a file exists in the file field, but UploadRequest.Overwrite was set to false.

Use the NOT Condition to negate a condition.

The exception is thrown when none of the endpoint types provided to the ArtifactManagerProxy cannot initialize a connection using any of the endpoint types provided to it.

Use an ObjectCondition in a Query to test an Object field against an array of ArtifactIDs of items

Use an ObjectsCondition in a Query to test an Objects field against an array of ArtifactIDs of items

Thrown when an attempt is made to upload to an object that already has an uplod in progress.

Represents the outcome of a service operation.

Contains information on the call to run a process asynchronously.

Contains information on a cancelled Process.

Contains information on a successfully completed Process.

Contains information on a successfully completed Process.

Contains information about a Process.

Thrown when the Process Polling API method fails

Contains information on a failed Process.

Stores the state of a process.

Represents the outcome of a process operation.

Contains information on the progress of a Process.

Contains information about a transfer in progress.

Abstract base class providing settings for controlling connections to Relativity.

Describes a query or search of the Relativity workspace. It is passed into the Query method.

Thrown when the Query API method fails

Provides the output of a call to the Query or QuerySubset methods.

Represents the outcome of an individual Read operation on a single Artifact.

Provides the results of a Read operation.

Provides the contents of a RelativityApplication field.

Represents an input to a Relativity Script as a Name/Value pair.

Represents an individual script input parameter. Objects of this type are returned by the GetRelativityScriptInputs method.

Provides the output of executing a Relativity Script.

Options for Creating/Updating a Resource File

Represents the outcome of an individual Create, Update, or Delete operation on a single Artifact.

Provides the results of a Create, Update, Delete and ExecuteBatch operation.

Exposes the available Services API functionality.

Provides the capability for programmatically applying client-side overrides to configuration settings for the RSAPIClient.

Use the Saved Search Condition to execute a saved search.

Specifies the protocol used for this connection.

Contains the necessary parameters to execute a Search Provider search.

An Exception thrown for a Serialization or Deserialization error.

Represents the outcome of a get license operation.

Provides information about the services that comprise the ArtifactManagerProxy.

Contains information about a failed service operation. Accessible when the ServiceOperationFailed event is raised.

Use a SingleChoiceCondition in a Query to test a SingleChoice field against one or more values. The Value property can be a single Choice ArtifactID value or an array of ArtifactID values.

Describes how to sort Query results.

Describes the target field in Relativity.

Use a TextCondition in a Query to compare a FixedLengthText or LongText field against a string value.

Specifies that token authentication will be used to authenticate the connection.

An UpdateCommand can be passed into the ExecuteBatch() method, representing an Update call.

Contains information about a successfully completed upload.

Used to upload a file via the FileTransfer service.

Provides the contents of a User field.

Use a UserCondition in a Query to test a User field against a user name.

Specifies that username-password authentication will be used to authenticate the connection.

Use the View Condition to execute a view.

Use a WholeNumberCondition to test a WholeNumber field against a numeric value.

The WorkspaceGroupID class provides the identifier of a Group object in an associated workspace.

The WorkspaceUserID class provides the identifier of a User object in an associated workspace.

Implement a way to add/read documentation to/from WCF WSDL service contracts

Contains a string of Xml.

Defines the interface used for performing process monitoring operations.

Defines operations offered by RSAPIClient.

Defines operations offered by ServiceInformation

Handles Cancel events from a file transfer.

Handles DownloadComplete events from a file transfer.

Handles Failure events from a file transfer.

The CancelProcessEventHandler is used to handle ProcessCancel events.

The ProcessCompleteEventHandler is used to handle ProcessComplete events.

The ProcessCompleteWithErrorEventHandler is used to handle ProcessCompleteWithError events.

The ProcessFailureEventHandler is used to handle ProcessFailure events.

The ProcessProgressEventHandler is used to handle ProcessProgress events.

Handles Progress events from a file transfer.

The RSAPIClientServiceOperationFailedHandler is used to handle RSAPIClientServiceOperationFailed events from the RSAPIClient.

The ServiceOperationFailedHandler is used to handle ServiceOperationFailed events from ArtifactManager.

Handles UploadComplete events from a file transfer.

This delegate describes the method on the interface to be called.

Custom event delegate that takes an XmlElement as a parameter

Represents the services that make up ArtifactManagerProxy.

The ArtifactType enumeration represents the various artifact types within Relativity.

Defines the comparison operators available against the Boolean field type

Defines the type of Composite Logical Operator

Defines the types of comparison operators available for the DateTime field type

The available delete type options for use in the DocumentMassDeleteOptions constructor.

Represents available endpoint configurations for establishing a connection between the Services API and a client.

Defines the field category

Defines the field type, used to Create or Update Fields

Defines the types of comparison operators available for the File field type

This enumeration can be used to set the highlight color for a choice.

Defines the import behavior for relational fields only

Keyboard shortcut key

Defines the Months for when the DateTimeRange is equal to MonthOf

Defines the comparison operators available against the MonthOf field type

Defines the types of comparison operators available for the MultiChoice field type

Defines how a multi choice field should be updated

Defines how a multi object field should be updated

Defines the types of comparison operators available for the numeric field types

Defines the types of comparison operators available for the Object field type

Defines the types of comparison operators available for the Objects field type

An enum representing the state of the process.

The types of input taken by a Relativity Script.

Defines the type of data returned from a RelativityScript

Defines what type a result set is, used when a ResultSet is returned by ExecuteBatch.

An enumeration of Serialization Exception ID's.

Represents the services that make up ArtifactManagerProxy.

Defines the types of comparison operators available for the SingleChoice field type

Defines the sort direction for a Sort

Defines the types of comparison operators available against Text fields.

Defines whether a Command is executed within a Transaction.

Defines the comparison operators available against User fields