Show / Hide Table of Contents

Class RoleController

Inheritance
object
ServiceLocator<IRoleController, RoleController>
RoleController
Implements
IRoleController
Inherited Members
ServiceLocator<IRoleController, RoleController>.SetTestableInstance(IRoleController)
ServiceLocator<IRoleController, RoleController>.ClearInstance()
ServiceLocator<IRoleController, RoleController>.GetFactory()
ServiceLocator<IRoleController, RoleController>.Instance
ServiceLocator<IRoleController, RoleController>.Factory
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: DotNetNuke.Security.Roles
Assembly: DotNetNuke.dll
Syntax
public class RoleController : ServiceLocator<IRoleController, RoleController>, IRoleController

Constructors

RoleController()

Declaration
public RoleController()

Methods

AddRole(RoleInfo)

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

AddRoleGroup(RoleGroupInfo)

Declaration
public static int AddRoleGroup(RoleGroupInfo objRoleGroupInfo)
Parameters
Type Name Description
RoleGroupInfo objRoleGroupInfo
Returns
Type Description
int

AddUserRole(UserInfo, RoleInfo, PortalSettings, RoleStatus, DateTime, DateTime, bool, bool)

Declaration
public static void AddUserRole(UserInfo user, RoleInfo role, PortalSettings portalSettings, RoleStatus status, DateTime effectiveDate, DateTime expiryDate, bool notifyUser, bool isOwner)
Parameters
Type Name Description
UserInfo user
RoleInfo role
PortalSettings portalSettings
RoleStatus status
DateTime effectiveDate
DateTime expiryDate
bool notifyUser
bool isOwner

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

Declaration
public 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

CanRemoveUserFromRole(PortalInfo, int, int)

Declaration
public static bool CanRemoveUserFromRole(PortalInfo portalInfo, int userId, int roleId)
Parameters
Type Name Description
PortalInfo portalInfo
int userId
int roleId
Returns
Type Description
bool

CanRemoveUserFromRole(PortalSettings, int, int)

Declaration
public static bool CanRemoveUserFromRole(PortalSettings portalSettings, int userId, int roleId)
Parameters
Type Name Description
PortalSettings portalSettings
int userId
int roleId
Returns
Type Description
bool

ClearRoleCache(int)

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

DeleteRole(RoleInfo)

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

DeleteRoleGroup(RoleGroupInfo)

Declaration
public static void DeleteRoleGroup(RoleGroupInfo objRoleGroupInfo)
Parameters
Type Name Description
RoleGroupInfo objRoleGroupInfo

DeleteRoleGroup(int, int)

Declaration
public static void DeleteRoleGroup(int portalID, int roleGroupId)
Parameters
Type Name Description
int portalID
int roleGroupId

DeleteUserRole(UserInfo, RoleInfo, PortalSettings, bool)

Declaration
public static bool DeleteUserRole(UserInfo objUser, RoleInfo role, PortalSettings portalSettings, bool notifyUser)
Parameters
Type Name Description
UserInfo objUser
RoleInfo role
PortalSettings portalSettings
bool notifyUser
Returns
Type Description
bool

GetFactory()

Declaration
protected override Func<IRoleController> GetFactory()
Returns
Type Description
Func<IRoleController>
Overrides
ServiceLocator<IRoleController, RoleController>.GetFactory()

GetRole(int, Func<RoleInfo, bool>)

Declaration
public 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
public RoleInfo GetRoleById(int portalId, int roleId)
Parameters
Type Name Description
int portalId
int roleId
Returns
Type Description
RoleInfo

GetRoleByName(int, string)

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

GetRoleGroup(int, int)

Declaration
public static RoleGroupInfo GetRoleGroup(int portalId, int roleGroupId)
Parameters
Type Name Description
int portalId
int roleGroupId
Returns
Type Description
RoleGroupInfo

GetRoleGroupByName(int, string)

Declaration
public static RoleGroupInfo GetRoleGroupByName(int portalId, string roleGroupName)
Parameters
Type Name Description
int portalId
string roleGroupName
Returns
Type Description
RoleGroupInfo

GetRoleGroups(int)

Declaration
public static ArrayList GetRoleGroups(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
ArrayList

GetRoleSettings(int)

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

GetRoles(int)

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

GetRoles(int, Func<RoleInfo, bool>)

Declaration
public 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
public 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
public 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
public 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
public 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
public IList<UserInfo> GetUsersByRole(int portalId, string roleName)
Parameters
Type Name Description
int portalId
string roleName
Returns
Type Description
IList<UserInfo>

SerializeRoleGroups(XmlWriter, int)

Declaration
public static void SerializeRoleGroups(XmlWriter writer, int portalID)
Parameters
Type Name Description
XmlWriter writer
int portalID

UpdateRole(RoleInfo, bool)

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

UpdateRoleGroup(RoleGroupInfo)

Declaration
public static void UpdateRoleGroup(RoleGroupInfo roleGroup)
Parameters
Type Name Description
RoleGroupInfo roleGroup

UpdateRoleGroup(RoleGroupInfo, bool)

Declaration
public static void UpdateRoleGroup(RoleGroupInfo roleGroup, bool includeRoles)
Parameters
Type Name Description
RoleGroupInfo roleGroup
bool includeRoles

UpdateRoleSettings(RoleInfo, bool)

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

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

Declaration
public 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

Implements

IRoleController

Extension Methods

JsonExtensionsWeb.ToJson(object)
Back to top by the community, for the community... #DNNCMS