In This Topic ▼

beginUploadDocument Method

Summary

Starts uploading a document to the cache.

Syntax

TypeScript

JavaScript

beginUploadDocument = function( 
   uploadOptions 
)

static beginUploadDocument( 
   _uploadOptions?_: UploadDocumentOptions 
): JQueryPromise<string>;

Parameters

uploadOptions

Options to use with the new document. This value cannot be null.

Return Value

A Promise object that may resolve successfully to a string, or fail if the document cannot be uploaded.

Remarks

beginUpload, uploadDocument, and abortUploadDocument can be used to upload a document in chunks to the cache used by this DocumentFactory. After the document is uploaded, you can use LoadFromUri to create a LEADDocument object from the data.

When uploading is finished, endUpload must be called to inform the factory that the uploading process has finished.

This method returns a URL with a special LEAD cache scheme to indicate a loaded document. This URL can be detected using isUploadDocumentUri helper method.

Refer to Uploading Using the Document Library for detailed information on how to use these methods.

Example

For an example, refer to UploadDocument or UploadDocumentBlob.

Requirements

Target Platforms