{"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":"ab0e5b2c-b6e0-4428-8c59-216564c943e9"}},{"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":"c048a373-feee-4f57-ba74-3140e3e88414"}},{"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 Capture 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":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"The “Open with…” feature can be found under different names in the Android phones, e.g: \"Send to\", \"Share\", “Share with” and \"Open with\"","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Please note that the “Open with (Share, Send to)” feature is ","type":"text"},{"text":"disabled by default","type":"text","marks":[{"type":"strong"}]},{"text":".","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":"GiniCapture.Builder.setFileImportEnabled()","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 Capture SDK.","type":"text"}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Register image and PDF file types","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Make sure the name of activity used in the below configuration ","type":"text"},{"text":"is the same","type":"text","marks":[{"type":"strong"}]},{"text":" as the name of the activity handling your SKD implementation.","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition: Make sure that this activity ","type":"text"},{"text":"is publically available.","type":"text","marks":[{"type":"strong"}]}]}]},{"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":"rule"},{"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 Intent 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":"java"},"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 create an ","type":"text"},{"text":"Intent","type":"text","marks":[{"type":"code"}]},{"text":" for launching Gini Capture SDK with ","type":"text"},{"text":"GiniCapture.getInstance().createIntentForImportedFiles()","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"void configureGiniCapture() {\n GiniCapture.newInstance(this).\n .setFileImportEnabled(true)\n ... // other configuration options\n .build()\n}\n\nvoid startGiniCaptureSDKForImportedFile(final Intent importedFileIntent) {\n // Configure the Gini Capture SDK first\n configureGiniCapture();\n if (GiniCapture.hasInstance()) {\n mFileImportCancellationToken = GiniCapture.getInstance().createIntentForImportedFiles(\n importedFileIntent, (Context) this,\n new AsyncCallback() {\n @Override\n public void onSuccess(final Intent result) {\n mFileImportCancellationToken = null;\n startActivityForResult(result, REQUEST_SCAN);\n }\n\n @Override\n public void onError(final ImportedFileValidationException exception) {\n mFileImportCancellationToken = null;\n handleFileImportError(exception);\n }\n\n @Override\n public void onCancelled() {\n mFileImportCancellationToken = null;\n }\n });\n }\n}\n\nvoid handleFileImportError(final ImportedFileValidationException exception) {\n String message = ...\n if (exception.getValidationError() != null) {\n // Get the default message\n message = getString(exception.getValidationError().getTextResource());\n // Or use custom messages\n switch (exception.getValidationError()) {\n case TYPE_NOT_SUPPORTED:\n message = ...\n break;\n case SIZE_TOO_LARGE:\n message = ...\n break;\n case TOO_MANY_PDF_PAGES:\n message = ...\n break;\n case PASSWORD_PROTECTED_PDF:\n message = ...\n break;\n case TOO_MANY_DOCUMENT_PAGES:\n message = ...\n break;\n }\n }\n new AlertDialog.Builder((Context) this)\n .setMessage(message)\n .setPositiveButton(\"OK\", (dialogInterface, i) -> finish())\n .show();\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":"https://gini.atlassian.net/wiki/spaces/SCSV/pages/3604773"}}]},{"text":".","type":"text"}]}],"version":1}

Browser not supported