matrix-js-sdk

    Interface RoomSummary

    The summary of a room as defined by an initial version of MSC3266 and implemented in Synapse Proposed at https://github.com/matrix-org/matrix-doc/pull/3266

    interface RoomSummary {
        avatar_url?: string;
        guest_can_join: boolean;
        "im.nheko.summary.encryption"?: string;
        "im.nheko.summary.room_version"?: string;
        join_rule?: Public | Knock;
        membership?: string;
        name?: string;
        num_joined_members: number;
        room_id: string;
        room_type?: string;
        topic?: string;
        world_readable: boolean;
    }

    Hierarchy

    Index

    Properties

    avatar_url? guest_can_join im.nheko.summary.encryption? im.nheko.summary.room_version? join_rule? membership? name? num_joined_members room_id room_type? topic? world_readable

    Properties

    avatar_url?: string
    guest_can_join: boolean
    "im.nheko.summary.encryption"?: string

    The encryption algorithm used for this room, if the room is encrypted.

    "im.nheko.summary.room_version"?: string

    Version of the room.

    join_rule?: Public | Knock
    membership?: string

    The current membership of this user in the room. Usually "leave" if the room is fetched over federation.

    name?: string
    num_joined_members: number
    room_id: string
    room_type?: string
    topic?: string
    world_readable: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR