Interface IServerSettingRead

Reader for the settings inside of the server (Rocket.Chat). Only a subset of them are exposed to Apps.

Hierarchy

IServerSettingRead

Index

Methods

Methods

getAll

getAll(): Promise<IterableIterator<ISetting>>

- Defined in accessors/IServerSettingRead.ts:34
Gets all of the server settings which are exposed to the Apps.

Returns Promise<IterableIterator<ISetting>>

an iterator of the exposed settings

getOneById

getOneById(id: string): Promise<ISetting>

- Defined in accessors/IServerSettingRead.ts:16
Gets a server setting by id. Please note: a error will be thrown if not found or trying to access one that isn't exposed.

Parameters
- id: string
  
  the id of the setting to get
Returns Promise<ISetting>

the setting

getValueById

getValueById(id: string): Promise<any>

- Defined in accessors/IServerSettingRead.ts:26
Gets a server setting's value by id. Please note: a error will be thrown if not found or trying to access one that isn't exposed.

Parameters
- id: string
  
  the id of the setting to get
Returns Promise<any>

the setting's value

isReadableById

isReadableById(id: string): Promise<boolean>

- Defined in accessors/IServerSettingRead.ts:42
Checks if the server setting for the id provided is readable, will return true or false and won't throw an error.

Parameters
- id: string
  
  the server setting id
Returns Promise<boolean>

Generated using TypeDoc