tgstation-server
The /tg/station 13 server suite
IApiClient.cs
Go to the documentation of this file.
1 using System;
2 using System.Threading;
3 using System.Threading.Tasks;
4 using Tgstation.Server.Api;
5 
7 {
11  interface IApiClient : IDisposable
12  {
16  ApiHeaders Headers { get; set; }
17 
21  Uri Url { get; }
22 
26  TimeSpan Timeout { get; set; }
27 
32  void AddRequestLogger(IRequestLogger requestLogger);
33 
43  Task<TResult> Create<TBody, TResult>(string route, TBody body, CancellationToken cancellationToken);
44 
52  Task<TResult> Create<TResult>(string route, CancellationToken cancellationToken);
53 
61  Task<TResult> Read<TResult>(string route, CancellationToken cancellationToken);
62 
72  Task<TResult> Update<TBody, TResult>(string route, TBody body, CancellationToken cancellationToken);
73 
81  Task<TResult> Update<TResult>(string route, CancellationToken cancellationToken);
82 
91  Task Update<TBody>(string route, TBody body, CancellationToken cancellationToken);
92 
99  Task Delete(string route, CancellationToken cancellationToken);
100 
111  Task<TResult> Create<TBody, TResult>(string route, TBody body, long instanceId, CancellationToken cancellationToken);
112 
121  Task<TResult> Create<TResult>(string route, long instanceId, CancellationToken cancellationToken);
122 
131  Task<TResult> Patch<TResult>(string route, long instanceId, CancellationToken cancellationToken);
132 
141  Task<TResult> Read<TResult>(string route, long instanceId, CancellationToken cancellationToken);
142 
153  Task<TResult> Update<TBody, TResult>(string route, TBody body, long instanceId, CancellationToken cancellationToken);
154 
162  Task Delete(string route, long instanceId, CancellationToken cancellationToken);
163 
173  Task Delete<TBody>(string route, TBody body, long instanceId, CancellationToken cancellationToken);
174 
183  Task<TResult> Delete<TResult>(string route, long instanceId, CancellationToken cancellationToken);
184  }
185 }
ApiHeaders Headers
The ApiHeaders the IApiClient uses
Definition: IApiClient.cs:16
TimeSpan Timeout
The request timeout
Definition: IApiClient.cs:26
Task Delete< TBody >(string route, TBody body, long instanceId, CancellationToken cancellationToken)
Run an HTTP DELETE request
Represents the header that must be present for every server request
Definition: ApiHeaders.cs:17
Task< TResult > Patch< TResult >(string route, long instanceId, CancellationToken cancellationToken)
Run an HTTP PATCH request
Task< TResult > Create< TResult >(string route, CancellationToken cancellationToken)
Run an HTTP PUT request
Task Update< TBody >(string route, TBody body, CancellationToken cancellationToken)
Run an HTTP POST request
Task< TResult > Delete< TResult >(string route, long instanceId, CancellationToken cancellationToken)
Run an HTTP DELETE request
Task< TResult > Read< TResult >(string route, CancellationToken cancellationToken)
Run an HTTP GET request
Task< TResult > Create< TBody, TResult >(string route, TBody body, CancellationToken cancellationToken)
Run an HTTP PUT request
For logging HTTP requests and responses
Task Delete(string route, CancellationToken cancellationToken)
Run an HTTP DELETE request
Task< TResult > Update< TBody, TResult >(string route, TBody body, CancellationToken cancellationToken)
Run an HTTP POST request
Uri Url
The Uri pointing the tgstation-server
Definition: IApiClient.cs:21
void AddRequestLogger(IRequestLogger requestLogger)
Adds a requestLogger to the request pipeline
Task< TResult > Update< TResult >(string route, CancellationToken cancellationToken)
Run an HTTP POST request
Web interface for the API
Definition: IApiClient.cs:11