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 Sep 7, 2022
1 parent 91efed8 commit 825b933
Show file tree
Hide file tree
Showing 7 changed files with 140 additions and 96 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,24 @@ 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)

## [13.0.0] - 2022-09-07

### Added

- Public: Add onfidoSecondaryButtonTextColor for secondary button title and border color customisation
- UI: Face alignment additional feedback for accessibility
- Public: Improve NFC instructions screen

### Changed

- Public: Allow enterprise features and mediacallback in orchesteratrion workflow builder
- Public: Removed unused strings with translations

### Fixed

- UI: Fix submitting proof of address uploading issue
- Public: Disable image quality validations before submission on the backside of Romanian National Identity Cards (fixing issues with blank backsides)

## [12.3.1] - 2022-08-18

### Fixed
Expand All @@ -25,6 +43,7 @@ translations. [More on language localisation](README.md#4-localisation)

### Changed

- Public: Combined country and document type selection in one single screen (country first, document type second)
- Public: Updated supported documents (Zambia NIC added, Albania Residence Permits removed, others)
- Public: Introduced a new analytics event listener and deprecated the legacy UserEventHandler
- Public: Disabled some functionalities that require Google Play Service when Google Play Service is unavailable
Expand Down
66 changes: 66 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,71 @@
# Onfido Android SDK Migration Guide

## `12.3.1` -> `13.0.0`

### String Changes

#### Added

- `onfido_avc_face_alignment_feedback_move_left_accessibility`
- `onfido_avc_face_alignment_feedback_move_right_accessibility`
- `onfido_avc_face_alignment_feedback_move_up_accessibility`
- `onfido_avc_face_alignment_feedback_move_down_accessibility`

#### Removed

- `onfido_permission_recovery_button_secondary_cam`
- `onfido_permission_recovery_button_secondary_mic`
- `onfido_permission_recovery_button_secondary_both`
- `onfido_welcome_list_item_doc`
- `onfido_permission_recovery_subtitle_video`
- `onfido_permission_recovery_extra_instructions_cam`
- `onfido_permission_recovery_extra_instructions_mic`
- `onfido_permission_recovery_extra_instructions_both`
- `onfido_permission_recovery_body_mic`
- `onfido_permission_recovery_body_cam`
- `onfido_permission_recovery_body_both`
- `onfido_app_title_user_consent`
- `onfido_country_select_error_no_country_body`
- `onfido_welcome_list_item_video`
- `onfido_doc_confirmation_body_visa`
- `onfido_welcome_list_item_selfie`
- `onfido_welcome_list_header_photo`
- `onfido_welcome_list_header_record`
- `onfido_welcome_list_header_doc_video`
- `onfido_app_title_doc_video_confirmation`
- `onfido_doc_capture_header_license_front_auto`
- `onfido_doc_capture_header_visa_back`
- `onfido_doc_capture_header_passport_auto`
- `onfido_doc_capture_header_license_back_auto`
- `onfido_doc_capture_frame_accessibility_pp_cover_manual`
- `onfido_doc_capture_frame_accessibility_pp_manual`
- `onfido_welcome_list_item_face_generic`
- `onfido_doc_capture_alert_no_face_title`
- `onfido_doc_capture_alert_no_face_detail`
- `onfido_doc_capture_header_live_guidance_distance_ok`
- `onfido_doc_capture_header_live_guidance_distance_ok_accessibility`
- `onfido_nfc_intro_sheet_scanning_subtitle`
- `onfido_avc_connection_error_button_primary_reload`
- `onfido_doc_select_button_bill_detail`
- `onfido_poa_country_not_found`
- `onfido_doc_select_extra_no_mobile`
- `onfido_label_doc_type_driving_license_short`
- `onfido_label_doc_type_residence_permit_short`
- `onfido_face_tracking_timeout_button_retry`
- `onfido_allow`
- `onfido_permission_subtitle_video`
- `onfido_permission_body_video`
- `onfido_accessibility_liveness_confirmation_view`
- `onfido_nfc_sheet_ready_button_secondary`
- `onfido_nfc_intro_sheet_header_scan_retry`
- `onfido_nfc_sheet_scanning_instruction_retry`
- `onfido_nfc_intro_sheet_header_fail_passport`
- `onfido_nfc_intro_sheet_header_fail_card`
- `onfido_nfc_intro_sheet_header_ready_card`
- `onfido_nfc_intro_sheet_header_ready_passport`
- `onfido_poa_document_submission_empty`
- `onfido_flow_user_exit_message_user_cancelled`

## `12.2.3` -> `12.3.0`

### Added Strings
Expand Down
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ Average size (with Proguard enabled):

| ABI | Size |
| ----------- | :-----: |
| armeabi-v7a | 6.79 Mb |
| arm64-v8a | 7.67 Mb |
| armeabi-v7a | 7.02 Mb |
| arm64-v8a | 7.91 Mb |

#### 2.2 `onfido-capture-sdk-core`

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

| ABI | Size |
| ----------- | :-----: |
| universal | 4.25 Mb |
| universal | 4.49 Mb |


**Note**: The average sizes were measured by building the minimum possible wrappers around our SDK,
Expand Down Expand Up @@ -360,11 +360,11 @@ For more information about this step, and how to collect user consent, please vi

#### Document capture step

In this step, a user can pick the type of document and its issuing country before capturing it with their phone camera.
In this step, a user can select the issuing country and document type before taking the photo. This selection screen is optional, and will only be shown to the end user if a specific country and document type is not configured for the SDK. By default, the country will be pre-selected based on the end-user’s region settings on their device, but the end-user can select another country from the list.

Document type selection and country selection are both optional screens. These screens will only show to the end user if specific options are not configured to the SDK.
Country and document type selection are optional. This screen will only show to the end user if specific options are not configured to the SDK.

You can configure the document step to capture single document types with specific properties using the `DocumentCaptureStepBuilder` class's functions for the corresponding document types.
You can configure the document step to capture single document types with specific properties, as well as customize the screen to display only a limited list of document types using the `DocumentCaptureStepBuilder` class's functions for the corresponding document types.

| Document Type | Configuration function | Configurable Properties |
| ----------------------- | ----------------------- | ---------------------------- |
Expand All @@ -380,13 +380,13 @@ You can configure the document step to capture single document types with specif

- **Document type**

The list of document types visible for the user to select can be shown or hidden using this option. If only one document type is specified, users will not see the document selection screen or country selection screen and will be taken directly to the capture screen.
The list of document types visible for the user to select can be shown or hidden using this option. If only one document type is specified, users will not see the selection screen and will be taken directly to the capture screen. Please see a more detailed guide [here](https://documentation.onfido.com/sdk/android/#document-capture-step).

Each document type has its own configuration class.

##### Customizing the document type selection screen

You can also customize the document type selection screen to display a specific list of documents for a user to select from. Use the configuration function to specify the document types to show on the document type selection screen.
You can also customize the screen to display only a limited list of document types, using the configuration function to specify the ones you want to show.

⚠️ Currently you can only include PASSPORT, NATIONAL_IDENTITY_CARD, DRIVING_LICENCE, RESIDENCE_PERMIT in the list.

Expand Down Expand Up @@ -417,7 +417,7 @@ onfidoConfigBuilder.withAllowedDocumentTypes(documentTypes)

- **Document country**

The configuration function allows you to specify the document's country of origin. If a document country is specified for a document type, the country selection screen is not displayed.
The configuration function allows you to specify the document's country of origin. If a document country is specified for a document type, the selection screen is displayed with preselected country.

**Note**: You can specify country for all document types except `Passport`. This is because passports have the same format worldwide so the SDK does not require this additional information.

Expand Down Expand Up @@ -587,6 +587,8 @@ the color of the text on the secondary action buttons (e.g. retake picture/video

* `onfidoPrimaryButtonTextColor`: Defines the color of the text inside the primary action buttons

* `onfidoSecondaryButtonTextColor`: Defines the color of the text inside and border color of secondary action buttons

**Widgets**

You can customize the appearance of some widgets in your `dimens.xml` file by overriding:
Expand Down Expand Up @@ -844,8 +846,8 @@ For a full list of events see [TRACKED_EVENTS.md](TRACKED_EVENTS.md).

| property | description |
| ---- | ----- |
|`type` | **OnfidoAnalyticsEventType** <br/> Indicates the type of event. Potential values (enum instances) are `FLOW`, `SCREEN`, `ACTION`, `ERROR`.|
| `properties` | **Map<OnfidoAnalyticsPropertyKey, String?>** <br/> Contains details of an event. For example, you can get the name of the visited screen using the `SCREEN_NAME` property. The current potential property keys are: `SCREEN_NAME`, `SCREEN_MODE`, `DOCUMENT_TYPE`, `COUNTRY_CODE`, `VIDEO_CHALLENGE_TYPE`, `IS_AUTOCAPTURE`.|
|`type` | **OnfidoAnalyticsEventType** <br /> Indicates the type of event. Potential values (enum instances) are `FLOW`, `SCREEN`, `ACTION`, `ERROR`.|
| `properties` | **Map<OnfidoAnalyticsPropertyKey, String?>** <br /> Contains details of an event. For example, you can get the name of the visited screen using the `SCREEN_NAME` property. The current potential property keys are: `SCREEN_NAME`, `SCREEN_MODE`, `DOCUMENT_TYPE`, `COUNTRY_CODE`, `VIDEO_CHALLENGE_TYPE`, `IS_AUTOCAPTURE`.|

### Properties

Expand Down
8 changes: 4 additions & 4 deletions sample-app/app/build.gradle
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
apply plugin: 'com.android.application'

def sdkVersion = '12.3.1'
def versionCodeNumber = 1230
def sdkVersion = '13.0.0-rc.1'
def versionCodeNumber = 1300

android {
compileSdkVersion 30
compileSdkVersion 31
defaultConfig {
applicationId "com.onfido.sampleapp"
minSdkVersion 21
targetSdkVersion 29
targetSdkVersion 31
versionCode versionCodeNumber
versionName "$versionCode-sdk:$sdkVersion"
multiDexEnabled true
Expand Down
5 changes: 3 additions & 2 deletions sample-app/app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@
<activity
android:name=".MainActivity"
android:label="@string/app_name"
android:theme="@style/AppTheme.NoActionBar">
android:theme="@style/AppTheme.NoActionBar"
android:exported="true">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>

</manifest>
</manifest>
Binary file modified screenshots.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 825b933

Please sign in to comment.