Note: This API is now obsolete.
ArtifactManagerProxy is used to perform CRUD and other operations on objects in Relativity.
Inheritance Hierarchy
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
Name | Description | |
---|---|---|
![]() | ArtifactManagerProxy(String) |
Initializes a new instance of the ArtifactManagerProxy class with a server name.
|
![]() | ArtifactManagerProxy(Uri) |
Initializes a new instance of the ArtifactManagerProxy class with a URI specifying the location of the Services API.
|
![]() | ArtifactManagerProxy(String, ArtifactManagerSettings) |
Initializes a new instance of the ArtifactManagerProxy class with a server name and configuration values
used to override client-side settings.
|
![]() | ArtifactManagerProxy(String, EndpointType) |
Initializes a new instance of the ArtifactManagerProxy class with a server name and an EndpointType value
for the connection.
|
![]() | ArtifactManagerProxy(String, IEnumerable<EndpointType>) |
Initializes a new instance of the ArtifactManagerProxy class with a server name and a collection of EndpointType
values for the connection.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(String, String, String) |
Initializes a new instance of the ArtifactManagerProxy class with a server name and a Relativity user name and
password for authentication.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
![]() | ArtifactManagerProxy(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.
|
Properties
Name | Description | |
---|---|---|
![]() | ActiveEndpointType | Obsolete.
Retrieves the endpoint type used to create the proxy.
|
![]() | APIOptions |
Provides an instance of APIOptions associated with the current ArtifactManagerProxy instance.
|
![]() | DefaultServiceAPIPath | 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.
|
![]() | EndpointTypeExceptions | Obsolete.
Retrieves a collection that contains more detailed information about what failed during proxy construction.
The data structure represents the following: (scheme) -> (EndpointType, Exception)
|
![]() | Item | Obsolete.
Gets a ServiceInformation instance containing information about an underlying service.
|
![]() | MetadataEndpoint | Obsolete.
Gets the URI of the endpoint used to fetch the metadata.
|
![]() | Repositories |
Used to access the group of repositories.
|
![]() | State | Obsolete.
Gets the current state of the communication-oriented object.
|
Methods
Name | Description | |
---|---|---|
![]() | Abort | Obsolete.
Causes an immediate transition from the current state into the closed state.
|
![]() | Clear |
Clears the value of a file field in Relativity.
|
![]() | Close | Obsolete.
Causes a transition from the current state into the closed state.
|
![]() | ConvertToScriptInputList |
Outputs a list of RelativityScriptInput objects for use with the ExecuteRelativityScript method.
|
![]() | Create |
Creates the specified ArtifactRequests.
|
![]() | CreateBatchesForBatchSetAsync(APIOptions, Int32) |
Asynchronously creates batches for a given batchset. This method monitors the process by default.
|
![]() | CreateBatchesForBatchSetAsync(APIOptions, Int32, Boolean) |
Asynchronously creates batches for a given batchset.
|
![]() | Delete |
Deletes the specified ArtifactRequests.
|
![]() | Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
![]() | Download(FileRequest) |
Downloads the contents of a Relativity file field as a Stream object.
|
![]() | Download(FileRequest, String) |
Downloads the contents of a Relativity file field to disk.
|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | ExecuteBatch |
Executes Create, Update, Delete, MassEdit and/or MassCreate commands within a database transaction.
|
![]() | ExecuteRelativityScript |
Executes a Relativity Script configured in a workspace by the Relativity Administrator.
|
![]() | ExportApplication |
Exports an Application from Relativity workspace.
|
![]() | FlagProcessForCancellationAsync |
Cancels a running process.
|
![]() | GenerateRelativityAuthenticationToken |
Generates Relativity Authorization Token from session token.
|
![]() | GetAdminChoiceTypes |
Get a collection of Choice Type IDs for Admin Choices
|
![]() | GetAuthenticationToken | Obsolete.
This method is obsolete. Do not use.
|
![]() | GetFileFieldDownloadURL |
Get a URL to download the file contained in a file field.
|
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetLicense |
Gets serialized license object.
|
![]() | GetProcessState |
Returns information on the state of an active long-running process within the system.
|
![]() | GetRelativityScriptInputs |
Gets a list of inputs required for a script configured in a workspace by a Relativity Administrator.
|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InstallApplication |
Installs an Application.
|
![]() | InstallLibraryApplication |
Imports a Application to the Application Library
|
![]() | Login |
Establishes a session with the Services API.
|
![]() | LoginWithCredentials |
Establishes a session with the Services API.
|
![]() | Logout |
Terminates the session with the Relativity.Services API.
|
![]() | MassCreate |
Creates new custom objects in bulk using Field values provided by a template Artifact.
|
![]() | MassCreateWithAPIParameters |
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.
|
![]() | MassCreateWithDetails |
Creates new custom objects in bulk using Field values provided by a template Artifact. The results contain the IDs for the
created artifacts.
|
![]() | MassDelete |
Deletes all artifacts of the type specified in the MassDeleteOptions whose identifier matches items specified in the artifact identifiers list.
|
![]() | MassDeleteAllDocuments |
Deletes all documents in a workspace.
|
![]() | MassDeleteAllObjects |
Deletes all artifacts of the type specified.
|
![]() | MassDeleteDocuments |
Deletes all artifacts of the type specified in the MassDeleteOptions whose identifier matches items specified in the artifact identifiers list.
|
![]() | MassEdit |
Updates Documents with Field values from a template.
|
![]() | MonitorProcessState |
Registers the current proxy to monitor and raise status events for a running process.
|
![]() | PurgeBatchesOfBatchSetAsync(APIOptions, Int32) |
Asynchronously purges batches associated with a given batchset.
|
![]() | PurgeBatchesOfBatchSetAsync(APIOptions, Int32, Boolean) |
Asynchronously purges batches associated with a given batchset.
|
![]() | PushResourceFiles |
Imports a list of resource files for an application
|
![]() | Query |
Queries Relativity to find Artifacts matching the selection criteria.
|
![]() | QuerySubset |
Fetches additional search results after a call to Query.
|
![]() | Read |
Searches for the objects specified in the ArtifactRequest list, and reads them.
|
![]() | TokenLogin |
Logs in using a token, establishing a session with the Services API.
|
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | Update |
Updates the specified ArtifactRequest objects.
|
![]() | Upload |
Populates the contents of a file field in Relativity.
|
Events
Name | Description | |
---|---|---|
![]() | Cancel |
Occurs when the cancellation of an upload or download operation succeeds.
|
![]() | Closed | Obsolete.
Occurs when the communication object completes its transition from the closing state into the closed state.
|
![]() | Closing | Obsolete.
Occurs when the communication object first enters the closing state.
|
![]() | DownloadComplete |
Occurs when a download operation succeeds.
|
![]() | Failure |
Occurs when a download or upload file transfer encounters an error.
|
![]() | Faulted | Obsolete.
Occurs when the communication object first enters the faulted state.
|
![]() | Opened | Obsolete.
Occurs when the communication object completes its transition from the opening state into the opened state.
|
![]() | Opening | Obsolete.
Occurs when the communication object first enters the opening state.
|
![]() | ProcessCancelled |
Occurs when a running process is cancelled.
|
![]() | ProcessComplete |
Occurs when a running process has completed.
|
![]() | ProcessCompleteWithError |
Occurs when a running process has completed with an error.
|
![]() | ProcessFailure |
Occurs when a running process has failed during execution.
|
![]() | ProcessProgress |
Occurs when there is a notable change in the progress of a running process.
|
![]() | Progress |
Occurs when the percentage completed for an upload or download operation changes.
|
![]() | ServiceOperationFailed |
The ServiceOperationFailed event is raised when an error occurs while an operation is being attempted.
|
![]() | UploadComplete |
Occurs when an upload operation succeeds.
|
See Also