react-native-scanbot-barcode-scanner-sdk
Version:
Scanbot Barcode Scanner SDK React Native Plugin for Android and iOS
91 lines • 4.08 kB
TypeScript
import { BarcodeScannerConfiguration, BatchBarcodeScannerConfiguration, ScanbotBarcodeSdkConfiguration } from './configurations';
import { BarcodeScannerResult, BatchBarcodeScannerResult, LicenseInfoResult } from './results';
import { DetectBarcodesOnImageArguments, ExtractImagesFromPdfArguments } from './customConfigurations';
import { ScanbotBarcodeCameraView } from './component/barcode-camera-view/ScanbotBarcodeCameraView';
import { ResultWrapper } from './customTypes';
declare const ScanbotBarcodeSDK: {
/**
* Initialize the Scanbot Barcode Scanner SDK with the preferred configuration.
*
* @param {ScanbotBarcodeSdkConfiguration} config
* @returns {Promise<ResultWrapper<string>>}
*/
initializeSdk: (config: ScanbotBarcodeSdkConfiguration) => Promise<ResultWrapper<string>>;
/**
* Provides complete information about the current license status.
*
* @returns {Promise<ResultWrapper<LicenseInfoResult>>}
*/
getLicenseInfo: () => Promise<ResultWrapper<LicenseInfoResult>>;
/**
* Remove all files generated by this plugin.
*
* @returns {Promise<ResultWrapper<string>>}
*/
cleanup: () => Promise<ResultWrapper<string>>;
/**
* Opens the Ready-To-Use UI screen for barcode scanning with the desired configuration.
*
* @param {BarcodeScannerConfiguration} config
* @returns {Promise<ResultWrapper<BarcodeScannerResult>>}
*
* @deprecated Use ***startBarcodeScanner*** from ***'react-native-scanbot-barcode-scanner-sdk/ui_v2'*** instead.
*/
startBarcodeScanner: (config: BarcodeScannerConfiguration) => Promise<ResultWrapper<BarcodeScannerResult>>;
/**
* Force the barcode scanning Ready-To-Use UI screen to close while it is running.
*
* @returns {Promise<ResultWrapper<undefined>>}
*
* @deprecated
*/
closeBarcodeScanner: () => Promise<ResultWrapper<undefined>>;
/**
* Opens the Ready-To-Use UI screen for batch barcode scanning with the desired configuration.
*
* @param {BatchBarcodeScannerConfiguration} config
* @returns {Promise<ResultWrapper<BatchBarcodeScannerResult>>}
*
* @deprecated Use ***startBarcodeScanner*** from ***'react-native-scanbot-barcode-scanner-sdk/ui_v2'*** instead.
*/
startBatchBarcodeScanner: (config: BatchBarcodeScannerConfiguration) => Promise<ResultWrapper<BatchBarcodeScannerResult>>;
/**
* Force the batch barcode scanning Ready-To-Use UI screen to close while it is running.
*
* @returns {Promise<ResultWrapper<undefined>>}
*
* @deprecated
*/
closeBatchBarcodeScanner: () => Promise<ResultWrapper<undefined>>;
/**
* Detect barcodes on the image represented by the file URL. The image file URL is part of the input arguments.
*
* @param {DetectBarcodesOnImageArguments} args
* @returns {Promise<ResultWrapper<BarcodeScannerResult>>}
*/
detectBarcodesOnImage: (args: DetectBarcodesOnImageArguments) => Promise<ResultWrapper<BarcodeScannerResult>>;
/**
* Extract images from a PDF represented by the file URL. The PDF file URL is part of the input arguments.
*
* @param {ExtractImagesFromPdfArguments} args
* @returns {Promise<ResultWrapper<string[]>>}
*/
extractImagesFromPDF: (args: ExtractImagesFromPdfArguments) => Promise<ResultWrapper<string[]>>;
/**
* Returns the Base 64 encoded representation of the image data.
*/
getImageData(imageFileUri: string): Promise<ResultWrapper<string>>;
};
export default ScanbotBarcodeSDK;
export * from './types';
export * from './customTypes';
export * from './results';
export * from './configurations';
export * from './customConfigurations';
export { Point } from './utils';
export * from './documents/BarcodeDocumentModel';
export * from './documents/CommonFieldType';
export * from './documents/GenericDocument';
export * from './component/barcode-camera-view/ScanbotBarcodeCameraViewProperties';
export { ScanbotBarcodeCameraView };
//# sourceMappingURL=index.d.ts.map