Information about the room which clients may need to correctly render it to users. More...

#include <sync.hpp>

Public Attributes
immer::array< std::string >	mHeroes
	The users which can be used to generate a room name if the room does not have one. More...

std::optional< int >	mJoinedMemberCount
	The number of users with `membership` of `join`, including the client's own user ID. More...

std::optional< int >	mInvitedMemberCount
	The number of users with `membership` of `invite`. More...

Detailed Description

Information about the room which clients may need to correctly render it to users.

Member Data Documentation

◆ mHeroes

immer::array<std::string> Kazv::Api::SyncJob::RoomSummary::mHeroes

The users which can be used to generate a room name if the room does not have one.

Required if the room's m.room.name or m.room.canonical_alias state events are unset or empty.

This should be the first 5 members of the room, ordered by stream ordering, which are joined or invited. The list must never include the client's own user ID. When no joined or invited members are available, this should consist of the banned and left users. More than 5 members may be provided, however less than 5 should only be provided when there are less than 5 members to represent.

When lazy-loading room members is enabled, the membership events for the heroes MUST be included in the state, unless they are redundant. When the list of users changes, the server notifies the client by sending a fresh list of heroes. If there are no changes since the last sync, this field may be omitted.

◆ mInvitedMemberCount

std::optional<int> Kazv::Api::SyncJob::RoomSummary::mInvitedMemberCount

The number of users with membership of invite.

If this field has not changed since the last sync, it may be omitted. Required otherwise.

◆ mJoinedMemberCount

std::optional<int> Kazv::Api::SyncJob::RoomSummary::mJoinedMemberCount

The number of users with membership of join, including the client's own user ID.