tgstation-server 6.19.0
The /tg/station 13 server suite
Loading...
Searching...
No Matches
UsersClient.cs
Go to the documentation of this file.
1using System;
2using System.Collections.Generic;
3using System.Threading;
4using System.Threading.Tasks;
5
10
12{
15 {
20 public UsersClient(IApiClient apiClient)
21 : base(apiClient)
22 {
23 }
24
26 public ValueTask<UserResponse> Create(UserCreateRequest user, CancellationToken cancellationToken) => ApiClient.Create<UserCreateRequest, UserResponse>(Routes.User, user ?? throw new ArgumentNullException(nameof(user)), cancellationToken);
27
29 public ValueTask<UserResponse> GetId(EntityId user, CancellationToken cancellationToken) => ApiClient.Read<UserResponse>(Routes.SetID(Routes.User, user?.Id ?? throw new ArgumentNullException(nameof(user))), cancellationToken);
30
34
36 public ValueTask<UserResponse> Read(CancellationToken cancellationToken) => ApiClient.Read<UserResponse>(Routes.User, cancellationToken);
37
39 public ValueTask<UserResponse> Update(UserUpdateRequest user, CancellationToken cancellationToken) => ApiClient.Update<UserUpdateRequest, UserResponse>(Routes.User, user ?? throw new ArgumentNullException(nameof(user)), cancellationToken);
40 }
41}
Common base of entities with IDs.
Definition EntityId.cs:7
Routes to a server actions.
Definition Routes.cs:9
static string SetID(string route, long id)
Apply an id postfix to a route .
const string User
The user controller.
Definition Routes.cs:38
static string ListRoute(string route)
Get the /List postfix for a route .
Client that deals with getting paginated results.
Settings for a paginated request.
ValueTask< UserResponse > Update(UserUpdateRequest user, CancellationToken cancellationToken)
Update a user .A ValueTask<TResult> resulting in the updated UserResponse.
UsersClient(IApiClient apiClient)
Initializes a new instance of the UsersClient class.
ValueTask< UserResponse > Read(CancellationToken cancellationToken)
Read the current user's information and general rights.A ValueTask<TResult> resulting in the current ...
ValueTask< UserResponse > GetId(EntityId user, CancellationToken cancellationToken)
Get a specific user .A ValueTask<TResult> resulting in the requested user .
ValueTask< List< UserResponse > > List(PaginationSettings? paginationSettings, CancellationToken cancellationToken)
List all UserResponses.A ValueTask<TResult> resulting in a List<T> of all UserResponses.
ValueTask< UserResponse > Create(UserCreateRequest user, CancellationToken cancellationToken)
Create a new user .A ValueTask<TResult> resulting in the new UserResponse.
Web interface for the API.
Definition IApiClient.cs:17
For managing UserResponses.