sdk.AppSettings
Constructors
constructor
new AppSettings(log
, db
, globalChannel
)
Parameters
Name | Type |
---|---|
log | Logging |
db | DB |
globalChannel | EventBus |
Defined in
Methods
get
get(appName
): Promise
<{ data
: undefined
| IntegrationSchema
}>
Returns an app configuration object
Parameters
Name | Type | Description |
---|---|---|
appName | string | Name of the app |
Returns
Promise
<{ data
: undefined
| IntegrationSchema
}>
Defined in
getAll
getAll(): Promise
<{ data
: undefined
| IntegrationSchema
[] }>
Returns all installed apps
Returns
Promise
<{ data
: undefined
| IntegrationSchema
[] }>
Defined in
install
install(app
, isLocal?
): Promise
<never
>
Persist installed app configuration for the current user
Parameters
Name | Type | Default value | Description |
---|---|---|---|
app | Object | undefined | Object |
app.id? | string | undefined | - |
app.name | string | undefined | - |
isLocal | boolean | false | True only for development. Default is false |
Returns
Promise
<never
>
Defined in
toggleAppStatus
toggleAppStatus(appName
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
appName | string |
Returns
Promise
<boolean
>
Defined in
uninstall
uninstall(appName
): Promise
<void
>
Uninstall app by name
Parameters
Name | Type | Description |
---|---|---|
appName | string | Name of the app |
Returns
Promise
<void
>
Defined in
updateConfig
updateConfig(app
): Promise
<never
>
Parameters
Name | Type |
---|---|
app | ConfigInfo |
Returns
Promise
<never
>
Defined in
updateVersion
updateVersion(app
): Promise
<never
>
Parameters
Name | Type |
---|---|
app | VersionInfo |
Returns
Promise
<never
>