Package io.scanbot.sdk.docprocessing
Interface DocumentApi
-
- All Implemented Interfaces:
public interface DocumentApi
Represents a Document API that allows to create, load and store documents. Please call all this methods in IO thread if possible as they performs file operations.
-
-
Method Summary
Modifier and Type Method Description abstract Document
createDocument(Integer documentImageSizeLimit)
Create a new document. abstract Document
loadDocument(String documentId)
Load a document by its ID. abstract List<String>
storedDocumentIds()
Get all stored documents. abstract Boolean
deleteDocument(String uuid)
Delete a document by its ID. abstract Boolean
deleteAllDocuments()
Delete all stores documents. abstract Boolean
isDocumentExist(String documentId)
Check if a document with the given ID exists. -
-
Method Detail
-
createDocument
abstract Document createDocument(Integer documentImageSizeLimit)
Create a new document.
-
loadDocument
abstract Document loadDocument(String documentId)
Load a document by its ID.
-
storedDocumentIds
abstract List<String> storedDocumentIds()
Get all stored documents.
-
deleteDocument
abstract Boolean deleteDocument(String uuid)
Delete a document by its ID.
-
deleteAllDocuments
abstract Boolean deleteAllDocuments()
Delete all stores documents.
-
isDocumentExist
abstract Boolean isDocumentExist(String documentId)
Check if a document with the given ID exists.
-
-
-
-