DocumentService Protocol Reference


                    
                    
                    apiDomain

Undocumented

Declaration

Swift

var apiDomain: APIDomain { get }


                    
                    
                    delete(_:completion:)

Deletes a document

Declaration

Swift

func delete(_ document: Document, completion: @escaping CompletionResult<String>)

Parameters

`document`	Document to be deleted
`completion`	A completion callback


                    
                    
                    documents(limit:offset:completion:)

Fetches the user documents, with the possibility to retrieve them paginated

Declaration

Swift

func documents(limit: Int?, offset: Int?, completion: @escaping CompletionResult<[Document]>)

Parameters

`limit`	Limit of documents to retrieve
`offset`	Document’s offset
`completion`	A completion callback, returning the document list on success


                    
                    
                    extractions(for:cancellationToken:completion:)

Retrieves the extractions for a given document.

Declaration

Swift

func extractions(for document: Document, cancellationToken: CancellationToken, completion: @escaping CompletionResult<ExtractionResult>)

Parameters

`document`	Document to get the extractions for
`cancellationToken`	Token use to stopped the analysis when a user cancels it
`completion`	A completion callback, returning the extraction result on success


                    
                    
                    fetchDocument(with:completion:)

Retrieves a document for a given document id

Declaration

Swift

func fetchDocument(with id: String, completion: @escaping CompletionResult<Document>)

Parameters

`id`	The document’s unique identifier
`completion`	A completion callback, returning the requested document on success


                    
                    
                    layout(for:completion:)

Retrieves the layout of a given document

Declaration

Swift

func layout(for document: Document, completion: @escaping CompletionResult<Document.Layout>)

Parameters

`id`	The document’s unique identifier
`completion`	A completion callback, returning the requested document layout on success


                    
                    
                    pages(in:completion:)

Retrieves the pages of a given document

Declaration

Swift

func pages(in document: Document, completion: @escaping CompletionResult<[Document.Page]>)

Parameters

`id`	The document’s unique identifier
`completion`	A completion callback, returning the requested document layout on success


                    
                    
                    pagePreview(for:pageNumber:size:completion:)

Retrieves the page preview of a document for a given page and size

Declaration

Swift

func pagePreview(for document: Document, pageNumber: Int, size: Document.Page.Size, completion: @escaping CompletionResult<Data>)

Parameters

`document`	Document to get the preview for
`pageNumber`	The document’s page number
`size`	The document’s page size
`completion`	A completion callback, returning the requested page preview on success


                    
                    
                    submitFeedback(for:with:completion:)

Submits the analysis feedback for a given document.

Declaration

Swift

func submitFeedback(for document: Document, with extractions: [Extraction], completion: @escaping CompletionResult<Void>)

Parameters

`document`	The document which the feedback will be updated to
`extractions`	The document’s updated extractions
`completion`	A completion callback


                    
                    
                    documents(resourceHandler:limit:offset:completion:)

Extension method

Undocumented

Declaration

Swift

func documents(resourceHandler: ResourceDataHandler<APIResource<DocumentList>>,
               limit: Int?,
               offset: Int?,
               completion: @escaping CompletionResult<[Document]>)


                    
                    
                    deleteDocument(resourceHandler:with:completion:)

Extension method

Undocumented

Declaration

Swift

func deleteDocument(resourceHandler: ResourceDataHandler<APIResource<String>>,
                    with id: String,
                    completion: @escaping CompletionResult<String>)


                    
                    
                    extractions(resourceHandler:documentResourceHandler:for:cancellationToken:completion:)

Extension method

Undocumented

Declaration

Swift

func extractions(resourceHandler: @escaping CancellableResourceDataHandler<APIResource<ExtractionsContainer>>,
                 documentResourceHandler: @escaping CancellableResourceDataHandler<APIResource<Document>>,
                 for document: Document,
                 cancellationToken: CancellationToken?,
                 completion: @escaping CompletionResult<ExtractionResult>)


                    
                    
                    fetchDocument(resourceHandler:with:cancellationToken:completion:)

Extension method

Undocumented

Declaration

Swift

func fetchDocument(resourceHandler: CancellableResourceDataHandler<APIResource<Document>>,
                   with id: String,
                   cancellationToken: CancellationToken? = nil,
                   completion: @escaping CompletionResult<Document>)


                    
                    
                    layout(resourceHandler:for:completion:)

Extension method

Undocumented

Declaration

Swift

func layout(resourceHandler: ResourceDataHandler<APIResource<Document.Layout>>,
            for document: Document,
            completion: @escaping CompletionResult<Document.Layout>)


                    
                    
                    pages(resourceHandler:in:completion:)

Extension method

Undocumented

Declaration

Swift

func pages(resourceHandler: ResourceDataHandler<APIResource<[Document.Page]>>,
           in document: Document,
           completion: @escaping CompletionResult<[Document.Page]>)


                    
                    
                    pagePreview(resourceHandler:in:pageNumber:size:completion:)

Extension method

Undocumented

Declaration

Swift

func pagePreview(resourceHandler: @escaping ResourceDataHandler<APIResource<Data>>,
                 in document: Document,
                 pageNumber: Int,
                 size: Document.Page.Size?,
                 completion: @escaping CompletionResult<Data>)


                    
                    
                    submitFeedback(resourceHandler:for:with:completion:)

Extension method

Undocumented

Declaration

Swift

func submitFeedback(resourceHandler: ResourceDataHandler<APIResource<String>>,
                    for document: Document,
                    with extractions: [Extraction],
                    completion: @escaping CompletionResult<Void>)