Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RoomUpgradeHandlerOpts

Hierarchy

  • RoomUpgradeHandlerOpts

Index

Properties

consumeEvent

consumeEvent: boolean

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

migrateGhosts

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

migrateStoreEntries: boolean

Migrate room store entries automatically. Defaults to true

Methods

Optional migrateEntry

Optional onRoomMigrated

  • onRoomMigrated(oldRoomId: string, newRoomId: string): void | Promise<void>
  • Invoked after a room has been upgraded and its entries updated.

    Parameters

    • oldRoomId: string

      The old roomId.

    • newRoomId: string

      The new roomId.

    Returns void | Promise<void>

Generated using TypeDoc