Class RoomStore

Client-side state of all rooms, built by applying sync responses; not thread-safe.

Inheritance
object
RoomStore
Inherited Members
Namespace: Uniform.Matrix.Client.State
Assembly: Uniform.Matrix.Client.dll
Syntax
public sealed class RoomStore
Examples
RoomStore store = new(client.UserId!);
await foreach (SyncResponse sync in client.SyncLoopAsync(ct: ct))
{
    SyncChanges changes = store.Apply(sync);
    foreach (TimelineBatch batch in changes.Timeline)
        foreach (ClientEvent ev in batch.Events)
            if (ev.TryGetContent(out MessageContent? message)) Console.WriteLine($"[{batch.Room.DisplayName}] {batch.Room.GetMemberDisplayName(ev.Sender)}: {message.Body}");
}

Constructors

| Edit this page View Source

RoomStore(string)

Create an empty store for the logged-in ownUserId.

Declaration
public RoomStore(string ownUserId)
Parameters
Type Name Description
string ownUserId

Properties

| Edit this page View Source

AccountData

Global account data keyed by type.

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

IgnoredUsers

Ignored user IDs from IgnoredUserList.

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

MaxTimelineLength

Most events kept per room by sync; backfilled events come on top.

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

NextBatch

NextBatch of the last applied sync; stores it to resume syncing.

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

OwnUserId

Logged-in user, excluded from computed room names.

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

Presence

Latest presence keyed by user ID.

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

Rooms

Known rooms of every membership keyed by room ID.

Declaration
public IReadOnlyDictionary<string, Room> Rooms { get; }
Property Value
Type Description
IReadOnlyDictionary<string, Room>

Methods

| Edit this page View Source

Apply(SyncResponse)

Apply sync and return what changed.

Declaration
public SyncChanges Apply(SyncResponse sync)
Parameters
Type Name Description
SyncResponse sync
Returns
Type Description
SyncChanges
| Edit this page View Source

ApplyHistory(Room, MessagesResponse)

Prepend a backward page fetched from HistoryToken; return its events oldest first.

Declaration
public IReadOnlyList<ClientEvent> ApplyHistory(Room room, MessagesResponse page)
Parameters
Type Name Description
Room room
MessagesResponse page
Returns
Type Description
IReadOnlyList<ClientEvent>
| Edit this page View Source

ApplyMembers(Room, IReadOnlyList<ClientEvent>)

Apply current member events, e.g. from GetMembersAsync(string, string?, CancellationToken).

Declaration
public void ApplyMembers(Room room, IReadOnlyList<ClientEvent> memberEvents)
Parameters
Type Name Description
Room room
IReadOnlyList<ClientEvent> memberEvents
| Edit this page View Source

BackfillAsync(MatrixClient, Room, int, CancellationToken)

Load up to limit events older than Timeline and prepend them; return them oldest first.

Declaration
public Task<IReadOnlyList<ClientEvent>> BackfillAsync(MatrixClient client, Room room, int limit = 50, CancellationToken cancellationToken = default)
Parameters
Type Name Description
MatrixClient client
Room room
int limit
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<ClientEvent>>
Remarks

Fetches and applies in one call; when other threads apply syncs, fetch with GetMessagesAsync(string, string?, Direction, int?, string?, string?, CancellationToken) and apply with ApplyHistory(Room, MessagesResponse) under their lock instead.

| Edit this page View Source

CanBackfill(Room)

Whether room has a token for older history; clears HasMoreHistory when it never will.

Declaration
public static bool CanBackfill(Room room)
Parameters
Type Name Description
Room room
Returns
Type Description
bool
| Edit this page View Source

LoadMembersAsync(MatrixClient, Room, CancellationToken)

Load the full member list, which sync omits when lazy-loading members.

Declaration
public Task LoadMembersAsync(MatrixClient client, Room room, CancellationToken cancellationToken = default)
Parameters
Type Name Description
MatrixClient client
Room room
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SetIgnoredUsers(IEnumerable<string>)

Replace IgnoredUsers at once, e.g. right after changing the list on the server, before the sync brings it.

Declaration
public void SetIgnoredUsers(IEnumerable<string> userIds)
Parameters
Type Name Description
IEnumerable<string> userIds
| Edit this page View Source

TryGetRoom(string, out Room?)

Return a known room by ID.

Declaration
public bool TryGetRoom(string roomId, out Room? room)
Parameters
Type Name Description
string roomId
Room room
Returns
Type Description
bool