更新记录

1.0.1（2023-11-06）

1. 插件一键登录功能首次上线
2. 插件本机号码校验功能首次上线

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

一键登录uni 插件集成文档

[TOC]

修订记录：

1 uni sdk接入指南

1.1 注意事项

\1. 使用一键登录服务用户须打开蜂窝数据流量，取号过程中会消耗用户少量的流量。

\2. sdk中自带有授权页面的UI逻辑，开发者可通过SDK接口暴露参数修改部分UI界面样式。

\3. 如果用户使用双卡手机，sdk会使用当前设备上网的流量卡进行预取号操作。

\4. 开发者需要具备一定的原生开发能力

2 uni sdk使用方法

2.1 环境配置

\1. 把DCAbilityLoginUniPlugin拖入工程nativeplugins文件夹中。

\2. 在mainfest.json / App原生插件配置 ，选择本地插件。

2.2 初始化接口

应用调用此方法初始化sdk，初始化会校验应用标识是否存在，回调成功后进行下一步预取号操作。

参数定义

成功响应

代码示例：

abilityPlugin.initFunc({
​           'appId': appId,
​           'appsecret': secret
​       },
​       (ret) => {
​           console.log('init: ' + JSON.stringify(ret));
​       });

2.3 预取号接口

应用调用预取号接口校验应用签名，校验成功后接口会返回运营商类型和状态信息，回调成功后进行调起授权页面操作。

abilityPlugin.preLoginFunc（）

成功响应

代码示例：

abilityPlugin.preLoginFunc(
​       (ret) => {
​         console.log('prelogin: ' + JSON.stringify(ret));     
​       }
);

2.4 调起授权页接口

应用调用该方法会拉起用户授权页面，当用户点击确认授权后接口会返回运营商类型和token；用户授权页支持部分页面样式自定义，开发者可以设置响应的参数调整页面样式。

参数定义

成功响应

代码示例：

abilityPlugin.getLoginTokenFunc(authPageMap,

​        (ret) => {

​           console.log('getLoginTokenFunc: ' + JSON.stringify(ret));

​           //取号请求

​        });

2.5 点击其它登录方式回调

globalEvent.addEventListener('otherLoginClick', function(e) {

​       console.log('otherLoginClick' + JSON.stringify(e));

​    });

2.6 点击关闭授权页按钮回调

globalEvent.addEventListener('closeButtonClick', function(e) {

​       console.log('closeButtonClick' + JSON.stringify(e));

​       abilityPlugin.quitAuthPage({});

​    });

2.7 点击授权登录未同意隐私协议回调

globalEvent.addEventListener('uncheckPrivacy', function(e) {

​       console.log('uncheckPrivacy' + JSON.stringify(e));

​    });

2.8 点击隐私协议勾选框回调

globalEvent.addEventListener('privacyBoxStatusChange', function(e) {

​       console.log('privacyBoxStatusChange' + JSON.stringify(e));

​    });

2.9 点击登录按钮回调

globalEvent.addEventListener('abilityLoginClick', function(e) {

​       console.log('abilityLoginClick' + JSON.stringify(e));

​    });

2.10 其他能力接口

1.蜂窝网络是否打开

abilityPlugin.isCellularNetworkFunc（）

2.获取插件版本号

abilityPlugin.getPluginVersionFunc（）

3.获取运营商类型

abilityPlugin.getCellularTypeFunc（）

CM:移动 CU:联通 CT:电信 UN:未知

2.11 添加图片资源

ios: 在DCAbilityLoginUniPlugin/ios/BundleResources/AbilityResource.bundle下的static文件夹中放入自定义的图片资源；

*注：选择bundle文件，右击显示包内容

android: 建议将需要使用的图片资源包含到aar文件中

在DCAbilityLoginUniPlugin/android/DCAbilityLoginUniPlugin下的res/drawabl文件夹下放入自定义的图片资源；

*注：先将aar后缀设置为zip，解压后放入自定义图片到指定文件夹，然后压缩当前文件夹为zip，再把文件后缀改为aar。

2.12 授权页面自定义UI参数

ios属性

android属性

注：所用到的背景,图片资源,都将资源包含到aar的 res/drawable文件下,参数值填为不加后缀的资源名称（可参考demo）

3.获取手机号能力

详见《一键登录服务端接入文档》

4.本机号码校验

参数定义

成功响应

代码示例：

abilityModule.getVerifyTokenFunc({

​           'phoneNumber': this.inputValue, 

​       },

​        (ret) => {

​           console.log('verification :'+JSON.stringify(ret));

​           //校验手机号请求

​       });