summaryrefslogtreecommitdiff
path: root/includes/external/matrix/node_modules/matrix-js-sdk/lib/models/room-summary.d.ts
blob: 32f2df458551ea2834c03a2e06253ce9a0256416 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
export interface IRoomSummary {
    "m.heroes": string[];
    "m.joined_member_count"?: number;
    "m.invited_member_count"?: number;
}
interface IInfo {
    /** The title of the room (e.g. `m.room.name`) */
    title: string;
    /** The description of the room (e.g. `m.room.topic`) */
    desc?: string;
    /** The number of joined users. */
    numMembers?: number;
    /** The list of aliases for this room. */
    aliases?: string[];
    /** The timestamp for this room. */
    timestamp?: number;
}
/**
 * Construct a new Room Summary. A summary can be used for display on a recent
 * list, without having to load the entire room list into memory.
 * @param roomId - Required. The ID of this room.
 * @param info - Optional. The summary info. Additional keys are supported.
 */
export declare class RoomSummary {
    readonly roomId: string;
    constructor(roomId: string, info?: IInfo);
}
export {};
//# sourceMappingURL=room-summary.d.ts.map