Class DocumentReader

Entry point of the Regula Document Reader.

Properties

customization

customization: Customization

Params that relate to the camera view controller customization and etc.

env

env: string | null

Environment type.

functionality

functionality: Functionality

Params that influence the scanning process, camera view controller customization and etc.

locale

locale: string | null

Custom language locale code of DocumentReaderSDK. If empty or doesn't exist - app language is used. Format "en-US" or "en".

localizationDictionary

localizationDictionary: Record<string, string> | null

A localization dictionary to override default localization logic. Allows to replace any string of DocumentReader SDK with an arbitrary string.

To see all the localization keys, look up the RegulaSDK.strings file at ios/Pods/DocumentReader/DocumentReader.xcframework/ios-arm64/DocumentReader.framework/en.lproj/RegulaSDK.strings.

Unmodifiable property. Use setter instead of editing.

processParams

processParams: ProcessParams

Params that influence the scanning process.

rfidScenario

rfidScenario: RFIDScenario

Params that influence the RFID chip processing.

rfidSessionStatus

rfidSessionStatus: string | null

Allows you to get a status of the RFID chip reading process. IOS only.

tag

tag: string | null

Current Session identifier.

tenant

tenant: string | null

Customer name.

Accessors

availableScenarios

get availableScenarios(): DocReaderScenario[]
A list of scenarios that can be used for documents recognition based on your license and Core framework capabilities.

Returns DocReaderScenario[]
- Defined in index.d.ts:346

license

get license(): License | null
Information about your license.

Returns License | null
- Defined in index.d.ts:352

onCustomButtonTapped

set onCustomButtonTapped(completion: CustomButtonTappedCompletion): void
Set click listener for buttons from the UI customization layer.
Parameters
- completion: CustomButtonTappedCompletion
Returns void
- Defined in index.d.ts:428

version

get version(): DocReaderVersion | null
Information about the SDK.

Returns DocReaderVersion | null
- Defined in index.d.ts:349

videoEncoderCompletion

set videoEncoderCompletion(completion: VideoEncoderCompletion): void
Allows user to receive a video file of current session.
Parameters
- completion: VideoEncoderCompletion
Returns void
- Defined in index.d.ts:431

`Static`instance

get instance(): DocumentReader
The only instance of singleton class DocumentReader.

Returns DocumentReader
- Defined in index.d.ts:339

Methods

addPKDCertificates

addPKDCertificates(certificates: PKDCertificate[]): void
Used to pass certificates to Document Reader that will be used during the RFID chip processing.
Parameters
- certificates: PKDCertificate[]
  PKD certificates.
Returns void
- Defined in index.d.ts:551

cancelDBUpdate

cancelDBUpdate(): Promise<boolean>
Cancels any ongoing database update or preparation.

Returns Promise<boolean>
- Defined in index.d.ts:492

checkDatabaseUpdate

checkDatabaseUpdate(databaseID: string): Promise<DocumentsDatabase | null>
Allows you to to check database update.

Requires android.permission.INTERNET android permission.
Parameters
- databaseID: string
  identifier of the database.
Returns Promise<DocumentsDatabase | null>
Returns DocumentsDatabase or null.
- Defined in index.d.ts:489

clearPKDCertificates

clearPKDCertificates(): void
It's used to remove certificates from your app that are used during the RFID chip processing.

Returns void
- Defined in index.d.ts:556

connectBluetoothDevice

connectBluetoothDevice(deviceName: string): Promise<boolean>
Used to connect to the ble device.

Requires btdevice plugin.
Parameters
- deviceName: string
  name of the device to connect to.
Returns Promise<boolean>
Returns boolean indicating success of connection.
- Defined in index.d.ts:450

deinitializeReader

deinitializeReader(): void
Used to deinitialize Document Reader and free up RAM as a consequence of this.

Returns void
- Defined in index.d.ts:453

endBackendTransaction

endBackendTransaction(): void
It's used to end transaction during backend processing.

Returns void
- Defined in index.d.ts:574

engageDevice

engageDevice(
    type: MDLDeviceEngagement,
    options?: { data?: string; withoutUI: boolean },
): Promise<
    [engagement: DeviceEngagement | null, error: DocReaderException | null],
>
Used to engage device.
Parameters
- type: MDLDeviceEngagement
  = MDLDeviceEngagement.QR and
- Optionaloptions: { data?: string; withoutUI: boolean }
Returns Promise<[engagement: DeviceEngagement | null, error: DocReaderException | null]>
- Defined in index.d.ts:588

finalizePackage

