Genius Scan SDK/com.geniusscansdk.scanflow/ScanFlowErrorCode

ScanFlowErrorCode

enum ScanFlowErrorCode : Enum<ScanFlowErrorCode>

Error codes that can occur during a scan flow.

Cross-platform plugins expose stringCode as the code field in their structured error payloads.


`cancellation_error`	The user canceled the document or barcode scan flow.	Treat as a normal exit; do not show an error.
`configuration_error`	The configuration or input parameters are invalid.	Fix the configuration before retrying.
`licensing_error`	The license key is invalid, expired, or not initialized.	Verify the license key and contact support if needed.
`capture_error`	The camera or capture session failed.	Let the user retry; restart the device if the problem persists.
`storage_space_error`	There is not enough storage space to write generated files.	Ask the user to free up storage space and retry.
`internal_error`	An unexpected SDK error occurred.	Show a generic error and collect `underlying_error` for diagnostics.

Entries

CANCELLATION

User has canceled the scan flow.

CONFIGURATION

Invalid configuration or input parameters.

LICENSING

License key invalid/expired/not initialized.

CAPTURE

Camera/capture session failure.

STORAGE_SPACE

Not enough storage space available.

INTERNAL

Unexpected/internal SDK error.

Properties

entries

val entries: EnumEntries<ScanFlowErrorCode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

stringCode

val stringCode: String

Functions

valueOf

fun valueOf(value: String): ScanFlowErrorCode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ScanFlowErrorCode>

Returns an array containing the constants of this enum type, in the order they're declared.