DocumentDataProviderImpl

class DocumentDataProviderImpl : BaseDataProvider, DocumentDataProvider

Interfaces with the DocumentsApi directly, handling access to the document api

Types

Companion

object Companion

Functions

checkDocumentsStatusImmediate

open suspend override fun checkDocumentsStatusImmediate(vararg ids: String): DataProviderResponse<GetDocumentStatusResponse>

Check the current DocumentStatus of one or more documents

open suspend override fun checkDocumentsStatusImmediate(ids: List<String>): DataProviderResponse<GetDocumentStatusResponse>

deleteDocuments

open suspend override fun deleteDocuments(requestBody: DeleteDocumentBody): DataProviderResponse<DeleteDocumentResponse>

Delete one or more documents

open suspend override fun deleteDocuments(vararg ids: String): DataProviderResponse<DeleteDocumentResponse>

Delete one or more documents by id

open suspend override fun deleteDocuments(ids: List<String>): DataProviderResponse<DeleteDocumentResponse>

downloadDocumentImage

open suspend override fun downloadDocumentImage(documentId: String, saveDir: File, overwriteCache: Boolean): DataProviderResponse<File>

Download the original document image for the document represented by documentId to the saveDir folder.

editDocument

open suspend override fun editDocument(id: String, requestBody: EditDocumentBody): DataProviderResponse<String>

Edit the document with id - will modify the provided fields in the requestBody

getDocumentById

open suspend override fun getDocumentById(id: String): DataProviderResponse<GetDocumentResponse>

Fetch a full document model by document id

getDocumentList

open suspend override fun getDocumentList(params: DocumentListRequestParams): DataProviderResponse<DocumentListResponse>

Fetch a list of documents with configurable limit/search/filter parameters

longPollDocumentsStatus

open suspend override fun longPollDocumentsStatus(vararg ids: String): DataProviderResponse<GetDocumentStatusResponse>

Long poll / wait for the DocumentStatus of one or more documents.

open suspend override fun longPollDocumentsStatus(ids: List<String>): DataProviderResponse<GetDocumentStatusResponse>

uploadDocument

open suspend override fun uploadDocument(payload: DocumentUploadPayload): DataProviderResponse<String>