IUserService¶

Namespace: Rest_API.Services.User

Service interface for user management operations including user retrieval, updates, and deletion.

public interface IUserService

Methods¶

Changes a user's password after validating the current password.

Task ChangePassword(ApiUser user, string currentPassword, string newPassword)

user ApiUser

The user whose password will be changed.

currentPassword String

The user's current password for validation.

newPassword String

The new password to set.

A task representing the asynchronous password change operation.

ArgumentException

Thrown when parameters are null or invalid.

UnauthorizedAccessException

Thrown when current password is incorrect.

Updates user information in the system.

Task ChangeUser(ApiUser user)

user ApiUser

The user object with updated information.

A task representing the asynchronous user update operation.

ArgumentException

Thrown when user is null or contains invalid data.

InvalidOperationException

Thrown when user update fails.

Deletes a user from the system.

Task<Boolean> DeleteUser(ApiUser user)

user ApiUser

The user to delete from the system.

A task containing true if deletion was successful, false otherwise.

ArgumentException

Thrown when user is null.

InvalidOperationException

Thrown when user deletion fails.

Retrieves a specific user by their unique identifier.

Task<ApiUser> GetUserById(string userId)

userId String

The unique identifier of the user to retrieve.

A task containing the user if found, or null if not found.

ArgumentException

Thrown when userId is null or empty.

Retrieves a list of all users in the system.

Task<List<ApiUser>> GetUserInformations()

A task containing a list of all API users.

UnauthorizedAccessException

Thrown when user lacks sufficient permissions.