更新记录

1.0.0（2025-07-07）

初始化版本发布。

平台兼容性

uni-app

uni-app x

概述

XF-singBoxVPNUTS实现了Android集成sing-box实现VPN功能。

插件接口

setConfig

配置VPN参数

uni-app项目中（nvue）调用示例：

import { setConfig } from "@/uni_modules/XF-singBoxVPNUTS"

setConfig({
  conf: "",
  complete: (res) => {
        console.log(res)
  }
});

uni-app x项目（uvue）中调用示例：

import { setConfig } from "@/uni_modules/XF-singBoxVPNUTS";
import { ConfigOptions } from "@/uni_modules/XF-singBoxVPNUTS/utssdk/interface.uts";

let options = {
  conf: "",
  complete: (res : any) => {
    console.log(res)
  }
} as ConfigOptions;
setConfig(options);

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startVPN

开启VPN服务

uni-app项目中（nvue）调用示例：

import { startVPN } from "@/uni_modules/XF-singBoxVPNUTS"

startVPN({
  complete: (res) => {
        console.log(res)
  }
});

uni-app x项目（uvue）中调用示例：

import { startVPN } from "@/uni_modules/XF-singBoxVPNUTS";
import { VPNOptions } from "@/uni_modules/XF-singBoxVPNUTS/utssdk/interface.uts";

let options = {
  complete: (res : any) => {
    console.log(res)
  }
} as VPNOptions;
startVPN(options);

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopVPN

停止VPN服务

uni-app项目中（nvue）调用示例：

import { stopVPN } from "@/uni_modules/XF-singBoxVPNUTS"

stopVPN({
  complete: (res) => {
        console.log(res)
  }
});

uni-app x项目（uvue）中调用示例：

import { stopVPN } from "@/uni_modules/XF-singBoxVPNUTS";
import { VPNOptions } from "@/uni_modules/XF-singBoxVPNUTS/utssdk/interface.uts";

let options = {
  complete: (res : any) => {
    console.log(res)
  }
} as VPNOptions;
stopVPN(options);

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addStatusCallback

监听VPN状态通知

uni-app项目中（nvue）调用示例：

import { addStatusCallback } from "@/uni_modules/XF-singBoxVPNUTS"

addStatusCallback({
  complete: (res) => {
        console.log(res)
  }
});

uni-app x项目（uvue）中调用示例：

import { addStatusCallback } from "@/uni_modules/XF-singBoxVPNUTS";
import { VPNOptions } from "@/uni_modules/XF-singBoxVPNUTS/utssdk/interface.uts";

let options = {
  complete: (res : any) => {
    console.log(res)
  }
} as VPNOptions;
addStatusCallback(options);

可用性

iOS、Android系统

可提供的1.0.0及更高版本

isConnected

是否已连接

uni-app项目中（nvue）调用示例：

import { isConnected } from "@/uni_modules/XF-singBoxVPNUTS"

isConnected();

uni-app x项目（uvue）中调用示例：

import { isConnected } from "@/uni_modules/XF-singBoxVPNUTS";

isConnected();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getConfig

获取正在运行的配置文件内容

uni-app项目中（nvue）调用示例：

import { getConfig } from "@/uni_modules/XF-singBoxVPNUTS"

getConfig();

uni-app x项目（uvue）中调用示例：

import { getConfig } from "@/uni_modules/XF-singBoxVPNUTS";

getConfig();

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getLog

获取日志信息

uni-app项目中（nvue）调用示例：

import { getLog } from "@/uni_modules/XF-singBoxVPNUTS"

getLog();

uni-app x项目（uvue）中调用示例：

import { getLog } from "@/uni_modules/XF-singBoxVPNUTS";

getLog();

可用性

iOS、Android系统

可提供的1.0.0及更高版本