io.digified.digified_library.api.result

Class IdExtractionResult

java.lang.Object

io.digified.digified_library.api.result.DigifiedResult

io.digified.digified_library.api.result.IdExtractionResult

public class IdExtractionResult
extends DigifiedResult

Constructor Summary

Constructors

Constructor and Description
IdExtractionResult(String message, String nextProcess, Integer overallStatus, Integer result, Boolean shouldTerminate, FrontIdData frontIdData, BackIdData backIdData, String error, ArrayList<String> errorCode, String warning, ArrayList<String> warningCode) Response of the "Extract request" of the API Constructor for IdExtractionResult

Method Summary

Modifier and Type	Method and Description
BackIdData	getBackIdData() Getter method for backIdData: data of the back side of the id
FrontIdData	getFrontIdData() Getter method for frontIdData: data of the front side of the id
String	getWarning() Getter method for warning: the warning message
ArrayList<String>	getWarningCode() Getter method for warningCode: the warning code

Methods inherited from class io.digified.digified_library.api.result.DigifiedResult

getError, getErrorCode, getMessage, getNextProcess, getOverallStatus, getResult, getShouldTerminate

Methods inherited from class java.lang.Object

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

Constructor Detail

IdExtractionResult

public IdExtractionResult(String message,
                          String nextProcess,
                          Integer overallStatus,
                          Integer result,
                          Boolean shouldTerminate,
                          FrontIdData frontIdData,
                          BackIdData backIdData,
                          String error,
                          ArrayList<String> errorCode,
                          String warning,
                          ArrayList<String> warningCode)

Response of the "Extract request" of the API Constructor for IdExtractionResult

Parameters:

message - "msg" in the API response, represents the recommended action for user

nextProcess - "next" in the API response, represents the next operation

overallStatus - "overall_status" in the API response, Enumeration representing overall status of the session: (FAILED: 0, VERIFIED: 1, IN_PROGRESS: 2, PENDING: 3)

result - "result" in the API response, indicating the session status: (SUCCESS: 0, HAS_ERRORS: -1, HAS_WARNINGS: 1)

shouldTerminate - "should_terminate" in the API response, False if there will be a next op-state / try, True otherwise

frontIdData - "front" in the API response, data of the front side of the id

backIdData - "back" in the API response, data of the back side of the id

error - "Error" in the API response, the error message

errorCode - "code" in the API response, the error code

warning - "warning" in the API response, the warning message

warningCode - "warning_code" in the API response, the warning code

Method Detail

getFrontIdData

public FrontIdData getFrontIdData()

Getter method for frontIdData: data of the front side of the id

Returns:

"front" in the API response

getBackIdData

public BackIdData getBackIdData()

Getter method for backIdData: data of the back side of the id

Returns:

"back" in the API response

getWarning

public String getWarning()

Getter method for warning: the warning message

Returns:

"warning" in the API response

getWarningCode

public ArrayList<String> getWarningCode()

Getter method for warningCode: the warning code

Returns:

"warning_code" in the API response