Package io.digified.digified_library.api.result

Class DigifiedResult

java.lang.Object
io.digified.digified_library.api.result.BaseDigifiedResult
io.digified.digified_library.api.result.DigifiedResult
Direct Known Subclasses:
FaceMatchResult, GenericIdExtractionResult, IdExtractionResult, InitializationResult, PassportExtractionResult, TransliterationResult, VehicleLicenseExtractionResult
public abstract class DigifiedResult extends BaseDigifiedResult

  • Constructor Details

    • DigifiedResult

      public DigifiedResult()

  • Method Details

    • getMessage

      public String getMessage()
      Getter method for message: represents the recommended action for user
      Returns:
      "msg" in the API response

    • getNextProcess

      public String getNextProcess()
      Getter method for nextProcess: represents the next operation
      Returns:
      "next" in the API response

    • getOverallStatus

      public Integer getOverallStatus()
      Getter method for overallStatus: Enumeration representing overall status of the session: (FAILED: 0, VERIFIED: 1, IN_PROGRESS: 2, PENDING: 3)
      Returns:
      "overall_status" in the API response

    • getResult

      public Integer getResult()
      Getter method for result: indicating the session status: (SUCCESS: 0, HAS_ERRORS: -1, HAS_WARNINGS: 1)
      Returns:
      "result" in the API response

    • getShouldTerminate

      public Boolean getShouldTerminate()
      Getter method for shouldTerminate: False if there will be a next op-state / try, True otherwise.
      Returns:
      "should_terminate" in the API response

    • getError

      public String getError()
      Getter method for error: the error message
      Returns:
      "Error" in the API response

    • getErrorCode

      public ArrayList<String> getErrorCode()
      Getter method for errorCode: the error code
      Returns:
      "code" in the API response