From 8f78023637b6de4173fba75c832afdc31168fd8c Mon Sep 17 00:00:00 2001 From: wangzhitong Date: Wed, 22 Feb 2023 20:53:46 +0800 Subject: [PATCH] update frv --- docs/api/plugins/facialRecognitionVerify.md | 13 +++- docs/uniCloud/frv/dev.md | 70 ++++++++++++--------- 2 files changed, 50 insertions(+), 33 deletions(-) diff --git a/docs/api/plugins/facialRecognitionVerify.md b/docs/api/plugins/facialRecognitionVerify.md index a432640b0..7156035fb 100644 --- a/docs/api/plugins/facialRecognitionVerify.md +++ b/docs/api/plugins/facialRecognitionVerify.md @@ -1,5 +1,14 @@ ### uni.getFacialRecognitionMetaInfo() -实人认证获取设备信息 + +uni.getFacialRecognitionMetaInfo是客户端API,用户获取实人认证设备信息 + +App端API规范参考:[详情](https://uniapp.dcloud.net.cn/uniCloud/frv/dev.html#get-meta-info) + +**平台说明** + +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|√(3.7.4+)|x|x|x|x|x|x|x|x| ### uni.startFacialRecognitionVerify(OBJECT) 实人认证 @@ -15,5 +24,5 @@ App平台完整业务开发流程,参考[开发指南](https://uniapp.dcloud.n |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|√(3.7.2+)|x|√|x|x|x|x|x|x| +|√(3.7.4+)|x|√|x|x|x|x|x|x| diff --git a/docs/uniCloud/frv/dev.md b/docs/uniCloud/frv/dev.md index 5667a01ab..3acf4fd8b 100644 --- a/docs/uniCloud/frv/dev.md +++ b/docs/uniCloud/frv/dev.md @@ -46,36 +46,25 @@ sequenceDiagram ### 客户端接口 -#### 获取设备信息@get-meta-info +#### 获取实人认证设备信息@get-meta-info 调用刷脸前通过客户端先获取设备信息,调用[uni.getFacialRecognitionMetaInfo](https://uniapp.dcloud.net.cn/api/plugins/facialRecognitionVerify.html) `const metaInfo = uni.getFacialRecognitionMetaInfo();` +**返回值** + +|字段名 |类型 | 描述 | +|:-: |:-: |:-: | +|metaInfo|String |云函数获取认证服务的certifyId时,在入参metaInfo中传入该值 | + #### 调起实人认证界面@start-frv 通过云函数获取certifyId后,在客户端调用[uni.startFacialRecognitionVerify](https://uniapp.dcloud.net.cn/api/plugins/facialRecognitionVerify.html)打开认证界面,通过刷脸操作获取认证结果。 `uni.startFacialRecognitionVerify(OBJECT)` -**示例** -```js -uni.startFacialRecognitionVerify({ - certifyId:"", - progressBarColor: "#CC0000", //刷脸圈的颜色 - screenOrientation: "port", //认证界面UI朝向 - success:(e)=>{ - console.log(JSON.stringify(e)) - }, - fail:(e)=>{ - console.log(JSON.stringify(e)) - }, - complete:(e)=>{ - console.log(JSON.stringify(e)) - } -}) -``` -##### OBJECT参数说明 +**参数说明** | 参数 | 类型 | 是否必传 | 支持平台 | 描述 | | --- | --- | --- | --- | --- | @@ -88,21 +77,40 @@ uni.startFacialRecognitionVerify({ 注: 颜色字符串格式为“#RRGGBB”,RRGGBB为十六进制字符串,如红色("#FF0000") -##### CALLBACK返回值 +**返回值** -| 参数 | 描述 | -| --- | --- | -| errSubject | 模块名称(uni-facialRecognitionVerify) | -| errCode | 错误码,详情见:[错误码](#err-code) | -| errMsg | 错误信息,详情见:[错误码](#err-code) | -| cause | SDK返回的原始数据 (certifyId不为空时返回) | +| 字段名 | 类型 | 描述 | +| --- | --- | --- | +| errSubject| String | 模块名称(uni-facialRecognitionVerify)| +| errCode | Number| 错误码,详情见:[错误码](#err-code)| +| errMsg | String | 错误信息,详情见:[错误码](#err-code)| +| cause | Object| SDK返回的原始数据 (certifyId不为空时返回)| -##### cause +**cause** -| 参数 | 描述 | -| --- | --- | -| code | SDK原始错误码 | -| message | SDK原始错误信息 | +| 字段名 | 类型 | 描述 | +| --- | --- | --- | +| code | Number| SDK原始错误码 | +| message | String | SDK原始错误信息 | + +**示例代码** + +```js +uni.startFacialRecognitionVerify({ + certifyId:"", + progressBarColor: "#CC0000", //刷脸圈的颜色 + screenOrientation: "port", //认证界面UI朝向 + success:(e)=>{ + console.log(JSON.stringify(e)) + }, + fail:(e)=>{ + console.log(JSON.stringify(e)) + }, + complete:(e)=>{ + console.log(JSON.stringify(e)) + } +}) +``` #### iOS平台自定义UI iOS平台不支持通过参数的方式修改刷脸页的提示文案,但可以通过自定义bundle文件的方式修改提示内容以及国际化信息 -- GitLab