Class RoomService

Rooms of local users: creation, membership, messages and state, redaction, and what a user may read.

Inheritance
object
RoomService
Inherited Members
Namespace: Uniform.Matrix.Server.Rooms
Assembly: Uniform.Matrix.Server.dll
Syntax
public sealed class RoomService

Constructors

| Edit this page View Source

RoomService(IDbContextFactory<ServerDbContext>, EventSender, IOptions<ServerOptions>, TimeProvider, RemoteJoins, RemoteInvites, ILogger<RoomService>)

Create the service.

Declaration
public RoomService(IDbContextFactory<ServerDbContext> contexts, EventSender sender, IOptions<ServerOptions> options, TimeProvider time, RemoteJoins remoteJoins, RemoteInvites remoteInvites, ILogger<RoomService> logger)
Parameters
Type Name Description
IDbContextFactory<ServerDbContext> contexts
EventSender sender
IOptions<ServerOptions> options
TimeProvider time
RemoteJoins remoteJoins
RemoteInvites remoteInvites
ILogger<RoomService> logger

Methods

| Edit this page View Source

CanSendStateAsync(string, string, string, CancellationToken)

Return whether a joined user's power level allows sending state of type.

Declaration
public Task<bool> CanSendStateAsync(string userId, string roomId, string type, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string roomId
string type
CancellationToken cancellationToken
Returns
Type Description
Task<bool>
| Edit this page View Source

CreateRoomAsync(Requester, JsonObject, CancellationToken)

Create a room following createRoom; return its ID.

Declaration
public Task<string> CreateRoomAsync(Requester requester, JsonObject body, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
JsonObject body
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

ForgetAsync(string, string, CancellationToken)

Forget a room the user has left, so it disappears from their sync.

Declaration
public Task ForgetAsync(string userId, string roomId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string roomId
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

GetEventAsync(Requester, string, string, CancellationToken)

Return an event a user may see: anything up to their leaving, while they were or are a member.

Declaration
public Task<JsonObject> GetEventAsync(Requester requester, string roomId, string eventId, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
string eventId
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

GetJoinedMembersAsync(Requester, string, CancellationToken)

Return the joined members with display names and avatars; only for members.

Declaration
public Task<JsonObject> GetJoinedMembersAsync(Requester requester, string roomId, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

GetJoinedRoomsAsync(string, CancellationToken)

Return the rooms a user is joined to.

Declaration
public Task<IReadOnlyList<string>> GetJoinedRoomsAsync(string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<string>>
| Edit this page View Source

GetMembershipAsync(string, string, CancellationToken)

Return a user's current membership in a room, or null.

Declaration
public Task<string?> GetMembershipAsync(string roomId, string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string roomId
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

GetStateAsync(Requester, string, CancellationToken)

Return the state a user may see: the current state while joined, otherwise the state when they left; throw M_FORBIDDEN for others.

Declaration
public Task<IReadOnlyList<JsonObject>> GetStateAsync(Requester requester, string roomId, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<JsonObject>>
| Edit this page View Source

GetStateContentAsync(Requester, string, string, string, CancellationToken)

Return the content of one state event a user may see; throw M_NOT_FOUND when unset.

Declaration
public Task<JsonObject> GetStateContentAsync(Requester requester, string roomId, string type, string stateKey, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
string type
string stateKey
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

InviteAsync(string, string, string, string?, bool, CancellationToken)

Invite a user: local users directly, other servers' users through their server, which signs the invite too.

Declaration
public Task InviteAsync(string userId, string roomId, string target, string? reason, bool isDirect, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string roomId
string target
string reason
bool isDirect
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

JoinAsync(string, string, string?, CancellationToken, IReadOnlyList<string>?)

Join a room by ID or alias; already joined users stay joined. Aliases of other servers are asked from them. A room ID that is not here yet is joined through the server that invited the user, via servers and the server in the room ID, in that order. Returns the room ID.

Declaration
public Task<string> JoinAsync(string userId, string roomIdOrAlias, string? reason, CancellationToken cancellationToken, IReadOnlyList<string>? via = null)
Parameters
Type Name Description
string userId
string roomIdOrAlias
string reason
CancellationToken cancellationToken
IReadOnlyList<string> via
Returns
Type Description
Task<string>
| Edit this page View Source

LeaveAsync(string, string, string?, CancellationToken)

Leave a room; leaving a room one is not in does nothing.

Declaration
public Task LeaveAsync(string userId, string roomId, string? reason, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string roomId
string reason
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

RedactAsync(Requester, string, string, string?, string, CancellationToken)

Redact an event of the room: one's own, or anyone's with the redact level. Returns the redaction's ID.

Declaration
public Task<string> RedactAsync(Requester requester, string roomId, string eventId, string? reason, string transactionId, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
string eventId
string reason
string transactionId
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

ResolveAsync(string, CancellationToken)

Return the room ID of a room ID or local alias of a room here; throw M_NOT_FOUND for unknown rooms.

Declaration
public Task<string> ResolveAsync(string roomIdOrAlias, CancellationToken cancellationToken)
Parameters
Type Name Description
string roomIdOrAlias
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

SendMessageAsync(Requester, string, string, JsonObject, string, CancellationToken)

Send a message event; return its ID, the same for a retried transaction.

Declaration
public Task<string> SendMessageAsync(Requester requester, string roomId, string type, JsonObject content, string transactionId, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
string type
JsonObject content
string transactionId
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

SetMembershipAsync(string, string, string, string, string?, CancellationToken)

Change another user's membership: kick (leave), ban or unban (leave of a banned user).

Declaration
public Task SetMembershipAsync(string userId, string roomId, string target, string membership, string? reason, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string roomId
string target
string membership
string reason
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SetStateAsync(Requester, string, string, string, JsonObject, CancellationToken)

Set room state; return the event ID.

Declaration
public Task<string> SetStateAsync(Requester requester, string roomId, string type, string stateKey, JsonObject content, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
string type
string stateKey
JsonObject content
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

UpdateMemberProfilesAsync(string, CancellationToken)

Update the user's member event in every joined room to their current profile.

Declaration
public Task UpdateMemberProfilesAsync(string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task