Skip to main content

Class: AppNamespace

Hierarchy

  • NamespaceBase

    AppNamespace

Methods

getOperatingSystem

getOperatingSystem(): Promise<OperatingSystem>

Returns

Promise<OperatingSystem>


getPlatform

getPlatform(): Promise<Platform>

Returns

Promise<Platform>


registerCSS

registerCSS(id, css): Promise<void>

Parameters

NameType
idstring
cssstring

Returns

Promise<void>


registerCallback

registerCallback<T>(callbackId, callback): void

Type parameters

NameType
Textends undefined | SpecialPluginCallback = undefined

Parameters

NameType
callbackIdstring
callbackT extends undefined ? CallbackFn : T extends SpecialPluginCallback ? SpecialPluginCallbackInfo[T] : never

Returns

void


registerCommand

registerCommand(command): Promise<void>

Parameters

NameType
commandCommand

Returns

Promise<void>


registerMenuItem

registerMenuItem(menuItem): Promise<void>

Parameters

NameType
menuItemPluginMenuItem

Returns

Promise<void>


registerPowerup

registerPowerup(args): Promise<void>

Parameters

NameType
argsObject
args.codestring
args.descriptionstring
args.namestring
args.options{ slots: { code: string; name: string; onlyProgrammaticModifying?: boolean | undefined; hidden?: boolean | undefined; enumValues?: Record<string, string> | undefined; defaultEnumValue?: string | undefined; propertyType?: PropertyType | undefined; propertyLocation?: PropertyLocation | undefined; selectSourceType?: SelectSourc...[] } | { properties: { code: string; name: string; onlyProgrammaticModifying?: boolean | undefined; hidden?: boolean | undefined; enumValues?: Record<string, string> | undefined; defaultEnumValue?: string | undefined; propertyType?: PropertyType | undefined; propertyLocation?: PropertyLocation | undefined; selectSourceType?: SelectSourc...[] }

Returns

Promise<void>


registerRemMenuItem

registerRemMenuItem(command): Promise<void>

Parameters

NameType
commandCommand

Returns

Promise<void>


registerWidget

registerWidget(fileName, location, options): Promise<void>

Parameters

NameType
fileNamestring
locationWidgetLocation
optionsWidgetOptions

Returns

Promise<void>


releaseKeys

releaseKeys(keys): Promise<void>

Parameters

NameType
keysstring[]

Returns

Promise<void>


stealKeys

stealKeys(keys): Promise<void>

Parameters

NameType
keysstring[]

Returns

Promise<void>


toast

toast(message): Promise<void>

Parameters

NameType
messagestring

Returns

Promise<void>


transaction

transaction<F>(fn): Promise<Awaited<ReturnType<F>>>

Type parameters

NameType
Fextends () => any

Parameters

NameType
fnF

Returns

Promise<Awaited<ReturnType<F>>>


unregisterMenuItem

unregisterMenuItem(id): Promise<void>

Parameters

NameType
idstring

Returns

Promise<void>


unregisterWidget

unregisterWidget(fileName, location): Promise<void>

Parameters

NameType
fileNamestring
locationWidgetLocation

Returns

Promise<void>


waitForInitialSync

waitForInitialSync(): Promise<void>

Returns

Promise<void>