tgstation-server 6.3.2
The /tg/station 13 server suite
Loading...
Searching...
No Matches
InstancePermissionSetClient.cs
Go to the documentation of this file.
1using System;
2using System.Collections.Generic;
3using System.Threading;
4using System.Threading.Tasks;
5
11
13{
16 {
21
28 : base(apiClient)
29 {
30 this.instance = instance ?? throw new ArgumentNullException(nameof(instance));
31 }
32
34 public ValueTask<InstancePermissionSetResponse> Create(InstancePermissionSetRequest instancePermissionSet, CancellationToken cancellationToken) => ApiClient.Create<InstancePermissionSetRequest, InstancePermissionSetResponse>(Routes.InstancePermissionSet, instancePermissionSet ?? throw new ArgumentNullException(nameof(instancePermissionSet)), instance.Id!.Value, cancellationToken);
35
37 public ValueTask Delete(InstancePermissionSet instancePermissionSet, CancellationToken cancellationToken) => ApiClient.Delete(
40 instancePermissionSet.PermissionSetId),
41 instance.Id!.Value,
42 cancellationToken);
43
45 public ValueTask<InstancePermissionSetResponse> Read(CancellationToken cancellationToken) => ApiClient.Read<InstancePermissionSetResponse>(Routes.InstancePermissionSet, instance.Id!.Value, cancellationToken);
46
48 public ValueTask<InstancePermissionSetResponse> Update(InstancePermissionSetRequest instancePermissionSet, CancellationToken cancellationToken) => ApiClient.Update<InstancePermissionSetRequest, InstancePermissionSetResponse>(Routes.InstancePermissionSet, instancePermissionSet ?? throw new ArgumentNullException(nameof(instancePermissionSet)), instance.Id!.Value, cancellationToken);
49
51 public ValueTask<List<InstancePermissionSetResponse>> List(PaginationSettings? paginationSettings, CancellationToken cancellationToken)
52 => ReadPaged<InstancePermissionSetResponse>(
53 paginationSettings,
56 cancellationToken);
57
59 public ValueTask<InstancePermissionSetResponse> GetId(InstancePermissionSet instancePermissionSet, CancellationToken cancellationToken) => ApiClient.Read<InstancePermissionSetResponse>(Routes.SetID(Routes.InstancePermissionSet, instancePermissionSet?.PermissionSetId ?? throw new ArgumentNullException(nameof(instancePermissionSet))), instance.Id!.Value, cancellationToken);
60 }
61}
virtual ? long Id
The ID of the entity.
Definition: EntityId.cs:13
Metadata about a server instance.
Definition: Instance.cs:9
Represents a PermissionSets permissions in an Instance.
Routes to a server actions.
Definition: Routes.cs:9
static string SetID(string route, long id)
Apply an id postfix to a route .
static string ListRoute(string route)
Get the /List postfix for a route .
const string InstancePermissionSet
The instance permission set controller.
Definition: Routes.cs:83
ValueTask Delete(string route, CancellationToken cancellationToken)
Run an HTTP DELETE request. A ValueTask representing the running operation.
ValueTask< InstancePermissionSetResponse > Read(CancellationToken cancellationToken)
Get the instance permission sets associated with the logged on user. A ValueTask<TResult> resulting i...
InstancePermissionSetClient(IApiClient apiClient, Instance instance)
Initializes a new instance of the InstancePermissionSetClient class.
ValueTask< List< InstancePermissionSetResponse > > List(PaginationSettings? paginationSettings, CancellationToken cancellationToken)
Get the instance permission sets in the instance. A ValueTask<TResult> resulting in a List<T> of Inst...
ValueTask Delete(InstancePermissionSet instancePermissionSet, CancellationToken cancellationToken)
Delete a instancePermissionSet . A ValueTask representing the running operation.
readonly Instance instance
The Instance for the InstancePermissionSetClient.
ValueTask< InstancePermissionSetResponse > Create(InstancePermissionSetRequest instancePermissionSet, CancellationToken cancellationToken)
Create a instancePermissionSet . A ValueTask<TResult> reulting in the new InstancePermissionSetRespon...
ValueTask< InstancePermissionSetResponse > GetId(InstancePermissionSet instancePermissionSet, CancellationToken cancellationToken)
Get a specific instancePermissionSet . A ValueTask<TResult> resulting in the requested instancePermis...
ValueTask< InstancePermissionSetResponse > Update(InstancePermissionSetRequest instancePermissionSet, CancellationToken cancellationToken)
Update a instancePermissionSet . A ValueTask representing the running operation.
Client that deals with getting paginated results.
Settings for a paginated request.
Web interface for the API.
Definition: IApiClient.cs:19