matrix-js-sdk
    Preparing search index...

    Interface RoomSummary

    The summary of a room, as returned by the room summary endpoint. https://spec.matrix.org/latest/client-server-api/#get_matrixclientv1room_summaryroomidoralias

    Also covers the initial version of MSC3266 implemented in older versions of Synapse, which prefixed some of the fields. See MatrixClient.getRoomSummary.

    interface RoomSummary {
        allowed_room_ids?: string[];
        avatar_url?: string;
        canonical_alias?: string;
        encryption?: string;
        guest_can_join: boolean;
        "im.nheko.summary.encryption"?: string;
        "im.nheko.summary.room_version"?: string;
        join_rule?: JoinRule;
        membership?: string;
        name?: string;
        num_joined_members: number;
        room_id: string;
        room_type?: string;
        room_version?: string;
        topic?: string;
        world_readable: boolean;
    }

    Hierarchy

    Index
    allowed_room_ids? avatar_url? canonical_alias? encryption? guest_can_join im.nheko.summary.encryption? im.nheko.summary.room_version? join_rule? membership? name? num_joined_members room_id room_type? room_version? topic? world_readable
    allowed_room_ids?: string[]

    For restricted rooms, the room IDs which are specified by the join rule.

    avatar_url?: string
    canonical_alias?: string

    The canonical alias of the room, if any.

    encryption?: string

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

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

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

    Only returned by the unstable endpoint; use RoomSummary.encryption.

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

    Version of the room.

    Only returned by the unstable endpoint; use RoomSummary.room_version.

    join_rule?: JoinRule

    The join rule of the room. Unlike the join rule of a public rooms chunk, this may be any join rule, since the room does not have to be published to the room directory.

    membership?: string

    The current membership of this user in the room.

    name?: string
    num_joined_members: number
    room_id: string
    room_type?: string
    room_version?: string

    Version of the room.

    topic?: string
    world_readable: boolean

    Settings
    Member Visibility

    On This Page
    Properties