AipGateway/AipGateway.API-old/obj/Debug/net6.0/API.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>API</name>
    </assembly>
    <members>
        <member name="M:API.Controllers.UserModule.RoleController.GetAllRoles">
            <summary>
            Get ALL Roles
            </summary>
            <returns>List of Roles</returns>
        </member>
        <member name="M:API.Controllers.UserModule.RoleController.GetRoleById(System.Int32)">
            <summary>
            Get Role by ID
            </summary>
            <param name="id">role ID</param>
            <returns>Role</returns>
        </member>
        <member name="M:API.Controllers.UserModule.RoleController.GetAllDraftAsync">
            <summary>
            Get Current user/Logged-In user Role
            </summary>
            <returns>Role</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.GetByIdAsync(System.Int32)">
            <summary>
            Gets user by ID
            </summary>
            <param name="id">ID of user</param>
            <returns>user</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.GetMeAsync">
            <summary>
            Gets Current Logged-In user
            </summary>
            <returns>user</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.RegisterAsync(Domain.RequestModels.UserRequests.RegisterRequestModel)">
            <summary>
            user can register themself here
            </summary>
            <param name="request">user attributes</param>
            <returns>Authorized token response to login</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.LoginAsync(Domain.RequestModels.UserRequests.LoginRequestModel)">
            <summary>
            user can login here
            </summary>
            <param name="loginRequest">username, password</param>
            <returns>Authorized token response to login</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.AddAsync(Domain.RequestModels.UserRequests.UpsertUserRequest)">
            <summary>
            Adds a new user
            </summary>
            <param name="request">user attributes</param>
            <returns>user</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.ChangePassword(Domain.RequestModels.UserRequests.UpdatePasswordRequestModel)">
            <summary>
            user can change password here
            </summary>
            <param name="request">CurrentPassword, PasswordConfirmation, NewPassword</param>
            <returns>Boolean</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.ForgetPassword(Domain.RequestModels.UserRequests.ForgetPasswordRequestModel)">
            <summary>
            used if user forgets his/her password, email will be sent on given username/email if it exists
            </summary>
            <param name="request">Email</param>
            <returns>Boolean</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.UpdateStatusAsync(System.Int32,System.Boolean)">
            <summary>
            Activates or de-activates a user
            </summary>
            <param name="id">id of user</param>
            <param name="status">true to activate and false for deactive</param>
            <returns>boolean</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.UpdateAsync(Domain.RequestModels.UserRequests.UpsertUserRequest)">
            <summary>
            Updates a user by ID in given request-body
            </summary>
            <param name="request">user attributes</param>
            <returns>User</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.UpdateMeAsync(Domain.RequestModels.UserRequests.UpdateCurrentUserRequest)">
            <summary>
             updates current logged in User
            </summary>
            <param name="request">user attributes</param>
            <returns>User</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.UpdateMyProfilePictureAsync(Domain.RequestModels.UserRequests.UpsertProfilePictureRequest)">
            <summary>
            upserts current logged-in users' profile picture
            </summary>
            <param name="request">prfile picture to update with current</param>
            <returns>user</returns>
        </member>
        <member name="M:API.Controllers.UserModule.UserController.DeleteAsync(System.Int32)">
            <summary>
            Deletes user by ID
            </summary>
            <param name="id">ID of user</param>
            <returns>Boolean</returns>
        </member>
    </members>
</doc>