mirror of
https://github.com/vector-im/element-web.git
synced 2025-12-27 04:01:10 +01:00
4a381c2a10
* Update all non-major dependencies * Delint Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Prettier Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
70 lines
2.7 KiB
TypeScript
70 lines
2.7 KiB
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
Copyright 2017 Travis Ralston
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import { type SettingLevel } from "../SettingLevel";
|
|
|
|
/**
|
|
* Represents a controller for individual settings to alter the reading behaviour
|
|
* based upon environmental conditions, or to react to changes and therefore update
|
|
* the working environment.
|
|
*
|
|
* This is not intended to replace the functionality of a SettingsHandler, it is only
|
|
* intended to handle environmental factors for specific settings.
|
|
*/
|
|
export default abstract class SettingController {
|
|
/**
|
|
* Gets the overridden value for the setting, if any. This must return null if the
|
|
* value is not to be overridden, otherwise it must return the new value.
|
|
* @param {string} level The level at which the value was requested at.
|
|
* @param {String} roomId The room ID, may be null.
|
|
* @param {*} calculatedValue The value that the handlers think the setting should be,
|
|
* may be null.
|
|
* @param {SettingLevel} calculatedAtLevel The level for which the calculated value was
|
|
* calculated at. May be null.
|
|
* @return {*} The value that should be used, or null if no override is applicable.
|
|
*/
|
|
public getValueOverride(
|
|
level: SettingLevel,
|
|
roomId: string | null,
|
|
calculatedValue: any,
|
|
calculatedAtLevel: SettingLevel | null,
|
|
): any {
|
|
return null; // no override
|
|
}
|
|
|
|
/**
|
|
* Called before the setting value has been changed, can abort the change.
|
|
* @param {string} level The level at which the setting has been modified.
|
|
* @param {String} roomId The room ID, may be null.
|
|
* @param {*} newValue The new value for the setting, may be null.
|
|
* @return {boolean} Whether the settings change should be accepted.
|
|
*/
|
|
public async beforeChange(level: SettingLevel, roomId: string | null, newValue: any): Promise<boolean> {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Called when the setting value has been changed.
|
|
* @param {string} level The level at which the setting has been modified.
|
|
* @param {String} roomId The room ID, may be null.
|
|
* @param {*} newValue The new value for the setting, may be null.
|
|
*/
|
|
public onChange(level: SettingLevel, roomId: string | null, newValue: any): void {
|
|
// do nothing by default
|
|
}
|
|
|
|
/**
|
|
* Gets whether the setting has been disabled due to this controller.
|
|
* Can also return a string with the reason the setting is disabled.
|
|
*/
|
|
public get settingDisabled(): boolean | string {
|
|
return false;
|
|
}
|
|
}
|