handleExternalInvite -> handleExternalMembership.

Protections may need access to other events, such as leaving rooms.
Gnuxie · Jan 31, 2025 · 1b1fc29 · 1b1fc29
1 parent 5379866
commit 1b1fc29
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/src/Protection/ProtectedRoomsSet.ts b/src/Protection/ProtectedRoomsSet.ts
@@ -69,7 +69,7 @@ export interface ProtectedRoomsSet {
   readonly allProtectedRooms: MatrixRoomID[];
   handleTimelineEvent(roomID: StringRoomID, event: RoomEvent): void;
   handleEventReport(report: EventReport): void;
-  handleExternalInvite(roomID: StringRoomID, event: MembershipEvent): void;
+  handleExternalMembership(roomID: StringRoomID, event: MembershipEvent): void;
   isProtectedRoom(roomID: StringRoomID): boolean;
   unregisterListeners(): void;
 }
@@ -168,15 +168,15 @@ export class StandardProtectedRoomsSet implements ProtectedRoomsSet {
       void Task(protection.handleEventReport(report));
     }
   }
-  public handleExternalInvite(
+  public handleExternalMembership(
     roomID: StringRoomID,
     event: MembershipEvent
   ): void {
     for (const protection of this.protections.allProtections) {
-      if (protection.handleExternalInvite === undefined) {
+      if (protection.handleExternalMembership === undefined) {
         continue;
       }
-      protection.handleExternalInvite(roomID, event);
+      protection.handleExternalMembership(roomID, event);
     }
   }
 

diff --git a/src/Protection/Protection.ts b/src/Protection/Protection.ts
@@ -157,11 +157,11 @@ export interface Protection<TProtectionDescription> {
   handlePermissionRequirementsMet?(room: MatrixRoomID): void;
 
   /**
-   * Handle an invitation to a room that is external to the protected rooms set.
+   * Handle an invitation, room join, kick, leave etc to a room that is external to the protected rooms set.
    * @param roomID The room the invitation is for.
    * @param event The invitation event itself.
    */
-  handleExternalInvite?(roomID: StringRoomID, event: MembershipEvent): void;
+  handleExternalMembership?(roomID: StringRoomID, event: MembershipEvent): void;
 
   /**
    * This can be used to determine who are new to the overall protected rooms