DocumentUploadProgressState Enumeration

Summary

Specifies the state of the document upload.

Syntax

JavaScript Syntax

lt.Documents.DocumentUploadProgressState = { 
	Created: 0, 
	Uploading: 1, 
	Finished: 2, 
	Error: 3, 
	Aborted: 4 
}

TypeScript Syntax

lt.Documents.DocumentUploadProgressState = { 
	Created: 0, 
	Uploading: 1, 
	Finished: 2, 
	Error: 3, 
	Aborted: 4 
}

Members

0	Created	(0) The Document object has been created and an upload URL should be available for use. This state is returned from a DocumentUploadProgress object returned in a progress notification handler for UploadFile.
1	Uploading	(1) A chunk of the Document object has been successfully uploaded. This state is returned from a DocumentUploadProgress object returned in a progress notification handler for UploadFile.
2	Finished	(2) The Document object has been entirely uploaded to the cache and is ready for use. This state can be returned from a DocumentUploadProgress object returned in a progress notification handler for UploadFile just before the Promise object is resolved
3	Error	(3) The Document upload process has encountered an error, specifically while communicating with the service. This state can be returned from a DocumentUploadProgress object returned in a progress notification handler for UploadFile.
4	Aborted	(4) The Document upload process was aborted through the special method Abort. This state can be returned from a DocumentUploadProgress object returned in a progress notification handler for UploadFile.

Remarks

The DocumentUploadProgressState enumeration specifies the stage of upload of a document with UploadFile. The enumeration is available as a property of DocumentUploadProgress when the Promise object returned receives a progress notification.

Aborting a document upload using the Abort method of UploadFile will result in a progress notification as well.

No progress events are returned from within BeginUpload, UploadDocument, or AbortUploadDocument on their own.

Requirements

Target Platforms

See Also