tgstation-server 6.12.0
The /tg/station 13 server suite
Loading...
Searching...
No Matches
IAdministrationClient.cs
Go to the documentation of this file.
1using System;
2using System.Collections.Generic;
3using System.IO;
4using System.Threading;
5using System.Threading.Tasks;
6
9
11{
15 public interface IAdministrationClient
16 {
23 ValueTask<AdministrationResponse> Read(bool forceFresh = false, CancellationToken cancellationToken = default);
24
32 ValueTask<ServerUpdateResponse> Update(ServerUpdateRequest updateRequest, Stream? zipFileStream, CancellationToken cancellationToken);
33
39 ValueTask Restart(CancellationToken cancellationToken);
40
47 ValueTask<List<LogFileResponse>> ListLogs(PaginationSettings? paginationSettings, CancellationToken cancellationToken);
48
55 ValueTask<Tuple<LogFileResponse, Stream>> GetLog(LogFileResponse logFile, CancellationToken cancellationToken);
56 }
57}
Settings for a paginated request.
ValueTask< AdministrationResponse > Read(bool forceFresh=false, CancellationToken cancellationToken=default)
Get the AdministrationResponse represented by the IAdministrationClient.
ValueTask Restart(CancellationToken cancellationToken)
Restarts the TGS server.
ValueTask< ServerUpdateResponse > Update(ServerUpdateRequest updateRequest, Stream? zipFileStream, CancellationToken cancellationToken)
Updates the AdministrationResponse setttings.
ValueTask< Tuple< LogFileResponse, Stream > > GetLog(LogFileResponse logFile, CancellationToken cancellationToken)
Download a given logFile .
ValueTask< List< LogFileResponse > > ListLogs(PaginationSettings? paginationSettings, CancellationToken cancellationToken)
Lists the log files available for download.