In This Topic ▼

abortUploadDocument Method

Summary

Informs the cache to stop allowing uploads of the document to this uri.

Syntax

TypeScript

JavaScript

abortUploadDocument = function( 
   uri 
)

static abortUploadDocument( 
   uri: string 
): JQueryPromise<void>;

Parameters

uri

The uri data used to stop allowing document uploads to with UploadDocument/uploaddocumentblob.

Return Value

A void Promise object that may resolve successfully.

Remarks

After beginUpload or beginUploadDocument has resolved and returned a uri, uploadDocument is used to upload chunks of data to the server. abortUploadDocument is used to clear the cache entry for the document upload when the developer knows the upload will not be completed.

Unlike UploadFile/uploadfiledocument, the Promise object returned by UploadDocument/uploaddocumentblob, does not have an abort method. Instead, AbortUploadDocument must be called. This will not necessarily cause the Promise object from this method to fail immediately, but continued calls to UploadDocument/uploaddocumentblob will.

Refer to Uploading Using LEADTOOLS Document Library for more information on how to use this method.

Requirements

Target Platforms