More docs for https://github.com/oqtane/oqtane.framework/issues/1382 - should not affect any code
This commit is contained in:
@ -1,15 +1,47 @@
|
||||
using Oqtane.Models;
|
||||
using Oqtane.Models;
|
||||
using System.Collections.Generic;
|
||||
using System.Threading.Tasks;
|
||||
|
||||
namespace Oqtane.Services
|
||||
{
|
||||
/// <summary>
|
||||
/// Manage <see cref="Role"/>s assigned to a specific <see cref="User"/>
|
||||
/// </summary>
|
||||
public interface IUserRoleService
|
||||
{
|
||||
/// <summary>
|
||||
/// Get all <see cref="UserRole"/>s on a <see cref="Site"/>
|
||||
/// </summary>
|
||||
/// <param name="siteId">ID-reference to a <see cref="Site"/></param>
|
||||
/// <returns></returns>
|
||||
Task<List<UserRole>> GetUserRolesAsync(int siteId);
|
||||
|
||||
/// <summary>
|
||||
/// Get one specific <see cref="UserRole"/>
|
||||
/// </summary>
|
||||
/// <param name="userRoleId">ID-reference to a <see cref="UserRole"/></param>
|
||||
/// <returns></returns>
|
||||
Task<UserRole> GetUserRoleAsync(int userRoleId);
|
||||
|
||||
/// <summary>
|
||||
/// Save a new <see cref="UserRole"/>
|
||||
/// </summary>
|
||||
/// <param name="userRole"></param>
|
||||
/// <returns></returns>
|
||||
Task<UserRole> AddUserRoleAsync(UserRole userRole);
|
||||
|
||||
/// <summary>
|
||||
/// Update a <see cref="UserRole"/> in the database
|
||||
/// </summary>
|
||||
/// <param name="userRole"></param>
|
||||
/// <returns></returns>
|
||||
Task<UserRole> UpdateUserRoleAsync(UserRole userRole);
|
||||
|
||||
/// <summary>
|
||||
/// Delete a <see cref="UserRole"/> in the database
|
||||
/// </summary>
|
||||
/// <param name="userRoleId"></param>
|
||||
/// <returns></returns>
|
||||
Task DeleteUserRoleAsync(int userRoleId);
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user