Class Room

Client-side state of one room, kept up to date by RoomStore; not thread-safe.

Inheritance
object
Room
Inherited Members
Namespace: Uniform.Matrix.Client.State
Assembly: Uniform.Matrix.Client.dll
Syntax
public sealed class Room
Remarks

A mutable class rather than a record, as identity matters and value equality over live state would be misleading.

Properties

| Edit this page View Source

AccountData

Room account data keyed by type.

Declaration
public IReadOnlyDictionary<string, MatrixEvent> AccountData { get; }
Property Value
Type Description
IReadOnlyDictionary<string, MatrixEvent>
| Edit this page View Source

AvatarUrl

Avatar mxc:// URI: the room's own from RoomAvatar, or the other person's in a direct chat; null when none.

Declaration
public string? AvatarUrl { get; }
Property Value
Type Description
string
| Edit this page View Source

CanonicalAlias

Main alias from RoomCanonicalAlias.

Declaration
public string? CanonicalAlias { get; }
Property Value
Type Description
string
| Edit this page View Source

Creators

Creators with unlimited power, from room version 12: the create event's sender and its additional creators; empty in older rooms.

Declaration
public IReadOnlyCollection<string> Creators { get; }
Property Value
Type Description
IReadOnlyCollection<string>
| Edit this page View Source

DirectUserId

Other user of a direct-message room per Direct; null for other rooms.

Declaration
public string? DirectUserId { get; }
Property Value
Type Description
string
| Edit this page View Source

DisplayName

Name to show for the room, computed per spec: name, alias, then member names.

Declaration
public string DisplayName { get; }
Property Value
Type Description
string
| Edit this page View Source

FullyReadEventId

Event up to which the user has read everything, from FullyRead.

Declaration
public string? FullyReadEventId { get; }
Property Value
Type Description
string
| Edit this page View Source

HasMoreHistory

Whether older history may exist beyond Timeline.

Declaration
public bool HasMoreHistory { get; }
Property Value
Type Description
bool
| Edit this page View Source

Heroes

Heroes from the latest RoomSummary.

Declaration
public IReadOnlyList<string>? Heroes { get; }
Property Value
Type Description
IReadOnlyList<string>
| Edit this page View Source

HighlightCount

Unread highlights such as mentions per server.

Declaration
public int HighlightCount { get; }
Property Value
Type Description
int
| Edit this page View Source

HistoryToken

Token for loading events older than Timeline; null when not known yet or history is exhausted.

Declaration
public string? HistoryToken { get; }
Property Value
Type Description
string
| Edit this page View Source

InvitedMemberCount

Invited members per summary, or counted from known members.

Declaration
public int InvitedMemberCount { get; }
Property Value
Type Description
int
| Edit this page View Source

InviterUserId

Users who invited us, i.e. sender of our invite; null unless invited.

Declaration
public string? InviterUserId { get; }
Property Value
Type Description
string
| Edit this page View Source

IsDirect

Whether this is a direct-message room, including direct invites.

Declaration
public bool IsDirect { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsEncrypted

Whether the room is end-to-end encrypted; such messages arrive as RoomEncrypted.

Declaration
public bool IsEncrypted { get; }
Property Value
Type Description
bool
| Edit this page View Source

JoinedMemberCount

Joined members per summary, or counted from known members.

Declaration
public int JoinedMemberCount { get; }
Property Value
Type Description
int
| Edit this page View Source

Members

Known members keyed by user ID; partial when the server lazy-loads members, see LoadMembersAsync(MatrixClient, Room, CancellationToken).

Declaration
public IReadOnlyDictionary<string, RoomMemberInfo> Members { get; }
Property Value
Type Description
IReadOnlyDictionary<string, RoomMemberInfo>
| Edit this page View Source

Membership

Own membership, see Memberships.

Declaration
public string Membership { get; }
Property Value
Type Description
string
| Edit this page View Source

Name

Name from RoomName; null when unset.

Declaration
public string? Name { get; }
Property Value
Type Description
string
| Edit this page View Source

NotificationCount

Unread notifying messages per server.

Declaration
public int NotificationCount { get; }
Property Value
Type Description
int
| Edit this page View Source

PowerLevels

Power levels from RoomPowerLevels; null when the room has none.

Declaration
public PowerLevelsContent? PowerLevels { get; }
Property Value
Type Description
PowerLevelsContent
| Edit this page View Source

ReadReceipts

Latest read receipt event ID per user.

Declaration
public IReadOnlyDictionary<string, string> ReadReceipts { get; }
Property Value
Type Description
IReadOnlyDictionary<string, string>
| Edit this page View Source

RoomId

Room ID.

Declaration
public string RoomId { get; }
Property Value
Type Description
string
| Edit this page View Source

Tags

Tags from Tag, see RoomTags.

Declaration
public IReadOnlyDictionary<string, TagInfo> Tags { get; }
Property Value
Type Description
IReadOnlyDictionary<string, TagInfo>
| Edit this page View Source

Timeline

Recent events in chronological order, at most MaxTimelineLength plus backfilled ones.

Declaration
public IReadOnlyList<ClientEvent> Timeline { get; }
Property Value
Type Description
IReadOnlyList<ClientEvent>
| Edit this page View Source

Topic

Topic from RoomTopic.

Declaration
public string? Topic { get; }
Property Value
Type Description
string
| Edit this page View Source

TypingUserIds

Users currently typing.

Declaration
public IReadOnlyList<string> TypingUserIds { get; }
Property Value
Type Description
IReadOnlyList<string>

Methods

| Edit this page View Source

GetAccountDataContent<T>(string)

Return the content of room account data as T, or null.

Declaration
public T? GetAccountDataContent<T>(string type) where T : class
Parameters
Type Name Description
string type
Returns
Type Description
T
Type Parameters
Name Description
T
| Edit this page View Source

GetMemberDisplayName(string)

Name to show for userId per spec: display name, with the user ID appended when another member shares it.

Declaration
public string GetMemberDisplayName(string userId)
Parameters
Type Name Description
string userId
Returns
Type Description
string
| Edit this page View Source

GetPowerLevel(string)

Return the power level of userId: Creator for Creators; without power levels, 100 for the room's creator and 0 for others.

Declaration
public long GetPowerLevel(string userId)
Parameters
Type Name Description
string userId
Returns
Type Description
long
| Edit this page View Source

GetState(string, string)

Return the current state event of type and stateKey, or null.

Declaration
public MatrixEvent? GetState(string type, string stateKey = "")
Parameters
Type Name Description
string type
string stateKey
Returns
Type Description
MatrixEvent
| Edit this page View Source

GetStateContent<T>(string, string)

Return the content of a state event as T, or null when unset or malformed.

Declaration
public T? GetStateContent<T>(string type, string stateKey = "") where T : class
Parameters
Type Name Description
string type
string stateKey
Returns
Type Description
T
Type Parameters
Name Description
T
| Edit this page View Source

GetStates(string)

Return current state events of type keyed by state key.

Declaration
public IReadOnlyDictionary<string, MatrixEvent> GetStates(string type)
Parameters
Type Name Description
string type
Returns
Type Description
IReadOnlyDictionary<string, MatrixEvent>
| Edit this page View Source

TryGetEvent(string, out ClientEvent?)

Return a timeline event by ID.

Declaration
public bool TryGetEvent(string eventId, out ClientEvent? clientEvent)
Parameters
Type Name Description
string eventId
ClientEvent clientEvent
Returns
Type Description
bool