uTools API

utools.onPluginReady(() => {
    console.log('插件装配完成，已准备好')
  })
  

utools.onPluginEnter(({code, type, payload, optional}) => {
    console.log('用户进入插件', code, type, payload)
  })
  

utools.onPluginOut(() => {
    console.log('用户退出插件')
  })
  

utools.onPluginDetach(() => {
    console.log('插件被分离')
  })
  

utools.onDbPull(() => {
    console.log('onDbPull')
  })
  

utools.hideMainWindow()
  

utools.showMainWindow()
  

utools.setExpendHeight(100)
  

utools.setSubInput(({ text }) => {
    console.log(text)
  }, '搜索')
  

utools.removeSubInput()
  

utools.setSubInputValue('uTools')
  

utools.subInputFocus()
  

utools.subInputSelect()
  

utools.subInputBlur()
  

utools.outPlugin()
  

//content 为string类型
  utools.redirect('翻译', 'hello world')
  
  //content 为object类型
  utools.redirect('翻译', {
      'type': 'text',
      'data': 'hello world'
  })
  
  //传递图片
  utools.redirect('图片识别', {
      'type': 'img',
      // data 可以是本地图片路径、base64编码的图片、Buffer对象
      'data': '/path/to/img.jpg(支持jpeg|png|bmp)' //filePath、base64、Buffer
  })
  
  //传递文件、文件夹
  utools.redirect('图片压缩', {
      'type': 'files',
      // data 可以是本地文件、文件夹路径
      'data': '/path/to/img.jpg' //filePath、array
      //'data': ['path1', 'path2'] //支持数组
  })
  

utools.showOpenDialog({ 
    filters: [{ 'name': 'plugin.json', extensions: ['json'] }], 
    properties: ['openFile'] 
  })
  

utools.showSaveDialog({ 
    title: '保存位置', 
    defaultPath: utools.getPath('downloads')
    buttonLabel: '保存'
  })
  

utools.showMessageBox({
    type: 'question',
    buttons: ['取消', '关机'],
    title: '关机确认',
    message: '电脑确定要关机?',
    defaultId: 1
  })
  

utools.findInPage('utools')
  

utools.stopFindInPage()
  

utools.startDrag('/path/to/file')
  

utools.createBrowserWindow('test.html?param=xxxxxx', {
    title: '测试窗口',
    fullscreen: true,
    webPreferences: {
      preload: 'test/preload.js'
    }
  })
  

const features = utools.getFeatures()
  console.log(features)
  

utools.setFeature({
    "code": "hosts",
    "explain": "hosts切换",
    // "icon": "res/xxx.png",
    // "icon": "data:image/png;base64,xxx...",
    // "platform": ["win32", "darwin", "linux"]
    "cmds": ["hosts"]
  })
  

utools.removeFeature('code')
  

utools.screenColorPick(({hex, rgb})=>{
    console.log(hex) // #FFFFFF
    console.log(rgb) // RGB(0, 0, 0)
  })
  

utools.screenCapture(base64Str => {
    utools.redirect('识别图片中文字', { type: 'img', data: base64Str })
  })
  

// 模拟键盘敲击 Enter
  utools.simulateKeyboardTap('enter')
  // windows linux 模拟粘贴
  utools.simulateKeyboardTap('v', 'ctrl')
  // macos 模拟粘贴
  utools.simulateKeyboardTap('v', 'command')
  // 模拟 Ctrl + Alt + A
  utools.simulateKeyboardTap('a', 'ctrl', 'alt')
  

utools.simulateMouseMove(100，100)
  

utools.simulateMouseClick(100，100)
  

utools.simulateMouseRightClick(100，100)
  

utools.simulateMouseDoubleClick(100，100)
  

const point = utools.getCursorScreenPoint()
  console.log(point.x, point.y)
  

const display = utools.getPrimaryDisplay()
  console.log(display)
  

const displays = utools.getAllDisplays()
  console.log(displays)
  

const display = utools.getDisplayNearestPoint({x: 100, y: 100 })
  console.log(display)
  

const display = utools.getDisplayMatching({x: 100, y: 100, width: 200, height: 200 })
  console.log(display)
  

// 复制单个文件
  utools.copyFile('/path/to/file')
  // 复制多个文件
  utools.copyFile(['/path/to/file1', '/path/to/file2'])
  

// 路径
  utools.copyImage('/path/to/img.png')
  // base64
  utools.copyImage('data:image/png;base64,xxxxxxxxx')
  

utools.copyText('Hi, uTools')
  

utools.showNotification('Hi, uTools')
  

utools.shellOpenItem('/path/to/file')
  

utools.shellShowItemInFolder('/path/to/file')
  

// 浏览器打开
  utools.shellOpenExternal('https://u.tools')
  

utools.shellBeep()
  

console.log(utools.getLocalId())
  

// 获取下载路径
  console.log(utools.getPath('downloads'))
  

console.log(utools.getCurrentFolderPath())
  

console.log(utools.getCurrentBrowserUrl())
  

if (utools.isMacOs()) {
    console.log('mac')
  }
  

if (utools.isWindows()) {
    console.log('windows')
  }
  

if (utools.isLinux()) {
    console.log('linux')
  }
  

// 创建请求
  utools.db.put({
    _id: "demo",
    data: "demo"
  })
  // 返回 {id: "demo", ok: true, rev: "1-05c9b92e6f24287dc1f4ec79d9a34fa8"}
  
  // 更新请求
  utools.db.put({
    _id: "demo",
    data: "demo",
    _rev: "1-05c9b92e6f24287dc1f4ec79d9a34fa8"
  })
  

utools.db.get("demo")
  // 返回 {_id: "demo", _rev: "3-9836c5c68af5aef618e17d615882942a", data: "demo"}
  

utools.db.remove("demo")
  // 返回 {id: "demo", ok: true, rev: "2-effe5dbc23dffc180d8411b23f3108fb"}
  

utools.db.bulkDocs([{
    _id: "demo1",
    data: "demo",
    _rev: "1-c8817a74e292eda4cba1a45924853af6"
  }, {
    _id: "demo2",
    data: "demo",
    _rev: "1-f0399b42cc6123a9cc8503632ba7b3a7"
  }])
  /* 返回
  [{
    id: "demo1", ok: true, rev: "2-7857b2801bc0303d2cc0bb82e8afd796"
  }, {
    id: "demo2", ok: true, rev: "2-7857b2801bc0303d2cc0bb82e8afd796"
  }]
  */
  

// 获取所有文档
  utools.db.allDocs()
  
  // 传入字符串，则返回id以 demo 开头的文档
  utools.db.allDocs("demo")
  /* 返回
  [{
    _id: "demo/123", _rev: "2-7857b2801bc0303d2cc0bb82e8afd796", data: "demo"
  }, {
    _id: "demo/124", _rev: "1-f0399b42cc6123a9cc8503632ba7b3a7", data: "demo"
  }, {
    _id: "demo/125", _rev: "1-f0399b42cc6123a9cc8503632ba7b3a7", data: "demo"
  }]
  */
  // 根据id数组请求
  utools.db.allDocs([
    "demo1",
    "demo2"
  ])
  /* 返回
  [{
    _id: "demo1", _rev: "2-7857b2801bc0303d2cc0bb82e8afd796", data: "demo"
  }, {
    _id: "demo2", _rev: "1-f0399b42cc6123a9cc8503632ba7b3a7", data: "demo"
  }]
  */
  

console.log(utools.getIdleUBrowsers())
  // [{ id: number, title: string, url: string }]
  

utools.setUBrowserProxy({
    proxyRules: 'http=foopy:80;ftp=foopy2'
  })