UnboundGlobal

The global unbound object while the client is initialized: the API plus the lifecycle.

interface UnboundGlobal extends UnboundLifecycle

Members

assetsassets

The assets module, which plugins also import from @unbound-app/api/assets.

builtinsbuiltins

The builtins module, which plugins also import from @unbound-app/api/builtins.

commandscommands

The commands module, which plugins also import from @unbound-app/api/commands.

dialogsdialogs

The dialogs module, which plugins also import from @unbound-app/api/dialogs.

fluxflux

The flux module, which plugins also import from @unbound-app/api/flux.

fontsfonts

The fonts module, which plugins also import from @unbound-app/api/fonts.

fsfs

The fs module, which plugins also import from @unbound-app/api/fs.

i18ni18n

The i18n module, which plugins also import from @unbound-app/api/i18n.

iconPacksiconPacks

The iconPacks module, which plugins also import from @unbound-app/api/iconPacks.

marketplacemarketplace

The marketplace module, which plugins also import from @unbound-app/api/marketplace.

metrometro

The metro module, which plugins also import from @unbound-app/api/metro.

nativenative

The native module, which plugins also import from @unbound-app/api/native.

patcherpatcher

The patcher module, which plugins also import from @unbound-app/api/patcher.

pluginsplugins

The plugins module, which plugins also import from @unbound-app/api/plugins.

settingssettings

The settings module, which plugins also import from @unbound-app/api/settings.

shimsshims

The shims module, which plugins also import from @unbound-app/api/shims.

storagestorage

The storage module, which plugins also import from @unbound-app/api/storage.

syncsync

The sync module, which plugins also import from @unbound-app/api/sync.

themesthemes

The themes module, which plugins also import from @unbound-app/api/themes.

toaststoasts

The toasts module, which plugins also import from @unbound-app/api/toasts.

uiui

The ui module, which plugins also import from @unbound-app/api/ui.

updatesupdates

The updates module, which plugins also import from @unbound-app/api/updates.

utilsutils

The utils module, which plugins also import from @unbound-app/api/utils.

initialize(): void

Inherited from UnboundLifecycle.initialize

Brings up the client: registers the addon managers, starts the built-ins, loads each kind's addons, then runs the built-ins' afterAddons hooks. Twin of shutdown.

shutdown(): Promise<void>

Inherited from UnboundLifecycle.shutdown

Tears the client back down: stops the built-ins, shuts down each kind's manager, persists settings, unregisters the managers and clears the global down to the lifecycle entry points. Twin of initialize.

Returns

A promise that resolves once settings have been persisted and shutdown is complete.