Skip to main content

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

ChannelDirectionParametersReturns
keychain-get-allrenderer -> main-KeychainItem[]
keychain-createrenderer -> mainPartial<KeychainItem>KeychainItem
keychain-updaterenderer -> mainid, Partial<KeychainItem>KeychainItem
keychain-deleterenderer -> mainidboolean

Favorites

ChannelDirectionParametersReturns
get-favoritesrenderer -> main-FavoriteItem[]
add-favorite-manualrenderer -> main{ url, title, name? }FavoriteItem
update-favoriterenderer -> mainid, updatesFavoriteItem
remove-favoriterenderer -> mainidboolean
get-favorite-tagsrenderer -> main-string[]
fetch-page-titlerenderer -> mainurlstring

Music

ChannelDirectionParametersReturns
music-get-allrenderer -> main{ page, pageSize }{ items, total }
music-get-filerenderer -> mainid{ fileData, mimeType }
music-deleterenderer -> mainidboolean
music-update-last-playedrenderer -> mainidvoid
music-move-to-playlistrenderer -> mainmusicId, playlistIdvoid
music-playlist-get-allrenderer -> main-MusicPlaylist[]
music-playlist-createrenderer -> main{ name }MusicPlaylist
music-playlist-updaterenderer -> mainid, { name }MusicPlaylist
music-playlist-deleterenderer -> mainidboolean

Countdown

ChannelDirectionParametersReturns
countdown-get-allrenderer -> main-CountdownItem[]
countdown-createrenderer -> mainPartial<CountdownItem>CountdownItem
countdown-updaterenderer -> mainid, Partial<CountdownItem>CountdownItem
countdown-deleterenderer -> mainidboolean

Metaverse

ChannelDirectionParametersDescription
mv2-pc-navigaterenderer -> mainpcIndex, urlOpen URL in specified PC
mv2-pc-createrenderer -> main-Create new PC
mv2-pc-closerenderer -> mainpcIndexClose PC

Data Change Events

ChannelDirectionParametersDescription
data-changedmain -> renderer{ module }Data change broadcast