更新记录

1.3（2023-12-27）

1.修复Android12打包提示android:exported的异常问题。

1.2（2023-12-23）

1.修复高版本打包提示android:exported的异常问题。

1.1（2023-11-02）

初始化发布

平台兼容性

原生插件通用使用流程：

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原生插件配置”->”云端插件“列表中删除该插件重新选择

OpenVPN VPN接入

概述

XF-openVPN模块，实现了iOS平台集成Network Extensions集成OpenVPN、Android集成OpenVPN实现VPN功能。

模块使用攻略

1. iOS扩展配套插件地址下载：Gitee仓库

接口

requestIgnoreBattery

申请加入电池白名单

requestIgnoreBattery(callback(ret))

callback(ret)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true,  //布尔型；true||false
    msg : ''
}

示例代码

var demo = uni.requireNativePlugin('XF-openVPN');
demo.requestIgnoreBattery(function(ret){
    alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

initVpn

加载VPN配置信息

initVpn({params},callback(ret))

params

name：

• 类型：字符串
• 描述：（可选项）vpn名称。
• 默认值：OpenVPN

providerBundleIdentifier：

• 类型：字符串
• 描述：（必填项）iOS扩展工程的bid(仅iOS有效)。

config：

• 类型：字符串
• 描述：（必填项）OpenVPN的配置信息

callback(ret)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true,  //布尔型；true||false
    msg : '',
    currentStatus: '',
    expireAt: '',
}

示例代码

var demo = uni.requireNativePlugin('XF-openVPN');
demo.initVpn({
    config : ""
},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startVPN

连接VPN

startVPN({params},callback(ret))

params

user：

• 类型：字符串
• 描述：（可选项）用户名称。

pass：

• 类型：字符串
• 描述：（可选项）用户密码。

callback(ret)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-openVPN');
demo.startVPN({},function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopVPN

断开VPN

stopVPN(callback(ret))

callback(ret)

ret：

• 类型：JSON对象
• 内部字段：

{
    status: true,  //布尔型；true||false
    msg: ""
}

示例代码

var demo = uni.requireNativePlugin('XF-openVPN');
demo.stopVPN(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addStatusCallback

添加VPN连接状态监听

addStatusCallback(callback(ret))

callback(ret)

ret：

• 类型：JSON对象
• 内部字段：

{
   status: true,  //布尔型；true||false
   evenType: 'onStatusChanged',//onStatusChanged onConnectionUpdate
    message: 'CONNECTED',//CONNECTED CONNECTING DISCONNECTED DISCONNECTING REASSERTING
    duration: '',
    lastPacketRecieve: '',
    byteIn: '',
    byteOut: ''
}

示例代码

var demo = uni.requireNativePlugin('XF-openVPN');
demo.addStatusCallback(function(ret){
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getServiceStatus

获取连接状态

getServiceStatus()

ret：

• 类型：字符串

示例代码

var demo = uni.requireNativePlugin('XF-openVPN');
var serviceStatus = demo.getServiceStatus();

可用性

iOS、Android系统

可提供的1.0.0及更高版本