Interface DocumentApi
-
- All Implemented Interfaces:
public interface DocumentApiRepresents 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 DocumentcreateDocument(Integer documentImageSizeLimit)Create a new document. abstract DocumentloadDocument(String documentId)Load a document by its ID. abstract List<String>storedDocumentIds()Get all stored documents. abstract BooleandeleteDocument(String uuid)Delete a document by its ID. abstract BooleandeleteAllDocuments()Delete all stores documents. abstract BooleanisDocumentExist(String documentId)Check if a document with the given ID exists. -
-
Method Detail
-
createDocument
abstract Document createDocument(Integer documentImageSizeLimit)
Create a new document. This is an IO operation and is not recommended to execute in the UI thread.
-
loadDocument
abstract Document loadDocument(String documentId)
Load a document by its ID. This is an IO operation and is not recommended to execute in the UI thread.
-
storedDocumentIds
abstract List<String> storedDocumentIds()
Get all stored documents. This is an IO operation and is not recommended to execute in the UI thread.
-
deleteDocument
abstract Boolean deleteDocument(String uuid)
Delete a document by its ID. This is an IO operation and is not recommended to execute in the UI thread.
-
deleteAllDocuments
abstract Boolean deleteAllDocuments()
Delete all stores documents. This is an IO operation and is not recommended to execute in the UI thread.
-
isDocumentExist
abstract Boolean isDocumentExist(String documentId)
Check if a document with the given ID exists. This is an IO operation and is not recommended to execute in the UI thread.
-
-
-
-