Android Scanbot SDK/io.scanbot.sdk.docprocessing/Document

Document

Represents a document.

Constructors

constructor(documentStorage: DocumentStorage, pageFileStorage: PageFileStorage, fileIOProcessor: FileIOProcessor, documentRepository: DocumentRepository)

constructor(documentStorage: DocumentStorage, pageFileStorage: PageFileStorage, fileIOProcessor: FileIOProcessor, documentImageSizeLimit: Int, documentRepository: DocumentRepository)

constructor(documentStorage: DocumentStorage, pageFileStorage: PageFileStorage, fileIOProcessor: FileIOProcessor, documentRepository: DocumentRepository, documentId: String, createIfNotExist: Boolean = false, documentImageSizeLimit: Int)

Types

Companion

object Companion

Properties

creationTimeStamp

var creationTimeStamp: Long

The creation timestamp of the document.

documentImageSizeLimit

var documentImageSizeLimit: Int

The MAX document image size limit. By default 0 - means original image size will be used.

pageCount

val pageCount: Int

The number of pages in the document.

pages

val pages: List<Page>

The list of pages in the document.

pagesFlow

val pagesFlow: <Error class: unknown class><List<Page>>

The flow of pages in the document.

pdfUri

val pdfUri: Uri

The URI of the default destination location for PDF rendering.

tiffUri

val tiffUri: Uri

The URI of the default destination location for TIFF rendering.

uuid

var uuid: String

The unique identifier of the document.

Functions

addPage

fun addPage(image: Bitmap): Result<Page>

fun addPage(imageUri: Uri): Result<Page>

fun addPage(image: ImageRef): Result<Page>

fun addPage(image: ByteArray): Result<Page>

Adds original image in the storage, and returns pageId. This is an IO operation and is not recommended to execute in the UI thread.

clone

fun clone(): Result<Document>

Creates a deep copy of the existing document with a new unique UUID, adjust JSON to new UUID and return the newly created Document. Creates a deep copy of the each page with a new unique UUIDs. This is an IO operation and is not recommended to execute in the UI thread.

delete

fun delete(): Result<Unit>

Deletes the document. This is an IO operation and is not recommended to execute in the UI thread.

duplicate

fun duplicate(newUuid: String = UUID.randomUUID().toString(), overwrite: Boolean = true): Result<Document>

Copy document folder recursively under a new uuid, adjust JSON to newUuid and return the newly created Document. Creates a deep copy of the each page with a new unique UUIDs. This is an IO operation and is not recommended to execute in the UI thread.

insertPage

fun insertPage(image: Bitmap, index: Int): Result<Page>

fun insertPage(image: ImageRef, index: Int): Result<Page>

fun insertPage(image: ByteArray, index: Int): Result<Page>

Inserts original image with the given index, and returns Result. This is an IO operation and is not recommended to execute in the UI thread.

loadSync

fun loadSync(createIfNotExist: Boolean = false): Result<Document>

Loads the document synchronously. This is an IO operation and is not recommended to execute in the UI thread.

movePage

fun movePage(sourceIndex: Int, destinationIndex: Int): Boolean

Move the page with the given index to the destination index. This is an IO operation and is not recommended to execute in the UI thread.

pageAtIndex

fun pageAtIndex(index: Int): Page?

Returns the page with the given index.

pageIds

fun pageIds(): List<String>

Returns the list of ids of the pages.

pageWithId

fun pageWithId(uuid: String): Page?

Returns the page with the given id.

removeAllPages

fun removeAllPages(): Result<Unit>

Remove all page from the document at one batch operation. This is an IO operation and is not recommended to execute in the UI thread.

removePage

fun removePage(page: Page): Result<Unit>

Remove the given page. This is an IO operation and is not recommended to execute in the UI thread.

fun removePage(atIndex: Int): Result<Unit>

Remove the page with the given index. This is an IO operation and is not recommended to execute in the UI thread.

fun removePage(pageUuid: String): Result<Unit>

Remove the page with the given id. This is an IO operation and is not recommended to execute in the UI thread.

saveSync

fun saveSync(): Result<Unit>

Saves the document synchronously. This is an IO operation and is not recommended to execute in the UI thread.

sortPagesById

fun sortPagesById(pageIds: List<String>)

Rearranges the order of pages due to order of passed Result IDs. This is an IO operation and is not recommended to execute in the UI thread.

toJson

fun toJson(): JSONObject

Returns the JSON representation of the document.