Class LocalServerAdmin

The dashboard's view of the server it runs in: its services, called directly.

Inheritance
object
LocalServerAdmin
Implements
Inherited Members
Namespace: Uniform.Chat.Server.Management
Assembly: uniform-chat-server.dll
Syntax
public sealed class LocalServerAdmin : IServerAdmin

Constructors

| Edit this page View Source

LocalServerAdmin(AdminService, ReportService, ServerStatus, IServer, IOptions<ServerOptions>, IOptions<ServerStorageOptions>, IHostEnvironment, FileLoggerProvider, SettingsStore)

The dashboard's view of the server it runs in: its services, called directly.

Declaration
public LocalServerAdmin(AdminService admin, ReportService reports, ServerStatus status, IServer server, IOptions<ServerOptions> options, IOptions<ServerStorageOptions> storage, IHostEnvironment environment, FileLoggerProvider fileLogger, SettingsStore settings)
Parameters
Type Name Description
AdminService admin

Accounts and rooms.
ReportService reports

Users' reports.
ServerStatus status

Live counters.
IServer server

The web server, for its addresses.
IOptions<ServerOptions> options

The server's name.
IOptions<ServerStorageOptions> storage

The data and log folders.
IHostEnvironment environment

The application name, which names the folders.
FileLoggerProvider fileLogger

This session's log.
SettingsStore settings

The settings file.

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
public Task<string> CreateUserAsync(string name, string password, bool isAdmin, CancellationToken cancellationToken)
Parameters
Type Name Description
string name
string password
bool isAdmin
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

DeleteReportAsync(long, CancellationToken)

Delete a report.

Declaration
public 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
public 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
public 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 counters, addresses and files.

Declaration
public 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
public 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
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 isAdmin, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
bool isAdmin
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SetDeactivatedAsync(string, bool, CancellationToken)

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

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

SetResolvedAsync(long, bool, CancellationToken)

Resolve a report, or open it again.

Declaration
public 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
public Task SetSuspendedAsync(string userId, bool suspended, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
bool suspended
CancellationToken cancellationToken
Returns
Type Description
Task

Implements