Prefer using the canonical alias in spotlight search (#9055)

* Prefer using the canonical alias in spotlight search

Public rooms on other homeservers are not joinable via the roomId if they haven't been joined by other users on your homeserver.

* Ensure we call the action with the room_alias

* lint

* Drop display

* Always provide roomId

* Add rationale to room_id, room_alias

* whoops

Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>

src/dispatcher/payloads/ViewRoomPayload.ts

@@ -26,7 +26,9 @@ import { IOpts } from "../../createRoom";
 export interface ViewRoomPayload extends Pick<ActionPayload, "action"> {
     action: Action.ViewRoom;
 
-    // either of room_id or room_alias must be specified
+    // either or both of room_id or room_alias must be specified
+    // where possible, a room_id should be provided with a room_alias as it reduces
+    // the number of API calls required.
     room_id?: string;
     room_alias?: string;