jverification-hbuilder-plugin

极光认证 官方支持的 Hbuilder 插件（Android & iOS）。是基于 HBuilder 提供的 uni-app 原生插件扩展 进而开发出的认证插件。开发者可以轻松将极光认证集成到自己的项目中，从而在 js 层实现对认证的控制。

uniapp插件市场地址

极光认证官方SDK

接入

• 1.将 nativeplugins/JG-JVerification 导入项目对应位置。
• 2.项目 manifest.json 中接入 JG-JVerification 插件。
• 3.在项目中引用插件

const jv = uni.requireNativePlugin('JG-JVerification');

• 4.从 v2.0.0 版本开始还需引入JG-JCore 插件。

since v2.0.0 注意事项

为了适配更多的极光 Uniapp 插件，我们引入了极光 Jcore 基础插件库。

从极光认证插件 2.0.0 版本开始，必须同时接入 JCore 插件才能正常使用。

已接入 2.0.0 版本之前的应用升级时请注意 appkey 和 channel 配置信息已转移至 JCore 中。

DEMO 体验

按照以下步骤快速体验 JVerification_Hbuilder_demo：

• 1.在极光 portal注册应用并开通认证功能。
• 2.在项目 manifest.json 中配置您申请的极光 appkey 信息
• 3.HbuilderX 中制作打包自定义基座，包名，签名，bundleID 需要与对应 appkey 配置的应用信息保持一致
• 4.HbuilderX 使用自定义基座运行即可

API 说明

JVerification Hbuilder API

引用方式

const jv = uni.requireNativePlugin('JG-JVerification');

设置 debug 模式

API - setDebugMode(Boolean)

开启 debug 模式，请在初始化前调用

参数说明

• true - 开启，false - 关闭

示例

jv.setDebugMode(true);

初始化

API - init(Object，CALLBACK)

初始化接口

参数说明

• Object

示例

jv.init({
        timeout:7000,
        isProduction:false,
    },result=>{
        let code = result.code
        let desc = result.content
    });

获取初始化状态

API - isInitSuccess(CALLBACK)

初始化是否成功

示例

jv.isInitSuccess(result=>{
		let isSucc = result.enable;
	})

判断网络环境是否支持

API - checkVerifyEnable(CALLBACK)

判断当前网络环境是否可以发起认证

示例

jv.checkVerifyEnable(result=>{
		let isSupport = result.enable;
	})

获取 token

API - getToken(number，CALLBACK)

初始化接口

参数说明

• number:设置初始化超时时间，单位毫秒，合法范围是(0,30000]，推荐设置为 5000-10000,默认值为 10000。

示例

jv.getToken(7000,result=>{
        let code = result.code;
        let token = result.content;
        let operator = result.operator;
    });

登录预取号

API - preLogin(number，CALLBACK)

验证当前运营商网络是否可以进行一键登录操作，该方法会缓存取号信息，提高一键登录效率。建议发起一键登录前先调用此方法。

参数说明

• number:设置初始化超时时间，单位毫秒，合法范围是(0,30000]，推荐设置为 5000-10000,默认值为 10000。

示例

jv.preLogin(7000,result=>{
        let code = result.code;
        let token = result.content;
    });

清除预取号缓存

API - clearPreLoginCache()

清除预取号缓存。

示例

jv.clearPreLoginCache();

请求授权一键登录

• 一键登录需要依赖预取号结果，如果没有预取号，一键登录时会自动预取号。
• 建议拉起授权页前，比如在开屏页或者业务入口页预先调用此接口进行预取号，可以提升授权页拉起速度，优化体验。
• 一键登录请求成功后，不要频繁重复调用。运营商会限制单位时间内请求次数。
• 不要在一键登录回调中重复调用预取号或者拉起授权页接口。

API - loginAuth(Object，CALLBACK，EVENTCALLBACK)

调起一键登录授权页面，在用户授权后获取 loginToken，同时支持授权页事件监听。

参数说明

• Object

示例

jv.loginAuth({
        autoFinish:true,
        timeout:5000
    },result=>{
        // 结果监听
        let code = result.code;
        let loginToken = result.content;
        let operator = result.operator;

    },event=>{
        // 事件监听
        let code = result.code;
        let eventDesc = result.content;
    })

自定义授权页面样式

iOS 和 Android 分开设置

API - setCustomUIWithConfigAndroid

修改 Android 授权页面主题，支持传入竖屏和横屏两套config。sdk会根据当前横竖屏状态动态切换，需在 loginAuth 接口之前调用。

接口定义

// 设置一个 config 时应用全部
jv.setCustomUIWithConfigAndroid(JVerifyUIConfig)
// 设置两个 config 时，前者应用与竖屏配置，后者应用与横屏配置
jv.setCustomUIWithConfigAndroid(JVerifyUIConfig,JVerifyUIConfig)

参数说明

• JVerifyUIConfig（object）:Android 主题配置参数集合，参考Android JVerifyUIConfig 说明

示例

jv.setCustomUIWithConfigAndroid({
    setNavColor:0xff000000,
    setLogBtnText:" 极光认证测试 ",
    setPrivacyState:false,
    setAppPrivacyColor:[0xff00f000,0xff000000]
})

API - addCustomViewsClickCallback

添加自定义 view 回调。配合 setCustomUIWithConfigAndroid 的 addCustomViews 属性一起使用

示例

jv.addCustomViewsClickCallback(id=>{

})

API - setCustomUIWithConfigiOS

修改 iOS 授权页面主题，需在 loginAuth 接口之前调用。

接口定义

jv.setCustomUIWithConfigiOS(JVerifyUIConfig)

参数说明

• JVerifyUIConfig（object）:iOS 主题配置参数集合，参考iOS JVerifyUIConfig 说明

示例

jv.setCustomUIWithConfigiOS({
    navColor:0xff000000,
    logBtnText:" 极光认证测试 ",
    privacyState:true,
    appPrivacyColor:[0xff000000,0xff000000]
})

API - dismissLoginAuth

隐藏登录页.当授权页被拉起以后，可调用此接口隐藏授权页。当一键登录自动隐藏授权页时，不建议调用此接口。

接口定义

jv.dismissLoginAuth(flag, res=>{
    //授权页隐藏完成
})

参数说明

• flag:隐藏时是否需要动画。

示例

jv.dismissLoginAuth(true, 
res=>{
    //授权页隐藏完成
})

获取验证码

API - getCode

• 获取短信验证码，使用此功能需要在Portal控制台中极光短信模块添加短信签名和验证码短信模版，或者使用默认的签名或模版。详见：操作指南
• 通过此接口获得到短信验证码后，需要调用极光验证码验证API来进行验证，详见：验证码验证 API

接口定义

jv.getCode(object)

参数说明

• Object

示例

jv.getCode({
    phoneNumber :  "电话号码",
    signID : "短信签名ID",
    templateID : "短信模板ID"
})

设置前后两次获取验证码的时间间隔

API - setTimeWithConfig(number)

设置前后两次获取验证码的时间间隔。

参数说明

• number:默认30000ms，有效范围(0,300000)。

示例

jv.setTimeWithConfig(7000);

错误码

参考资料

官方文档

Support

• 集成前请先尝试 demo 工程跑通
• 出现问题请先打开 debug 模式，拿到前端和原生日志
• 更多问题请前往极光社区

常见问题

• 1.这个sdk100M，会打包到apk吗？

  包容量，与打包方式有关， 安卓应该在1M左右，看打包方式；iOS会大一些。可以看我们demo 的大小，

  Android demo apk 最多也就 3 M，iOS 是 2.9M。https://docs.jiguang.cn/jverification/resources/#demo。

• 2.demo跑不起来，脑壳疼。

  a、可以去GitHub上下载demo，用HbuilderX打开JVerification_Hbuilder_Demo文件，在manifest.json文件里面自己生成一个uniapp的appid，这是自动生成的。有的话换成自己的appid。

b、配置您申请的极光 appkey 信息。

c、HbuilderX 中制作打包自定义基座。注意：包名，签名，证书，bundleID 需要与对应 appkey 配置的应用信息保持一致。（极光 portal注册分配）

• 3.初始化一直报“8004，init failed”。

  一定要填好极光 portal分配的包名，签名，证书，bundleID和appkey，这些全是配套的，不能瞎填。

License

MIT © JiGuang