Skip to main content

API Reference

OpenTree API documentation.

info

The API is divided into two parts:

  • Electron API - Called via window.electronAPI (desktop)
  • IPC Channels - Underlying IPC communication channels

Electron API​

Access via window.electronAPI in the renderer process:

window.electronAPI.keychain.getAll()
window.electronAPI.getFavorites()
window.electronAPI.music.getAll({ page: 1, pageSize: 50 })
window.electronAPI.countdown.getAll()

IPC Channels​

All IPC channels are called via ipcRenderer.invoke:

ipcRenderer.invoke('keychain-get-all')
ipcRenderer.invoke('keychain-create', { name, password })

See the IPC channel tables in each module's documentation for details.