net.gini.android.vision.review

Interface ReviewFragmentListener

All Known Implementing Classes:

ReviewActivity

public interface ReviewFragmentListener

Interface used by ReviewFragmentStandard and ReviewFragmentCompat to dispatch events to the hosting Activity.

Method Summary

Modifier and Type	Method and Description
void	onDocumentReviewedAndAnalyzed(Document document) Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).
void	onDocumentWasRotated(Document document, int oldRotation, int newRotation) Deprecated. When a GiniVision and a GiniVisionNetworkService instance is available rotation is handled internally. The document is analyzed by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).
void	onError(GiniVisionError error) Called when an error occurred.
void	onExtractionsAvailable(java.util.Map extractions) Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).
void	onProceedToAnalysisScreen(Document document) Deprecated. When a GiniVision instance is available ReviewFragmentListener.onProceedToAnalysisScreen(Document, String) is invoked instead.
void	onProceedToAnalysisScreen(Document document, java.lang.String errorMessage) Called when the user tapped on the Next button and one of the following conditions apply: Analysis is in progress Analysis completed with an error The image was rotated
void	onProceedToNoExtractionsScreen(Document document) Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).
void	onShouldAnalyzeDocument(Document document) Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).

Method Detail

onShouldAnalyzeDocument

@Deprecated
void onShouldAnalyzeDocument(Document document)

Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).

Called when the Review Fragment was started and you should start analyzing the original document by sending it to the Gini API.

We assume that in most cases the photo is good enough and this way we are able to provide analysis results quicker.

Note: Call ReviewFragmentStandard.onDocumentAnalyzed() or ReviewFragmentCompat.onDocumentAnalyzed() when the analysis is done and your Activity wasn't stopped.

Parameters:

document - contains the original image taken by the camera

onProceedToAnalysisScreen

@Deprecated
void onProceedToAnalysisScreen(Document document)

Deprecated. When a GiniVision instance is available ReviewFragmentListener.onProceedToAnalysisScreen(Document, String) is invoked instead.

Called if you didn't call ReviewFragmentStandard.onDocumentAnalyzed() or ReviewFragmentCompat.onDocumentAnalyzed() (or the image was changed) and the user tapped on the Next button.

You should start your Activity extending AnalysisActivity and set the document as the AnalysisActivity.EXTRA_IN_DOCUMENT extra.

Parameters:

document - contains the reviewed image (can be the original one or a modified image)

onDocumentReviewedAndAnalyzed

@Deprecated
void onDocumentReviewedAndAnalyzed(Document document)

Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).

Called if you called ReviewFragmentStandard.onDocumentAnalyzed() or ReviewFragmentCompat.onDocumentAnalyzed() and the image wasn't changed and the user tapped on the Next button.

You should finish your Activity and proceed to handling the results of the analysis.

Parameters:

document - contains the reviewed image (can be the original one or a modified image)

onDocumentWasRotated

@Deprecated
void onDocumentWasRotated(Document document,
                                      int oldRotation,
                                      int newRotation)

Deprecated. When a GiniVision and a GiniVisionNetworkService instance is available rotation is handled internally. The document is analyzed by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).

Called when the user rotated the image.

In case you started the document analysis in ReviewFragmentListener.onShouldAnalyzeDocument(Document) you should cancel it here as the original image is not valid anymore.

Parameters:

document - contains the modified image

oldRotation - the previous rotation in degrees

newRotation - the new rotation in degrees

onError

void onError(GiniVisionError error)

Called when an error occurred.

Parameters:

error - details about what went wrong

onExtractionsAvailable

@Deprecated
void onExtractionsAvailable(java.util.Map extractions)

Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).

Called when the document has been analyzed and extractions are available.

Parameters:

extractions - a map of the extractions with the extraction labels as keys

onProceedToNoExtractionsScreen

@Deprecated
void onProceedToNoExtractionsScreen(Document document)

Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).

Called when the document has been analyzed and no extractions were received.

You should show the NoResultsFragmentStandard or NoResultsFragmentCompat.

Parameters:

document - contains the reviewed document

onProceedToAnalysisScreen

void onProceedToAnalysisScreen(Document document,
                               java.lang.String errorMessage)

Called when the user tapped on the Next button and one of the following conditions apply:

• Analysis is in progress
• Analysis completed with an error
• The image was rotated

  You should start your Activity extending AnalysisActivity and set the document as the AnalysisActivity.EXTRA_IN_DOCUMENT extra.

Parameters:

document - contains the reviewed image (can be the original one or a modified image)

errorMessage - an optional error message to be passed to the Analysis Screen