libkazv
Kazv::Api::PublicRoomsChunk Struct Reference

#include <public_rooms_response.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...
 
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...
 

Member Data Documentation

◆ avatarUrl

std::optional<std::string> Kazv::Api::PublicRoomsChunk::avatarUrl

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

◆ canonicalAlias

std::optional<std::string> Kazv::Api::PublicRoomsChunk::canonicalAlias

The canonical alias of the room, if any.

◆ guestCanJoin

bool Kazv::Api::PublicRoomsChunk::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::PublicRoomsChunk::joinRule

The room's join rule.

When not present, the room is assumed to be public. Note that rooms with invite join rules are not expected here, but rooms with knock rules are given their near-public nature.

◆ name

std::optional<std::string> Kazv::Api::PublicRoomsChunk::name

The name of the room, if any.

◆ numJoinedMembers

int Kazv::Api::PublicRoomsChunk::numJoinedMembers

The number of members joined to the room.

◆ roomId

std::string Kazv::Api::PublicRoomsChunk::roomId

The ID of the room.

◆ topic

std::optional<std::string> Kazv::Api::PublicRoomsChunk::topic

The topic of the room, if any.

◆ worldReadable

bool Kazv::Api::PublicRoomsChunk::worldReadable

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


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