Android Scanbot SDK API reference

7.1.0

Android Scanbot SDK API reference/io.scanbot.sdk.persistence.document/DocumentStoreStrategy

DocumentStoreStrategy

class DocumentStoreStrategy(context: Context, preferences: SharedPreferences)

Provides java.io.File directories for saving Document

The structure of the document folder is the following: {documents_directory}/document UUID -------{document_name}.pdf -------{thumbnail}

Constructors

DocumentStoreStrategy

constructor(context: Context, preferences: SharedPreferences)

Types

object Companion

Properties

val documentsDir: File

val documentsFiles: List<File>

Functions

ensureDocumentDir

fun ensureDocumentDir(docDir: File?): Boolean

ensureDocumentDirectory

fun ensureDocumentDirectory(docId: String?)

Creates directory for Document if not exists.

fun eraseDocument(docId: String, docName: String)

Deletes Document directory and all its pages from file system Use from BG thread only

eraseDocumentThumbnail

fun eraseDocumentThumbnail(docId: String)

Deletes Document thumbnail Use from BG thread only

fun getDocumentDir(docId: String?): File

getDocumentFile

fun getDocumentFile(docId: String, name: String): File

getPageImagePath

fun getPageImagePath(pagePosition: Int, document: Document): String

getThumbnailFile

fun getThumbnailFile(docId: String): File

fun getUniqueName(newName: String): String

Recursively trying to find unique name for pdf document in pdf files directory

migrateDocuments

fun migrateDocuments(newPath: String?, documents: List<Document>)

Migrates all pdf files to directory specified in preferences PreferencesConstants.EXTERNAL_DIR or default directory Constants.DEFAULT_EXTERNAL_DIR_NAME or from external directory to internal application document directories.

fun renameDocument(docId: String, oldName: String, newName: String): Boolean

Renames document. Use from BG thread only