settings
Keys and defaults come from manifest.settings. Views receive get only. Ordinary actions can also set and reset values. File hooks receive a resolved settings snapshot instead of this interface.
Usage guide: services. API index.
Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.
PluginSettings
Section titled “PluginSettings”PluginSettings.get
Section titled “PluginSettings.get”Supported hosts: Lite Mobile
Read a declared setting.
get(key: string): Promise<SettingValue>;| Parameter | Type | Required |
|---|---|---|
key |
string |
Yes |
Returns: Promise<SettingValue>.
PluginSettings.set
Section titled “PluginSettings.set”Supported hosts: Lite Mobile
Set a declared setting from an ordinary action context.
set(key: string, value: SettingValue): Promise<void>;| Parameter | Type | Required |
|---|---|---|
key |
string |
Yes |
value |
SettingValue |
Yes |
Returns: Promise<void>.
PluginSettings.reset
Section titled “PluginSettings.reset”Supported hosts: Lite Mobile
Reset a setting to its declared default.
reset(key: string): Promise<void>;| Parameter | Type | Required |
|---|---|---|
key |
string |
Yes |
Returns: Promise<void>.
Related types: SettingValue.