Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Onfido Android Team committed Oct 31, 2023
1 parent 9795b79 commit 1416508
Show file tree
Hide file tree
Showing 55 changed files with 923 additions and 241 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
are responsible for testing your translated layout in case you are using custom
translations. [More on language localisation](README.md#4-localisation)

## [19.4.0] - 2023-10-31

### Changed

- Replaced `com.google.android.play:core` library with a more specific `com.google.android.play:feature-delivery` library for Dynamic Feature Module compatibility

### Fixed

- Fixed Motion Capture screen restoration after Camera/Mic permissions being removed

## [19.3.0] - 2023-10-09

### Added
Expand All @@ -26,6 +36,7 @@ translations. [More on language localisation](README.md#4-localisation)
- Fixed the Out of Memory issue encountered during captured image confirmation
- Replaced direct usage of Json serializer with our globally configured instance
- Fixed background customization issue in capture confirmation screen
- Used TextureView to workaround Android 14 Beta crashes in SurfaceView

## [19.2.1] - 2023-08-29

Expand Down
12 changes: 9 additions & 3 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Onfido Android SDK Migration Guide

The guides below are provided to ease the transition of existing applications using the Onfido SDK from one version to another that introduces breaking API changes.

If your migration involves upgrading across multiple SDK versions, be sure to read each individual guide in order to account for all relevant breaking changes.

## `19.2.2` -> `19.3.0`

#### Deprecation
Expand Down Expand Up @@ -35,9 +39,11 @@
## `18.0.0` -> `19.0.0`

#### Breaking changes
- Remove `Parcelable` implementation from `MediaCallback` and run it in the same process with the application.
- Remove `Parcelable` implementation from `OnfidoAnalyticsEventListener` and run it in the same process with the application.
- Remove `Parcelable` implementation from `TokenExpirationHandler` and run it in the same process with the application.
- Removed `Parcelable` implementation from `MediaCallback` and run it in the same process with the application.
- Removed `Parcelable` implementation from `OnfidoAnalyticsEventListener` and run it in the same process with the application.
- Removed `Parcelable` implementation from `TokenExpirationHandler` and run it in the same process with the application.
- Deprecated `withNFCReadFeature()` in `OnfidoConfig`, as NFC is now enabled by default. Use `disableNFC()` if you want to disable NFC.


## `17.0.0` -> `18.0.0`

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Average size (with Proguard enabled):

| ABI | Size |
|-------------|:--------:|
| armeabi-v7a | 13.02 Mb |
| armeabi-v7a | 13.12 Mb |
| arm64-v8a | 12.88 Mb |
| universal | 40.13 Mb |

Expand All @@ -126,7 +126,7 @@ Average size (with Proguard enabled):

| ABI | Size |
|------------------|:--------:|
| core-armeabi-v7a | 9.90 Mb |
| core-armeabi-v7a | 10.01 Mb |
| core-arm64-v8a | 9.97 Mb |
| core-universal | 14.82 Mb |

Expand Down Expand Up @@ -1131,10 +1131,10 @@ Further information about the Onfido API is available in our [API reference](htt

### Support

Please open an issue through [GitHub](https://github.com/onfido/onfido-android-sdk/issues). Please be as detailed as you can. Remember **not** to submit your token in the issue. Also check the closed issues to see whether it has been previously raised and answered.
Should you encounter any technical issues during integration, please contact Onfido's Customer Support team via [email](mailto:support@onfido.com), including the word ISSUE at the start of the subject line.

If you have any issues that contain sensitive information please send us an email with the `ISSUE:` at the start of the subject to [android-sdk@onfido.com](mailto:android-sdk@onfido.com).
Alternatively, you can search the support documentation available via the customer experience portal, [public.support.onfido.com](https://public.support.onfido.com/s/).

Previous version of the SDK will be supported for a month after a new major version release. Note that when the support period has expired for an SDK version, no bug fixes will be provided, but the SDK will keep functioning (until further notice).
Previous versions of the SDK will be supported for a month after a new major version release. Note that when the support period has expired for an SDK version, no bug fixes will be provided, but the SDK will keep functioning (until further notice).

Copyright 2018 Onfido, Ltd. All rights reserved.
Copyright 2023 Onfido, Ltd. All rights reserved.
8 changes: 4 additions & 4 deletions sample-app/app/build.gradle
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apply plugin: 'com.android.application'

def sdkVersion = '19.3.0'
def versionCodeNumber = 1922
def sdkVersion = '19.4.0'
def versionCodeNumber = 1940

android {
compileSdkVersion 33
Expand All @@ -18,8 +18,8 @@ android {
abortOnError false
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
}
buildTypes {
debug {
Expand Down
1 change: 1 addition & 0 deletions sample-app/app/proguard-rules.pro
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@
# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
-dontwarn com.onfido.javax.inject.Inject
2 changes: 1 addition & 1 deletion sample-app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.android.tools.build:gradle:4.2.2'
classpath 'com.android.tools.build:gradle:7.2.2'

// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
Expand Down
Binary file modified sample-app/gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
2 changes: 1 addition & 1 deletion sample-app/gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.0-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
Loading

0 comments on commit 1416508

Please sign in to comment.