Updating the Device SDK (Android, iOS, Browser)
Learn how to update the FaceTec Device SDK when it is already integrated into Your App.
For Initial Integration, see our Android SDK, iOS SDK, and Browser SDK Initial Integration Guides.
Important Note: These steps are only meant to be used for general guidance. The specific steps for updating the Device SDK in Your App may differ as a result of how Your App is currently configured. Please keep this in mind when updating your Device SDK.
Android SDK
- Download and extract the latest version of the FaceTec Android SDK.
- Replace the old facetec-sdk-#####.aar in Your App with the new facetec-sdk-#####.aar from the FaceTec Android SDK.
- Using Android Studio, open the build.gradle (Module) and update Your App to use the latest version of the FaceTec Android SDK:
implementation 'com.facetec:facetec-sdk:<FACETEC_SDK_VERSION>@aar' - Determine if any localization changes have been specified in the Release Notes. If any of the Localization Strings or Files have changed, you may need to import the latest version of the String Files into Your App. For more information on String Files and Localization, see the Text & Language Editing Guide.
- Check the Release Notes for any new features or APIs. FaceTec continuously adds new and improved tools to the Device SDKs as part of these updates. Some of the features included in past updates have included new Localization Files and additional feedback strings for Blind User Assistance (BUA).
- Check the Release Notes for any Deprecated or Removed APIs. Once you have updated Your App accordingly, rebuild and recompile Your App to ensure that there are no initial problems.
Important Note: If Your App fails to build or experiences a Compilation Error, then you might be using a Deprecated API that was recently removed.
- Check and verify that Your App's Core APIs are all functioning properly.
iOS SDK
- Download and extract the latest version of the FaceTec iOS SDK.
- Using Xcode, replace the old FaceTecSDK.xcframework in Your App with the new FaceTecSDK.xcframework from the FaceTec iOS SDK.
- In the left bar under Targets, choose <Your Application Name>. Then, choose "General" and scroll down to Frameworks, Libraries, and Embedded Content. If not already set, select "Embed & Sign" for the FaceTecSDK.xcframework.
- Determine if any localization changes have been specified in the Release Notes. If any of the Localization Strings or Files have changed, you may need to import the latest version of the String Files into Your App. For more information on String Files and Localization, see the Text & Language Editing Guide.
- Check the Release Notes for any new features or APIs. FaceTec continuously adds new and improved tools to the Device SDKs as part of these updates. Some of the features included in past updates have included new Localization Files and additional feedback strings for Blind User Assistance (BUA).
- Check the Release Notes for any Deprecated or Removed APIs. Once you have updated Your App accordingly, rebuild and recompile Your App to ensure that there are no initial problems.
Important Note: If Your App fails to build or experiences a Compilation Error, then you might be using a deprecated API that was recently removed.
- Once you have successfully rebuilt Your App, check and verify that Your App's Core APIs are all functioning properly. The following are some of the APIs you may want to check:
Browser SDK
- Download and extract the latest version of the FaceTec Browser SDK.
- Replace the old core-sdk directory in Your App's Folder with the new core-sdk directory from the FaceTec Browser SDK.
- Verify that Your App's index file is importing FaceTecSDK.
TypeScript Example:import { FaceTecSDK } from "../core-sdk/FaceTecSDK.js/FaceTecSDK"; - Determine if any localization changes have been specified in the Release Notes. If any of the Localization Strings or Files have changed, you may need to import the latest version of the String Files into Your App. For more information on String Files and Localization, see the Text & Language Editing Guide.
- Check the Release Notes for any new features or APIs. FaceTec continuously adds new and improved tools to the Device SDKs as part of these updates. Some of the features included in past updates have included new Localization Files and additional feedback strings for Blind User Assistance (BUA).
- Check the Release Notes for any Deprecated or Removed APIs and update Your App accordingly. Then, clear the cache of the files in core-sdk.
- Rebuild and recompile Your App to ensure that there are no initial problems.
Important Note: If Your App fails to build or experiences a Compilation Error, then you might be using a deprecated API that was recently removed, or you might have improperly cleared the cache of the files in core-sdk.
- Once you have successfully rebuilt Your App, check and verify that Your App's Core APIs are all functioning properly. The following are some of the APIs you may want to check: