Child struct
#include <include/mtx/events/spaces.hpp>
Event to point at a child room or space from a parent space.
The admins of a space can advertise rooms and subspaces for their space by setting m.space.child state events. The state_key is the ID of a child room or space, and the content must contain a via key which gives a list of candidate servers that can be used to join the room.
Public variables
- std::optional<std::vector<std::string>> via
- Servers to join the child room/space via.
- std::optional<std::string> order
- A string which is used to provide a default ordering of siblings in the room list.
- bool suggested
- Optional (default false) flag to denote whether the child is “suggested” or of interest to members of the space. This is primarily intended as a rendering hint for clients to display the room differently, such as eagerly rendering them in the room list.
Variable documentation
std::optional<std::vector<std::string>> mtx::
Servers to join the child room/space via.
Needs to contain at least one server.
std::optional<std::string> mtx::
A string which is used to provide a default ordering of siblings in the room list.
Rooms are sorted based on a lexicographic ordering of the Unicode codepoints of the characters in order values. Rooms with no order come last, in ascending numeric order of the origin_server_ts of their m.room.create events, or ascending lexicographic order of their room_ids in case of equal origin_server_ts. orders which are not strings, or do not consist solely of ascii characters in the range \x20 (space) to \x7E (~), or consist of more than 50 characters, are forbidden and the field should be ignored if received.