Skip to content

Commit 21e630a

Browse files
author
ci-bot
committed
Updated projects
1 parent 88471be commit 21e630a

File tree

50 files changed

+806
-384
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+806
-384
lines changed

1120-Without License/README.md

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,43 @@
1-
# Regula Document Reader (Android version)
2-
`1120` folder contains the sample project for working with the [Mobile document authenticator Regula 1120](https://regulaforensics.com/en/products/machine_verification/1120/).
1+
# BLE Device without Hardware License Sample Project (Android)
32

4-
# Content
5-
* [How to build the demo application](#how-to-build-the-demo-application)
3+
* [Overview](#overview)
4+
* [Installation](#installation)
65
* [Documentation](#documentation)
7-
* [Additional information](#additional-information)
8-
9-
## How to build the demo application
10-
1. Visit our [Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
11-
2. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`.
12-
3. Open the `1120-Without License` project in an IDE.
13-
4. Copy the license file to the project: `1120-Without License/app/src/main/res/raw/`.
14-
5. Copy the database file db.dat from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `1120-Without License/app/src/main/assets/Regula/`.
15-
6. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
16-
7. Run the project.
17-
Note: Android Gradle plugin requires Java 11 to run
6+
* [Demo Application](#demo-application)
7+
* [Technical Support](#technical-support)
8+
* [Business Enquiries](#business-enquiries)
9+
10+
## Overview
11+
12+
Sample project in Kotlin, demonstrating the Document Reader SDK integration with the device <a target="_blank" href="https://docs.regulaforensics.com/develop/1120/">Mobile Document Authenticator Regula 1120</a> without the hardware license inside it.
13+
14+
In this case, to run the project, it needs to be initialized with a proper software license in the application.
15+
16+
## Installation
17+
18+
1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`
19+
2. Open the `1120-Without License` project in an IDE.
20+
3. Add license and database files to the project:
21+
- Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
22+
- Copy the license file to the project: `1120-Without License/app/src/main/res/raw/`
23+
- Copy the database file `db.dat` from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `1120-Without License/app/src/main/assets/Regula/`
24+
4. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
25+
5. Run the project.
26+
27+
**Note:** Android Gradle plugin requires Java 11 to run.
1828

1929
## Documentation
20-
The documentation on the SDK can be found [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile?utm_source=github).
2130

22-
## Additional information
23-
If you have any technical questions or suggestions, feel free to [contact](mailto:[email protected]) us or create an issue [here](https://github.com/regulaforensics/DocumentReader-Android/issues).
31+
<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a>
32+
33+
## Demo Application
34+
35+
<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a>
36+
37+
## Technical Support
38+
39+
To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>.
40+
41+
## Business Enquiries
42+
43+
To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements.

1120-Without License/app/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ dependencies {
3636
implementation 'com.google.android.material:material:1.6.1'
3737
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
3838

39-
implementation 'com.regula.btdevice:api:1.0.+@aar'
40-
implementation 'com.regula.documentreader.core:fullauthrfid:7.4.+@aar'
41-
implementation('com.regula.documentreader:api:7.4.+@aar') {
39+
implementation 'com.regula.btdevice:api:1.1.+@aar'
40+
implementation 'com.regula.documentreader.core:fullauthrfid:7.5.+@aar'
41+
implementation('com.regula.documentreader:api:7.5.+@aar') {
4242
transitive = true;
4343
}
4444
}

1120-Without License/app/src/main/java/com/regula/ble_1120/MainActivity.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class MainActivity : AppCompatActivity() {
7272
if (result) {
7373
btnConnect?.isEnabled = true
7474
} else {
75-
Toast.makeText(this@MainActivity, "Init failed:$error", Toast.LENGTH_LONG).show()
75+
Toast.makeText(this@MainActivity, "Init failed:${error?.message}", Toast.LENGTH_LONG).show()
7676
return@IDocumentReaderInitCompletion
7777
}
7878
}
Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,53 @@
1-
# Regula Document Reader (Android version)
2-
`Advanced` folder contains the advanced sample project with almost all available features.
1+
# Document Reader SDK Advanced Sample Project (Android)
32

4-
# Content
5-
* [How to build the demo application](#how-to-build-the-demo-application)
6-
* [Troubleshooting license issues](#troubleshooting-license-issues)
3+
* [Overview](#overview)
4+
* [Installation](#installation)
5+
* [Troubleshooting](#troubleshooting)
76
* [Documentation](#documentation)
8-
* [Additional information](#additional-information)
7+
* [Demo Application](#demo-application)
8+
* [Technical Support](#technical-support)
9+
* [Business Enquiries](#business-enquiries)
910

10-
## How to build the demo application
11-
1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`.
11+
## Overview
12+
13+
Sample project in Kotlin, demonstrating a variety of Document Reader SDK configuration and customization options.
14+
15+
# Installation
16+
17+
1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`
1218
2. Open the `Advanced/DocumentReader-Kotlin` project in an IDE.
13-
3. If you use any mobile device (except 7310):
14-
- visit our [Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
15-
- copy the license file to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`.
16-
- copy the database file db.dat from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`.
17-
4. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
19+
3. If you use any mobile device (except Regula 7310), add license and database files to the project:
20+
- Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
21+
- Copy the license file to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`
22+
- Copy the database file `db.dat` from the [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `Advanced/DocumentReader-Kotlin/app/src/main/assets/Regula/`
23+
4. Change the application ID to the one you have specified during the registration at the [Client Portal](https://client.regulaforensics.com/).
1824
5. Run the project.
19-
Note: Android Gradle plugin requires Java 11 to run
25+
26+
**Note:** Android Gradle plugin requires Java 11 to run
27+
28+
## Troubleshooting
29+
30+
If you have issues with the license verification when running the application, check the following:
2031

21-
## Troubleshooting license issues
22-
If you have issues with license verification when running the application, please verify that next is true:
2332
1. The OS, which you use, is specified in the license (Android).
2433
2. The application ID, which you use, is specified in the license.
2534
3. The license is valid (not expired).
2635
4. The date and time on the device, where you run the application, are valid.
2736
5. You use the latest release version of the Document Reader SDK.
28-
6. You placed the license into the project.
37+
6. You placed the license into the project as described in the [Installation](#installation) section.
2938

3039
## Documentation
31-
The documentation on the SDK can be found [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile?utm_source=github).
3240

33-
## Additional information
34-
If you have any technical questions or suggestions, feel free to [contact](mailto:[email protected]) us or create an issue [here](https://github.com/regulaforensics/DocumentReader-Android/issues).
41+
<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a>
42+
43+
## Demo Application
44+
45+
<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a>
46+
47+
## Technical Support
48+
49+
To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>.
50+
51+
## Business Enquiries
3552

36-
To use our SDK in your own app you have to [purchase](https://pipedrivewebforms.com/form/5f1d771cbe4f844a1f78f8a06fbf94361841159) a commercial license.
53+
To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements.

Advanced/DocumentReader-Kotlin/app/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ dependencies {
3737
implementation 'androidx.navigation:navigation-ui-ktx:2.4.0'
3838
implementation "androidx.recyclerview:recyclerview:1.2.1"
3939

40-
implementation 'com.regula.btdevice:api:1.0.+@aar'
40+
implementation 'com.regula.btdevice:api:1.1.+@aar'
4141
//noinspection GradleDynamicVersion
42-
implementation 'com.regula.documentreader.core:fullrfid:7.4.+@aar'
42+
implementation 'com.regula.documentreader.core:fullrfid:7.5.+@aar'
4343
//noinspection GradleDynamicVersion
44-
implementation('com.regula.documentreader:api:7.4.+@aar') {
44+
implementation('com.regula.documentreader:api:7.5.+@aar') {
4545
transitive = true
4646
}
4747

Advanced/DocumentReader-Kotlin/app/src/main/java/com/regula/documentreader/DeviceActivity.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ class DeviceActivity : AppCompatActivity() {
134134
IDocumentReaderInitCompletion { result: Boolean, error: DocumentReaderException? ->
135135
dismissDialog()
136136
if (!result) { //Initialization was not successful
137-
Toast.makeText(this, "Init failed:$error", Toast.LENGTH_LONG).show()
137+
Toast.makeText(this, "Init failed: ${error?.message}", Toast.LENGTH_LONG).show()
138138
return@IDocumentReaderInitCompletion
139139
} else {
140140
MainActivity.isInitializedByBleDevice = true

Advanced/DocumentReader-Kotlin/app/src/main/java/com/regula/documentreader/MainActivity.kt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ class MainActivity : FragmentActivity(), Serializable {
178178
else
179179
Toast.makeText(
180180
this@MainActivity,
181-
"Init failed:$error_initializeReader",
181+
"Init failed:${error_initializeReader?.message}",
182182
Toast.LENGTH_LONG
183183
).show()
184184
}
@@ -276,7 +276,9 @@ class MainActivity : FragmentActivity(), Serializable {
276276
results_RFIDReader: DocumentReaderResults?,
277277
error: DocumentReaderException?
278278
) {
279-
if (rfidAction == DocReaderAction.COMPLETE || rfidAction == DocReaderAction.CANCEL)
279+
if (rfidAction == DocReaderAction.COMPLETE
280+
|| rfidAction == DocReaderAction.ERROR
281+
|| rfidAction == DocReaderAction.CANCEL)
280282
displayResults(results_RFIDReader!!)
281283
}
282284
})

BackendProcessing/README.md

Lines changed: 42 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,53 @@
1-
# Regula Document Reader (Android version)
2-
The `BackendProcessing` sample project shows how configure Backend Processing in the Android app
1+
# Document Reader SDK Backend Processing Sample Project (Android)
32

4-
# Content
5-
* [How to build the demo application](#how-to-build-the-demo-application)
6-
* [Troubleshooting license issues](#troubleshooting-license-issues)
3+
* [Overview](#overview)
4+
* [Installation](#installation)
5+
* [Troubleshooting](#troubleshooting)
76
* [Documentation](#documentation)
8-
* [Additional information](#additional-information)
9-
10-
## How to build the demo application
11-
1. Visit our [Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
12-
2. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`.
13-
3. Open the `BackendProcessing` project in an IDE.
14-
4. Copy the license file to the project: `BackendProcessing/app/src/main/res/raw/`.
15-
5. Copy the database file db.dat from [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `BackendProcessing/app/src/main/assets/Regula/`.
16-
6. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
17-
7. Run the project.
18-
Note: Android Gradle plugin requires Java 11 to run
19-
20-
## Troubleshooting license issues
21-
If you have issues with license verification when running the application, please verify that next is true:
7+
* [Demo Application](#demo-application)
8+
* [Technical Support](#technical-support)
9+
* [Business Enquiries](#business-enquiries)
10+
11+
## Overview
12+
13+
Sample project in Kotlin, demonstrating how to set up and use the <a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/integration/server-side-verification/">Complete Server-Side Verification</a> feature.
14+
15+
## Installation
16+
17+
1. Download or clone the current repository using the command `git clone https://github.com/regulaforensics/DocumentReader-Android.git`
18+
2. Open the `BackendProcessing` project in an IDE.
19+
3. Add license and database files to the project:
20+
- Visit [Regula Client Portal](https://client.regulaforensics.com/) to get a trial license (`regula.license` file). The license creation wizard will guide you through the necessary steps.
21+
- Copy the license file to the project: `BackendProcessing/app/src/main/res/raw/`
22+
- Copy the database file `db.dat` from the [Client Portal](https://client.regulaforensics.com/customer/databases) to the project: `BackendProcessing/app/src/main/assets/Regula/`
23+
4. Change the application ID to the one you have specified during the registration at [Client Portal](https://client.regulaforensics.com/).
24+
5. Run the project.
25+
26+
**Note:** Android Gradle plugin requires Java 11 to run.
27+
28+
## Troubleshooting
29+
30+
If you have issues with the license verification when running the application, check the following:
31+
2232
1. The OS, which you use, is specified in the license (Android).
2333
2. The application ID, which you use, is specified in the license.
2434
3. The license is valid (not expired).
2535
4. The date and time on the device, where you run the application, are valid.
2636
5. You use the latest release version of the Document Reader SDK.
27-
6. You placed the license into the project.
37+
6. You placed the license into the project as described in the [Installation](#installation) section.
2838

2939
## Documentation
30-
The documentation on the SDK can be found [here](https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile?utm_source=github).
3140

32-
## Additional information
33-
If you have any technical questions or suggestions, feel free to [contact](mailto:[email protected]) us or create an issue [here](https://github.com/regulaforensics/DocumentReader-Android/issues).
41+
<a target="_blank" href="https://docs.regulaforensics.com/develop/doc-reader-sdk/mobile/">Document Reader SDK Mobile Documentation</a>
42+
43+
## Demo Application
44+
45+
<a target="_blank" href="https://play.google.com/store/apps/details?id=com.regula.documentreader">Regula Document Reader Android Demo Application on Google Play</a>
46+
47+
## Technical Support
48+
49+
To submit a request to the Support Team, visit <a target="_blank" href="https://support.regulaforensics.com/hc/en-us/requests/new?utm_source=github">Regula Help Center</a>.
50+
51+
## Business Enquiries
3452

35-
To use our SDK in your own app you have to [purchase](https://pipedrivewebforms.com/form/5f1d771cbe4f844a1f78f8a06fbf94361841159) a commercial license.
53+
To discuss business opportunities, fill the <a target="_blank" href="https://explore.regula.app/docs-support-request">Enquiry Form</a> and specify your scenarios, applications, and technical requirements.

BackendProcessing/app/build.gradle

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ dependencies {
4040
implementation 'com.google.android.material:material:1.6.1'
4141
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
4242

43-
implementation 'com.regula.documentreader.core:fullrfid:7.4.+@aar'
44-
implementation('com.regula.documentreader:api:7.4.+@aar') {
43+
implementation 'com.regula.documentreader.core:fullrfid:7.5.+@aar'
44+
implementation('com.regula.documentreader:api:7.5.+@aar') {
4545
transitive = true
4646
}
4747
}

BackendProcessing/app/src/main/java/com/regula/backend.processing/MainActivity.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ class MainActivity : AppCompatActivity() {
8484
binding.showScannerBtn.isEnabled = false
8585
}
8686
} else {
87-
Toast.makeText(this@MainActivity, "Init failed:$error", Toast.LENGTH_LONG).show()
87+
Toast.makeText(this@MainActivity, "Init failed: ${error?.message}", Toast.LENGTH_LONG).show()
8888
return@IDocumentReaderInitCompletion
8989
}
9090
}
@@ -101,7 +101,7 @@ class MainActivity : AppCompatActivity() {
101101
Toast.makeText(this@MainActivity, "Scanning was cancelled", Toast.LENGTH_LONG)
102102
.show()
103103
} else if (action == DocReaderAction.ERROR) {
104-
Toast.makeText(this@MainActivity, "Error:$error", Toast.LENGTH_LONG).show()
104+
Toast.makeText(this@MainActivity, "Error:${error?.message}", Toast.LENGTH_LONG).show()
105105
}
106106
}
107107
}

0 commit comments

Comments
 (0)