matrix-appservice-bridge
    Preparing search index...

    Interface RoomUpgradeHandlerOpts

    interface RoomUpgradeHandlerOpts {
        consumeEvent: boolean;
        migrateEntry?: (
            entry: RoomBridgeStoreEntry,
            newRoomId: string,
        ) => Promise<null | RoomBridgeStoreEntry>;
        migrateGhosts: boolean;
        migrateStoreEntries: boolean;
        onRoomMigrated?: (
            oldRoomId: string,
            newRoomId: string,
        ) => void | Promise<void>;
    }
    Index

    Properties

    consumeEvent migrateEntry? migrateGhosts migrateStoreEntries onRoomMigrated?

    Properties

    consumeEvent: boolean

    Should upgrade and invite events be processed after being handled by the RoomUpgradeHandler. Defaults to false.

    migrateEntry?: (
        entry: RoomBridgeStoreEntry,
        newRoomId: string,
    ) => Promise<null | RoomBridgeStoreEntry>

    Invoked when iterating around a rooms entries. Should be used to update entries with a new room id.

    Type declaration

    migrateGhosts: boolean

    Should ghost users be migrated to the new room. This will leave any users matching the user regex list in the registration file from the old room, and join them to the new room. Defaults to true

    migrateStoreEntries: boolean

    Migrate room store entries automatically. Defaults to true

    onRoomMigrated?: (oldRoomId: string, newRoomId: string) => void | Promise<void>

    Invoked after a room has been upgraded and its entries updated.

    Type declaration

      • (oldRoomId: string, newRoomId: string): void | Promise<void>

      • Parameters

        • oldRoomId: string

          The old roomId.

        • newRoomId: string

          The new roomId.

        Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties