net.gini.android.vision

Class GiniVisionFileImport

java.lang.Object

net.gini.android.vision.GiniVisionFileImport

public final class GiniVisionFileImport
extends java.lang.Object

This class contains methods for preparing launching the Gini Vision Library with a file received from another app.

Method Summary

Modifier and Type	Method and Description
static Document	createDocumentForImportedFile(Intent intent, Context context) Deprecated. Use GiniVision.createDocumentForImportedFile(Intent, Context) instead.
static Intent	createIntentForImportedFile(Intent intent, Context context, java.lang.Class reviewActivityClass, java.lang.Class analysisActivityClass) Deprecated. Use GiniVision.createIntentForImportedFile(Intent, Context, Class, Class) instead.

Methods inherited from class java.lang.Object

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

Method Detail

createIntentForImportedFile

@Deprecated
public static Intent createIntentForImportedFile(Intent intent,
                                                             Context context,
                                                             java.lang.Class reviewActivityClass,
                                                             java.lang.Class analysisActivityClass)
                                                      throws ImportedFileValidationException

Deprecated. Use GiniVision.createIntentForImportedFile(Intent, Context, Class, Class) instead.

Screen API

When your application receives a file from another application you can use this method to create an Intent for launching the Gini Vision Library.

Start the Intent with android.app.Activity#startActivityForResult(Intent, int) to receive the GiniVisionError in case there was an error.

Parameters:

intent - the Intent your app received

context - Android context

reviewActivityClass - the class of your application's ReviewActivity subclass

analysisActivityClass - the class of your application's AnalysisActivity subclass

Returns:

an Intent for launching the Gini Vision Library

Throws:

ImportedFileValidationException - if the file didn't pass validation

java.lang.IllegalArgumentException - if the Intent's data is not valid or the mime type is not supported

createDocumentForImportedFile

@Deprecated
public static Document createDocumentForImportedFile(Intent intent,
                                                                 Context context)
                                                          throws ImportedFileValidationException

Deprecated. Use GiniVision.createDocumentForImportedFile(Intent, Context) instead.

Component API

When your application receives a file from another application you can use this method to create a Document for launching one of the Gini Vision Library's Review Fragments or Analysis Fragments.

If the Document can be reviewed (Document.isReviewable()) launch one of the Review Fragments (ReviewFragmentCompat or ReviewFragmentStandard).

If the Document cannot be reviewed you must launch one of the Analysis Fragments (AnalysisFragmentCompat or AnalysisFragmentStandard).

Parameters:

intent - the Intent your app received

context - Android context

Returns:

a Document for launching one of the Gini Vision Library's Review Fragments or Analysis Fragments

Throws:

ImportedFileValidationException - if the file didn't pass validation