Enumerations

The following enumerations are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, SBSDKAAMVARecordFieldType) {
    SBSDKAAMVARecordFieldTypeUnknown,
    SBSDKAAMVARecordFieldTypeFullName,
    SBSDKAAMVARecordFieldTypeLastName,
    SBSDKAAMVARecordFieldTypeFamilyName,
    SBSDKAAMVARecordFieldTypeFirstName,
    SBSDKAAMVARecordFieldTypeMiddleNameOrInitial,
    SBSDKAAMVARecordFieldTypeNameSuffix,
    SBSDKAAMVARecordFieldTypeNamePrefix,
    SBSDKAAMVARecordFieldTypeMailingStreetAddress1,
    SBSDKAAMVARecordFieldTypeMailingStreetAddress2,
    SBSDKAAMVARecordFieldTypeMailingCity,
    SBSDKAAMVARecordFieldTypeMailingJurisdictionCode,
    SBSDKAAMVARecordFieldTypeMailingPostalCode,
    SBSDKAAMVARecordFieldTypeResidenceStreetAddress1,
    SBSDKAAMVARecordFieldTypeResidenceStreetAddress2,
    SBSDKAAMVARecordFieldTypeResidenceCity,
    SBSDKAAMVARecordFieldTypeResidenceJurisdictionCode,
    SBSDKAAMVARecordFieldTypeResidencePostalCode,
    SBSDKAAMVARecordFieldTypeLicenseOrIdNumber,
    SBSDKAAMVARecordFieldTypeLicenseClassificationCode,
    SBSDKAAMVARecordFieldTypeLicenseRestrictionCode,
    SBSDKAAMVARecordFieldTypeLicenseEndorsementsCode,
    SBSDKAAMVARecordFieldTypeHeightInFeetInches,
    SBSDKAAMVARecordFieldTypeHeightInCM,
    SBSDKAAMVARecordFieldTypeWeightInLBS,
    SBSDKAAMVARecordFieldTypeWeightInKG,
    SBSDKAAMVARecordFieldTypeEyesColor,
    SBSDKAAMVARecordFieldTypeHairColor,
    SBSDKAAMVARecordFieldTypeLicenseExpirationDate,
    SBSDKAAMVARecordFieldTypeDateOfBirth,
    SBSDKAAMVARecordFieldTypeSex,
    SBSDKAAMVARecordFieldTypeLicenseOrIdDocumentIssueDate,
    SBSDKAAMVARecordFieldTypeIssueTimestamp,
    SBSDKAAMVARecordFieldTypeNumberOfDuplicates,
    SBSDKAAMVARecordFieldTypeMedicalIndicatorCodes,
    SBSDKAAMVARecordFieldTypeOrganDonor,
    SBSDKAAMVARecordFieldTypeNonResidentIndicator,
    SBSDKAAMVARecordFieldTypeUniqueCustomerIdentifier,
    SBSDKAAMVARecordFieldTypeSocialSecurityNumber,
    SBSDKAAMVARecordFieldTypeSuffix,
    SBSDKAAMVARecordFieldTypePrefix,
    SBSDKAAMVARecordFieldTypeVirginiaSpecificClass,
    SBSDKAAMVARecordFieldTypeVirginiaSpecificRestrictions,
    SBSDKAAMVARecordFieldTypeVirginiaSpecificEndorsements,
    SBSDKAAMVARecordFieldTypePhysicalDescriptionWeightRange,
    SBSDKAAMVARecordFieldTypeDocumentDiscriminator,
    SBSDKAAMVARecordFieldTypeCountryTerritoryOfIssuance,
    SBSDKAAMVARecordFieldTypeFederalCommercialVehicleCodes,
    SBSDKAAMVARecordFieldTypePlaceOfBirth,
    SBSDKAAMVARecordFieldTypeAuditInformation,
    SBSDKAAMVARecordFieldTypeInventoryControlNumber,
    SBSDKAAMVARecordFieldTypeRaceEthnicity,
    SBSDKAAMVARecordFieldTypeStandardVehicleClassification,
    SBSDKAAMVARecordFieldTypeStandardEndorsementCode,
    SBSDKAAMVARecordFieldTypeStandardRestrictionCode,
    SBSDKAAMVARecordFieldTypeJurisdictionSpecificVehicleClassificationDescription,
    SBSDKAAMVARecordFieldTypeJurisdictionSpecific,
    SBSDKAAMVARecordFieldTypeJurisdictionSpecificRestrictionCodeDescription,
    SBSDKAAMVARecordFieldTypeComplianceType,
    SBSDKAAMVARecordFieldTypeCardRevisionDate,
    SBSDKAAMVARecordFieldTypeHazMatEndorsementExpiryDate,
    SBSDKAAMVARecordFieldTypeLimitedDurationDocumentIndicator,
    SBSDKAAMVARecordFieldTypeFamilyNameTruncation,
    SBSDKAAMVARecordFieldTypeFirstNamesTruncation,
    SBSDKAAMVARecordFieldTypeMiddleNamesTruncation,
    SBSDKAAMVARecordFieldTypeUnder18Until,
    SBSDKAAMVARecordFieldTypeUnder19Until,
    SBSDKAAMVARecordFieldTypeUnder21Until,
    SBSDKAAMVARecordFieldTypeOrganDonorIndicator,
    SBSDKAAMVARecordFieldTypeVeteranIndicator,
    SBSDKAAMVARecordFieldTypePermitClassificationCode,
    SBSDKAAMVARecordFieldTypePermitExpirationDate,
    SBSDKAAMVARecordFieldTypePermitIdentifier,
    SBSDKAAMVARecordFieldTypePermitIssueDate,
    SBSDKAAMVARecordFieldTypePermitRestrictionCode,
    SBSDKAAMVARecordFieldTypePermitEndorsementCode,
    SBSDKAAMVARecordFieldTypeCourtRestrictionCode,
}

    Swift

    enum SBSDKAAMVARecordFieldType : Int

  • Boarding pass field types

    See more

    Declaration

    Objective-C

    enum SBSDKBoardingPassDocumentFieldType {}

    Swift

    enum SBSDKBoardingPassDocumentFieldType : Int

  • DC document field types

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificateDocumentFieldType {}

    Swift

    enum SBSDKDisabilityCertificateDocumentFieldType : Int

  • Type classifiers for checkboxes recognized on disability certificates.

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificateRecognizerCheckboxType {}

    Swift

    enum SBSDKDisabilityCertificateRecognizerCheckboxType : UInt

  • Type classifiers for dates recognized on disability certificates.

    See more

    Declaration

    Objective-C

    enum SBSDKDisabilityCertificatesRecognizerDateResultType {}

    Swift

    enum SBSDKDisabilityCertificatesRecognizerDateResultType : UInt

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, SBSDKDisabilityCertificatesRecognizerInsuredPersonType) {
    SBSDKDisabilityCertificatesRecognizerInsuredPersonTypeUnknown = -1,
    SBSDKDisabilityCertificatesRecognizerInsuredPersonTypeAdult = 0,
    SBSDKDisabilityCertificatesRecognizerInsuredPersonTypeChild = 1
}

    Swift

    enum SBSDKDisabilityCertificatesRecognizerInsuredPersonType : Int

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, SBSDKDisabilityCertificatesRecognizerDocumentIntentionType) {
    SBSDKDisabilityCertificatesRecognizerDocumentIntentionTypeUnknown = -1,
    SBSDKDisabilityCertificatesRecognizerDocumentIntentionTypeEmployer = 0,
    SBSDKDisabilityCertificatesRecognizerDocumentIntentionTypeInsuranceCompany = 1,
    SBSDKDisabilityCertificatesRecognizerDocumentIntentionTypeInsuredPerson = 2
}

    Swift

    enum SBSDKDisabilityCertificatesRecognizerDocumentIntentionType : Int

  • Undocumented

    See more

    Declaration

    Objective-C

    NS_ENUM(NSInteger, SBSDKDisabilityCertificatesRecognizerResultPatientFieldType) {
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeInsuranceProvider = 0,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeFirstName = 1,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeLastName = 2,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeAddressString1 = 3,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeAddressString2 = 4,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeDiagnose = 5,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeHealthInsuranceNumber = 6,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeInsuredPersonNumber = 7,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeStatus = 8,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypePlaceOfOperationNumber = 9,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeDoctorNumber = 10,
    SBSDKDisabilityCertificatesRecognizerResultPatientFieldTypeUndefined = -1
}

    Swift

    enum SBSDKDisabilityCertificatesRecognizerResultPatientFieldType : Int

  • The status of the latest document detection.

    See more

    Declaration

    Objective-C

    enum SBSDKDocumentDetectionStatus {}

    Swift

    struct SBSDKDocumentDetectionStatus : Equatable, RawRepresentable

  • EHIC field type.

    See more

    Declaration

    Objective-C

    enum SBSDKHealthInsuranceCardFieldType {}

    Swift

    enum SBSDKHealthInsuranceCardFieldType : UInt

  • EHIC detection status.

    See more

    Declaration

    Objective-C

    enum SBSDKHealthInsuranceCardDetectionStatus {}

    Swift

    enum SBSDKHealthInsuranceCardDetectionStatus : UInt

  • ID card field types

    See more

    Declaration

    Objective-C

    enum SBSDKIDCardPDF417DocumentFieldType {}

    Swift

    enum SBSDKIDCardPDF417DocumentFieldType : Int

  • Enumeration of supported image file types.

    See more

    Declaration

    Objective-C

    enum SBSDKImageFileFormat {}

  • The ScanbotSDK image filter types.

    See more

    Declaration

    Objective-C

    enum SBSDKImageFilterType {}

    Swift

    struct SBSDKImageFilterType : Equatable, RawRepresentable

  • Type classifiers for machine-readable-zone fields.

    See more

    Declaration

    Objective-C

    enum SBSDKMachineReadableZoneRecognizerFieldName {}

    Swift

    enum SBSDKMachineReadableZoneRecognizerFieldName : UInt

  • Type classifier for machine-readable-zone document types.

    See more

    Declaration

    Objective-C

    enum SBSDKMachineReadableZoneRecognizerResultDocumentType {}

    Swift

    enum SBSDKMachineReadableZoneRecognizerResultDocumentType : Int

  • MRZ checkdigit types.

    See more

    Declaration

    Objective-C

    enum SBSDKMachineReadableZoneRecognizerResultCheckDigitType {}

    Swift

    enum SBSDKMachineReadableZoneRecognizerResultCheckDigitType : UInt

  • German medical plan document subheading receipe information description field type

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanSubheadingReceipeFieldType {}

    Swift

    enum SBSDKMedicalPlanSubheadingReceipeFieldType : Int

  • German medical plan document medicine substance information description field type

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanMedicineSubstanceFieldType {}

    Swift

    enum SBSDKMedicalPlanMedicineSubstanceFieldType : Int

  • German medical plan document medicine information description field type

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanMedicineFieldType {}

    Swift

    enum SBSDKMedicalPlanMedicineFieldType : Int

  • German medical plan document subheading information description field type

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanStandardSubheadingFieldType {}

    Swift

    enum SBSDKMedicalPlanStandardSubheadingFieldType : Int

  • German medical plan document doctor information description field type

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanDoctorFieldType {}

    Swift

    enum SBSDKMedicalPlanDoctorFieldType : Int

  • German medical plan document patient information description field type

    See more

    Declaration

    Objective-C

    enum SBSDKMedicalPlanPatientFieldType {}

    Swift

    enum SBSDKMedicalPlanPatientFieldType : Int

  • When an OCR operation finishes it returns an array of result blocks containing e.g. the position and type of recognized text. Each of the result blocks has a specific type.

    See more

    Declaration

    Objective-C

    enum SBSDKOCRResultBlockType {}

    Swift

    enum SBSDKOCRResultBlockType : UInt

  • This enum describes the available orentiation lock modes for image capturing. All modes work independently from the user interface orientation.

    See more

    Declaration

    Objective-C

    enum SBSDKOrientationLock {}

  • Specifies the desired page size (media box size) for PDF rendering operations.

    See more

    Declaration

    Objective-C

    enum SBSDKPDFRendererPageSize {}

    Swift

    enum SBSDKPDFRendererPageSize : UInt

  • Part of the page layout analyis result. Describes the detected orientation of the text.

    See more

    Declaration

    Objective-C

    enum SBSDKPageOrientation {}

    Swift

    enum SBSDKPageOrientation : UInt

  • Part of the page layout analyis result. Describes the reading direction of the text independently from the orientation. Note: Experimental - this is currently not always working correctly for top-to-bottom text.

    See more

    Declaration

    Objective-C

    enum SBSDKWritingDirection {}

    Swift

    enum SBSDKWritingDirection : UInt

  • Part of the page layout analyis result. Describes the order of columns in top-to-bottom writing direction resp. of rows in left-right and right-left direction.

    See more

    Declaration

    Objective-C

    enum SBSDKTextlineOrder {}

    Swift

    enum SBSDKTextlineOrder : UInt

