November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class UIRoleProvider

Inheritance
System.Object
UIRoleProvider
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Shell.Security
Assembly: EPiServer.Shell.dll
Version: 11.20.7
Syntax
public abstract class UIRoleProvider : IDisposable

Constructors

UIRoleProvider()

Declaration
protected UIRoleProvider()

Properties

Enabled

Declaration
public abstract bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

Name

Declaration
public abstract string Name { get; }
Property Value
Type Description
System.String

Methods

AddUserToRoles(String, IEnumerable<String>)

Declaration
public abstract void AddUserToRoles(string username, IEnumerable<string> roleNames)
Parameters
Type Name Description
System.String username
System.Collections.Generic.IEnumerable<System.String> roleNames

CreateRole(String)

Declaration
public abstract void CreateRole(string newRoleName)
Parameters
Type Name Description
System.String newRoleName

DeleteRole(String, Boolean)

Declaration
public abstract bool DeleteRole(string roleName, bool throwOnPopulatedRole)
Parameters
Type Name Description
System.String roleName
System.Boolean throwOnPopulatedRole
Returns
Type Description
System.Boolean

DeleteRole(String, String, Boolean)

Declaration
public virtual bool DeleteRole(string providerName, string roleName, bool throwOnPopulatedRole)
Parameters
Type Name Description
System.String providerName
System.String roleName
System.Boolean throwOnPopulatedRole
Returns
Type Description
System.Boolean

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

GetAllRoles()

Declaration
public abstract IEnumerable<IUIRole> GetAllRoles()
Returns
Type Description
System.Collections.Generic.IEnumerable<IUIRole>

GetAllRolesForUser(String)

Declaration
public abstract IEnumerable<string> GetAllRolesForUser(string userName)
Parameters
Type Name Description
System.String userName
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

GetRoleProviderName(String)

Declaration
public virtual string GetRoleProviderName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.String

GetRolesForUser(String)

Declaration
public abstract IEnumerable<string> GetRolesForUser(string username)
Parameters
Type Name Description
System.String username
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

GetUsersInRole(String)

Declaration
public abstract IEnumerable<string> GetUsersInRole(string roleName)
Parameters
Type Name Description
System.String roleName
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

GetUsersInRole(String, Int32, Int32, out Int32)

Declaration
public virtual IEnumerable<string> GetUsersInRole(string roleName, int pageIndex, int pageSize, out int totalRecords)
Parameters
Type Name Description
System.String roleName
System.Int32 pageIndex
System.Int32 pageSize
System.Int32 totalRecords
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

GetUsersInRole(String, String)

Declaration
public virtual IEnumerable<string> GetUsersInRole(string providerName, string roleName)
Parameters
Type Name Description
System.String providerName
System.String roleName
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

IsSupported(ProviderActions)

Declaration
public virtual bool IsSupported(ProviderActions action)
Parameters
Type Name Description
ProviderActions action
Returns
Type Description
System.Boolean

RemoveUserFromRole(String, String)

Declaration
public abstract void RemoveUserFromRole(string userName, string roleName)
Parameters
Type Name Description
System.String userName
System.String roleName

RemoveUserFromRoles(String, IEnumerable<String>)

Declaration
public abstract void RemoveUserFromRoles(string username, IEnumerable<string> roleNames)
Parameters
Type Name Description
System.String username
System.Collections.Generic.IEnumerable<System.String> roleNames

RemoveUsersFromRoles(IEnumerable<String>, IEnumerable<String>)

Declaration
public abstract void RemoveUsersFromRoles(IEnumerable<string> usernames, IEnumerable<string> roleNames)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.String> usernames
System.Collections.Generic.IEnumerable<System.String> roleNames

RemoveUsersFromRoles(String, IEnumerable<String>, IEnumerable<String>)

Declaration
public virtual void RemoveUsersFromRoles(string providerName, IEnumerable<string> usernames, IEnumerable<string> roleNames)
Parameters
Type Name Description
System.String providerName
System.Collections.Generic.IEnumerable<System.String> usernames
System.Collections.Generic.IEnumerable<System.String> roleNames

RoleExists(String)

Declaration
public abstract bool RoleExists(string roleName)
Parameters
Type Name Description
System.String roleName
Returns
Type Description
System.Boolean

Implements

System.IDisposable

Extension Methods