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

Hierarchy

RoomLinkValidator

Index

Constructors

constructor

new RoomLinkValidator(config: {
rules: Rules;
}, asBot: AppServiceBot): 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
- Defined in src/components/room-link-validator.ts:56

Accessors

rules

get rules(): Rules
Returns Rules
- Defined in src/components/room-link-validator.ts:44

Methods

updateRules

updateRules(rules: Rules): void
Parameters
- rules: Rules
Returns void
- Defined in src/components/room-link-validator.ts:63

validateRoom

validateRoom(roomId: string, cache?: boolean): Promise<RoomLinkValidatorStatus>
Parameters
- roomId: string
- cache: boolean = true
Returns Promise<RoomLinkValidatorStatus>
- Defined in src/components/room-link-validator.ts:98

Class RoomLinkValidator

See

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

config: {
rules: Rules;
}

rules: Rules

asBot: AppServiceBot

Returns RoomLinkValidator

Accessors

rules

Returns Rules

Methods

updateRules

Parameters

rules: Rules

Returns void

validateRoom

Parameters

roomId: string

cache: boolean = true

Returns Promise<RoomLinkValidatorStatus>

Settings

Member Visibility

Theme

Class RoomLinkValidator

See

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

config: { rules: Rules; }

rules: Rules

asBot: AppServiceBot

Returns RoomLinkValidator

Accessors

rules

Returns Rules

Methods

updateRules

Parameters

rules: Rules

Returns void

validateRoom

Parameters

roomId: string

cache: boolean = true

Returns Promise<RoomLinkValidatorStatus>

Settings

Member Visibility

Theme

config: {
rules: Rules;
}