Class AdminService

Server administration: accounts, passwords, admin rights and the room directory for the dashboard, and the same with suspension, locks, rooms and media for the remote admin API.

Inheritance
object
AdminService
Inherited Members
Namespace: Uniform.Matrix.Server.Accounts
Assembly: Uniform.Matrix.Server.dll
Syntax
public sealed class AdminService
Remarks

Each change is logged at Information level, so the session log shows what the admin did; passwords are never logged.

  • AdminService.cs: accounts, admin rights and the room directory.
  • AdminService.Remote.cs: whois, suspension, locks, account details, room shutdown and media, for the remote admin API.

Constructors

| Edit this page View Source

AdminService(IDbContextFactory<ServerDbContext>, AccountService, AccountDeactivation, RoomService, MediaService, ILogger<AdminService>)

Create the service.

Declaration
public AdminService(IDbContextFactory<ServerDbContext> contexts, AccountService accounts, AccountDeactivation deactivation, RoomService rooms, MediaService media, ILogger<AdminService> logger)
Parameters
Type Name Description
IDbContextFactory<ServerDbContext> contexts
AccountService accounts
AccountDeactivation deactivation
RoomService rooms
MediaService media
ILogger<AdminService> logger

Methods

| Edit this page View Source

CreateOrUpdateUserAsync(string, AdminUserChange, CancellationToken)

Create the account when it does not exist, with Password, then apply the rest of change; return whether it was created.

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

CreateUserAsync(string, string, bool, CancellationToken)

Create an account that logs in with password; return its user ID.

Declaration
public Task<string> CreateUserAsync(string localpart, string password, bool admin, CancellationToken cancellationToken)
Parameters
Type Name Description
string localpart
string password
bool admin
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

DeactivateAsync(string, CancellationToken)

Deactivate an account the way its owner would: leave its rooms, clear its profile and end its sessions.

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

DeleteMediaAsync(string, string, CancellationToken)

Delete local media; throw M_NOT_FOUND for media of other servers and unknown media.

Declaration
public Task DeleteMediaAsync(string serverName, string mediaId, CancellationToken cancellationToken)
Parameters
Type Name Description
string serverName
string mediaId
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

GetRoomMembersAsync(string, CancellationToken)

Return the local users joined to a room; throw M_NOT_FOUND for unknown rooms.

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

GetRoomsAsync(CancellationToken)

Return every room, most members first.

Declaration
public Task<IReadOnlyList<AdminRoom>> GetRoomsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<AdminRoom>>
| Edit this page View Source

GetUserAsync(string, CancellationToken)

Return one local account; throw M_NOT_FOUND when unknown.

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

GetUserMediaAsync(string, CancellationToken)

Return the media uploaded by userId, newest first.

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

GetUsersAsync(CancellationToken)

Return every local account, by user ID.

Declaration
public Task<IReadOnlyList<AdminUser>> GetUsersAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<AdminUser>>
| Edit this page View Source

IsLockedAsync(string, CancellationToken)

Return whether the account is locked; throw M_NOT_FOUND when unknown.

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

IsRoomBlockedAsync(string, CancellationToken)

Return whether local users are kept from joining a room; throw M_NOT_FOUND for unknown rooms.

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

IsSuspendedAsync(string, CancellationToken)

Return whether the account is suspended; throw M_NOT_FOUND when unknown.

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

ResetPasswordAsync(string, string, CancellationToken)

Set a new password and log out every device of the user.

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

SetAdminAsync(string, bool, CancellationToken)

Give or take server admin rights.

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

SetDeactivatedAsync(string, bool, CancellationToken)

Deactivate an account, logging out every device, or reactivates it.

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

SetLockedAsync(string, bool, CancellationToken)

Lock an account, so its sessions are refused with M_USER_LOCKED but kept for when it is unlocked; or unlock it.

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

SetPublishedAsync(string, bool, CancellationToken)

List or unlists a room in the public room directory.

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

SetRoomBlockedAsync(string, bool, CancellationToken)

Block or unblock a room, so local users cannot or can join it.

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

SetSuspendedAsync(string, bool, CancellationToken)

Suspend an account, so it can read and leave but not send, join, invite or upload; or end the suspension.

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

ShutdownRoomAsync(string, bool, string?, CancellationToken)

Shut a room down on this server: make every local member leave and forget it, take it out of the directory, delete its local aliases, and, with block, keep local users from joining it again.

Declaration
public Task<RoomShutdown> ShutdownRoomAsync(string roomId, bool block, string? message, CancellationToken cancellationToken)
Parameters
Type Name Description
string roomId
bool block
string message
CancellationToken cancellationToken
Returns
Type Description
Task<RoomShutdown>
Remarks

The room's events stay in the database; other servers' users stay in the room.

| Edit this page View Source

WhoisAsync(string, CancellationToken)

Return the devices of userId, with when and from where each was last used; throw M_NOT_FOUND when unknown.

Declaration
public Task<IReadOnlyList<AdminDevice>> WhoisAsync(string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<AdminDevice>>