FileTransferProxy.Download Method (FileRequest)

Relativity Services API

Downloads the contents of a Relativity file field as a Stream object.

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

Syntax

Copy

public KeyValuePair<DownloadResponse, Stream> Download(
	FileRequest fileRequest
)

Public Function Download ( 
	fileRequest As FileRequest
) As KeyValuePair(Of DownloadResponse, Stream)

Parameters

fileRequest: Type: kCura.Relativity.Client.FileRequest
The FileRequest containing information about the file field to be downloaded.

Return Value

Type: KeyValuePair<DownloadResponse, Stream>
A KeyValuePair containing information about the download, and the Stream containing the file.

Remarks

This method supports zero-length files.

Reference

FileTransferProxy Class

Download Overload

kCura.Relativity.Client Namespace

2020 Relativity ODA LLC

Send comments on this topic to Relativity documentation

FileTransferProxy./* <![CDATA[ */AddLanguageSpecificTextSet("LSTA0C9A700_0?cpp=::|nu=.");/* ]]> */Download Method (FileRequest)

Parameters

Return Value

Reference

FileTransferProxy.Download Method (FileRequest)