Tgstation.Server.Client.IAdministrationClient Interface Reference

For managing server administration. More...

Inheritance diagram for Tgstation.Server.Client.IAdministrationClient:

Public Member Functions
ValueTask< AdministrationResponse >	Read (bool forceFresh=false, CancellationToken cancellationToken=default)
	Get the AdministrationResponse represented by the IAdministrationClient.
ValueTask< ServerUpdateResponse >	Update (ServerUpdateRequest updateRequest, Stream? zipFileStream, CancellationToken cancellationToken)
	Updates the AdministrationResponse setttings.
ValueTask	Restart (CancellationToken cancellationToken)
	Restarts the TGS server.
ValueTask< List< LogFileResponse > >	ListLogs (PaginationSettings? paginationSettings, CancellationToken cancellationToken)
	Lists the log files available for download.
ValueTask< Tuple< LogFileResponse, Stream > >	GetLog (LogFileResponse logFile, CancellationToken cancellationToken)
	Download a given logFile .

Detailed Description

For managing server administration.

Definition at line 15 of file IAdministrationClient.cs.

Member Function Documentation

GetLog()

ValueTask< Tuple< LogFileResponse, Stream > > Tgstation.Server.Client.IAdministrationClient.GetLog	(	LogFileResponse	logFile,
		CancellationToken	cancellationToken
	)

Download a given logFile .

Parameters

logFile	The LogFileResponse to download.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting a Tuple<T1, T2> containing the downloaded LogFileResponse and associated Stream.

Implemented in Tgstation.Server.Client.AdministrationClient.

ListLogs()

ValueTask< List< LogFileResponse > > Tgstation.Server.Client.IAdministrationClient.ListLogs	(	PaginationSettings?	paginationSettings,
		CancellationToken	cancellationToken
	)

Lists the log files available for download.

Parameters

paginationSettings	The optional PaginationSettings for the operation.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in an List<T> of LogFileResponse metadata.

Implemented in Tgstation.Server.Client.AdministrationClient.

Read()

ValueTask< AdministrationResponse > Tgstation.Server.Client.IAdministrationClient.Read	(	bool	forceFresh = false,
		CancellationToken	cancellationToken = default
	)

Get the AdministrationResponse represented by the IAdministrationClient.

Parameters

forceFresh	If true the response will be forcefully regenerated.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the AdministrationResponse represented by the IAdministrationClient.

Implemented in Tgstation.Server.Client.AdministrationClient.

Restart()

ValueTask Tgstation.Server.Client.IAdministrationClient.Restart

(

CancellationToken

cancellationToken

)

Restarts the TGS server.

Parameters

cancellationToken

The CancellationToken for the operation.

Returns

A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.AdministrationClient.

Update()

ValueTask< ServerUpdateResponse > Tgstation.Server.Client.IAdministrationClient.Update	(	ServerUpdateRequest	updateRequest,
		Stream?	zipFileStream,
		CancellationToken	cancellationToken
	)

Updates the AdministrationResponse setttings.

Parameters

updateRequest	The ServerUpdateRequest.
zipFileStream	The Stream for the .zip file if ServerUpdateRequest.UploadZip is true. Will be ignored if it is false.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the echoed ServerUpdateResponse.

Implemented in Tgstation.Server.Client.AdministrationClient.

---

The documentation for this interface was generated from the following file:

• src/Tgstation.Server.Client/IAdministrationClient.cs