Class RoleProvider

Inheritance

object

RoleProvider

DNNRoleProvider

Inherited Members

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 abstract class RoleProvider

Constructors

RoleProvider()

Declaration

protected RoleProvider()

Methods

AddUserToRole(int, UserInfo, UserRoleInfo)

Declaration

public abstract bool AddUserToRole(int portalId, UserInfo user, UserRoleInfo userRole)

Parameters

Type	Name	Description
int	portalId
UserInfo	user
UserRoleInfo	userRole

Returns

Type	Description
bool

CreateRole(RoleInfo)

Declaration

public virtual bool CreateRole(RoleInfo role)

Parameters

Type	Name	Description
RoleInfo	role

Returns

Type	Description
bool

CreateRoleGroup(RoleGroupInfo)

Declaration

public abstract int CreateRoleGroup(RoleGroupInfo roleGroup)

Parameters

Type	Name	Description
RoleGroupInfo	roleGroup

Returns

Type	Description
int

DeleteRole(RoleInfo)

Declaration

public virtual void DeleteRole(RoleInfo role)

Parameters

Type	Name	Description
RoleInfo	role

DeleteRoleGroup(RoleGroupInfo)

Declaration

public abstract void DeleteRoleGroup(RoleGroupInfo roleGroup)

Parameters

Type	Name	Description
RoleGroupInfo	roleGroup

GetRoleGroup(int, int)

Declaration

public abstract RoleGroupInfo GetRoleGroup(int portalId, int roleGroupId)

Parameters

Type	Name	Description
int	portalId
int	roleGroupId

Returns

Type	Description
RoleGroupInfo

GetRoleGroupByName(int, string)

Declaration

public virtual RoleGroupInfo GetRoleGroupByName(int portalID, string roleGroupName)

Parameters

Type	Name	Description
int	portalID
string	roleGroupName

Returns

Type	Description
RoleGroupInfo

GetRoleGroups(int)

Declaration

public abstract ArrayList GetRoleGroups(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetRoleSettings(int)

Declaration

public virtual IDictionary<string, string> GetRoleSettings(int roleId)

Parameters

Type	Name	Description
int	roleId

Returns

Type	Description
IDictionary<string, string>

GetRoles(int)

Declaration

public abstract ArrayList GetRoles(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetRolesBasicSearch(int, int, string)

Declaration

public abstract 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 abstract 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 virtual 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 abstract ArrayList GetUserRoles(int portalId, string username, string rolename)

Parameters

Type	Name	Description
int	portalId
string	username
string	rolename

Returns

Type	Description
ArrayList

GetUsersByRoleName(int, string)

Declaration

public abstract ArrayList GetUsersByRoleName(int portalId, string roleName)

Parameters

Type	Name	Description
int	portalId
string	roleName

Returns

Type	Description
ArrayList

Instance()

Declaration

public static RoleProvider Instance()

Returns

Type	Description
RoleProvider

RemoveUserFromRole(int, UserInfo, UserRoleInfo)

Declaration

public abstract void RemoveUserFromRole(int portalId, UserInfo user, UserRoleInfo userRole)

Parameters

Type	Name	Description
int	portalId
UserInfo	user
UserRoleInfo	userRole

UpdateRole(RoleInfo)

Declaration

public abstract void UpdateRole(RoleInfo role)

Parameters

Type	Name	Description
RoleInfo	role

UpdateRoleGroup(RoleGroupInfo)

Declaration

public abstract void UpdateRoleGroup(RoleGroupInfo roleGroup)

Parameters

Type	Name	Description
RoleGroupInfo	roleGroup

UpdateRoleSettings(RoleInfo)

Declaration

public virtual void UpdateRoleSettings(RoleInfo role)

Parameters

Type	Name	Description
RoleInfo	role

UpdateUserRole(UserRoleInfo)

Declaration

public abstract void UpdateUserRole(UserRoleInfo userRole)

Parameters

Type	Name	Description
UserRoleInfo	userRole

Extension Methods

JsonExtensionsWeb.ToJson(object)