Tgstation.Server.Client.UserGroupsClient Class Reference

More...

Inheritance diagram for Tgstation.Server.Client.UserGroupsClient:

Collaboration diagram for Tgstation.Server.Client.UserGroupsClient:

Public Member Functions
	UserGroupsClient (IApiClient apiClient)
	Initializes a new instance of the UserGroupsClient class.
ValueTask< UserGroupResponse >	Create (UserGroupCreateRequest group, CancellationToken cancellationToken)
	Create a new group . Parameters group The UserGroupCreateRequest. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the new UserGroupResponse.
ValueTask< UserGroupResponse >	GetId (EntityId group, CancellationToken cancellationToken)
	Get a specific group . Parameters group The EntityId of the user group to get. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the requested group .
ValueTask< List< UserGroupResponse > >	List (PaginationSettings? paginationSettings, CancellationToken cancellationToken)
	List all UserGroupResponses. Parameters paginationSettings The optional PaginationSettings for the operation. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in a List<T> of all UserGroupResponses.
ValueTask< UserGroupResponse >	Update (UserGroupUpdateRequest group, CancellationToken cancellationToken)
	Update a group . Parameters group The UserGroupUpdateRequest. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the updated UserGroupResponse.
ValueTask	Delete (EntityId group, CancellationToken cancellationToken)
	Deletes a group . Parameters group The EntityId of the user group to delete. cancellationToken The CancellationToken for the operation. Returns A ValueTask representing the running operation.
Public Member Functions inherited from Tgstation.Server.Client.PaginatedClient
	PaginatedClient (IApiClient apiClient)
	Initializes a new instance of the PaginatedClient class.

Private Member Functions
ValueTask< UserGroupResponse >	UserGroupResponse (Routes.UserGroup, group ?? throw new ArgumentNullException(nameof(group)), cancellationToken)
ValueTask< UserGroupResponse >	UserGroupResponse (Routes.UserGroup, group ?? throw new ArgumentNullException(nameof(group)), cancellationToken)

Additional Inherited Members
Protected Member Functions inherited from Tgstation.Server.Client.PaginatedClient
async ValueTask< List< TModel > >	ReadPaged< TModel > (PaginationSettings? paginationSettings, string route, long? instanceId, CancellationToken cancellationToken)
	Reads a given route with paged results.
Properties inherited from Tgstation.Server.Client.PaginatedClient
IApiClient	ApiClient [get]
	The IApiClient for the PaginatedClient.

Detailed Description

Definition at line 14 of file UserGroupsClient.cs.

Constructor & Destructor Documentation

UserGroupsClient()

Tgstation.Server.Client.UserGroupsClient.UserGroupsClient

(

IApiClient

apiClient

)

Initializes a new instance of the UserGroupsClient class.

Parameters

apiClient

The IApiClient for the PaginatedClient.

Definition at line 20 of file UserGroupsClient.cs.

            : base(apiClient)
        {
        }

Member Function Documentation

Create()

ValueTask< UserGroupResponse > Tgstation.Server.Client.UserGroupsClient.Create	(	UserGroupCreateRequest	group,
		CancellationToken	cancellationToken
	)

Create a new group .

Parameters

group	The UserGroupCreateRequest.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the new UserGroupResponse.

Implements Tgstation.Server.Client.IUserGroupsClient.

Delete()

ValueTask Tgstation.Server.Client.UserGroupsClient.Delete	(	EntityId	group,
		CancellationToken	cancellationToken
	)

Deletes a group .

Parameters

group	The EntityId of the user group to delete.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask representing the running operation.

Implements Tgstation.Server.Client.IUserGroupsClient.

GetId()

ValueTask< UserGroupResponse > Tgstation.Server.Client.UserGroupsClient.GetId	(	EntityId	group,
		CancellationToken	cancellationToken
	)

Get a specific group .

Parameters

group	The EntityId of the user group to get.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the requested group .

Implements Tgstation.Server.Client.IUserGroupsClient.

List()

ValueTask< List< UserGroupResponse > > Tgstation.Server.Client.UserGroupsClient.List	(	PaginationSettings?	paginationSettings,
		CancellationToken	cancellationToken
	)

List all UserGroupResponses.

Parameters

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

Returns

A ValueTask<TResult> resulting in a List<T> of all UserGroupResponses.

Implements Tgstation.Server.Client.IUserGroupsClient.

Update()

ValueTask< UserGroupResponse > Tgstation.Server.Client.UserGroupsClient.Update	(	UserGroupUpdateRequest	group,
		CancellationToken	cancellationToken
	)

Update a group .

Parameters

group	The UserGroupUpdateRequest.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the updated UserGroupResponse.

Implements Tgstation.Server.Client.IUserGroupsClient.

UserGroupResponse() [1/2]

ValueTask< UserGroupResponse > Tgstation.Server.Client.UserGroupsClient.UserGroupResponse ( Routes.  UserGroup, group ?? throw new   ArgumentNullExceptionnameof(group), cancellationToken    )

private

UserGroupResponse() [2/2]

ValueTask< UserGroupResponse > Tgstation.Server.Client.UserGroupsClient.UserGroupResponse ( Routes.  UserGroup, group ?? throw new   ArgumentNullExceptionnameof(group), cancellationToken    )

private

---

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

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