Class RoleProvider

Inheritance
System.Object
RoleProvider
DNNRoleProvider
Namespace: DotNetNuke.Security.Roles
Assembly: DotNetNuke.dll
Syntax
public abstract class RoleProvider : object

Methods

| Improve this Doc View Source

AddUserToRole(Int32, UserInfo, UserRoleInfo)

Declaration
public abstract bool AddUserToRole(int portalId, UserInfo user, UserRoleInfo userRole)
Parameters
Type Name Description
System.Int32 portalId
UserInfo user
UserRoleInfo userRole
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CreateRole(RoleInfo)

Declaration
public virtual bool CreateRole(RoleInfo role)
Parameters
Type Name Description
RoleInfo role
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CreateRoleGroup(RoleGroupInfo)

Declaration
public abstract int CreateRoleGroup(RoleGroupInfo roleGroup)
Parameters
Type Name Description
RoleGroupInfo roleGroup
Returns
Type Description
System.Int32
| Improve this Doc View Source

DeleteRole(RoleInfo)

Declaration
public virtual void DeleteRole(RoleInfo role)
Parameters
Type Name Description
RoleInfo role
| Improve this Doc View Source

DeleteRoleGroup(RoleGroupInfo)

Declaration
public abstract void DeleteRoleGroup(RoleGroupInfo roleGroup)
Parameters
Type Name Description
RoleGroupInfo roleGroup
| Improve this Doc View Source

GetRoleGroup(Int32, Int32)

Declaration
public abstract RoleGroupInfo GetRoleGroup(int portalId, int roleGroupId)
Parameters
Type Name Description
System.Int32 portalId
System.Int32 roleGroupId
Returns
Type Description
RoleGroupInfo
| Improve this Doc View Source

GetRoleGroupByName(Int32, String)

Declaration
public virtual RoleGroupInfo GetRoleGroupByName(int portalID, string roleGroupName)
Parameters
Type Name Description
System.Int32 portalID
System.String roleGroupName
Returns
Type Description
RoleGroupInfo
| Improve this Doc View Source

GetRoleGroups(Int32)

Declaration
public abstract ArrayList GetRoleGroups(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Returns
Type Description
ArrayList
| Improve this Doc View Source

GetRoles(Int32)

Declaration
public abstract ArrayList GetRoles(int portalId)
Parameters
Type Name Description
System.Int32 portalId
Returns
Type Description
ArrayList
| Improve this Doc View Source

GetRolesBasicSearch(Int32, Int32, String)

Declaration
public abstract IList<RoleInfo> GetRolesBasicSearch(int portalID, int pageSize, string filterBy)
Parameters
Type Name Description
System.Int32 portalID
System.Int32 pageSize
System.String filterBy
Returns
Type Description
IList<RoleInfo>
| Improve this Doc View Source

GetRoleSettings(Int32)

Declaration
public virtual IDictionary<string, string> GetRoleSettings(int roleId)
Parameters
Type Name Description
System.Int32 roleId
Returns
Type Description
IDictionary<System.String, System.String>
| Improve this Doc View Source

GetUserRole(Int32, Int32, Int32)

Declaration
public abstract UserRoleInfo GetUserRole(int portalId, int userId, int roleId)
Parameters
Type Name Description
System.Int32 portalId
System.Int32 userId
System.Int32 roleId
Returns
Type Description
UserRoleInfo
| Improve this Doc View Source

GetUserRoles(UserInfo, Boolean)

Declaration
public virtual IList<UserRoleInfo> GetUserRoles(UserInfo user, bool includePrivate)
Parameters
Type Name Description
UserInfo user
System.Boolean includePrivate
Returns
Type Description
IList<UserRoleInfo>
| Improve this Doc View Source

GetUserRoles(Int32, String, String)

Declaration
public abstract ArrayList GetUserRoles(int portalId, string username, string rolename)
Parameters
Type Name Description
System.Int32 portalId
System.String username
System.String rolename
Returns
Type Description
ArrayList
| Improve this Doc View Source

GetUsersByRoleName(Int32, String)

Declaration
public abstract ArrayList GetUsersByRoleName(int portalId, string roleName)
Parameters
Type Name Description
System.Int32 portalId
System.String roleName
Returns
Type Description
ArrayList
| Improve this Doc View Source

Instance()

Declaration
public static RoleProvider Instance()
Returns
Type Description
RoleProvider
| Improve this Doc View Source

RemoveUserFromRole(Int32, UserInfo, UserRoleInfo)

Declaration
public abstract void RemoveUserFromRole(int portalId, UserInfo user, UserRoleInfo userRole)
Parameters
Type Name Description
System.Int32 portalId
UserInfo user
UserRoleInfo userRole
| Improve this Doc View Source

UpdateRole(RoleInfo)

Declaration
public abstract void UpdateRole(RoleInfo role)
Parameters
Type Name Description
RoleInfo role
| Improve this Doc View Source

UpdateRoleGroup(RoleGroupInfo)

Declaration
public abstract void UpdateRoleGroup(RoleGroupInfo roleGroup)
Parameters
Type Name Description
RoleGroupInfo roleGroup
| Improve this Doc View Source

UpdateRoleSettings(RoleInfo)

Declaration
public virtual void UpdateRoleSettings(RoleInfo role)
Parameters
Type Name Description
RoleInfo role
| Improve this Doc View Source

UpdateUserRole(UserRoleInfo)

Declaration
public abstract void UpdateUserRole(UserRoleInfo userRole)
Parameters
Type Name Description
UserRoleInfo userRole

Extension Methods