capacitor-plugin-scanbot-sdk/dist/esm/ui_v2/document/DocumentScanningFlow.d.ts

Scanbot Document and Barcode Scanner SDK for Capacitor

import type { OrientationLockMode } from '../../ui_v2/common/Common';
import { Palette } from '../../ui_v2/common/Common';
import type { NavigationBarMode } from '../../ui_v2/common/NavigationBarConfiguration';
import type { StatusBarMode } from '../../ui_v2/common/TopBarConfiguration';
import { DocumentScannerOutputSettings } from '../../ui_v2/document/DocumentScannerOutputSettings';
import { DocumentScannerScreens } from '../../ui_v2/document/DocumentScannerScreens';
import { DocumentScannerTextLocalization } from '../../ui_v2/document/DocumentScannerTextLocalization';
import type { DeepPartial } from '../../utils/utils';
import { PartiallyConstructible } from '../../utils/utils';
/**
Configuration of the general appearance.
*/
export declare class DocumentFlowAppearanceConfiguration extends PartiallyConstructible {
    /**
      Determines the visual mode used for the status bar icons.
      
      Default is LIGHT
      */
    statusBarMode: StatusBarMode;
    /**
      Determines the visual mode used for the navigation bar icons. Android only.
      
      Default is LIGHT
      */
    navigationBarMode: NavigationBarMode;
    /**
      The background color of the top bar. Only applicable when the visual mode is specified as 'SOLID', otherwise ignored.
      
      Default is "?sbColorPrimary"
      */
    topBarBackgroundColor: string;
    /**
      The background color of the bottom bar.
      
      Default is "?sbColorPrimary"
      */
    bottomBarBackgroundColor: string;
    /**
      Which mode to use when orientation should be locked to landscape or portrait.
      
      Default is NONE
      */
    orientationLockMode: OrientationLockMode;
    /** @param source {@displayType `DeepPartial<DocumentFlowAppearanceConfiguration>`} */
    constructor(source?: DeepPartial<DocumentFlowAppearanceConfiguration>);
}
/**
Configuration of the document scanner screen.
*/
export declare class DocumentScanningFlow extends PartiallyConstructible {
    /**
      Version number of the configuration object.
      
      Default is "1.0"
      */
    version: string;
    /**
      The configuration object should be applied for this screen.
      
      Default is "DocumentScanner"
      */
    screen: string;
    /**
      Define the screen's base color values from which other colors are derived.
      */
    palette: Palette;
    /**
      Configuration of all the strings for the document scanner screen.
      */
    localization: DocumentScannerTextLocalization;
    /**
      Configuration of the general appearance.
      */
    appearance: DocumentFlowAppearanceConfiguration;
    /**
      Configuration of the output settings.
      */
    outputSettings: DocumentScannerOutputSettings;
    /**
      Configuration of the document scanner sub-screens.
      */
    screens: DocumentScannerScreens;
    /**
      The UUID of the existing document to be edited.
      */
    documentUuid: string | null;
    /**
      Clean the existing pages from the scanning session.
      
      Default is true
      */
    cleanScanningSession: boolean;
    /**
      If enabled, the scanner automatically navigates to the review screen when the flow starts. This property is ignored if the document is empty or if the review screen is disabled.
      
      Default is false
      */
    showReviewScreenOnStart: boolean;
    /**
      If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
      
      Default is true
      */
    keepScreenOn: boolean;
    /** @param source {@displayType `DeepPartial<DocumentScanningFlow>`} */
    constructor(source?: DeepPartial<DocumentScanningFlow>);
}