IPC Channels
All IPC channels used by OpenTree.
Channel Naming Convention
{module}-{action}
Example:
keychain-get-all
keychain-create
favorites-add-manual
music-playlist-delete
Complete Channel List
Keychain
| Channel | Direction | Parameters | Returns |
|---|---|---|---|
keychain-get-all | renderer -> main | - | KeychainItem[] |
keychain-create | renderer -> main | Partial<KeychainItem> | KeychainItem |
keychain-update | renderer -> main | id, Partial<KeychainItem> | KeychainItem |
keychain-delete | renderer -> main | id | boolean |
Favorites
| Channel | Direction | Parameters | Returns |
|---|---|---|---|
get-favorites | renderer -> main | - | FavoriteItem[] |
add-favorite-manual | renderer -> main | { url, title, name? } | FavoriteItem |
update-favorite | renderer -> main | id, updates | FavoriteItem |
remove-favorite | renderer -> main | id | boolean |
get-favorite-tags | renderer -> main | - | string[] |
fetch-page-title | renderer -> main | url | string |
Music
| Channel | Direction | Parameters | Returns |
|---|---|---|---|
music-get-all | renderer -> main | { page, pageSize } | { items, total } |
music-get-file | renderer -> main | id | { fileData, mimeType } |
music-delete | renderer -> main | id | boolean |
music-update-last-played | renderer -> main | id | void |
music-move-to-playlist | renderer -> main | musicId, playlistId | void |
music-playlist-get-all | renderer -> main | - | MusicPlaylist[] |
music-playlist-create | renderer -> main | { name } | MusicPlaylist |
music-playlist-update | renderer -> main | id, { name } | MusicPlaylist |
music-playlist-delete | renderer -> main | id | boolean |
Countdown
| Channel | Direction | Parameters | Returns |
|---|---|---|---|
countdown-get-all | renderer -> main | - | CountdownItem[] |
countdown-create | renderer -> main | Partial<CountdownItem> | CountdownItem |
countdown-update | renderer -> main | id, Partial<CountdownItem> | CountdownItem |
countdown-delete | renderer -> main | id | boolean |
Metaverse
| Channel | Direction | Parameters | Description |
|---|---|---|---|
mv2-pc-navigate | renderer -> main | pcIndex, url | Open URL in specified PC |
mv2-pc-create | renderer -> main | - | Create new PC |
mv2-pc-close | renderer -> main | pcIndex | Close PC |
Data Change Events
| Channel | Direction | Parameters | Description |
|---|---|---|---|
data-changed | main -> renderer | { module } | Data change broadcast |