Files
featherVoice/TencentCloudHuiyanSDKFace_framework/Libs/TencentCloudHuiyanSDKFace.framework/Headers/WBFaceVerifyCustomerService.h
2025-08-08 10:49:36 +08:00

178 lines
8.8 KiB
Objective-C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

//
// WBFaceVerifyCustomerService.h
// WBFaceV2
//
// Created by tank on 25/10/2016.
// Copyright © 2016 tencent. All rights reserved.
//
/**
注意拉起页面的方式:
SDK会创建一个UIWindow覆盖在当前界面,并在新创建的UIWindow界面进行人脸认证,并且可以通过实现 wbfaceVerifyServiceGetWindowLevel 代理方法,传入创建的UIWindow的windowLevel, 传入的windowLevel必须是1~999, 默认情况如果不实现 wbfaceVerifyServiceGetWindowLevel 方法,windowLevel = UIWindowLevelNormal + 1
*/
#import <UIKit/UIKit.h>
#import "WBFaceVerifyConst.h"
#import "WBFaceVerifySDKConfig.h"
#import "WBFaceVerifyResult.h"
NS_ASSUME_NONNULL_BEGIN
// SDK在运行结束退出时候会发出通知. 具体的通知内容可以见delegate方法wbfaceVerifyCustomerServiceDidFinished:中的注释
UIKIT_EXTERN NSString *const WBFaceVerifyCustomerServiceDidFinishedNotification;
@class WBFaceVerifyCustomerService;
/**
处理刷脸回调
*/
@protocol WBFaceVerifyCustomerServiceDelegate <NSObject>
@optional
-(void)wbfaceVerifyCustomerServiceWillUploadBestImage:(UIImage *)bestImage;
@required
-(void)wbfaceVerifyCustomerServiceDidFinishedWithFaceVerifyResult:(WBFaceVerifyResult *)faceVerifyResult;
@end
@interface WBFaceVerifyCustomerService : NSObject
@property (nullable,nonatomic,weak) id<WBFaceVerifyCustomerServiceDelegate> delegate;
@property (nonatomic, assign, readonly) BOOL isService;
/*
全局唯一单例
*/
+(instancetype)sharedInstance;
/*
初始化云刷脸sdk仅做参数初始化与登陆不拉起刷脸页面
登陆有时效性建议在登陆完成后success回调中拉起刷脸页面
登陆过程为异步操作,多次登陆以最后一次收到的结果为准!!
此SDK接口中
合作方后台开发需要通过后台接口获取sign,
然后根据自带比对源接口, 通过后台接口获取faceId!!!!(native端无需传入自带比对源图)
*** faceId为空时启用仅活体检测服务不做比对
注意, 请使用 dispatch_async(dispatch_get_main_queue(), ^{ }); 异步调用SDK的入口方法
@param userid 用户唯一标识, 由合作方自行定义具体要求参考word接入文档
@param nonce 满足接入要求的32位随机数具体要求参考word接入文档
@param sign 满足接入要求的40位签名值具体要求参考word接入文档
@param appid 腾讯服务分配的appid
@param orderNo 每次人脸身份认证请求的唯一订单号: 建议为32位字符串(不超过32位)
@param apiVersion 后台api接口版本号(不是SDK的版本号),默认请填写@"1.0.0"
@param licence 腾讯给合作方派发的前端使用的licence(该licence同app当前使用的bundle id绑定)
@param faceId 合作方必须要先在获取faceId的接口里送入用户自带比对源图片信息得到相应的faceId后再送入sdk!!!!(参考word接入文档)
*** faceId为空时启用仅活体检测服务不做比对
@param sdkConfig SDK基础配置项目
@param success 服务登录成功回调,登录成功以后开始进行活体和检测服务
@param failure 服务登录失败回调,具体参考错误码文档(参考word接入文档)
*/
-(void)initSDKWithUserId:(NSString *)userid
nonce:(NSString *)nonce
sign:(NSString *)sign
appid:(NSString *)appid
orderNo:(NSString *)orderNo
apiVersion:(NSString *)apiVersion
licence:(NSString *)licence
faceId:(nullable NSString *)faceId
sdkConfig:(WBFaceVerifySDKConfig *)sdkConfig
success:(void (^)(void))success
failure:(void (^)(WBFaceError * _Nonnull error))failure;
/*
Plus级SDK核身入口注意传入的faceId不能为空否则会报failure
@param userid 用户唯一标识, 由合作方自行定义具体要求参考word接入文档
@param nonce 满足接入要求的32位随机数具体要求参考word接入文档
@param sign 满足接入要求的40位签名值具体要求参考word接入文档
@param appid 腾讯服务分配的appid
@param orderNo 每次人脸身份认证请求的唯一订单号: 建议为32位字符串(不超过32位)
@param apiVersion 后台api接口版本号(不是SDK的版本号),默认请填写@"1.0.0"
@param licence 腾讯给合作方派发的前端使用的licence(该licence同app当前使用的bundle id绑定)
@param faceId 合作方必须要先获取*增强级*faceId再送入sdk不允许为空(参考word接入文档)
@param sdkConfig SDK基础配置项目
@param success 服务登录成功回调,登录成功以后开始进行活体和检测服务
@param failure 服务登录失败回调,具体参考错误码文档(参考word接入文档)
*/
- (void)initPlusSDKWithUserId:(NSString *)userid
nonce:(NSString *)nonce
sign:(NSString *)sign
appid:(NSString *)appid
orderNo:(NSString *)orderNo
apiVersion:(NSString *)apiVersion
licence:(NSString *)licence
faceId:(nullable NSString *)faceId
sdkConfig:(WBFaceVerifySDKConfig *)sdkConfig
success:(void (^)(void))success
failure:(void (^)(WBFaceError * _Nonnull error))failure;
/*
增强级SDK核身入口注意传入的faceId不能为空且必须为增强faceId否则会报failure
@param userid 用户唯一标识, 由合作方自行定义具体要求参考word接入文档
@param nonce 满足接入要求的32位随机数具体要求参考word接入文档
@param sign 满足接入要求的40位签名值具体要求参考word接入文档
@param appid 腾讯服务分配的appid
@param orderNo 每次人脸身份认证请求的唯一订单号: 建议为32位字符串(不超过32位)
@param apiVersion 后台api接口版本号(不是SDK的版本号),默认请填写@"1.0.0"
@param licence 腾讯给合作方派发的前端使用的licence(该licence同app当前使用的bundle id绑定)
@param faceId 合作方必须要先获取*增强级*faceId再送入sdk不允许为空(参考word接入文档)
@param sdkConfig SDK基础配置项目
@param success 服务登录成功回调,登录成功以后开始进行活体和检测服务
@param failure 服务登录失败回调,具体参考错误码文档(参考word接入文档)
*/
-(void)initAdvanceSDKWithUserId:(NSString *)userid
nonce:(NSString *)nonce
sign:(NSString *)sign
appid:(NSString *)appid
orderNo:(NSString *)orderNo
apiVersion:(NSString *)apiVersion
licence:(NSString *)licence
faceId:(nonnull NSString *)faceId
sdkConfig:(WBFaceVerifySDKConfig *)sdkConfig
success:(void (^)(void))success
failure:(void (^)(WBFaceError * _Nonnull error))failure;
/**
以上一次的登陆结果拉起刷脸页面,必须先登录再拉起刷脸页面
@return 拉起是否成功
*/
- (BOOL)startWbFaceVeirifySdk;
#pragma mark - 意愿性表达接口
/*
意愿性SDK入口注意传入的faceId不能为空
@param userid 用户唯一标识, 由合作方自行定义具体要求参考word接入文档
@param nonce 满足接入要求的32位随机数具体要求参考word接入文档
@param sign 满足接入要求的40位签名值具体要求参考word接入文档
@param appid 腾讯服务分配的appid
@param orderNo 每次人脸身份认证请求的唯一订单号: 建议为32位字符串(不超过32位)
@param apiVersion 后台api接口版本号(不是SDK的版本号),默认请填写@"1.0.0"
@param licence 腾讯给合作方派发的前端使用的licence(该licence同app当前使用的bundle id绑定)
@param faceId 合作方必须要先获取*增强级*faceId再送入sdk不允许为空(参考word接入文档)
@param sdkConfig SDK基础配置项目
@param success 服务登录成功回调,登录成功以后开始进行活体和检测服务
@param failure 服务登录失败回调,具体参考错误码文档(参考word接入文档)
*/
-(void)initWillSDKWithUserId:(NSString *)userid
nonce:(NSString *)nonce
sign:(NSString *)sign
appid:(NSString *)appid
orderNo:(NSString *)orderNo
apiVersion:(NSString *)apiVersion
licence:(NSString *)licence
faceId:(nonnull NSString *)faceId
sdkConfig:(WBFaceVerifySDKConfig *)sdkConfig
success:(void (^)(void))success
failure:(void (^)(WBFaceError * _Nonnull error))failure;
@end
NS_ASSUME_NONNULL_END