Interface IRoleController

Namespace: DotNetNuke.Security.Roles
Assembly: DotNetNuke.dll
Syntax
public interface IRoleController

Methods

AddRole(RoleInfo)

Declaration
int AddRole(RoleInfo role)
Parameters
Type Name Description
RoleInfo role
Returns
Type Description
int

AddRole(RoleInfo, bool)

Declaration
int AddRole(RoleInfo role, bool addToExistUsers)
Parameters
Type Name Description
RoleInfo role
bool addToExistUsers
Returns
Type Description
int

AddUserRole(int, int, int, RoleStatus, bool, DateTime, DateTime)

Declaration
void AddUserRole(int portalId, int userId, int roleId, RoleStatus status, bool isOwner, DateTime effectiveDate, DateTime expiryDate)
Parameters
Type Name Description
int portalId
int userId
int roleId
RoleStatus status
bool isOwner
DateTime effectiveDate
DateTime expiryDate

ClearRoleCache(int)

Declaration
void ClearRoleCache(int portalId)
Parameters
Type Name Description
int portalId

DeleteRole(RoleInfo)

Declaration
void DeleteRole(RoleInfo role)
Parameters
Type Name Description
RoleInfo role

GetRole(int, Func<RoleInfo, bool>)

Declaration
RoleInfo GetRole(int portalId, Func<RoleInfo, bool> predicate)
Parameters
Type Name Description
int portalId
Func<RoleInfo, bool> predicate
Returns
Type Description
RoleInfo

GetRoleById(int, int)

Declaration
RoleInfo GetRoleById(int portalId, int roleId)
Parameters
Type Name Description
int portalId
int roleId
Returns
Type Description
RoleInfo

GetRoleByName(int, string)

Declaration
RoleInfo GetRoleByName(int portalId, string roleName)
Parameters
Type Name Description
int portalId
string roleName
Returns
Type Description
RoleInfo

GetRoleSettings(int)

Declaration
IDictionary<string, string> GetRoleSettings(int roleId)
Parameters
Type Name Description
int roleId
Returns
Type Description
IDictionary<string, string>

GetRoles(int)

Declaration
IList<RoleInfo> GetRoles(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
IList<RoleInfo>

GetRoles(int, Func<RoleInfo, bool>)

Declaration
IList<RoleInfo> GetRoles(int portalId, Func<RoleInfo, bool> predicate)
Parameters
Type Name Description
int portalId
Func<RoleInfo, bool> predicate
Returns
Type Description
IList<RoleInfo>

GetRolesBasicSearch(int, int, string)

Declaration
IList<RoleInfo> GetRolesBasicSearch(int portalId, int pageSize, string filterBy)
Parameters
Type Name Description
int portalId
int pageSize
string filterBy
Returns
Type Description
IList<RoleInfo>

GetUserRole(int, int, int)

Declaration
UserRoleInfo GetUserRole(int portalId, int userId, int roleId)
Parameters
Type Name Description
int portalId
int userId
int roleId
Returns
Type Description
UserRoleInfo

GetUserRoles(UserInfo, bool)

Declaration
IList<UserRoleInfo> GetUserRoles(UserInfo user, bool includePrivate)
Parameters
Type Name Description
UserInfo user
bool includePrivate
Returns
Type Description
IList<UserRoleInfo>

GetUserRoles(int, string, string)

Declaration
IList<UserRoleInfo> GetUserRoles(int portalId, string userName, string roleName)
Parameters
Type Name Description
int portalId
string userName
string roleName
Returns
Type Description
IList<UserRoleInfo>

GetUsersByRole(int, string)

Declaration
IList<UserInfo> GetUsersByRole(int portalId, string roleName)
Parameters
Type Name Description
int portalId
string roleName
Returns
Type Description
IList<UserInfo>

UpdateRole(RoleInfo)

Declaration
void UpdateRole(RoleInfo role)
Parameters
Type Name Description
RoleInfo role

UpdateRole(RoleInfo, bool)

Declaration
void UpdateRole(RoleInfo role, bool addToExistUsers)
Parameters
Type Name Description
RoleInfo role
bool addToExistUsers

UpdateRoleSettings(RoleInfo, bool)

Declaration
void UpdateRoleSettings(RoleInfo role, bool clearCache)
Parameters
Type Name Description
RoleInfo role
bool clearCache

UpdateUserRole(int, int, int, RoleStatus, bool, bool)

Declaration
void UpdateUserRole(int portalId, int userId, int roleId, RoleStatus status, bool isOwner, bool cancel)
Parameters
Type Name Description
int portalId
int userId
int roleId
RoleStatus status
bool isOwner
bool cancel

Extension Methods