更新记录

1.0.0（2024-08-26）

• 2024-08-26
• 初版发布，主要提供以下方法
  • 1. VPN初始化
  • 2. 登录
  • 3. 同步获取状态
  • 4. 服务启动 | 关闭
  • 5. 检查权限
  • 6. 根据状态码查询信息
  • 7. 退出登录
  • 8. 获取设备信息

平台兼容性

天融信Vpn UTS解决方案

基于天融信VPN sdk封装uniapp插件，基本提供官方所有内置方法。（现仅支持Android，IOS联系定制）

使用示例

import { trxVpn } from "@/uni_modules/rss-trxvpn"

data() {
    return {  
        vpnIsStart: false, 
        vpnConfig:{
            addr: '', // vpn链接地址 eg: 127.0.0.1:8888  可不带 http:// 
            username: '', // 用户
            password: '', // 密码
        }
    }
},
methods:{
    initVpn(){
        // 初始化VPN
        this.trxVpn = new trxVpn({
            vpn_addr: this.vpnConfig.addr,
            username: this.vpnConfig.username,
            password: this.vpnConfig.password,
            serviceMode: 1, // 1. 登录成功立即启动服务 2. 手动启动服务
            logLevel: 'none', // none , debug, info, warn, error, default
            onResultCallback: (res)=>{
                console.log('onResultCallback===>',res)
                const {type, traceId, data, code, msg} = res;
                switch (type){
                    case 'OPERATION_GET_SERVERCFG': // 获取服务器配置 
                        if(code == -18){
                            this.vpnIsStart = true;
                        }else{
                            this.showToast(msg)
                        }
                        break;
                    case 'OPERATION_LOGIN_SYSTEM':
                        if(code == -18){
                            this.vpnIsStart = true;
                        }
                        break;
                    case 'OPERATION_START_SERVICE': // 启动 VPN 服务
                        if(code == 0 || code == -18){
                            this.vpnIsStart = true;
                        }else{
                            this.vpnIsStart = false;
                        }
                        break;
                    case 'OPERATION_GET_RESOURCE': // 获取资源列表（可不关注，排错使用） 
                        this.ResourceList = data;
                        break;
                    case 'OPERATION_GET_KEEPSTATUS':
                        break;
                    case 'OPERATION_CLOSE_SERVICE': // 关闭 VPN 服务
                        break;
                    default:
                        break;
                }
            },
            onAcceptSysLog: (res)=>{
                console.log(res)
            }
        }) 

    },
    // 调用登录
    login(){
        this.trxVpn.login();
    },

    getVpnState(){
        let res = this.trxVpn.getVpnState(); 
    },
    // 调用启动服务
    startService(){
        let res = this.trxVpn.startService();
    },
    // 调用关闭服务
    closeService(){
        let res = this.trxVpn.closeService();
    },
    // 调用退出登录 (退出登录前需关闭服务)
    logout(){
        let res = this.trxVpn.logout();
    },
    // 检查App权限
    checkPermission(){
        let res = this.trxVpn.requestpermission()
    },

}

API 列表

参数说明

事件说明

onResultCallback 返回值说明

onAcceptSysLog 返回值说明

APP所需权限及说明

返回值及说明 code

code 和 type 互通，类似于 key value 的关系，可以根据 type 找到对应的 code

注意

• 1. 所有异步接口调用结果都会在 onResultCallback 中返回；
• 2. 所有日志均通过 onAcceptSysLog 返回；
• 3. VPN 运行状态可通过 getVpnState (同步获取)得到
• 4. 对操作的返回值，成功都是 0，失败返回可以通过 getErrorInfoByCode 查询到具体的出错原因
• 5. 请配合天融信官方对接文档使用。（ 986893999@qq.com 备注 需要天融信官方对接文档）

如有特殊使用场景，请联系我！ 文档完善中...

部分场景下功能仍在完善中，请耐心等待...