ArtifactManagerProxy Class

Relativity Services API

Note: This API is now obsolete.

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

System.Object
  kCura.Relativity.Client.ArtifactManagerProxy

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

[ObsoleteAttribute("This class is deprecated and should be replaced with the RSAPIClient.  Refer to the documentation for the RSAPIClient.")]
public sealed class ArtifactManagerProxy : IProcessMonitorable, 
	IDisposable

The ArtifactManagerProxy type exposes the following members.

Constructors

  NameDescription
Public methodArtifactManagerProxy(String)
Initializes a new instance of the ArtifactManagerProxy class with a server name.
Public methodArtifactManagerProxy(Uri)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API.
Public methodArtifactManagerProxy(String, ArtifactManagerSettings)
Initializes a new instance of the ArtifactManagerProxy class with a server name and configuration values used to override client-side settings.
Public methodArtifactManagerProxy(String, EndpointType)
Initializes a new instance of the ArtifactManagerProxy class with a server name and an EndpointType value for the connection.
Public methodArtifactManagerProxy(String, IEnumerable<EndpointType>)
Initializes a new instance of the ArtifactManagerProxy class with a server name and a collection of EndpointType values for the connection.
Public methodArtifactManagerProxy(Uri, ArtifactManagerSettings)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API and configuration values used to override client-side settings.
Public methodArtifactManagerProxy(Uri, EndpointType)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API and an EndpointType value for the connection.
Public methodArtifactManagerProxy(Uri, IEnumerable<EndpointType>)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API and a collection of EndpointType values for the connection.
Public methodArtifactManagerProxy(String, EndpointType, ArtifactManagerSettings)
Initializes a new instance of the ArtifactManagerProxy class with a server name, an EndpointType value for the connection, and configuration values used to override client-side settings.
Public methodArtifactManagerProxy(String, IEnumerable<EndpointType>, ArtifactManagerSettings)
Initializes a new instance of the ArtifactManagerProxy class with a server name, a collection of EndpointType values for the connection, and configuration values used to override client-side settings.
Public methodArtifactManagerProxy(String, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a server name and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(Uri, EndpointType, ArtifactManagerSettings)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API, an EndpointType value for the connection, and the configuration values used to override client-side settings.
Public methodArtifactManagerProxy(Uri, IEnumerable<EndpointType>, ArtifactManagerSettings)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API, a collection of EndpointType values for the connection, and configuration values used to override client-side settings.
Public methodArtifactManagerProxy(Uri, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(String, ArtifactManagerSettings, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a server name, configuration values used to override client-side settings, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(String, EndpointType, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a server name, an EndpointType value for the connection, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(String, IEnumerable<EndpointType>, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a server name, a collection of EndpointType values for the connection, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(Uri, ArtifactManagerSettings, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API, configuration values used to override client-side settings, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(Uri, EndpointType, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API, an EndpointType value for the connection, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(Uri, IEnumerable<EndpointType>, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API, a collection of EndpointType values for the connection, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(String, EndpointType, ArtifactManagerSettings, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a server name, an EndpointType value for the connection, configuration values used to override client-side settings, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(String, IEnumerable<EndpointType>, ArtifactManagerSettings, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a server name, a collection of EndpointType values for the connection, configuration values used to override client-side settings, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(Uri, EndpointType, ArtifactManagerSettings, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API, an EndpointType value for the connection, configuration values used to override client-side settings, and a Relativity user name and password for authentication.
Public methodArtifactManagerProxy(Uri, IEnumerable<EndpointType>, ArtifactManagerSettings, String, String)
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API, a collection of EndpointType values for the connection, configuration values used to override client-side settings, and a Relativity user name and password for authentication.
Top
Properties

  NameDescription
Public propertyActiveEndpointType Obsolete.
Retrieves the endpoint type used to create the proxy.
Public propertyAPIOptions
Provides an instance of APIOptions associated with the current ArtifactManagerProxy instance.
Public propertyDefaultServiceAPIPath Obsolete.
Gets the relative portion of the URI that is used in combination with the serverName to construct a metadata endpoint address. This property reflects the default installation of the Relativity Services API.
Public propertyEndpointTypeExceptions Obsolete.
Retrieves a collection that contains more detailed information about what failed during proxy construction. The data structure represents the following: (scheme) -> (EndpointType, Exception)
Public propertyItem Obsolete.
Gets a ServiceInformation instance containing information about an underlying service.
Public propertyMetadataEndpoint Obsolete.
Gets the URI of the endpoint used to fetch the metadata.
Public propertyRepositories
Used to access the group of repositories.
Public propertyState Obsolete.
Gets the current state of the communication-oriented object.
Top
Methods

  NameDescription
Public methodAbort Obsolete.
Causes an immediate transition from the current state into the closed state.
Public methodClear
Clears the value of a file field in Relativity.
Public methodClose Obsolete.
Causes a transition from the current state into the closed state.
Public methodConvertToScriptInputList
Outputs a list of RelativityScriptInput objects for use with the ExecuteRelativityScript method.
Public methodCreate
Creates the specified ArtifactRequests.
Public methodCreateBatchesForBatchSetAsync(APIOptions, Int32)
Asynchronously creates batches for a given batchset. This method monitors the process by default.
Public methodCreateBatchesForBatchSetAsync(APIOptions, Int32, Boolean)
Asynchronously creates batches for a given batchset.
Public methodDelete
Deletes the specified ArtifactRequests.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodDownload(FileRequest)
Downloads the contents of a Relativity file field as a Stream object.
Public methodDownload(FileRequest, String)
Downloads the contents of a Relativity file field to disk.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteBatch
Executes Create, Update, Delete, MassEdit and/or MassCreate commands within a database transaction.
Public methodExecuteRelativityScript
Executes a Relativity Script configured in a workspace by the Relativity Administrator.
Public methodExportApplication
Exports an Application from Relativity workspace.
Public methodFlagProcessForCancellationAsync
Cancels a running process.
Public methodGenerateRelativityAuthenticationToken
Generates Relativity Authorization Token from session token.
Public methodGetAdminChoiceTypes
Get a collection of Choice Type IDs for Admin Choices
Public methodGetAuthenticationToken Obsolete.
This method is obsolete. Do not use.
Public methodGetFileFieldDownloadURL
Get a URL to download the file contained in a file field.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLicense
Gets serialized license object.
Public methodGetProcessState
Returns information on the state of an active long-running process within the system.
Public methodGetRelativityScriptInputs
Gets a list of inputs required for a script configured in a workspace by a Relativity Administrator.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInstallApplication
Installs an Application.
Public methodInstallLibraryApplication
Imports a Application to the Application Library
Public methodLogin
Establishes a session with the Services API.
Public methodLoginWithCredentials
Establishes a session with the Services API.
Public methodLogout
Terminates the session with the Relativity.Services API.
Public methodMassCreate
Creates new custom objects in bulk using Field values provided by a template Artifact.
Public methodMassCreateWithAPIParameters
Creates RDO instances based upon the Field values provided by a 'template' ArtifactRequest. The template provides the default values. An RDO instance will be created for each ArtifactRequest in the ArtifactRequests list. Any field values provided in an ArtifactRequest will override the defaults provided by the template ArtifactRequest.
Public methodMassCreateWithDetails
Creates new custom objects in bulk using Field values provided by a template Artifact. The results contain the IDs for the created artifacts.
Public methodMassDelete
Deletes all artifacts of the type specified in the MassDeleteOptions whose identifier matches items specified in the artifact identifiers list.
Public methodMassDeleteAllDocuments
Deletes all documents in a workspace.
Public methodMassDeleteAllObjects
Deletes all artifacts of the type specified.
Public methodMassDeleteDocuments
Deletes all artifacts of the type specified in the MassDeleteOptions whose identifier matches items specified in the artifact identifiers list.
Public methodMassEdit
Updates Documents with Field values from a template.
Public methodMonitorProcessState
Registers the current proxy to monitor and raise status events for a running process.
Public methodPurgeBatchesOfBatchSetAsync(APIOptions, Int32)
Asynchronously purges batches associated with a given batchset.
Public methodPurgeBatchesOfBatchSetAsync(APIOptions, Int32, Boolean)
Asynchronously purges batches associated with a given batchset.
Public methodPushResourceFiles
Imports a list of resource files for an application
Public methodQuery
Queries Relativity to find Artifacts matching the selection criteria.
Public methodQuerySubset
Fetches additional search results after a call to Query.
Public methodRead
Searches for the objects specified in the ArtifactRequest list, and reads them.
Public methodTokenLogin
Logs in using a token, establishing a session with the Services API.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Updates the specified ArtifactRequest objects.
Public methodUpload
Populates the contents of a file field in Relativity.
Top
Events

  NameDescription
Public eventCancel
Occurs when the cancellation of an upload or download operation succeeds.
Public eventClosed Obsolete.
Occurs when the communication object completes its transition from the closing state into the closed state.
Public eventClosing Obsolete.
Occurs when the communication object first enters the closing state.
Public eventDownloadComplete
Occurs when a download operation succeeds.
Public eventFailure
Occurs when a download or upload file transfer encounters an error.
Public eventFaulted Obsolete.
Occurs when the communication object first enters the faulted state.
Public eventOpened Obsolete.
Occurs when the communication object completes its transition from the opening state into the opened state.
Public eventOpening Obsolete.
Occurs when the communication object first enters the opening state.
Public eventProcessCancelled
Occurs when a running process is cancelled.
Public eventProcessComplete
Occurs when a running process has completed.
Public eventProcessCompleteWithError
Occurs when a running process has completed with an error.
Public eventProcessFailure
Occurs when a running process has failed during execution.
Public eventProcessProgress
Occurs when there is a notable change in the progress of a running process.
Public eventProgress
Occurs when the percentage completed for an upload or download operation changes.
Public eventServiceOperationFailed
The ServiceOperationFailed event is raised when an error occurs while an operation is being attempted.
Public eventUploadComplete
Occurs when an upload operation succeeds.
Top
See Also

Reference