finalizePackage(
    config?: FinalizeConfig,
): Promise<
    [
        action: DocReaderAction,
        info: TransactionInfo
        | null,
        error: DocReaderException | null,
    ],
>
It's used to finalize package during backend processing.
Parameters
- Optionalconfig: FinalizeConfig
Returns Promise<
    [
        action: DocReaderAction,
        info: TransactionInfo
        | null,
        error: DocReaderException | null,
    ],
>
Returns action, info and error.
- Defined in index.d.ts:571

initialize

initialize(config: InitConfig): Promise<[boolean, DocReaderException | null]>
Allows you to initialize Document Reader.
Parameters
- config: InitConfig
  configuration file for DocumentReader initialization.
Returns Promise<[boolean, DocReaderException | null]>
Returns boolean indicating success of initialization and a nullable DocReaderException.
- Defined in index.d.ts:440

isAuthenticatorAvailableForUse

isAuthenticatorAvailableForUse(): Promise<boolean>
Allows you to check if you can use external Regula Bluetooth devices based on your license, available scenarios and Core framework capabilities.

Returns Promise<boolean>
true if available.
- Defined in index.d.ts:372

isAuthenticatorRFIDAvailableForUse

isAuthenticatorRFIDAvailableForUse(): Promise<boolean>
Allows you to check if you can use external Regula Bluetooth devices for RFID based on your license and Core framework capabilities.

Returns Promise<boolean>
true if external Regula Bluetooth for RFID is supported.
- Defined in index.d.ts:365

isReady

isReady(): Promise<boolean>
Allows you to check if Document Reader is ready for use.

Returns Promise<boolean>
- Defined in index.d.ts:419

isRFIDAvailableForUse

isRFIDAvailableForUse(): Promise<boolean>
Allows you to check if native RFID chip reading can be performed based on your license and Core framework capabilities.

Returns Promise<boolean>
true if native RFID chip reading is supported.
- Defined in index.d.ts:358

prepareDatabase

prepareDatabase(
databaseID: string,
prepareCompletion?: DocumentReaderPrepareCompletion,
): Promise<[boolean, DocReaderException | null]>
Allows you to download a database from the Regula server. If it exists in your app and compatible with the SDK, it won't be downloaded.

Requires android.permission.INTERNET android permission.
Parameters
- databaseID: string
  Identifier of the database.
- OptionalprepareCompletion: DocumentReaderPrepareCompletion
  Optional callback for progress updates.
Returns Promise<[boolean, DocReaderException | null]>
Returns boolean indicating success of preparing database and a nullable DocReaderException.
- Defined in index.d.ts:466

readMDL

readMDL(
    type: MDLDeviceEngagement,
    retrieval: DataRetrieval,
): Promise<
    [
        action: DocReaderAction,
        results: Results
        | null,
        error: DocReaderException | null,
    ],
>
Used to read MDL.
Parameters
- type: MDLDeviceEngagement
- retrieval: DataRetrieval
Returns Promise<
    [
        action: DocReaderAction,
        results: Results
        | null,
        error: DocReaderException | null,
    ],
>
- Defined in index.d.ts:579

recognize

recognize(config: RecognizeConfig, completion: DocumentReaderCompletion): void
Used for proccessing predefined images.
Parameters
- config: RecognizeConfig
  Configuration for recognition.
- completion: DocumentReaderCompletion
  Block to execute after the recognition process finishes.
Returns void
- Defined in index.d.ts:529

removeDatabase

removeDatabase(): Promise<boolean>
Allows you to remove the database from your app.

Returns Promise<boolean>
true only if the database was removed or absent.
- Defined in index.d.ts:499

resetConfiguration

resetConfiguration(): void
Use this method to reset all parameters to their default values.

Returns void
- Defined in index.d.ts:425

retrieveData

retrieveData(
    retrieval: DataRetrieval,
    options?: { engagement?: DeviceEngagement; withoutUI?: MDLDeviceRetrieval },
): Promise<
    [
        action: DocReaderAction,
        results: Results
        | null,
        error: DocReaderException | null,
    ],
>
Used to retrieve data.
Parameters
- retrieval: DataRetrieval
- Optionaloptions: { engagement?: DeviceEngagement; withoutUI?: MDLDeviceRetrieval }
Returns Promise<
    [
        action: DocReaderAction,
        results: Results
        | null,
        error: DocReaderException | null,
    ],
>
- Defined in index.d.ts:597

rfid

rfid(config: RFIDConfig): void
Used for the RFID chip processing.

Requires android.permission.NFC android permission.
Parameters
- config: RFIDConfig
  chip reading configuration.
Returns void
- Defined in index.d.ts:538

