-
- All Implemented Interfaces:
public class GiniCaptureCoordinatorThe GiniCaptureCoordinator facilitates the default behavior for the Gini Capture Library.
You can ignore this class when using the Screen API.
If you use the Component API we recommend relying on this class to provide the default behavior of the Gini Capture Library. This can be achieved by calling the required methods at pre-defined points in your code and by implementing the GiniCaptureCoordinator.Listener.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceGiniCaptureCoordinator.ListenerInterface for the GiniCaptureCoordinator to dispatch events.
If you use the GiniCaptureCoordinator you should implement this interface in your Activity to facilitate the default behavior of the Gini Capture SDK.
-
Method Summary
Modifier and Type Method Description static booleanshouldShowGiniCaptureNoResultsScreen(Document document)static GiniCaptureCoordinatorcreateInstance(Context context)Factory method to create and configure a GiniCaptureCoordinator instance. GiniCaptureCoordinatorsetListener(GiniCaptureCoordinator.Listener listener)Listener for handling events from the GiniCaptureCoordinator to provide the default behavior. GiniCaptureCoordinatorsetShowOnboardingAtFirstRun(boolean showOnboardingAtFirstRun)Enable or disable showing the Onboarding Screen once per installation the first time the Camera Screen is started. voidonCameraStarted()Call this method when the CameraFragmentCompat has started. -
-
Method Detail
-
shouldShowGiniCaptureNoResultsScreen
static boolean shouldShowGiniCaptureNoResultsScreen(Document document)
-
createInstance
static GiniCaptureCoordinator createInstance(Context context)
Factory method to create and configure a GiniCaptureCoordinator instance.
- Parameters:
context- a Context used by the new instance to provide the default behavior
-
setListener
GiniCaptureCoordinator setListener(GiniCaptureCoordinator.Listener listener)
Listener for handling events from the GiniCaptureCoordinator to provide the default behavior.
- Parameters:
listener- your implementation of the GiniCaptureCoordinator.Listener
-
setShowOnboardingAtFirstRun
GiniCaptureCoordinator setShowOnboardingAtFirstRun(boolean showOnboardingAtFirstRun)
Enable or disable showing the Onboarding Screen once per installation the first time the Camera Screen is started.
Default value is
true.- Parameters:
showOnboardingAtFirstRun- iftruethe Onboarding Screen is shown the first time the Camera Screen is started
-
onCameraStarted
void onCameraStarted()
Call this method when the CameraFragmentCompat has started.
Can be called in your Acitivity's onStart method, which hosts the Camera Fragment.
-
-
-
-