SBSDKPayFormScannerRecognitionMode

  • An enumeration describing the recognition mode of the scanner.

    See more

    Declaration

    Objective-C

    enum SBSDKPayFormScannerRecognitionMode {}

    Swift

    enum SBSDKPayFormScannerRecognitionMode : Int

SBSDKPayFormTokenType

  • An enumeration describing the types of tokens the SBSDKPayFormScanner can detect and recognize.

    See more

    Declaration

    Objective-C

    enum SBSDKPayFormTokenType {}

    Swift

    enum SBSDKPayFormTokenType : Int

  • An enum describing the orientation of a polygon edge.

    See more

    Declaration

    Objective-C

    enum SBSDKPolygonEdgeOrientation {}

    Swift

    enum SBSDKPolygonEdgeOrientation : UInt

  • An enumeration that represents resource type.

    See more

    Declaration

    Objective-C

    enum SBSDKResourceType {}

    Swift

    enum SBSDKResourceType : UInt

  • SEPA document field types

    See more

    Declaration

    Objective-C

    enum SBSDKSEPADocumentFieldType {}

    Swift

    enum SBSDKSEPADocumentFieldType : Int

  • This enum describes the possible modes of the cameras shutter. Automatic shutter means, a photo is taken automatically if a document was detected in the video stream. The smart mode is the default mode. Whenever the automatic shutter is toggled the delegate of SBSDKScannerViewController is informed. You can also the query the autoShutterEnabled property. The default shutter button reflects this mode.

    See more

    Declaration

    Objective-C

    enum SBSDKShutterMode {}

    Swift

    enum SBSDKShutterMode : Int

  • This enum describes the possible modes of the view finder during scanning.

    See more

    Declaration

    Objective-C

    enum SBSDKFinderMode {}

    Swift

    enum SBSDKFinderMode : Int

  • TIFF Compression algorithms

    See more

    Declaration

    Objective-C

    enum SBSDKTIFFImageWriterCompressionOptions {}

    Swift

    enum SBSDKTIFFImageWriterCompressionOptions : Int32

  • Custom TIFF field type.

    See more

    Declaration

    Objective-C

    enum SBSDKTIFFImageWriterUserDefinedFieldType {}

    Swift

    enum SBSDKTIFFImageWriterUserDefinedFieldType : Int32

  • The ScanbotSDK text orientation types.

    See more

    Declaration

    Objective-C

    enum SBSDKTextOrientation {}

    Swift

    struct SBSDKTextOrientation : Equatable, RawRepresentable

  • Enumeration of image type classifiers. *

    See more

    Declaration

    Objective-C

    enum SBSDKUIPageFileType {}

  • Enumeration of video preview content mode.

    See more

    Declaration

    Objective-C

    enum SBSDKUIVideoContentMode {}

  • vCard document field type

    See more

    Declaration

    Objective-C

    enum SBSDKVCardDocumentFieldType {}

    Swift

    enum SBSDKVCardDocumentFieldType : Int