In This Topic ▼

DocumentFactory Class Members

Summary

The following tables list the members exposed by DocumentFactory.

Public Methods

	Name	Description
	abortUploadDocument	Informs the cache to stop allowing uploads of the document to this uri.
	beginUpload	Starts uploading a document to the cache.
	beginUploadDocument	Starts uploading a document to the cache.
	buildUrlProxy	Helper method to build the final URL with current proxy settings.
	cancelFromPrepareAjax	Raises a prepareAjax event and returns whether the AJAX should be cancelled.
	checkCacheInfo	Retrieves information for a document in the cache using its ID.
	create	Creates a new, empty virtual document.
	deleteFromCache	Deletes the specified Document from the cache.
	downloadDocumentData	Downloads the document data from the cache.
	endUpload	Finishes uploading a document to the cache.
	isUploadDocumentUri	Indicates whether the URL points to a special LEAD cache scheme.
	loadFromCache	Retrieves the document matching the given documentId string from the cache.
	loadFromFile	Loads a document from a `Blob` object.
	loadFromUri	Loads a document from existing data stored in a remote URL.
	saveToCache	Saves the document to the cache.
	uploadDocument	Uploads raw data to the cache.
	uploadDocumentBlob	Uploads data in a JavaScript `Blob`/`File` to the cache.
	uploadFile	Uploads a new document to the server in one shot.
	uploadFileDocument	Uploads a new document with options to the server in one shot.
	verifyService	Makes a parameter-less call to the Document Service to verify a proper connection and obtain service information.

Public Properties

	Name	Description
	localProxyUrlTemplate	The path to the proxy api of the service used to load local documents.
	logErrors	Indicate whether errors should be logged to the console.
	serviceApiPath	The path to the api endpoints of the service.
	serviceHost	The LEADTOOLS Document Service host location.
	servicePath	The path from the host to the application root.
	serviceUri	Gets the full URL of the service.
	serviceUserData	User data to be passed to the service with the next Document Service call.
	uploadBlobChunkSize	Maximum size of the chunk of data to use when uploading data to the service.

Public Events

	Name	Description
	prepareAjax	Event that occurs before any AJAX request is made to the server to allow the user to examine or modify the parameters passed.

Help Version 20.0.2020.4.3