Skip to main content

DocumentTransferStatus

Represents the current status of a document transfer operation, which could be an upload or a download. This status tracks the entire lifecycle of the transfer process, from initiation to completion or failure.

enum DocumentTransferStatus {
  INITIATED
  UPLOADING
  PROCESSING
  COMPLETED
  FAILED
  EXPIRED
}

Values​

DocumentTransferStatus.INITIATED​

The transfer request has been created but the actual upload or download has not started yet.

DocumentTransferStatus.UPLOADING​

The document is currently being uploaded. This applies only to upload operations.

DocumentTransferStatus.PROCESSING​

The document is being processed after upload (e.g., virus scanning, watermarking, indexing). This applies primarily to uploads.

DocumentTransferStatus.COMPLETED​

The transfer has finished successfully. The document is now available (downloaded or fully uploaded and processed).

DocumentTransferStatus.FAILED​

The transfer encountered an error and did not complete. Check failureReason (if available) for more details.

DocumentTransferStatus.EXPIRED​

The transfer session expired before it could be completed (e.g., upload window timed out or download link expired).

Member Of​

DataRoomDocumentDownload object ● DataRoomDocumentUpload object