Interface IServerSettingsModify

This accessor provides methods to change default setting options of Rocket.Chat in a compatible way. It is provided during your App's "onEnable".

Hierarchy

IServerSettingsModify

Index

Methods

hideGroup hideSetting incrementValue modifySetting

Methods

hideGroup

hideGroup(name): Promise<void>
Hides an existing settings group.
Parameters
- name: string
  
  The technical name of the group
Returns Promise<void>
- Defined in src/definition/accessors/IServerSettingsModify.ts:14

hideSetting

hideSetting(id): Promise<void>
Hides a setting. This does not influence the actual functionality (the setting will still have its value and can be programatically read), but the administrator will not be able to see it anymore
Parameters
- id: string
  
  the id of the setting to hide
Returns Promise<void>
- Defined in src/definition/accessors/IServerSettingsModify.ts:22

incrementValue

incrementValue(id, value?): Promise<void>
Increases the setting value by the specified amount. To be used only with statistic settings that track the amount of times an action has been performed
Parameters
- id: string
  
  the id of the existing Rocket.Chat setting
- Optional value: number
  
  how much should the count be increased by. Defaults to 1.
Returns Promise<void>
- Defined in src/definition/accessors/IServerSettingsModify.ts:39

modifySetting

modifySetting(setting): Promise<void>
Modifies the configured value of another setting, please use it with caution as an invalid setting configuration could cause a Rocket.Chat instance to become unstable.
Parameters
- setting: ISetting
  
  the modified setting (id must be provided)
Returns Promise<void>
- Defined in src/definition/accessors/IServerSettingsModify.ts:30

Generated using TypeDoc