Michael Telatynski
37 lines
863 B
TypeScript
37 lines
863 B
TypeScript
/*
|
|
Copyright 2025 New Vector Ltd.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import type { Room } from "../models/Room";
|
|
import { type Watchable } from "./watchable";
|
|
|
|
/**
|
|
* Provides some basic functionality of the Room List Store from element-web.
|
|
* @public
|
|
*/
|
|
export interface RoomListStoreApi {
|
|
/**
|
|
* Returns a watchable holding a flat list of sorted room.
|
|
*/
|
|
getRooms(): Watchable<Room[]>;
|
|
|
|
/**
|
|
* Returns a promise that resolves when RLS is ready.
|
|
*/
|
|
waitForReady(): Promise<void>;
|
|
}
|
|
|
|
/**
|
|
* Provides access to certain stores from element-web.
|
|
* @public
|
|
*/
|
|
export interface StoresApi {
|
|
/**
|
|
* Use this to access limited functionality of the RLS from element-web.
|
|
*/
|
|
roomListStore: RoomListStoreApi;
|
|
}
|