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

Methods

hideGroup

hideGroup(name: string): Promise<void>

- Defined in accessors/IServerSettingsModify.ts:14
Hides an existing settings group.

Parameters
- name: string
  
  The technical name of the group
Returns Promise<void>

hideSetting

hideSetting(id: string): Promise<void>

- Defined in accessors/IServerSettingsModify.ts:22
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>

modifySetting

modifySetting(setting: ISetting): Promise<void>

- Defined in accessors/IServerSettingsModify.ts:30
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>

Generated using TypeDoc