Web interface for the API. More...

Inheritance diagram for Tgstation.Server.Client.IApiClient:

[legend]

Collaboration diagram for Tgstation.Server.Client.IApiClient:

[legend]

Public Member Functions
void	AddRequestLogger (IRequestLogger requestLogger)
	Adds a requestLogger to the request pipeline.

ValueTask< IAsyncDisposable >	CreateHubConnection< THubImplementation > (THubImplementation hubImplementation, IRetryPolicy? retryPolicy, Action< ILoggingBuilder >? loggingConfigureAction, CancellationToken cancellationToken)
	Subscribe to all job updates available to the IRestServerClient.

ValueTask< TResult >	Create< TBody, TResult > (string route, TBody body, CancellationToken cancellationToken)
	Run an HTTP PUT request.

ValueTask< TResult >	Create< TResult > (string route, CancellationToken cancellationToken)
	Run an HTTP PUT request.

ValueTask< TResult >	Read< TResult > (string route, CancellationToken cancellationToken)
	Run an HTTP GET request.

ValueTask< TResult >	Update< TBody, TResult > (string route, TBody body, CancellationToken cancellationToken)
	Run an HTTP POST request.

ValueTask< TResult >	Update< TResult > (string route, CancellationToken cancellationToken)
	Run an HTTP POST request.

ValueTask	Update< TBody > (string route, TBody body, CancellationToken cancellationToken)
	Run an HTTP POST request.

ValueTask	Patch (string route, CancellationToken cancellationToken)
	Run an HTTP PATCH request.

ValueTask	Delete (string route, CancellationToken cancellationToken)
	Run an HTTP DELETE request.

ValueTask< TResult >	Create< TBody, TResult > (string route, TBody body, long instanceId, CancellationToken cancellationToken)
	Run an HTTP PUT request.

ValueTask< TResult >	Create< TResult > (string route, long instanceId, CancellationToken cancellationToken)
	Run an HTTP PUT request.

ValueTask< TResult >	Patch< TResult > (string route, long instanceId, CancellationToken cancellationToken)
	Run an HTTP PATCH request.

ValueTask< TResult >	Read< TResult > (string route, long instanceId, CancellationToken cancellationToken)
	Run an HTTP GET request.

ValueTask< TResult >	Update< TBody, TResult > (string route, TBody body, long instanceId, CancellationToken cancellationToken)
	Run an HTTP POST request.

ValueTask	Delete (string route, long instanceId, CancellationToken cancellationToken)
	Run an HTTP DELETE request.

ValueTask	Delete< TBody > (string route, TBody body, long instanceId, CancellationToken cancellationToken)
	Run an HTTP DELETE request.

ValueTask< TResult >	Delete< TResult > (string route, long instanceId, CancellationToken cancellationToken)
	Run an HTTP DELETE request.

ValueTask< TResult >	Delete< TBody, TResult > (string route, TBody body, long instanceId, CancellationToken cancellationToken)
	Run an HTTP DELETE request.

Public Member Functions inherited from Tgstation.Server.Client.ITransferClient
ValueTask< Stream >	Download (FileTicketResponse ticket, CancellationToken cancellationToken)
	Downloads a file Stream for a given ticket .

ValueTask	Upload (FileTicketResponse ticket, Stream? uploadStream, CancellationToken cancellationToken)
	Uploads a given uploadStream for a given ticket .

Properties
ApiHeaders	Headers `[get, set]`
	The ApiHeaders the IApiClient uses.

Uri	Url `[get]`
	The Uri pointing the tgstation-server.

TimeSpan	Timeout `[get, set]`
	The request timeout.

Detailed Description

Web interface for the API.

Definition at line 16 of file IApiClient.cs.

Member Function Documentation

◆ AddRequestLogger()

void Tgstation.Server.Client.IApiClient.AddRequestLogger ( IRequestLogger requestLogger )

