Class DocumentReaderResults
java.lang.Object
com.regula.documentreader.api.results.DocumentReaderResults
- All Implemented Interfaces:
Cloneable
Class describing results returned on completion of Document Reader work
-
Field Summary
FieldsModifier and TypeFieldDescriptionint
DocumentReaderAuthenticityResult
results of work with document authenticitypositions of found Barcoderesults of work with barcode resultint
Indicates which page of document contains RFID chip (0 if there's no page containing) Requires Document Type recognition, otherwise 1 by defaultrect with holograms on the documentpositions of document blanktype of the document, if recognized Requires Document Type recognitionint
int
image processing graphic resultsboolean
Indicates, if document is needed with high resolution false by defaultint
Image Quality check resultsint
int
Indicates, if document has more pages (count) to be processed (e.g.positions of the MRZ areaint[]
int
all available results in JSON formatint
One ofeRFID_ErrorCodes
values Result of RFID reading processRFIDSessionData
results of work with the SDK within the context of the current communication session with electronic documentimage processing text results -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
clone()
static DocumentReaderResults
fromRawResults
(String json) static DocumentReaderResults
fromRawResults
(JSONObject jsonObject) getContainers
(int[] resultType) Method returns containers by result type.Method returns only containers for eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_RFID_SESSION, eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_ENCRYPTED_RCL and eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_LICENSE values fromeRPRM_ResultType.ResultTypeValues
enum.getGraphicFieldByType
(int fieldType, int source) Use this method to get single graphic field from the results containergetGraphicFieldByType
(int fieldType, int source, int pageIndex) Use this method to get single graphic field from the results containergetGraphicFieldByType
(int fieldType, int source, int pageIndex, int light) Use this method to get single graphic field from the results containerBitmap
getGraphicFieldImageByType
(int fieldType) Use this method to get single graphic field from the results containerBitmap
getGraphicFieldImageByType
(int fieldType, int source) Use this method to get single graphic field from the results containerBitmap
getGraphicFieldImageByType
(int fieldType, int source, int pageIndex) Use this method to get single graphic field from the results containerBitmap
getGraphicFieldImageByType
(int fieldType, int source, int pageIndex, int light) Use this method to get single graphic field from the results containerint
getQualityResult
(int imageQualityCheckType) Use this method to get image quality verification resultint
getQualityResult
(int imageQualityCheckType, int securityFeature) Use this method to get image quality verification resultint
getQualityResult
(int imageQualityCheckType, int securityFeature, int pageIndex) Use this method to get image quality verification resultgetTextFieldByType
(int fieldType) Use this method, to get single text field from the results containergetTextFieldByType
(int fieldType, int lcid) Use this method, to get single text field from the results containerint
getTextFieldStatusByType
(int fieldType) Use this method to get single text field verification result from the results containerint
getTextFieldStatusByType
(int fieldType, int lcid) Use this method to get single text field verification result from the results containergetTextFieldValueByType
(int fieldType) Use this method, to get single text field value from the results containergetTextFieldValueByType
(int fieldType, int lcid) Use this method, to get single text field value from the results containergetTextFieldValueByType
(int fieldType, int lcid, int source) Use this method, to get single text field value from the results containergetTextFieldValueByType
(int fieldType, int lcid, int source, boolean original) Use this method, to get single text field value from the results containergetTextFieldValueByTypeAndSource
(int fieldType, int source) Use this method, to get single text field value from the results containergetTextFieldValueByTypeAndSource
(int fieldType, int source, boolean original) Use this method, to get single text field value from the results container
-
Field Details
-
videoCaptureSessionId
-
chipPage
public int chipPageIndicates which page of document contains RFID chip (0 if there's no page containing) Requires Document Type recognition, otherwise 1 by default -
irElapsedTime
public int irElapsedTime -
elapsedTime
public int elapsedTime -
elapsedTimeRFID
public int elapsedTimeRFID -
processingFinishedStatus
public int processingFinishedStatus -
morePagesAvailable
public int morePagesAvailableIndicates, if document has more pages (count) to be processed (e.g. ID card's front and back side) Requires Document Type recognition, otherwise 0 by default -
rfidResult
public int rfidResultOne ofeRFID_ErrorCodes
values Result of RFID reading process -
highResolution
public boolean highResolutionIndicates, if document is needed with high resolution false by default -
graphicResult
image processing graphic results -
textResult
image processing text results -
documentPosition
positions of document blank -
barcodePosition
positions of found Barcode -
mrzPosition
positions of the MRZ area -
imageQuality
Image Quality check results -
documentType
type of the document, if recognized Requires Document Type recognition -
docLivenessRects
rect with holograms on the document -
rawResult
all available results in JSON format -
rfidSessionData
public RFIDSessionData rfidSessionDataresults of work with the SDK within the context of the current communication session with electronic document -
authenticityResult
public DocumentReaderAuthenticityResult authenticityResultresults of work with document authenticity -
barcodeResult
results of work with barcode result -
ppmIn
-
hologramTiltType
public int hologramTiltType -
multipageAnimationImage
public int[] multipageAnimationImage -
animationImage
public int animationImage -
vdsncData
-
status
-
transactionInfo
-
-
Constructor Details
-
DocumentReaderResults
public DocumentReaderResults()
-
-
Method Details
-
getTextFieldValueByType
Use this method, to get single text field value from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetchedlcid
- one ofLCID
values indicating ID of language-culture to differentiate one field of the same type from another (e.g. Belarus Passport Page # 31 – Belarusian and Russian fields of the same type)source
- one ofeRPRM_ResultType
values, indicating the fields origin sourceoriginal
- define to return original image, false by default- Returns:
- value of the desired field or null, if not found
-
getTextFieldValueByType
Use this method, to get single text field value from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetchedlcid
- one ofLCID
values indicating ID of language-culture to differentiate one field of the same type from another (e.g. Belarus Passport Page # 31 – Belarusian and Russian fields of the same type)source
- one ofeRPRM_ResultType
values, indicating the fields origin source- Returns:
- value of the desired field or null, if not found
-
getTextFieldValueByType
Use this method, to get single text field value from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetchedlcid
- one ofLCID
values indicating ID of language-culture to differentiate one field of the same type from another (e.g. Belarus Passport Page # 31 – Belarusian and Russian fields of the same type)- Returns:
- value of the desired field or null, if not found
-
getTextFieldValueByType
Use this method, to get single text field value from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetched- Returns:
- value of the desired field or null, if not found
-
getTextFieldValueByTypeAndSource
Use this method, to get single text field value from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetchedsource
- one ofeRPRM_ResultType
values, indicating the fields origin source- Returns:
- value of the desired field or null, if not found
-
getTextFieldValueByTypeAndSource
Use this method, to get single text field value from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetchesource
- one ofeRPRM_ResultType
values, indicating the fields origin sourceoriginal
- define to return original image, false by default- Returns:
- value of the desired field or null, if not found
-
getTextFieldByType
Use this method, to get single text field from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetched- Returns:
- value of the desired field or null, if not found
-
getTextFieldByType
Use this method, to get single text field from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which value should be fetchedlcid
- one ofLCID
values indicating ID of language-culture to differentiate one field of the same type from another (e.g. Belarus Passport Page # 31 – Belarusian and Russian fields of the same type)- Returns:
- value of the desired field or null, if not found
-
getTextFieldStatusByType
public int getTextFieldStatusByType(int fieldType, int lcid) Use this method to get single text field verification result from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which status should be fetchedlcid
- one ofLCID
values indicating ID of language-culture to differentiate one field of the same type from another (e.g. Belarus Passport Page # 31 – Belarusian and Russian fields of the same type)- Returns:
- verification status of the requested field
-
getTextFieldStatusByType
public int getTextFieldStatusByType(int fieldType) Use this method to get single text field verification result from the results container- Parameters:
fieldType
- one ofeVisualFieldType
values, indicating type of field, which status should be fetched- Returns:
- verification status of the requested field
-
getGraphicFieldByType
Use this method to get single graphic field from the results container- Parameters:
fieldType
- one ofeGraphicFieldType
values, indicating the type of graphic elementsource
- one ofeRPRM_ResultType
values, indicating the graphic field's origin source- Returns:
- bitmap if requested field exists in results container or null
-
getGraphicFieldByType
Use this method to get single graphic field from the results container- Parameters:
fieldType
- one ofeGraphicFieldType
values, indicating the type of graphic elementsource
- one ofeRPRM_ResultType
values, indicating the graphic field's origin sourcepageIndex
- index of page- Returns:
- bitmap if requested field exists in results container or null
-
getGraphicFieldByType
public DocumentReaderGraphicField getGraphicFieldByType(int fieldType, int source, int pageIndex, int light) Use this method to get single graphic field from the results container- Parameters:
fieldType
- one ofeGraphicFieldType
values, indicating the type of graphic elementsource
- one ofeRPRM_ResultType
values, indicating the graphic field's origin sourcepageIndex
- index of pagelight
- one ofeRPRM_Lights
indicating lightning scheme of the graphic field was taken in- Returns:
- bitmap if requested field exists in results container or null
-
getGraphicFieldImageByType
public Bitmap getGraphicFieldImageByType(int fieldType, int source, int pageIndex, int light) Use this method to get single graphic field from the results container- Parameters:
fieldType
- one ofeGraphicFieldType
values, indicating the type of graphic elementsource
- one ofeRPRM_ResultType
values, indicating the graphic field's origin sourcepageIndex
- index of pagelight
- one ofeRPRM_Lights
indicating lightning scheme of the graphic field was taken in- Returns:
- bitmap if requested field exists in results container or null
-
getGraphicFieldImageByType
public Bitmap getGraphicFieldImageByType(int fieldType, int source, int pageIndex) Use this method to get single graphic field from the results container- Parameters:
fieldType
- one ofeGraphicFieldType
values, indicating the type of graphic elementsource
- one ofeRPRM_ResultType
values, indicating the graphic field's origin sourcepageIndex
- index of page- Returns:
- bitmap if requested field exists in results container or null
-
getGraphicFieldImageByType
public Bitmap getGraphicFieldImageByType(int fieldType, int source) Use this method to get single graphic field from the results container- Parameters:
fieldType
- one ofeGraphicFieldType
values, indicating the type of graphic elementsource
- one ofeRPRM_ResultType
values, indicating the graphic field's origin source- Returns:
- bitmap if requested field exists in results container or null
-
getGraphicFieldImageByType
public Bitmap getGraphicFieldImageByType(int fieldType) Use this method to get single graphic field from the results container- Parameters:
fieldType
- one ofeGraphicFieldType
values, indicating the type of graphic element- Returns:
- bitmap if requested field exists in results container or null
-
getQualityResult
public int getQualityResult(int imageQualityCheckType, int securityFeature) Use this method to get image quality verification result- Parameters:
imageQualityCheckType
- one ofeImageQualityCheckType
values, indicating kind of image quality verificationsecurityFeature
- one ofeRPRM_SecurityFeatureType
values, indicating element verified- Returns:
- Image Quality verification result
-
getQualityResult
public int getQualityResult(int imageQualityCheckType, int securityFeature, int pageIndex) Use this method to get image quality verification result- Parameters:
imageQualityCheckType
- one ofeImageQualityCheckType
values, indicating kind of image quality verificationsecurityFeature
- one ofeRPRM_SecurityFeatureType
values, indicating element verifiedpageIndex
- page index- Returns:
- Image Quality verification result
-
getQualityResult
public int getQualityResult(int imageQualityCheckType) Use this method to get image quality verification result- Parameters:
imageQualityCheckType
- one ofeImageQualityCheckType
values, indicating kind of image quality verification- Returns:
- Image Quality verification result
-
clone
-
fromRawResults
-
fromRawResults
-
clear
public void clear() -
getContainers
Method returns containers by result type. If result type doesn't exist, the result of the search will be null.- Parameters:
resultType
- array of result type specified ineRPRM_ResultType.ResultTypeValues
enum- Returns:
- get original containers from rawResult value in JSON format including information about the transaction.
-
getEncryptedContainers
Method returns only containers for eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_RFID_SESSION, eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_ENCRYPTED_RCL and eRPRM_ResultType.RPRM_RESULT_TYPE_INTERNAL_LICENSE values fromeRPRM_ResultType.ResultTypeValues
enum. For more details, seegetContainers(int[])
method.- Returns:
- get all encrypted containers from rawResult to reprocess data on the server side.
-