Tgstation.Server.Client.IUsersClient Interface Reference

For managing UserResponses. More...

Inheritance diagram for Tgstation.Server.Client.IUsersClient:

Public Member Functions
ValueTask< UserResponse >	Read (CancellationToken cancellationToken)
	Read the current user's information and general rights.
ValueTask< UserResponse >	GetId (EntityId user, CancellationToken cancellationToken)
	Get a specific user .
ValueTask< List< UserResponse > >	List (PaginationSettings? paginationSettings, CancellationToken cancellationToken)
	List all UserResponses.
ValueTask< UserResponse >	Create (UserCreateRequest user, CancellationToken cancellationToken)
	Create a new user .
ValueTask< UserResponse >	Update (UserUpdateRequest user, CancellationToken cancellationToken)
	Update a user .

Detailed Description

For managing UserResponses.

Definition at line 14 of file IUsersClient.cs.

Member Function Documentation

Create()

ValueTask< UserResponse > Tgstation.Server.Client.IUsersClient.Create	(	UserCreateRequest	user,
		CancellationToken	cancellationToken
	)

Create a new user .

Parameters

user	The UserCreateRequest.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the new UserResponse.

Implemented in Tgstation.Server.Client.UsersClient.

GetId()

ValueTask< UserResponse > Tgstation.Server.Client.IUsersClient.GetId	(	EntityId	user,
		CancellationToken	cancellationToken
	)

Get a specific user .

Parameters

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

Returns

A ValueTask<TResult> resulting in the requested user .

Implemented in Tgstation.Server.Client.UsersClient.

List()

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

List all UserResponses.

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 UserResponses.

Implemented in Tgstation.Server.Client.UsersClient.

Read()

ValueTask< UserResponse > Tgstation.Server.Client.IUsersClient.Read

(

CancellationToken

cancellationToken

)

Read the current user's information and general rights.

Parameters

cancellationToken

The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the current UserResponse.

Implemented in Tgstation.Server.Client.UsersClient.

Update()

ValueTask< UserResponse > Tgstation.Server.Client.IUsersClient.Update	(	UserUpdateRequest	user,
		CancellationToken	cancellationToken
	)

Update a user .

Parameters

user	The UserUpdateRequest used to update the UserResponse.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the updated UserResponse.

Implemented in Tgstation.Server.Client.UsersClient.

---

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

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