Class RoomUpgradeHandler

Handles migration of rooms when a room upgrade is performed.

Index

Constructors

Methods

onInvite onTombstone

Constructors

constructor

new RoomUpgradeHandler(
opts: RoomUpgradeHandlerOpts,
bridge: Bridge,
): RoomUpgradeHandler
Parameters
- opts: RoomUpgradeHandlerOpts
- bridge: Bridge
  The parent bridge.
Returns RoomUpgradeHandler
- Defined in src/components/room-upgrade-handler.ts:71

Methods

onInvite

onInvite(ev: { room_id: string }): Promise<boolean>
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
Returns Promise<boolean>
True if the invite is from an upgraded room and shouldn't be processed.
- Defined in src/components/room-upgrade-handler.ts:129

onTombstone

onTombstone(
    ev: {
        content: { replacement_room: string };
        room_id: string;
        sender: string;
    },
): Promise<boolean>
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.
Returns Promise<boolean>
- Defined in src/components/room-upgrade-handler.ts:85