Class SettingsManager

Hierarchy

SettingsManager

Index

Constructors

constructor

Methods

Constructors

constructor

new SettingsManager(_handler: StreamDeckHandlerBase<any>): SettingsManager

- Defined in manager/settings.manager.ts:18
Parameters
- _handler: StreamDeckHandlerBase<any>
Returns SettingsManager

Methods

cacheContextSettings

cacheContextSettings(context: string, settings: {}): void

- Defined in manager/settings.manager.ts:193
Sets settings without saving it

This is deprecated, please use ActionManager

deprecated

Parameters
- context: string
- settings: {}
Returns void

cacheGlobalSettings

cacheGlobalSettings(settings: {}): void

- Defined in manager/settings.manager.ts:181
Sets global settings without saving it

Parameters
- settings: {}
Returns void

disableAutoDebounce

disableAutoDebounce(): void

- Defined in manager/settings.manager.ts:32
Disables automatic debounce

Returns void

disableAutoSave

disableAutoSave(): void

- Defined in manager/settings.manager.ts:25
Disables automatic save

Returns void

getAllContextSettings

getAllContextSettings<Settings>(): Map<string, Settings>

- Defined in manager/settings.manager.ts:93
Gets all context settings

This is deprecated, please use ActionManager

deprecated

Type parameters
- Settings
  
  your settings interface for autocomplete
Returns Map<string, Settings>

getContextSettings

getContextSettings<Settings>(context: string): undefined | Settings

- Defined in manager/settings.manager.ts:81
Gets context settings

This is deprecated, please use ActionManager

deprecated

Type parameters
- Settings
  
  your settings interface for autocomplete
Parameters
- context: string
  
  the context of the action
Returns undefined | Settings

getGlobalSettings

getGlobalSettings<GlobalSettings>(): {} | GlobalSettings

- Defined in manager/settings.manager.ts:41
Gets global settings

Type parameters
- GlobalSettings
  
  your settings interface for autocomplete
Returns {} | GlobalSettings

| GlobalSettings}

saveContextSettings

saveContextSettings(context: string, ms: number): void

- Defined in manager/settings.manager.ts:159
Save context settings

This is deprecated, please use ActionManager

deprecated

Parameters
- context: string
  
  string for specific action or 'ALL' for all events
- ms: number
  
  for the debounce
Returns void

saveGlobalSettings

saveGlobalSettings(ms: number): void

- Defined in manager/settings.manager.ts:139
Save global settings

Parameters
- ms: number
  
  for the debounce
Returns void

setContextSettings

setContextSettings(context: string, settings: {}, ms?: number): void

- Defined in manager/settings.manager.ts:106
Set context settings

This is deprecated, please use ActionManager

deprecated

Parameters
- context: string
- settings: {}
- ms: number = 0
  
  for the debounce
Returns void

setContextSettingsAttributes

setContextSettingsAttributes(context: string, attributes: {}, ms?: number): void

- Defined in manager/settings.manager.ts:120
Set single or multiple attributes for settings This is deprecated, please use ActionManager

deprecated

Parameters
- context: string
  
  Single or multiple attributes
- attributes: {}
- ms: number = 0
  
  for the debounce
Returns void

setGlobalSettings

setGlobalSettings<GlobalSettings>(settings: GlobalSettings, ms?: number): void

- Defined in manager/settings.manager.ts:51
Sets global settings

Type parameters
- GlobalSettings
  
  your settings interface for autocomplete
Parameters
- settings: GlobalSettings
- ms: number = 0
  
  for the debounce
Returns void

setGlobalSettingsAttributes

setGlobalSettingsAttributes(attributes: {}, ms?: number): void

- Defined in manager/settings.manager.ts:65
Sets single or multiple attributes of the settings

Parameters
- attributes: {}
  
  single or multiple attributes
- ms: number = 0
  
  for the debounce
Returns void

Generated using TypeDoc