iOS installation
CocoaPods
CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Nevis Mobile Authentication SDK into your Xcode project using CocoaPods, specify it in your Podfile:
source 'https://github.com/CocoaPods/Specs.git'
...
pod 'NevisMobileAuthentication', '~> 3.2.0', :configurations => ['Release']
pod 'NevisMobileAuthentication-Debug', '~> 3.2.0', :configurations => ['Debug']
Then execute pod install with update.
pod install --repo-update
Swift Package Manager
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.
If you have your Swift package set up, adding Nevis Mobile Authentication SDK as a dependency is as easy as adding it to the dependencies value of your Package.swift:
dependencies: [
.package(url: "https://github.com/nevissecurity/nevis-mobile-authentication-sdk-ios-package.git", .upToNextMajor(from: "3.2.0"))
]
Or you can follow Apple's instructions about adding package dependencies to your app.
Currently only the release
flavour is released as SPM package.
Manual XCFramework integration
In case the SDK is provided as compressed archives, after unpacking, you see the following structure:
nevis-mobile-authentication-sdk-ios-debug.xcframework
: XCFramework withdebug
flavor.nevis-mobile-authentication-sdk-ios-release.xcframework
: XCFramework withrelease
flavor.nevis-mobile-authentication-sdk-ios-pod-debug.zip
: CocoaPod archive withdebug
flavor, contains the Framework and the Podspec file.nevis-mobile-authentication-sdk-ios-pod-release.zip
: CocoaPod archive withrelease
flavor, contains the Framework and the Podspec file.
To integrate the Nevis Mobile Authentication SDK using these XCFrameworks into your application, do the following:
- Rename the framework as follows:
nevis-mobile-authentication-sdk-ios-debug.xcframework -> MobileAuthenticationClient.xcframework
nevis-mobile-authentication-sdk-ios-release.xcframework -> MobileAuthenticationClient.xcframework
- Move or copy the framework to your project files.
- Open your application Xcode project or workspace.
- Drag and drop the framework into your project.
- Make sure the framework is listed under General > Linked Frameworks and Libraries.
General notes
Set ENABLE_BITCODE
to No
as the SDK does not contain bitcode.
Add a description to the NSFaceIDUsageDescription
key in the Info.plist
file of your application. Ideally, the NSFaceIDUsageDescription
key value is not localized.
<key>NSFaceIDUsageDescription</key>
<string>Enabling Face ID allows you to use the Face Recognition authenticator.</string>