app.wakelock - 防休眠 API

阻止系统休眠,使用 IOKit 电源断言。

方法

app.wakelock.preventSleep(opts?)

创建防休眠断言。

参数:

  • opts (table, 可选):
    • type (string) - 断言类型:
      • "idle" (默认) - 阻止空闲休眠
      • "display" - 阻止显示器休眠
      • "system" - 阻止系统休眠
    • reason (string) - 原因说明(默认 “Plugin requested sleep prevention”)
    • duration (number) - 持续时间(秒),到期自动释放

返回值: string, error - 断言 ID

-- 阻止空闲休眠(无时间限制)
local id, err = app.wakelock.preventSleep()

-- 阻止显示器休眠 30 分钟
local id = app.wakelock.preventSleep({
    type = "display",
    reason = "长时间任务进行中",
    duration = 1800
})

-- 阻止系统休眠 1 小时
local id = app.wakelock.preventSleep({
    type = "system",
    duration = 3600
})

app.wakelock.release(id)

释放指定断言。

参数:

  • id (string) - 断言 ID

返回值: boolean, error

local ok, err = app.wakelock.release(id)

app.wakelock.releaseAll()

释放当前插件的所有断言。

返回值: boolean

app.wakelock.releaseAll()

app.wakelock.list()

列出当前插件的活跃断言。

返回值: array<table> - 每项包含:

  • id (string) - 断言 ID
  • type (string) - 类型
  • reason (string) - 原因
  • createdAt (string) - 创建时间(ISO 8601)
local assertions = app.wakelock.list()
for _, a in ipairs(assertions) do
    app.log.info(a.id .. ": " .. a.type .. " - " .. a.reason)
end

说明

  • 断言在插件卸载时自动释放
  • 指定 duration 后会自动释放,无需手动调用 release()
  • "idle" 类型最常用:防止用户无操作时系统自动休眠
  • "display" 类型同时阻止显示器关闭

示例

长时间任务防休眠

function MyPlugin:handleLongTask(context)
    -- 开始任务前阻止休眠
    local cafId = app.wakelock.preventSleep({
        type = "idle",
        reason = "Processing files"
    })

    app.progress.show("处理中", {message = "正在处理..."})

    -- 执行长时间任务
    for i, file in ipairs(context.selectedFiles) do
        app.progress.update(i / #context.selectedFiles * 100)
        -- ... 处理文件 ...
    end

    app.progress.hide()

    -- 任务完成后释放
    if cafId then
        app.wakelock.release(cafId)
    end

    app.notification.show("完成", "处理了 " .. #context.selectedFiles .. " 个文件")
end
开发者文档
使用帮助
使用说明 脚本菜单 常见问题
脚本开发
开发指南
插件开发
快速开始 开发指南 示例插件
API 参考
概览 API 查询 插件信息 日志 Finder 上下文 插件设置 国际化
UI 与交互
对话框 进度条 系统通知 选择器 WebView 状态栏 Dock
文件与路径
文件操作 路径工具 Finder 操作 废纸篓 扩展属性 元数据 文件监听
数据格式
JSON Plist CSV XML PDF 图片
文本与编码
字符串 正则表达式 日期时间 颜色 加密编码
系统
Shell 命令 进程管理 应用管理 系统信息 AppleScript 快捷指令
系统信息
网络信息 电源/电池 屏幕/外观 音频控制 蓝牙设备 位置服务
网络
HTTP 请求 WebSocket URL 工具
输入与剪贴板
键盘模拟 鼠标模拟 全局热键 剪贴板 窗口管理
存储
SQLite Keychain UserDefaults
媒体
文字识别 二维码
工具
归档 类型标识 分享 定时器 防休眠 并发/协程