runAutoUpdate

runAutoUpdate(
databaseID: string,
prepareCompletion?: DocumentReaderPrepareCompletion,
): Promise<[boolean, DocReaderException | null]>
Allows you to download a database from the Regula server. Each new update of the database will be downloaded.

Requires android.permission.INTERNET android permission.
Parameters
- databaseID: string
  Identifier of the database.
- OptionalprepareCompletion: DocumentReaderPrepareCompletion
  Optional callback for progress updates.
Returns Promise<[boolean, DocReaderException | null]>
Returns boolean indicating success of running auto update and a nullable DocReaderException.
- Defined in index.d.ts:479

scan

scan(config: ScannerConfig, completion: DocumentReaderCompletion): void
Used for multiple frames processing which are captured from the camera(old UI).
Parameters
- config: ScannerConfig
  Scanning configuration.
- completion: DocumentReaderCompletion
  Block to execute after the recognition process finishes.
Returns void
- Defined in index.d.ts:513

setTCCParams

setTCCParams(params: TccParams): Promise<[boolean, DocReaderException | null]>
Sets the given TCCParams to the RFID session. The parameters are required to be set before starting RFID session.
Parameters
- params: TccParams
  TCC related parameters.
Returns Promise<[boolean, DocReaderException | null]>
Returns boolean indicating success of setting TCC parameters and a nullable DocReaderException.
- Defined in index.d.ts:565

startNewPage

startNewPage(): void
Used to start the processing of the next page of the document once the current one is processed.

Returns void
- Defined in index.d.ts:502

startNewSession

startNewSession(): void
Used to start a scanning process.

Returns void
- Defined in index.d.ts:505

startScanner

startScanner(config: ScannerConfig, completion: DocumentReaderCompletion): void
Used for multiple frames processing which are captured from the camera(new UI).
Parameters
- config: ScannerConfig
  Scanning configuration.
- completion: DocumentReaderCompletion
  Block to execute after the recognition process finishes.
Returns void
- Defined in index.d.ts:521

status

status(): Promise<string>
Allows you to get a status of Document Reader.

Returns Promise<string>
- Defined in index.d.ts:422

stopRFIDReader

stopRFIDReader(): void
Stops the RFID reader if it's active.

Returns void
- Defined in index.d.ts:544

stopScanner

stopScanner(): void
Stops the document scanner if it's active.

Returns void
- Defined in index.d.ts:541

Class DocumentReader

Index

Properties

Accessors

Methods

Properties

customization

env

functionality

locale

localizationDictionary

processParams

rfidScenario

rfidSessionStatus

tag

tenant

Accessors

availableScenarios

Returns DocReaderScenario[]

license

Returns License | null

onCustomButtonTapped

Parameters

Returns void

version

Returns DocReaderVersion | null

videoEncoderCompletion

Parameters

Returns void

Staticinstance

Returns DocumentReader

Methods

addPKDCertificates

Parameters

Returns void

cancelDBUpdate

Returns Promise<boolean>

checkDatabaseUpdate

Parameters

Returns Promise<DocumentsDatabase | null>

clearPKDCertificates

Returns void

connectBluetoothDevice

Parameters

Returns Promise<boolean>

deinitializeReader

Returns void

endBackendTransaction

Returns void

engageDevice

Parameters

Returns Promise<[engagement: DeviceEngagement | null, error: DocReaderException | null]>

finalizePackage

Parameters

Returns Promise< [ action: DocReaderAction, info: TransactionInfo | null, error: DocReaderException | null, ],>

initialize

Parameters

Returns Promise<[boolean, DocReaderException | null]>

isAuthenticatorAvailableForUse

Returns Promise<boolean>

isAuthenticatorRFIDAvailableForUse

Returns Promise<boolean>

isReady

Returns Promise<boolean>

isRFIDAvailableForUse

Returns Promise<boolean>

prepareDatabase

Parameters

Returns Promise<[boolean, DocReaderException | null]>

readMDL

Parameters

Returns Promise< [ action: DocReaderAction, results: Results | null, error: DocReaderException | null, ],>

recognize

Parameters

Returns void

removeDatabase

Returns Promise<boolean>

resetConfiguration

Returns void

retrieveData

`Static`instance

Returns Promise<
[
action: DocReaderAction,
info: TransactionInfo
| null,
error: DocReaderException | null,
],
>

Returns Promise<
[
action: DocReaderAction,
results: Results
| null,
error: DocReaderException | null,
],
>

Returns Promise<
[
action: DocReaderAction,
results: Results
| null,
error: DocReaderException | null,
],
>