Package com.incode.welcome_sdk.listeners

Interface IdScanListener

  • All Implemented Interfaces:
    com.incode.welcome_sdk.listeners.BaseListener , com.incode.welcome_sdk.listeners.ErrorListener , com.incode.welcome_sdk.listeners.UserCancelledListener 
    
public interface IdScanListener
 implements BaseListener

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      Unit onIdScanReady(NonUiIdScanController controller) Called when the NonUiIdScanController is ready to be used.
      abstract Unit onIdFrontCompleted(IdScanResult frontIdScanResult) Called when the front of an ID or a Passport Photo page scan is completed.
      abstract Unit onIdBackCompleted(IdScanResult backIdScanResult) Called when the back of an ID scan is completed.
      Unit onIdFrontAttemptCompleted(IdScanResult frontIdScanResult) Called after every individual front ID or Passport capture attempt, including intermediate failures such as glare, blur, wrong document side, or spoof detection.
      Unit onIdBackAttemptCompleted(IdScanResult backIdScanResult) Called after every individual back ID capture attempt, including intermediate failures such as glare, blur, wrong document side, or spoof detection.

      • Methods inherited from class com.incode.welcome_sdk.listeners.ErrorListener

        onError

      • Methods inherited from class com.incode.welcome_sdk.listeners.UserCancelledListener

        onUserCancelled

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • onIdScanReady

         Unit onIdScanReady(NonUiIdScanController controller)

        Called when the NonUiIdScanController is ready to be used.

        Parameters:
        controller - Instance of NonUiIdScanController

      • onIdFrontCompleted

         abstract Unit onIdFrontCompleted(IdScanResult frontIdScanResult)

        Called when the front of an ID or a Passport Photo page scan is completed.

        For per-attempt reporting that fires after every individual capture attempt (including intermediate failures), use onIdFrontAttemptCompleted.

        Parameters:
        frontIdScanResult - Result from the terminal front ID scan attempt.

      • onIdBackCompleted

         abstract Unit onIdBackCompleted(IdScanResult backIdScanResult)

        Called when the back of an ID scan is completed.

        For per-attempt reporting that fires after every individual capture attempt (including intermediate failures), use onIdBackAttemptCompleted.

        Parameters:
        backIdScanResult - Result from the terminal back ID scan attempt.

      • onIdFrontAttemptCompleted

         Unit onIdFrontAttemptCompleted(IdScanResult frontIdScanResult)

        Called after every individual front ID or Passport capture attempt, including intermediate failures such as glare, blur, wrong document side, or spoof detection.

        The terminal attempt is signaled when IdScanResult.allAttemptsExhausted is true or when the attempt succeeds; for terminal-only reporting, use onIdFrontCompleted instead.

        Parameters:
        frontIdScanResult - Result of the individual capture attempt.

      • onIdBackAttemptCompleted

         Unit onIdBackAttemptCompleted(IdScanResult backIdScanResult)

        Called after every individual back ID capture attempt, including intermediate failures such as glare, blur, wrong document side, or spoof detection.

        The terminal attempt is signaled when IdScanResult.allAttemptsExhausted is true or when the attempt succeeds; for terminal-only reporting, use onIdBackCompleted instead.

        Parameters:
        backIdScanResult - Result of the individual capture attempt.