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
| Name | Type |
|---|---|
id | string |
css | string |
Returns
Promise<void>
registerCallback
▸ registerCallback<T>(callbackId, callback): void
Type parameters
| Name | Type |
|---|---|
T | extends undefined | SpecialPluginCallback = undefined |
Parameters
| Name | Type |
|---|---|
callbackId | string |
callback | T extends undefined ? CallbackFn : T extends SpecialPluginCallback ? SpecialPluginCallbackInfo[T] : never |
Returns
void
registerCommand
▸ registerCommand(command): Promise<void>
Parameters
| Name | Type |
|---|---|
command | Command |
Returns
Promise<void>
registerMenuItem
▸ registerMenuItem(menuItem): Promise<void>
Parameters
| Name | Type |
|---|---|
menuItem | PluginMenuItem |
Returns
Promise<void>
registerPowerup
▸ registerPowerup(args): Promise<void>
Parameters
| Name | Type |
|---|---|
args | Object |
args.code | string |
args.description | string |
args.name | string |
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
| Name | Type |
|---|---|
command | Command |
Returns
Promise<void>
registerWidget
▸ registerWidget(fileName, location, options): Promise<void>
Parameters
| Name | Type |
|---|---|
fileName | string |
location | WidgetLocation |
options | WidgetOptions |
Returns
Promise<void>
releaseKeys
▸ releaseKeys(keys): Promise<void>
Parameters
| Name | Type |
|---|---|
keys | string[] |
Returns
Promise<void>
stealKeys
▸ stealKeys(keys): Promise<void>
Parameters
| Name | Type |
|---|---|
keys | string[] |
Returns
Promise<void>
toast
▸ toast(message): Promise<void>
Parameters
| Name | Type |
|---|---|
message | string |
Returns
Promise<void>
transaction
▸ transaction<F>(fn): Promise<Awaited<ReturnType<F>>>
Type parameters
| Name | Type |
|---|---|
F | extends () => any |
Parameters
| Name | Type |
|---|---|
fn | F |
Returns
Promise<Awaited<ReturnType<F>>>
unregisterMenuItem
▸ unregisterMenuItem(id): Promise<void>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<void>
unregisterWidget
▸ unregisterWidget(fileName, location): Promise<void>
Parameters
| Name | Type |
|---|---|
fileName | string |
location | WidgetLocation |
Returns
Promise<void>
waitForInitialSync
▸ waitForInitialSync(): Promise<void>
Returns
Promise<void>