Package io.github.ma1uta.matrix.client.model.sync

Class RoomSummary

java.lang.Object

io.github.ma1uta.matrix.client.model.sync.RoomSummary

public class RoomSummary
extends Object

Room summary.

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	heroes	The users which can be used to generate a room name if the room does not have one.
private Long	invitedMemberCount	The number of users with membership of invite.
private Long	joinedMemberCount	The number of users with membership of join, including the client's own user ID.

Constructor Summary

Constructors

Constructor	Description
RoomSummary()

Method Summary

Modifier and Type	Method	Description
List<String>	getHeroes()
Long	getInvitedMemberCount()
Long	getJoinedMemberCount()
void	setHeroes(List<String> heroes)
void	setInvitedMemberCount(Long invitedMemberCount)
void	setJoinedMemberCount(Long joinedMemberCount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

heroes

private List<String> heroes

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.

joinedMemberCount

private Long joinedMemberCount

The number of users with membership of join, including the client's own user ID. If this field has not changed since the last sync, it may be omitted. Required otherwise.

invitedMemberCount

private Long invitedMemberCount

The number of users with membership of invite. If this field has not changed since the last sync, it may be omitted. Required otherwise.

Constructor Detail

RoomSummary

public RoomSummary()

Method Detail

getHeroes

public List<String> getHeroes()

setHeroes

public void setHeroes(List<String> heroes)

getJoinedMemberCount

public Long getJoinedMemberCount()

setJoinedMemberCount

public void setJoinedMemberCount(Long joinedMemberCount)

getInvitedMemberCount

public Long getInvitedMemberCount()

setInvitedMemberCount

public void setInvitedMemberCount(Long invitedMemberCount)