Interface IServerAdmin

What the dashboard shows of a server and changes on it: its state, accounts, rooms and reports. LocalServerAdmin works in the server's own process; HttpServerAdmin over the admin socket or the network, for uniform-chat-server manage.

Namespace: Uniform.Chat.Server.Management
Assembly: uniform-chat-server.dll
Syntax
public interface IServerAdmin

Methods

| Edit this page View Source

CreateUserAsync(string, string, bool, CancellationToken)

Create an account named name, the part before the colon; return its user ID; fail when it exists.

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

DeleteReportAsync(long, CancellationToken)

Delete a report.

Declaration
Task DeleteReportAsync(long reportId, CancellationToken cancellationToken)
Parameters
Type Name Description
long reportId
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

GetReportsAsync(bool, CancellationToken)

Return the users' reports, newest first; resolved ones with includeResolved.

Declaration
Task<IReadOnlyList<Report>> GetReportsAsync(bool includeResolved, CancellationToken cancellationToken)
Parameters
Type Name Description
bool includeResolved
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<Report>>
| Edit this page View Source

GetRoomsAsync(CancellationToken)

Return the server's rooms.

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

GetSnapshotAsync(CancellationToken)

Return the server's state; what the connection cannot see is null.

Declaration
Task<ServerSnapshot> GetSnapshotAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<ServerSnapshot>
| Edit this page View Source

GetUsersAsync(CancellationToken)

Return the local accounts, deactivated ones too.

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

ResetPasswordAsync(string, string, CancellationToken)

Set a new password, logging out every device of the account.

Declaration
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
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, or reactivate it.

Declaration
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, or unlock it.

Declaration
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 a room in the public room directory, or take it out.

Declaration
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

SetResolvedAsync(long, bool, CancellationToken)

Resolve a report, or open it again.

Declaration
Task SetResolvedAsync(long reportId, bool resolved, CancellationToken cancellationToken)
Parameters
Type Name Description
long reportId
bool resolved
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SetSuspendedAsync(string, bool, CancellationToken)

Suspend an account, or end its suspension.

Declaration
Task SetSuspendedAsync(string userId, bool suspended, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
bool suspended
CancellationToken cancellationToken
Returns
Type Description
Task