FileTransferProxy Class

Relativity Services API

Note: This API is now obsolete.

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

Inheritance Hierarchy

System.Object
kCura.Relativity.Client.FileTransferProxy

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

Syntax

Copy

[ObsoleteAttribute("This class is deprecated.  Refer to the documentation for the RSAPIClient to find similar File Transfer methods.")]
public sealed class FileTransferProxy : IDisposable, 
	ICommunicationObject

<ObsoleteAttribute("This class is deprecated.  Refer to the documentation for the RSAPIClient to find similar File Transfer methods.")>
Public NotInheritable Class FileTransferProxy
	Implements IDisposable, ICommunicationObject

The FileTransferProxy type exposes the following members.

Constructors

	Name	Description
	FileTransferProxy(String)	Obsolete. Initializes a new instance of the FileTransferProxy class with a server name.
	FileTransferProxy(Uri)	Obsolete. Initializes a new instance of the FileTransferProxy class with a URI specifying the location of the FileTransfer service.
	FileTransferProxy(String, EndpointType)	Obsolete. Initializes a new instance of the FileTransferProxy class with a server name, and an EndpointType value for the connection.
	FileTransferProxy(String, FileTransferSettings)	Obsolete. Initializes a new instance of the FileTransferProxy class with a server name, and configuration values used to override client-side settings.
	FileTransferProxy(String, IEnumerable<EndpointType>)	Obsolete. Initializes a new instance of the FileTransferProxy class with a server name and a collection of EndpointType values for the connection.
	FileTransferProxy(Uri, EndpointType)	Obsolete. Initializes a new instance of the FileTransferProxy class with a URI specifying the location of the FileTransfer service, and an EndpointType value for the connection.
	FileTransferProxy(Uri, FileTransferSettings)	Obsolete. Initializes a new instance of the FileTransferProxy class with a URI specifying the location of the FileTransfer service, and configuration values used to override client-side settings.
	FileTransferProxy(Uri, IEnumerable<EndpointType>)	Obsolete. Initializes a new instance of the FileTransferProxy class with a URI specifying the location of the FileTransfer service and a collection of EndpointType values for the connection.
	FileTransferProxy(String, EndpointType, FileTransferSettings)	Obsolete. Initializes a new instance of the FileTransferProxy class with a server name, an EndpointType value for the connection, and configuration values used to override client-side settings.
	FileTransferProxy(String, IEnumerable<EndpointType>, FileTransferSettings)	Obsolete. Initializes a new instance of the FileTransferProxy class with a server name, a collection of EndpointType values for the connection, and configuration values used to override client-side settings.
	FileTransferProxy(Uri, EndpointType, FileTransferSettings)	Obsolete. Initializes a new instance of the FileTransferProxy class with a URI specifying the location of the FileTransfer service, an EndpointType value for the connection, and configuration values used to override client-side settings.
	FileTransferProxy(Uri, IEnumerable<EndpointType>, FileTransferSettings)	Obsolete. Initializes a new instance of the FileTransferProxy class with a URI specifying the location of the FileTransfer service a collection of EndpointType values for the connection, and configuration values used to override client-side settings.

Top

Properties

	Name	Description
	ActiveEndpointType	Obsolete. Gets the EndpointType used to make a connection.
	DefaultServiceAPIPath	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	Retrieves a collection that contains more detailed information about what failed during proxy construction. The data structure represents the following: (scheme) -> (EndpointType, Exception).
	MetadataEndpoint	Gets the URI of the endpoint used to fetch the metadata.
	State	Gets the current state of the communication-oriented object.

Top

Methods

	Name	Description
	Abort	Causes an immediate transition from the current state into the closed state.
	BeginClose(AsyncCallback, Object)	Begins an asynchronous operation to close the communication object.
	BeginClose(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to close the communication object with a specified timeout.
	BeginOpen(AsyncCallback, Object)	Begins an asynchronous operation to open a communication object.
	BeginOpen(TimeSpan, AsyncCallback, Object)	Begins an asynchronous operation to open a communication object within a specified interval of time.
	Clear	Clears the value of a file field in Relativity.
	Close()	Causes a transition from the current state into the closed state.
	Close(TimeSpan)	Causes a transition from the current state into the closed state.
	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.
	EndClose	Completes an asynchronous operation to close a communication object.
	EndOpen	Completes an asynchronous operation to open a communication object.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetFileFieldDownloadURL	Constructs a URL for downloading a file.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Open()	Causes a communication object to transition from the created state into the opened state.
	Open(TimeSpan)	Causes a communication object to transition from the created state into the opened state within a specified interval of time.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Upload	Populates the contents of a file field in Relativity.

Top

Events

	Name	Description
	Cancel	Occurs when the cancellation of an upload or download operation succeeds.
	Closed	Occurs when the communication object completes its transition from the closing state into the closed state.
	Closing	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	Occurs when the communication object first enters the faulted state.
	Opened	Occurs when the communication object completes its transition from the opening state into the opened state.
	Opening	Occurs when the communication object first enters the opening state.
	Progress	Occurs when the percentage completed for an upload or download operation changes.
	UploadComplete	Occurs when an upload operation succeeds.

Top

Remarks

The FileTransferProxy class is provided in the kCura.Relativity.Client.dll. It is used for populating, clearing, and reading from a file field. The process for constructing an instance of this class is the same as for the ArtifactManagerProxy class.

Reference

kCura.Relativity.Client Namespace

2020 Relativity ODA LLC

Send comments on this topic to Relativity documentation