scanbot_barcode_sdk_v2 library
Classes
- AAMVA
- AAMVA
- AAMVADLID
- Driver License Or ID Document
- AAMVADLIDFieldNames
- Constants for the field type names of AAMVA.DLID.
- AAMVADriverLicense
- Driver License. File type "DL".
- AAMVAEnhancedDriverLicense
- Enhanced Driver License. File type "EN".
- AAMVAFieldNames
- Constants for the field type names of AAMVA.
- AAMVAIDCard
- ID Card. File type "ID".
- AAMVAMotorCarrierData
- Motor Carrier Data. File type "MC".
- AAMVAMotorCarrierDataFieldNames
- Constants for the field type names of AAMVA.MotorCarrierData.
- AAMVARawDocument
- The raw document as was parsed from the barcode. The original field key names and field values as they appear in the barcode are left as-is. The mnemonic field keys from the AAMVA specification are not replaced with human-readable names. No field value normalization, like ISO 8601 date reformatting, etc., is done.
- AAMVARegistrantAndVehicleData
- Registrant And Vehicle Data. File type "IR".
- AAMVARegistrantAndVehicleDataFieldNames
- Constants for the field type names of AAMVA.RegistrantAndVehicleData.
- AAMVARegistrationData
- Registration Data. File type "RG".
- AAMVARegistrationDataFieldNames
- Constants for the field type names of AAMVA.RegistrationData.
- AAMVATitleData
- Title Data. File type "TD".
- AAMVATitleDataFieldNames
- Constants for the field type names of AAMVA.TitleData.
- AAMVAVehicleData
- Vehicle Data. File type "VH".
- AAMVAVehicleDataFieldNames
- Constants for the field type names of AAMVA.VehicleData.
- AAMVAVehicleOwnerData
- Vehicle Owner Data. File type "OW".
- AAMVAVehicleOwnerDataFieldNames
- Constants for the field type names of AAMVA.VehicleOwnerData.
- AAMVAVehicleSafetyInspectionData
- Vehicle Safety Inspection Data. File type "VS".
- AAMVAVehicleSafetyInspectionDataFieldNames
- Constants for the field type names of AAMVA.VehicleSafetyInspectionData.
- ActionBarConfiguration
- Configuration of the buttons available in the action bar.
- ArOverlayFindAndPickConfiguration
- Configuration of the AR overlay.
- ArOverlayGeneralConfiguration
- Configuration of the AR overlay displayed on top of barcodes in the camera preview.
- ArOverlayPolygonConfiguration
- Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
- AspectRatio
- Configuration of the finder's aspect ratio.
- BackgroundStyle
- Appearance of the polygon used for buttons and hint backgrounds.
- BadgedButton
- Configuration of the round button with badge.
- BadgeStyle
- Configuration of the round button.
- BarcodeAdditionalParameters
- A class that contains additional parameters for barcodes detection and filtering.
- BarcodeInfoMapping
- Configuration of the barcode data mapping.
- BarcodeItem
- Data about the scanned barcode.
- BarcodeItemConfiguration
- Configuration of the barcode info box displayed in the camera preview.
- BarcodeItemErrorState
- Configuration of the the mapper's error dialog.
- BarcodeMappedData
- Format of the mapped barcode data.
- BarcodeRecognizerConfiguration
- Configuration of the scanning behavior.
- BarcodeScannerConfiguration
- Configuration of the barcode scanner screen.
- BarcodeScannerResult
- Results of the barcode scan.
- BarcodeTextLocalization
- Configuration of the all strings for barcode scanner.
- BarcodeUseCase
- Configuration of the barcode scanner screen's behavior.
- BoardingPass
- Boarding Pass
- BoardingPassFieldNames
- Constants for the field type names of BoardingPass.
- BoardingPassLeg
- Leg of the journey
- BoardingPassLegFieldNames
- Constants for the field type names of BoardingPass.Leg.
- ButtonConfiguration
- Button configuration.
- CameraConfiguration
- Configuration of the camera settings to be used while scanning.
- CameraPermissionScreen
- Configuration of the camera permission request view.
- DEMedicalPlan
- Medical Plan
- DEMedicalPlanDoctor
- Doctor
- DEMedicalPlanDoctorFieldNames
- Constants for the field type names of DEMedicalPlan.Doctor.
- DEMedicalPlanFieldNames
- Constants for the field type names of DEMedicalPlan.
- DEMedicalPlanPatient
- Patient
- DEMedicalPlanPatientFieldNames
- Constants for the field type names of DEMedicalPlan.Patient.
- DEMedicalPlanSubheading
- Subheading
- DEMedicalPlanSubheadingFieldNames
- Constants for the field type names of DEMedicalPlan.Subheading.
- DEMedicalPlanSubheadingMedicine
- Medicine
- DEMedicalPlanSubheadingMedicineFieldNames
- Constants for the field type names of DEMedicalPlan.Subheading.Medicine.
- DEMedicalPlanSubheadingMedicineSubstance
- Substance
- DEMedicalPlanSubheadingMedicineSubstanceFieldNames
- Constants for the field type names of DEMedicalPlan.Subheading.Medicine.Substance.
- DEMedicalPlanSubheadingPrescription
- Prescription
- DEMedicalPlanSubheadingPrescriptionFieldNames
- Constants for the field type names of DEMedicalPlan.Subheading.Prescription.
- EncryptionParameters
- ExpectedBarcode
- Configuration of the barcode to find and scan.
- Field
- Document field
- FieldType
- Field type
- FindAndPickArOverlayPolygonConfiguration
- Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
- FindAndPickBadgeConfiguration
- Configuration of the round badge on find and pick ar layer.
- FindAndPickScanningMode
- Configuration of the Find and Pick barcode scanning mode.
- FinderCorneredStyle
- Variant of the viewfinder displaying only the four corners of the scanning area as user guidance.
- FinderStrokedStyle
- Variant of the viewfinder displaying a full outline of the scanning area as user guidance.
- FinderStyle
- Visual appearance of the viewfinder.
- FlutterLicense
- ForegroundStyle
- Configuration of the appearance of foreground elements (e.g. text and/or icons on buttons, etc).
- GenericDocument
- A generic document. Contains fields and sub-documents.
- GenericDocumentNormalizedType
- Field type
- GS1
- GS1
- GS1Element
- GS1 Element
- GS1ElementFieldNames
- Constants for the field type names of GS1.Element.
- IconStyle
- Configuration of the icon appearance.
- IDCardPDF417
- ID Card
- IDCardPDF417FieldNames
- Constants for the field type names of IDCardPDF417.
- Insets
- ManualCountEditDialog
- Configuration of the dialog to manually edit the barcode count.
- MedicalCertificate
- Medical Certificate
- MedicalCertificateFieldNames
- Constants for the field type names of MedicalCertificate.
- MultipleScanningMode
- Configuration of the mode for scanning multiple barcodes.
- OcrResult
- Result of OCR text recognition.
- Page
- The Scanbot SDK provides a ready-to-use UI for document scanning and cropping. Both components use the notion of a 'page' as a data model for the scanning and cropping activities.
- Palette
- Value palette describing the colors of the scanner screens.
- PolygonPoint
- PolygonStyle
- Configuration of the polygon appearance.
- PredefinedBarcodes
- Rect
- Result
- Parent result class for ready-to-use UI components return data
-
ResultWrapper<
T> - Parent result class for ready-to-use UI components return data
- RoundButton
- Configuration of the round button.
- ScanbotAlertDialog
- Configuration of the the standard alert dialog.
- ScanbotBarcodeSdk
- ScanbotColor
- ScanbotEncryptionHandler
- ScanbotSdkConfig
- Scanbot SDK initialization config parameters.
- SdkLicenseException
- SdkLicenseStatus
- Scanbot SDK license status.
- SEPA
- SEPA
- SEPAFieldNames
- Constants for the field type names of SEPA.
- Sheet
- Configuration of the preview mode for scanning multiple barcodes.
- SheetContent
- Configuration of the list containing the barcodes that have already been scanned.
- SingleScanningMode
- Configuration of the single barcode scanning mode.
- Sound
- Sound configuration.
- StyledText
- Configuration of the text field appearance.
- SwipeToDelete
- Configuration of the swipe-to-delete button.
- SwissQR
- SwissQR
- SwissQRFieldNames
- Constants for the field type names of SwissQR.
- Timeouts
- Configuration of timeouts.
- TopBarConfiguration
- Configuration of the top screen bar's appearance.
- UserGuidanceConfiguration
- Configuration of the hint guiding users through the scanning process.
- VCard
- VCard
- VCardAnniversary
- Anniversary
- VCardBirthday
- Birthday
- VCardBusyTimeURL
- Busy Time URL
- VCardCalendarURI
- Calendar URI
- VCardCalendarURIForRequests
- Calendar URI For Requests
- VCardCategories
- Categories
- VCardClientPIDMap
- Client PID Map
- VCardCustom
- Custom
- VCardDeliveryAddress
- Delivery Address
- VCardEmail
- VCardEntry
- VCard Entry
- VCardEntryFieldNames
- Constants for the field type names of VCard.Entry.
- VCardFirstName
- First Name
- VCardGender
- Gender
- VCardGeoLocation
- Geo Location
- VCardIMPP
- IMPP
- VCardKind
- Kind
- VCardLanguages
- Languages
- VCardLogo
- Logo
- VCardMember
- Member
- VCardName
- Name
- VCardNickname
- Nickname
- VCardNote
- Note
- VCardOrganisation
- Organisation
- VCardPhoto
- Photo
- VCardProductId
- ProductId
- VCardPublicKey
- Public Key
- VCardRelated
- Related
- VCardRevision
- Revision
- VCardRole
- Role
- VCardSound
- Sound
- VCardSource
- Source
- VCardTelephoneNumber
- Telephone Number
- VCardTimeZone
- Time Zone
- VCardTitle
- Title
- VCardUID
- UID
- VCardURL
- URL
- VCardVersion
- Version
- VCardXML
- XML
- Vibration
- Vibration configuration.
- ViewFinderConfiguration
- Configuration of the scanning interface's viewfinder, serving as guidance to the user.
Enums
- BarcodeDocumentFormat
- Type of barcode document format used.
- BarcodeFormat
- Barcode symbology used.
- BarcodeItemInfoPosition
- Where to display the barcode info box in the camera preview.
- BarcodesExtensionFilter
- Filter for extended EAN and UPC barcodes.
- CameraModule
- Determine which camera module to use on start-up.
- CameraPreviewMode
- Configuration of the camera preview mode.
- CodeDensity
- Expected quantity of QR codes in an image.
- CollapsedVisibleHeight
- Configuration of the barcodes result sheet's height while collapsed.
- CommonFieldType
- Common field types
- DetectionStatus
- Document detection status
- DocumentDetectorMode
- Mode for document detection.
- FileEncryptionMode
- Gs1Handling
- GS1_COMPOSITE barcode type handling
- ImageFormat
- MSIPlesseyChecksumAlgorithm
- Type of MSI plessey checksum algorithm used.
- MultipleBarcodesScanningMode
- Configuration of the mode used for scanning multiple barcodes.
- OperationResult
- Standard result status
- OrientationLockMode
- Configure the orientation of the interface.
- SdkFeature
- SheetMode
- Configuration of the barcode result sheet's default visibility state.
- SoundType
- The sound selection type.
- Status
- StatusBarMode
- Visual mode used for the status bar icons.
- TopBarMode
- Visual mode used for the top bar.
- ValidationStatus
- Barcode document format
Extensions
Constants
-
allBarcodeTypes
→ const List<
BarcodeFormat> -
allDocumentFormatTypes
→ const List<
BarcodeDocumentFormat> -
contourDetectorTypeMap
→ const Map<
DocumentDetectorMode, String> -
imageFormatMap
→ const Map<
ImageFormat, String> -
oneDimensionalBarcodes
→ const List<
BarcodeFormat> -
twoDimensionalBarcodes
→ const List<
BarcodeFormat> - Return list of two dimensional barcode formats
Functions
-
colorFromString(
String? color) → Color? -
dateFromString(
String? string) → DateTime? -
encodeByteListToBase64(
List byteList) → String -
fileUriToString(
Uri? uri) → String? -
imageFilterJsonValue(
ImageFilterType filter) → String -
licenses(
) → Stream< LicenseEntry> -
stringToFileUri(
String? string) → Uri? -
toArgbString(
Color? color) → String? -
toColorString(
Color? color) → String? -
toRgbaString(
Color? color) → String? -
uintListFromString(
String string) → Uint8List
Typedefs
- BarcodeItemMapper = dynamic Function(BarcodeItem barcodeItem, dynamic onResult(BarcodeMappedData), dynamic onError())
- Handler = Future Function(MethodCall call)