{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"details","parameters":{"macroParams":{"hidden":{"value":"true"}},"macroMetadata":{"macroId":{"value":"87a661e756d05fd1bd12cfaccae13bfd"},"schemaVersion":{"value":"1"},"title":"Page Properties"}},"localId":"a8d9604f-4e66-4f43-9fdf-c9295aff1d10"},"content":[{"type":"table","attrs":{"layout":"default","localId":"3aced34c-0764-4c2b-9fab-3e91aa1472d5"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Status","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"approved","localId":"86ca50ab-6b69-4f59-a67c-91519f75dbe4"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Approver","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"type":"mention","attrs":{"id":"5c7642abe73ff946487628c5","text":"@Alpar Szotyori (Unlicensed)"}},{"text":" ","type":"text"}]}]}]}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"e0a8cbdc-8e13-4b68-a3d7-25ea589e1d30"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"2cbf6633-93bb-4d6d-875b-73a37a909c65"}},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"We use the term ","type":"text"},{"text":"file import","type":"text","marks":[{"type":"code"}]},{"text":" to refer to the ","type":"text"},{"text":"Share","type":"text","marks":[{"type":"strong"}]},{"text":" feature within Gini Bank SDK. From the point of view of the SDK, files are imported into the SDK from an outside source. It is unaware and can't set configuration related to enabling the client app to receive files via Android’s ","type":"text"},{"text":"Share ","type":"text","marks":[{"type":"strong"}]},{"text":"functionality.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"To enable this feature, pass ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"GiniBank.setCaptureConfiguration(CaptureConfiguration(fileImportEnabled = ))","type":"text","marks":[{"type":"code"}]},{"text":". Additionally, your app should declare intent filters for receiving images and/or PDF files from other apps and then forward the incoming intent to Gini Bank SDK.","type":"text"}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Register image and PDF file types","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the following intent filter to the activity in your ","type":"text"},{"text":"AndroidManifest.xml","type":"text","marks":[{"type":"code"}]},{"text":" to receive incoming images and PDF files:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"We recommend adding ","type":"text"},{"text":"ACTION_VIEW","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.android.com/reference/android/content/Intent.html#ACTION_VIEW"}}]},{"text":" to the intent filter to let users send images and PDF files to your app from apps that don’t implement sharing with ","type":"text"},{"text":"ACTION_SEND","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.android.com/reference/android/content/Intent.html#ACTION_SEND"}}]},{"text":" but enable viewing images and PDF files with other apps.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Handle imported files","type":"text"}]},{"type":"paragraph","content":[{"text":"When your app is requested to handle an image or a PDF file, your activity (declaring the intent filter shown above) is launched or resumed (","type":"text"},{"text":"onNewIntent()","type":"text","marks":[{"type":"code"}]},{"text":") with the ","type":"text"},{"text":"Intent","type":"text","marks":[{"type":"code"}]},{"text":" having ","type":"text"},{"text":"ACTION_VIEW","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"ACTION_SEND","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"We recommend checking whether the ","type":"text"},{"text":"Intent","type":"text","marks":[{"type":"code"}]},{"text":" has the required action before proceeding with it:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"kotlin"},"content":[{"text":"String action = intent.getAction();\nif (Intent.ACTION_VIEW.equals(action) || Intent.ACTION_SEND.equals(action)) {\n ...\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"If the ","type":"text"},{"text":"Intent","type":"text","marks":[{"type":"code"}]},{"text":" passes the above check then register an activity result handler with the ","type":"text"},{"text":"CaptureFlowImportContract()","type":"text","marks":[{"type":"code"}]},{"text":" and pass the ","type":"text"},{"text":"Intent","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"GiniBank.startCaptureFlowFortent()","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"none"},"content":[{"text":"fun configureCapture() {\n GiniBank.setCaptureConfiguration(this,\n CaptureConfiguration(\n fileImportEnabled = true,\n ... // other configuration options\n )\n )\n}\n\n// Use the androidx's Activity Result API to register a handler for the capture result.\nval captureImportLauncher = registerForActivityResult(CaptureFlowImportContract()) { result: CaptureResult ->\n when (result) {\n is CaptureResult.Success -> {\n handleExtractions(result.specificExtractions)\n }\n is CaptureResult.Error -> {\n when (result.value) {\n is ResultError.Capture -> {\n val captureError: GiniCaptureError = (result.value as ResultError.Capture).giniCaptureError\n handleCaptureError(captureError)\n }\n is ResultError.FileImport -> {\n val fileImportError = result.value as ResultError.FileImport\n handleFileImportError(fileImportError)\n }\n }\n }\n CaptureResult.Empty -> {\n handleNoExtractions()\n }\n CaptureResult.Cancel -> {\n handleCancellation()\n }\n }\n}\n\nfun handleFileImportError(exception: ImportedFileValidationException) {\n var message = ...\n exception.validationError?.let { validationError ->\n // Get the default message\n message = getString(validationError.textResource)\n // Or use custom messages\n message = when (validationError) {\n FileImportValidator.Error.TYPE_NOT_SUPPORTED -> ...\n FileImportValidator.Error.SIZE_TOO_LARGE -> ...\n FileImportValidator.Error.TOO_MANY_PDF_PAGES -> ...\n FileImportValidator.Error.PASSWORD_PROTECTED_PDF -> ...\n FileImportValidator.Error.TOO_MANY_DOCUMENT_PAGES -> ...\n }\n }\n AlertDialog.Builder(this)\n .setMessage(message)\n .setPositiveButton(\"OK\") { _, _ -> finish() }\n .show()\n}\n\nfun startGiniBankSDKForImportedFile(importedFileIntent: Intent) {\n // Configure capture first\n configureCapture();\n\n fileImportCancellationToken =\n GiniBank.startCaptureFlowForIntent(captureImportLauncher, this, importedFileIntent)\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Detect when your app is the default app for opening images or PDF files","type":"text"}]},{"type":"paragraph","content":[{"text":"Android users can unintentionally set your app as the default for opening images or PDF files. To inform users about it and let them undo it, the SDK detects if your app is selected as the default app and shows the Clear Defaults Dialog enabling them to clear the defaults for your app in the Android settings.","type":"text"}]},{"type":"paragraph","content":[{"text":"The UI customization options for the Clear Defaults Dialog can be viewed in the UI Customisation Guide ","type":"text"},{"text":"Analysis Screen","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/ABS34/pages/39816065"}}]},{"text":".","type":"text"}]}],"version":1}

Browser not supported