Class RoomLinkValidator

The RoomLinkValidator checks if a room should be linked to a remote channel, given a set of rules supplied in a config.

This ruleset can be hot-reloaded. Developers should call Bridge.updateRoomLinkValidatorRules within the CliOpts.onConfigChanged callback to reload rules on config reload.

See

  • CliOpts#onConfigChanged
  • Bridge#updateRoomLinkValidatorRules

Constructors

constructor

Accessors

rules

Methods

updateRules validateRoom

Constructors

constructor

  • new RoomLinkValidator(config, asBot): RoomLinkValidator

  • Parameters

    • config: {
          rules: Rules;
      }

      Config for the validator.

      • rules: Rules

        Rules if not using a rule file, will be overwritten if both is set.

    • asBot: AppServiceBot

      The AS bot.

    Returns RoomLinkValidator

Accessors

rules

  • get rules(): Rules

  • Returns Rules

Methods

updateRules

  • updateRules(rules): void

  • Parameters

    Returns void

validateRoom

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc