| Leadtools.Documents Namespace : DocumentUploadProgressState Enumeration |
Leadtools.Documents.DocumentUploadProgressState = function() { };
Leadtools.Documents.DocumentUploadProgressState.prototype = {
created = 0,
uploading = 1,
finished = 2,
error = 3,
aborted = 4,
};
| Value | Member | Description |
|---|---|---|
| 0 | created |
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 |
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 |
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 |
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 |
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. |
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.