Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • IServerSettingRead

Index

Methods

getAll

  • getAll(): Promise<IterableIterator<ISetting>>

getOneById

  • getOneById(id: string): Promise<ISetting>

getValueById

  • getValueById(id: string): Promise<any>
  • 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>
  • 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