Class HttpServerAdmin

The dashboard's view of a server over HTTP: its admin API, through the local admin socket or over the network as a logged-in admin. Only the socket also tells the server's counters and files.

Inheritance

object

HttpServerAdmin

Implements

IServerAdmin

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Chat.Server.Management

Assembly: uniform-chat-server.dll

Syntax

public sealed class HttpServerAdmin : IServerAdmin, IAsyncDisposable

Properties

| Edit this page View Source

IsSocket

Whether this goes through the local admin socket, which sees the server's files, rather than the network.

Declaration

public bool IsSocket { get; }

Property Value

Type	Description
bool

Methods

| Edit this page View Source

ChangeSettingsAsync(string, IReadOnlyDictionary<string, string?>, CancellationToken)

Apply or save changes of the server's settings, action apply or save; return the settings after; through the socket only.

Declaration

public Task<JsonObject> ChangeSettingsAsync(string action, IReadOnlyDictionary<string, string?> changes, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	action
IReadOnlyDictionary<string, string>	changes
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonObject>

Exceptions

Type	Condition
IOException	When the server refuses, e.g. an unknown option or an invalid value, which the message tells.

| Edit this page View Source

ConnectSocketAsync(string, CancellationToken)

Connect to the admin socket at path and read the server's name.

Declaration

public static Task<HttpServerAdmin> ConnectSocketAsync(string path, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	path
CancellationToken	cancellationToken

Returns

Type	Description
Task<HttpServerAdmin>

Exceptions

Type	Condition
HttpRequestException	When nothing listens there, or this user may not open it.

| Edit this page View Source

CreateUserAsync(string, string, bool, CancellationToken)

Create the account, refusing one that exists, as the admin API would change it instead.

Declaration

public 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

public Task DeleteReportAsync(long reportId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
long	reportId
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

DisposeAsync()

Log out of a network session, so no access token is left behind; then close the connection.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask

| Edit this page View Source

GetReportsAsync(bool, CancellationToken)

Return the reports, page by page, without resolved ones unless asked.

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 every room, page by page.

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

GetSettingsAsync(CancellationToken)

Return the server's settings file, and each option's value and source; through the socket only.

Declaration

public Task<JsonObject> GetSettingsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonObject>

Exceptions

Type	Condition
IOException	When the server refuses, e.g. without a settings file.

| Edit this page View Source

GetSnapshotAsync(CancellationToken)

Return the counters, addresses and files from the socket; over the network only the name and address.

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 every local account, page by page.

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

LoginAsync(Uri, string, string, CancellationToken)

Declaration

public static Task<HttpServerAdmin> LoginAsync(Uri homeserver, string user, string password, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Uri	homeserver
string	user
string	password
CancellationToken	cancellationToken

Returns

Type	Description
Task<HttpServerAdmin>

Exceptions

Type	Condition
MatrixException	When the login fails, or the user is not a server admin; the session is then logged out.

| 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 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

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

IServerAdmin

IAsyncDisposable