Class UsdlCombinedRecognizer.Result

    • Constructor Detail

      • Result

        protected Result​(long nativeResult)
    • Method Detail

      • getLastName

        @NonNull
        public java.lang.String getLastName()
        The last name of the United States driver license owner.
      • getDateOfExpiry

        @NonNull
        public DateResult getDateOfExpiry()
        The date of expiry of the United States driver license.
      • getAddress

        @NonNull
        public java.lang.String getAddress()
        The full address of the United States driver license owner.
      • getDocumentNumber

        @NonNull
        public java.lang.String getDocumentNumber()
        The document number of the United States driver license.
      • getSex

        @NonNull
        public java.lang.String getSex()
        The sex of the United States driver license owner.
      • getFullName

        @NonNull
        public java.lang.String getFullName()
        The full name of the United States driver license owner.
      • getNameSuffix

        @NonNull
        public java.lang.String getNameSuffix()
        The name suffix of the United States driver license owner.
      • getRestrictions

        @NonNull
        public java.lang.String getRestrictions()
        The restrictions to driving privileges for the United States driver license owner.
      • getDateOfBirth

        @NonNull
        public DateResult getDateOfBirth()
        The date of birth of the United States driver license owner.
      • getRawData

        @NonNull
        public byte[] getRawData()
        The raw bytes contained inside 2D barcode.
      • getDateOfIssue

        @NonNull
        public DateResult getDateOfIssue()
        The date of issue of the United States driver license.
      • isUncertain

        public boolean isUncertain()
        True if returned result is uncertain, i.e. if scanned barcode was incomplete (i.e. (has parts of it missing).
      • getFirstName

        @NonNull
        public java.lang.String getFirstName()
        The first name of the United States driver license owner.
      • isScanningFirstSideDone

        public boolean isScanningFirstSideDone()
        Specified by:
        isScanningFirstSideDone in interface CombinedResult
        Returns:
        true if recognizer has finished scanning first side and is now scanning back side, false if it's still scanning first side.
      • getEndorsements

        @NonNull
        public java.lang.String getEndorsements()
        The additional privileges granted to the United States driver license owner.
      • getVehicleClass

        @NonNull
        public java.lang.String getVehicleClass()
        The type of vehicle the driver license owner has privilege to drive.
      • getMiddleName

        @NonNull
        public java.lang.String getMiddleName()
        The middle name of the United States driver license owner.
      • getRawStringData

        @NonNull
        public java.lang.String getRawStringData()
        Raw string inside 2D barcode.
      • getAge

        public int getAge()
        The current age of the document owner in years. It is calculated difference between now and date of birth. Now is current time on the device.
        Returns:
        current age of the document owner in years or -1 if date of birth is unknown.
      • getAgeLimitStatus

        public AgeLimitStatus getAgeLimitStatus​(int ageLimit)
        Calculates whether the document owner is older than the given ageLimit in years or not. Status is calculated by using the date of birth and the current time on the device.
        Parameters:
        ageLimit - age limit in years
        Returns:
        age limit status for the document owner:
      • getOptionalElements

        @NonNull
        @Deprecated
        public java.lang.String[] getOptionalElements()
        Deprecated.
        Array of elements that are not part of AAMVA standard and are specific to each US state. If no specific elements existed inside 2D barcode, this is an empty array. Otherwise, this array contains list of state-specific elements in the same order as given inside barcode. NOTE: Size of this array is both state-specific and barcode-specific. Each US state has ability to arbitrarily define size and contents of these elements. You can obtain the US state with getField(com.microblink.entities.recognizers.blinkbarcode.usdl.UsdlKeys) and using UsdlKeys.IssuingJurisdictionName as a parameter.
      • getField

        @NonNull
        public java.lang.String getField​(@NonNull
                                         UsdlKeys key)
        Returns a field inside US Driver's licence. Available Keys are listed in UsdlKeys enum.
        Parameters:
        key - Key representing the required information.
        Returns:
        required information (if it exists), or empty string if it does not
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object