欢迎使用 Puzzl 的 iOS SDK
Puzzl iOS SDK 用于渲染 Puzzl 的员工入职流程
将 Puzzl SDK 添加到项目中
使用 CocoaPods
- 您可以使用 CocoaPods("CocoaPods 是一个开源的 Swift 和 Objective-C Coca 项目依赖管理器。CocoaPods 在使用 Xcode 时易于安装或更新新的 SDK。")
$ sudo gem install cocoapods
- 在项目目录中创建一个 Podfile(与 .xcodeproj 文件在同一个目录)
- 打开 Podfile,并包含 PuzzlIOS 依赖项。以下是一个示例
target "YourProjectNameHere" do
use_frameworks!
pod 'PuzzlIOS'
end
- 在 Podfile 目录中运行 'pod install'
$ pod install
- 要随时更新 SDK,请运行 'pod update' 以获取最新版本的 Puzzl iOS SDK。
- 安装完成后,请使用项目新创建的 .xcworkspace 文件。
手动安装
如果您不希望使用上述任何依赖性管理器,可以将Puzzl手动集成到您的项目中。
-
打开终端,使用
cd
命令进入到您的顶级项目目录,如果您还没有将项目初始化为git仓库,请运行以下命令:$ git init
-
通过执行以下命令将Puzzl作为git 子模块添加:
$ git submodule add https://github.com/Puzzl/puzzl-iOS
-
打开新的Puzzl文件夹,然后将
Puzzl-iOS.xcodeproj
拖放到您应用的Xcode项目导航器中。它应该出现在您的应用蓝色项目图标下方。它是在其他所有Xcode组之上还是之下无关紧要。
-
在项目导航器中选择
Puzzl-iOS.xcodeproj
,并确保部署目标与您的应用目标相匹配(在“通用”>“部署信息”下)。 -
接下来,在项目导航器中选择您的应用项目(蓝色项目图标),导航到目标配置窗口,然后在边栏的“目标”标题下选择应用目标。
-
在该窗口顶部的标签栏中,打开“通用”面板。
-
在“框架、库和嵌入内容”部分下点击《+》按钮。
-
选择‘Puzzl_iOS.framework’并点击‘添加’。
-
添加后,在“嵌入”列(仍在“框架、库和嵌入内容”部分下)下选择“嵌入并签名”选项。
-
就这样!
Puzzl_iOS.framework
将自动添加为目标依赖项,在复制文件构建阶段链接框架和嵌入框架,这是在模拟器和设备上构建所需的所有内容。
使用Puzzl iOS SDK
- 向应用Info.plist中添加使用描述
如果不添加这些使用描述,当在需要时请求权限时,系统会终止应用。
Veriff iOS SDK在身份验证过程中需要相机和麦克风权限来捕捉照片和视频。您的应用需要描述为什么使用相机和麦克风。您必须将以下2个描述添加到您应用的info.plist
中,并解释其使用目的:
NSCameraUsageDescription
NSMicrophoneUsageDescription
-
将Puzzl导入到您的代码中。为了使用Puzzl SDK,将其导入到使用SDK的类中(通常是视图控制器)。
import Puzzl_iOS
-
在您希望触发Puzzl的引导流程的地方,设置委托以跟踪Puzzl引导SDK的状态,并允许Puzzl显示引导。例子:
Puzzl.setDelegate(from: <YOUR VIEW CONTROLLER>) Example: Puzzl.setDelegate(from: self)
-
从Puzzl调用‘showOnboardingWith’方法。例子:
Puzzl.setDelegate(from: <YOUR VIEW CONTROLLER>) Puzzl.showOnboarding(apiKey: <PUZZL LIVE KEY>, companyID: <PUZZL COMPANY ID>, workerID: <PUZZL EMPLOYEE ID>, from: <YOUR VIEW CONTROLLER>)
-
为了跟踪Puzzl引导流程的状态,创建一个新的方法
extension ViewController: PuzzlDelegate { func getStatus(status: PuzzlStatus) { switch status { case .error: print("Error") //handle error in onboarding case .success: print("Success") //handle successful onboarding } } }
一旦教导员成功引导,现在您可以为他们运行工资了!
🎉