@rocket.chat/apps-engine/definition/accessors/IServerSettingRead.d.ts

The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.

import type { ISetting } from '../settings/ISetting';
/**
 * Reader for the settings inside of the server (Rocket.Chat).
 * Only a subset of them are exposed to Apps.
 */
export interface IServerSettingRead {
    /**
     * 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.
     *
     * @param id the id of the setting to get
     * @return the setting
     */
    getOneById(id: string): Promise<ISetting>;
    /**
     * 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.
     *
     * @param id the id of the setting to get
     * @return the setting's value
     */
    getValueById(id: string): Promise<any>;
    /**
     * Gets all of the server settings which are exposed
     * to the Apps.
     *
     * @return an iterator of the exposed settings
     */
    getAll(): Promise<IterableIterator<ISetting>>;
    /**
     * Checks if the server setting for the id provided is readable,
     * will return true or false and won't throw an error.
     *
     * @param id the server setting id
     */
    isReadableById(id: string): Promise<boolean>;
}