RoomSummary

Defined in: src/client.ts:870

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

Extends

• Omit<IPublicRoomsChunkRoom, "canonical_alias" | "aliases">

Properties

avatar_url?

optional avatar_url?: string

Defined in: src/client.ts:754

Inherited from

IPublicRoomsChunkRoom.avatar_url

---

guest_can_join

guest_can_join: boolean

Defined in: src/client.ts:759

Inherited from

IPublicRoomsChunkRoom.guest_can_join

---

im.nheko.summary.encryption?

optional im.nheko.summary.encryption?: string

Defined in: src/client.ts:883

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

---

im.nheko.summary.room_version?

optional im.nheko.summary.room_version?: string

Defined in: src/client.ts:879

Version of the room.

---

join_rule?

optional join_rule?: Public | Knock

Defined in: src/client.ts:762

Inherited from

IPublicRoomsChunkRoom.join_rule

---

membership?

optional membership?: string

Defined in: src/client.ts:875

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

---

name?

optional name?: string

Defined in: src/client.ts:753

Inherited from

IPublicRoomsChunkRoom.name

---

num_joined_members

num_joined_members: number

Defined in: src/client.ts:760

Inherited from

IPublicRoomsChunkRoom.num_joined_members

---

room_id

room_id: string

Defined in: src/client.ts:752

Inherited from

IPublicRoomsChunkRoom.room_id

---

room_type?

optional room_type?: string

Defined in: src/client.ts:761

Inherited from

IPublicRoomsChunkRoom.room_type

---

topic?

optional topic?: string

Defined in: src/client.ts:755

Inherited from

IPublicRoomsChunkRoom.topic

---

world_readable

world_readable: boolean

Defined in: src/client.ts:758

Inherited from

IPublicRoomsChunkRoom.world_readable