Paginates over the space tree in a depth-first manner to locate child rooms of a given space. More...

#include <space_hierarchy.hpp>

Public Attributes
int	numJoinedMembers
	The number of members joined to the room. More...

std::string	roomId
	The ID of the room. More...

bool	worldReadable
	Whether the room may be viewed by guest users without joining. More...

bool	guestCanJoin
	Whether guest users may join the room and participate in it. More...

immer::array< StrippedChildStateEvent >	childrenState
	The `m.space.child` events of the space-room, represented as Stripped State Events with an added `origin_server_ts` key. More...

std::optional< std::string >	canonicalAlias
	The canonical alias of the room, if any. More...

std::optional< std::string >	name
	The name of the room, if any. More...

std::optional< std::string >	topic
	The topic of the room, if any. More...

std::optional< std::string >	avatarUrl
	The URL for the room's avatar, if one is set. More...

std::optional< std::string >	joinRule
	The room's join rule. More...

std::optional< std::string >	roomType
	The `type` of room (from `m.room.create`), if any. More...

Detailed Description

Paginates over the space tree in a depth-first manner to locate child rooms of a given space.

Where a child room is unknown to the local server, federation is used to fill in the details. The servers listed in the via array should be contacted to attempt to fill in missing rooms.

Only m.space.child state events of the room are considered. Invalid child rooms and parent events are not covered by this endpoint.

Member Data Documentation

◆ avatarUrl

std::optional<std::string> Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::avatarUrl

The URL for the room's avatar, if one is set.

◆ canonicalAlias

std::optional<std::string> Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::canonicalAlias

The canonical alias of the room, if any.

◆ childrenState

immer::array<StrippedChildStateEvent> Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::childrenState

The m.space.child events of the space-room, represented as Stripped State Events with an added origin_server_ts key.

If the room is not a space-room, this should be empty.

◆ guestCanJoin

bool Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::guestCanJoin

Whether guest users may join the room and participate in it.

If they can, they will be subject to ordinary power level rules like any other user.

◆ joinRule

std::optional<std::string> Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::joinRule

The room's join rule.

When not present, the room is assumed to be public.

◆ name

std::optional<std::string> Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::name

The name of the room, if any.

◆ numJoinedMembers

int Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::numJoinedMembers

The number of members joined to the room.

◆ roomId

std::string Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::roomId

The ID of the room.

◆ roomType

std::optional<std::string> Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::roomType

The type of room (from m.room.create), if any.

◆ topic

std::optional<std::string> Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::topic

The topic of the room, if any.

◆ worldReadable

bool Kazv::Api::GetSpaceHierarchyJob::ChildRoomsChunk::worldReadable

Whether the room may be viewed by guest users without joining.

The documentation for this struct was generated from the following file:

src/api/csapi/space_hierarchy.hpp

Public Attributes