Class RoomUpgradeHandler

Handles migration of rooms when a room upgrade is performed.

Hierarchy

RoomUpgradeHandler

Index

Constructors

constructor

Methods

Constructors

constructor

new RoomUpgradeHandler(opts: RoomUpgradeHandlerOpts, bridge: Bridge): RoomUpgradeHandler

- Defined in src/components/room-upgrade-handler.ts:70
Parameters
- opts: RoomUpgradeHandlerOpts
- bridge: Bridge
  
  The parent bridge.
Returns RoomUpgradeHandler

Methods

onInvite

onInvite(ev: { room_id: string }): Promise<boolean>

- Defined in src/components/room-upgrade-handler.ts:128
Called when an invite event reaches the bridge. This function will check if the invite is from an upgraded room, and will join the room if so.

Parameters
- ev: { room_id: string }
  
  A Matrix m.room.member event of membership=invite directed to the bridge bot
  - room_id: string
Returns Promise<boolean>
True if the invite is from an upgraded room and shouldn't be processed.

onTombstone

onTombstone(ev: { content: { replacement_room: string }; room_id: string; sender: string }): Promise<boolean>

- Defined in src/components/room-upgrade-handler.ts:84
Called when the bridge sees a "m.room.tombstone" event.

Parameters
- ev: { content: { replacement_room: string }; room_id: string; sender: string }
  
  The m.room.tombstone event.
  - content: { replacement_room: string }
    - replacement_room: string
  - room_id: string
  - sender: string
Returns Promise<boolean>

Generated using TypeDoc