net.gini.android.vision.camera

Interface CameraFragmentListener

All Known Implementing Classes:

CameraActivity

public interface CameraFragmentListener

Interface used by CameraFragmentStandard and CameraFragmentCompat to dispatch events to the hosting Activity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CameraFragmentListener.DocumentCheckResultCallback Callback to inform the Gini Vision Library about the outcome of the custom imported document checks.

Method Summary

Modifier and Type	Method and Description
void	onCheckImportedDocument(Document document, CameraFragmentListener.DocumentCheckResultCallback callback) This method is invoked for imported documents to allow custom validations.
void	onDocumentAvailable(Document document) Called when the user has taken an image with the camera or has imported a document that passed the Gini Vision Library's validation and any custom checks that were implemented.
void	onError(GiniVisionError error) Called when an error occurred.
void	onExtractionsAvailable(java.util.Map extractions) Called after a QRCode was successfully analyzed.
void	onProceedToMultiPageReviewScreen(GiniVisionMultiPageDocument multiPageDocument)
void	onQRCodeAvailable(QRCodeDocument qrCodeDocument) Deprecated. When a GiniVision instance is available the QRCode is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in CameraFragmentListener.onExtractionsAvailable(Map).

Method Detail

onDocumentAvailable

void onDocumentAvailable(Document document)

Called when the user has taken an image with the camera or has imported a document that passed the Gini Vision Library's validation and any custom checks that were implemented.

Parameters:

document - the image taken by the camera or the validated imported document

onProceedToMultiPageReviewScreen

void onProceedToMultiPageReviewScreen(GiniVisionMultiPageDocument multiPageDocument)

onQRCodeAvailable

@Deprecated
void onQRCodeAvailable(QRCodeDocument qrCodeDocument)

Deprecated. When a GiniVision instance is available the QRCode is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in CameraFragmentListener.onExtractionsAvailable(Map).

Called when the user clicked the QR Code detected popup. You should upload the QRCodeDocument's data to the Gini API to get the extractions, close the Gini Vision Library and continue to your app's transfer form.

See QRCodeDocument for supported formats.

Parameters:

qrCodeDocument - contains payment data from a QR Code

onCheckImportedDocument

void onCheckImportedDocument(Document document,
                             CameraFragmentListener.DocumentCheckResultCallback callback)

This method is invoked for imported documents to allow custom validations.

Invoke one of the CameraFragmentListener.DocumentCheckResultCallback methods on the main thread to inform the Gini Vision Library about the result.

Note: The Gini Vision Library will wait until one of the CameraFragmentListener.DocumentCheckResultCallback methods are invoked.

Parameters:

document - a Document created from the file the user picked

callback - use this callback to inform the Gini Vision Library about the result of the custom checks

onError

void onError(GiniVisionError error)

Called when an error occurred.

Parameters:

error - details about what went wrong

onExtractionsAvailable

void onExtractionsAvailable(java.util.Map extractions)

Called after a QRCode was successfully analyzed.

Parameters:

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