Page Properties | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Info |
---|
We recommend using Capture Flow with Fragments instead of activities. |
In order to use the capture flow with activities, follow these steps:
Request camera access.
Configure the capture feature using the
CaptureConfiguration
.Register an activity result handler with the
CaptureFlowContract()
.Launch the SDK with
GiniBank.startCaptureFlow()
.Handle the extraction results (e.g. in the
registerForActivityResult
).Send the final transfer summary values to Gini by calling
GiniBank.sendTransferSummary()
method which will be used to improve the future extraction accuracyClean up the SDK by calling
GiniBank.releaseCapture()
while also providing the required extraction feedback to improve future extraction accuracy. Follow the recommendations below which will release the resources used by SDK.
Follow these recommendations:
Note |
---|
|
You don’t need to implement any extra steps.
...
The diagram below shows the interaction between your app and the SDK:
Drawio | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Info |
---|
Check out an example app to see how an integration could can look like. |
Gini Bank SDK returns one of the following results:
CaptureResult.Success
A document was analyzed analysed and the extractions are available in the properties of the CaptureResult.Success
object.
...
Learn how to launch the capture flow and handle the results from the example below:
Code Block | ||
---|---|---|
| ||
// Use the androidx's Activity Result API to register a handler for the capture result. val captureLauncher = registerForActivityResult(CaptureFlowContract()) { result: CaptureResult -> when (result) { is CaptureResult.Success -> { handleExtractionsshowExtractions(result.specificExtractions) } is CaptureResult.Error -> { when (result.value) { is ResultError.Capture -> { val captureError: GiniCaptureError = (result.value as ResultError.Capture).giniCaptureError handleCaptureError(captureError) } is ResultError.FileImport -> { // See the File Import section on the Capture Features page for more details. val fileImportError = result.value as ResultError.FileImport handleFileImportError(fileImportError) } } GiniBank.releaseCapture(this) } this, "", CaptureResult.Empty -> { "", "", "", "", Amount.EMPTYhandleNoExtractions() GiniBank.releaseCapture(this) } CaptureResult.EmptyCancel -> { handleNoExtractionshandleCancellation() GiniBank.releaseCapture(this) } this, "", CaptureResult.EnterManually -> { "", "", "", "", Amount.EMPTYhandleEnterManually() GiniBank.releaseCapture(this) } } } CaptureResult.Cancel -> fun startGiniBankSDK() { // Make sure camera permission has been already handleCancellation()granted at this point. // Instantiate the networking GiniBankimplementation.releaseCapture( val networkService: GiniCaptureNetworkService = ... // this, "", Configure the capture feature. GiniBank.setCaptureConfiguration( CaptureConfiguration( "", "", "", "", Amount.EMPTY networkService = networkService, ) } ... CaptureResult.EnterManually ->) { ) // Launch and handleEnterManually()wait for the result. GiniBank.releaseCapturestartCaptureFlow(captureLauncher) } fun this, "",stopGiniBankSDKWithTransferSummary(paymentRecipient: String, "", "", "", "", Amount.EMPTY ) paymentReference: String, } } } fun launchGiniCapture() { // Make sure camera permission has been already granted at this point. // Check that the device fulfills the requirements. val report = GiniCaptureRequirements.checkRequirements((Context) this) if (!report.isFulfilled()) {paymentPurpose: String, handleUnfulfilledRequirements(report) return } // Instantiate the networking implementation. val networkServiceiban: GiniCaptureNetworkServiceString, = ... // Configure the capture feature. GiniBank.setCaptureConfiguration( CaptureConfiguration( networkService = networkServicebic: String, ... ) ) // Launch and wait for the result. GiniBank.startCaptureFlow(captureLauncher) }amount: Amount void stopGiniBankSDK() { // After the user has seen and potentially corrected the extractions, send the final // cleanup the SDK// while passing in the final extraction transfer summary values to //Gini which will be used as feedback to improve the future extraction accuracy: GiniBank.releaseCapturesendTransferSummary(this, paymentRecipient, paymentReference, paymentPurpose, iban, bic, amount ) // cleanup the capture SDK after sending the transfer summary GiniBank.releaseCapture(this) } |