系统

提供一些系统级 API 的封装，也包含部分对于 uTools 底座功能的封装。

utools.showNotification(text[, clickFeatureCode])

显示一个系统通知

类型定义

function showNotification(text: string, clickFeatureCode?: string): void;

• clickFeatureCode 对应 plugin.json 配置的 feature.code，点击通知进入插件应用功能(该 feature.cmds 至少包含一个搜索字符串指令)

示例代码

utools.showNotification("Hi, uTools");

utools.shellOpenPath(path)

系统默认方式打开给定的文件

类型定义

function shellOpenPath(path: string): void;

示例代码

utools.shellOpenPath("C:\\Users\\Administrator\\Desktop\\test.txt");

utools.shellTrashItem(path)

删除文件到回收站

类型定义

function shellTrashItem(path: string): void;

示例代码

utools.shellTrashItem("C:\\Users\\Administrator\\Desktop\\test.txt");

utools.shellShowItemInFolder(path)

在文件管理器中显示文件

类型定义

function shellShowItemInFolder(path: string): void;

示例代码

utools.shellShowItemInFolder("C:\\Users\\Administrator\\Desktop\\test.txt");

utools.shellOpenExternal(url)

系统默认的协议打开 URL

类型定义

function shellOpenExternal(url: string): void;

示例代码

utools.shellOpenExternal("https://www.u-tools.cn");

utools.shellBeep()

播放系统提示音

类型定义

function shellBeep(): void;

示例代码

utools.shellBeep();

utools.getNativeId()

获取本地 ID

类型定义

function getNativeId(): string;

示例代码

// 存储只与当前设备相关的信息
const nativeId = utools.getNativeId();
utools.dbStorage.setItem(nativeId + "/key", "native value");

utools.getAppName()

获取软件名称

类型定义

function getAppName(): string;

示例代码

console.log(utools.getAppName());

utools.getAppVersion()

获取软件版本

类型定义

function getAppVersion(): string;

示例代码

console.log(utools.getAppVersion());

utools.getPath(path)

获取路径，提供了一些特殊的路径获取方法

类型定义

function getPath(path: string): string;

提示

name 可以是以下特定的值

• home 用户主目录
• appData 应用程序数据目录
  • %APPDATA% (Windows)
  • ~/Library/Application Support (macOS)
• userData 应用程序用户数据目录，默认是 appData 文件夹附加应用的名称
• temp 临时目录
• exe 当前可执行文件的绝对路径
• desktop 用户桌面目录
• documents 用户文档目录
• downloads 用户下载目录
• music 用户音乐目录
• pictures 用户图片目录
• videos 用户视频目录
• logs 用户日志目录

utools.getFileIcon(filePath)

获取文件图标

类型定义

function getFileIcon(filePath: string): string;

• filePath 支持文件或者文件夹路径、文件扩展名

示例代码

const icon = utools.getFileIcon("C:\\Users\\Administrator\\Desktop\\test.txt");
console.log(icon);

utools.readCurrentFolderPath()

读取当前文件管理器窗口路径 (linux 不支持)

类型定义

function readCurrentFolderPath(): Promise<string>;

示例代码

const path = await utools.readCurrentFolderPath();
console.log(path);

utools.readCurrentBrowserUrl()

读取当前浏览器窗口路径 (linux 不支持)

警告

由于浏览器差异，目前仅对以下浏览器完成测试：

• MacOS: Safari、Chrome、Microsoft Edge、Opera、Vivaldi、Brave
• Windows: Chrome、Firefox、Edge、IE、Opera、Brave

类型定义

function readCurrentBrowserUrl(): Promise<string>;

示例代码

const url = await utools.readCurrentBrowserUrl();
console.log(url);

utools.isDev()

判断插件应用是否在开发环境

提示

插件应用开发环境是指：插件在 uTools 开发者工具中直接运行启动

类型定义

function isDev(): boolean;

示例代码

if (utools.isDev()) {
  console.log("插件应用开发环境");
}

utools.isMacOS()

判断当前系统是否是 macOS

类型定义

function isMacOS(): boolean;

示例代码

if (utools.isMacOS()) {
  console.log("当前系统是 macOS");
}

utools.isWindows()

判断当前系统是否是 Windows

类型定义

function isWindows(): boolean;

示例代码

if (utools.isWindows()) {
  console.log("当前系统是 Windows");
}

utools.isLinux()

判断当前系统是否是 Linux

类型定义

function isLinux(): boolean;

示例代码

if (utools.isLinux()) {
  console.log("当前系统是 Linux");
}