API 参考

TimeLens 前后端通过 Tauri IPC 通信。本文档列出所有可用的 Rust Command 接口，以及前端 tauriApi.ts 中的对应封装。

监控 (Monitor)

事件监听

import { listen } from "@tauri-apps/api/event";

const unlisten = await listen("active-window-changed", (event) => {
  console.log("前台窗口变更:", event.payload);
});

// 组件卸载时取消监听
unlisten();

屏幕时间统计

分类管理

目标与限额

专注模式

小组件管理

待办事项

浏览器扩展

应用设置

生产力分析

数据导入导出

系统通知

核心类型定义

所有类型定义位于 src/types/index.ts，以下是常用类型：

MonitorStatus

interface MonitorStatus {
  active: boolean;           // 监控是否运行中
  current_app: string;       // 当前前台应用名
  current_exe_path: string;  // 当前应用可执行文件路径
  current_title: string;     // 当前窗口标题
}

AppUsageSummary

interface AppUsageSummary {
  app_name: string;      // 应用名称
  exe_path: string;      // 可执行文件路径
  total_seconds: number; // 总使用秒数
}

WidgetConfig

interface WidgetConfig {
  id: string;
  widget_type: string;
  monitor_index: number;
  x: number;
  y: number;
  width: number;
  height: number;
  opacity: number;
  always_on_top_mode: "always" | "focus" | "never";
  pinned: boolean;
  start_on_launch: boolean;
}

UsageGoal

interface UsageGoal {
  id?: number;
  scope_type: "category" | "app";      // 目标范围：分类 或 单个应用
  scope_value: string;                  // 分类名或应用名
  period: "daily" | "weekly";           // 统计周期
  operator: "at_least" | "at_most";     // 约束类型
  target_seconds: number;               // 目标秒数
  enabled: boolean;
}

AppSettingsPayload

interface AppSettingsPayload {
  launch_at_startup: boolean;
  silent_startup: boolean;
  auto_open_widgets: boolean;
  ignore_system_processes: boolean;
  idle_time_policy: "count" | "exclude";
  track_window_titles: boolean;
  browser_extension_enabled: boolean;
  shortcuts: ShortcutSettings;
}

前端调用示例

import * as api from "@/services/tauriApi";

// 获取今日应用排行
const todayStats = await api.getTodayAppTotals();

// 暂停监控
await api.setMonitoringActive(false);

// 创建时钟小组件
const config = await api.createWidget("clock");

// 监听窗口切换事件
const unlisten = await api.onActiveWindowChanged((info) => {
  console.log(info.app_name, info.window_title);
});

// 保存设置
await api.setLaunchAtStartup(true);

最后更新：2025-05-03 · TimeLens v1.1.0