Adds a requestLogger to the request pipeline.

Parameters

requestLogger The IRequestLogger to add.

Implemented in Tgstation.Server.Client.ApiClient.

Referenced by Tgstation.Server.Client.RestServerClientFactory.GetServerInformation().

Here is the caller graph for this function:

◆ Create< TBody, TResult >() [1/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Create< TBody, TResult >	(	string	route,
		TBody	body,
		CancellationToken	cancellationToken
	)

Run an HTTP PUT request.

Template Parameters

TBody	The type to of the request body.
TResult	The type of the response body.

Parameters

route	The server route to make the request to.
body	The request body.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

TBody

:

class

◆ Create< TBody, TResult >() [2/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Create< TBody, TResult >	(	string	route,
		TBody	body,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP PUT request.

Template Parameters

TBody	The type to of the request body.
TResult	The type of the response body.

Parameters

route	The server route to make the request to.
body	The request body.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

TBody

:

class

◆ Create< TResult >() [1/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Create< TResult >	(	string	route,
		CancellationToken	cancellationToken
	)

Run an HTTP PUT request.

Template Parameters

TResult The type of the response body.

Parameters

route	The server route to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

◆ Create< TResult >() [2/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Create< TResult >	(	string	route,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP PUT request.

Template Parameters

TResult The type of the response body.

Parameters

route	The server route to make the request to.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

◆ CreateHubConnection< THubImplementation >()

ValueTask< IAsyncDisposable > Tgstation.Server.Client.IApiClient.CreateHubConnection< THubImplementation >	(	THubImplementation	hubImplementation,
		IRetryPolicy?	retryPolicy,
		Action< ILoggingBuilder >?	loggingConfigureAction,
		CancellationToken	cancellationToken
	)

Subscribe to all job updates available to the IRestServerClient.

Template Parameters

THubImplementation The Type of the hub being implemented.

Parameters

hubImplementation	The THubImplementation to use for proxying the methods of the hub connection.
retryPolicy	The optional IRetryPolicy to use for the backing connection. The default retry policy waits for 1, 2, 4, 8, and 16 seconds, then 30s repeatedly.
loggingConfigureAction	The optional Action<T1> used to configure a ILoggingBuilder.
cancellationToken	The CancellationToken for the operation.

Returns: An IAsyncDisposable representing the lifetime of the subscription.

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

THubImplementation

:

class

◆ Delete() [1/2]

ValueTask Tgstation.Server.Client.IApiClient.Delete	(	string	route,
		CancellationToken	cancellationToken
	)

Run an HTTP DELETE request.

Parameters

route	The server route to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.ApiClient.

◆ Delete() [2/2]

ValueTask Tgstation.Server.Client.IApiClient.Delete	(	string	route,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP DELETE request.

Parameters

route	The server route to make the request to.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.ApiClient.

◆ Delete< TBody >()

ValueTask Tgstation.Server.Client.IApiClient.Delete< TBody >	(	string	route,
		TBody	body,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP DELETE request.

Template Parameters

TBody The type to of the request body.

Parameters

route	The server route to make the request to.
body	The request body.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

TBody

:

class

◆ Delete< TBody, TResult >()

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Delete< TBody, TResult >	(	string	route,
		TBody	body,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP DELETE request.

Template Parameters

TBody	The type to of the request body.
TResult	The type of the response body.

Parameters

route	The server route to make the request to.
body	The request body.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

TBody

:

class

◆ Delete< TResult >()

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Delete< TResult >	(	string	route,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP DELETE request.

Template Parameters

TResult The type of the response body.

Parameters

route	The server route to make the request to.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

◆ Patch()

ValueTask Tgstation.Server.Client.IApiClient.Patch	(	string	route,
		CancellationToken	cancellationToken
	)

Run an HTTP PATCH request.

Parameters

route	The server route to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.ApiClient.

◆ Patch< TResult >()

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Patch< TResult >	(	string	route,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP PATCH request.

Template Parameters

TResult The type of the response body.

Parameters

route	The server route to make the request to.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

◆ Read< TResult >() [1/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Read< TResult >	(	string	route,
		CancellationToken	cancellationToken
	)

Run an HTTP GET request.

Template Parameters

TResult The type of the response body.

Parameters

route	The server route to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

◆ Read< TResult >() [2/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Read< TResult >	(	string	route,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP GET request.

Template Parameters

TResult The type of the response body.

Parameters

route	The server route to make the request to.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

◆ Update< TBody >()

ValueTask Tgstation.Server.Client.IApiClient.Update< TBody >	(	string	route,
		TBody	body,
		CancellationToken	cancellationToken
	)

Run an HTTP POST request.

Template Parameters

TBody The type to of the request body.

Parameters

route	The server route to make the request to.
body	The request body.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask representing the running operation.

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

TBody

:

class

◆ Update< TBody, TResult >() [1/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Update< TBody, TResult >	(	string	route,
		TBody	body,
		CancellationToken	cancellationToken
	)

Run an HTTP POST request.

Template Parameters

TBody	The type to of the request body.
TResult	The type of the response body.

Parameters

route	The server route to make the request to.
body	The request body.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

TBody

:

class

◆ Update< TBody, TResult >() [2/2]

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Update< TBody, TResult >	(	string	route,
		TBody	body,
		long	instanceId,
		CancellationToken	cancellationToken
	)

Run an HTTP POST request.

Template Parameters

TBody	The type to of the request body.
TResult	The type of the response body.

Parameters

route	The server route to make the request to.
body	The request body.
instanceId	The instance EntityId.Id to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

Type Constraints

TBody

:

class

◆ Update< TResult >()

ValueTask< TResult > Tgstation.Server.Client.IApiClient.Update< TResult >	(	string	route,
		CancellationToken	cancellationToken
	)

Run an HTTP POST request.

Template Parameters

TResult The type of the response body.

Parameters

route	The server route to make the request to.
cancellationToken	The CancellationToken for the operation.

Returns: A ValueTask<TResult> resulting in the response body as a TResult .

Implemented in Tgstation.Server.Client.ApiClient.

Property Documentation

◆ Headers

ApiHeaders Tgstation.Server.Client.IApiClient.Headers

getset

The ApiHeaders the IApiClient uses.

Implemented in Tgstation.Server.Client.ApiClient.

Definition at line 21 of file IApiClient.cs.

21{ get; set; }

◆ Timeout

TimeSpan Tgstation.Server.Client.IApiClient.Timeout

getset

The request timeout.

Implemented in Tgstation.Server.Client.ApiClient.

Definition at line 31 of file IApiClient.cs.

31{ get; set; }

◆ Url

Uri Tgstation.Server.Client.IApiClient.Url

get

The Uri pointing the tgstation-server.

Implemented in Tgstation.Server.Client.ApiClient.

Definition at line 26 of file IApiClient.cs.

26{ get; }

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

src/Tgstation.Server.Client/IApiClient.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddRequestLogger()

◆ Create< TBody, TResult >() [1/2]

◆ Create< TBody, TResult >() [2/2]

◆ Create< TResult >() [1/2]

◆ Create< TResult >() [2/2]

◆ CreateHubConnection< THubImplementation >()

◆ Delete() [1/2]

◆ Delete() [2/2]

◆ Delete< TBody >()

◆ Delete< TBody, TResult >()

◆ Delete< TResult >()

◆ Patch()

◆ Patch< TResult >()

◆ Read< TResult >() [1/2]

◆ Read< TResult >() [2/2]

◆ Update< TBody >()

◆ Update< TBody, TResult >() [1/2]

◆ Update< TBody, TResult >() [2/2]

◆ Update< TResult >()

Property Documentation

◆ Headers

◆ Timeout

◆ Url