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

AI OnAI Off

Class WindowsProviderDB

Database access routines for Windows membership provider and Windows role provider.

Inheritance
System.Object
DataAccessBase
WindowsProviderDB
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.DataAccess
Assembly: EPiServer.dll
Version: 9.12.2
Syntax
[Obsolete("Use SynchronizingUserService instead")]
[ServiceConfiguration(typeof(WindowsProviderDB))]
public class WindowsProviderDB : DataAccessBase

Constructors

WindowsProviderDB(IDatabaseHandler)

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public WindowsProviderDB(IDatabaseHandler databaseHandler)
Parameters
Type Name Description
IDatabaseHandler databaseHandler

The IDatabaseHandler that will be used for database communication.

Methods

DeleteGroup(String, Boolean)

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public bool DeleteGroup(string groupName, bool forceDelete)
Parameters
Type Name Description
System.String groupName
System.Boolean forceDelete
Returns
Type Description
System.Boolean

FindUsersByName(String)

Lists Windows users that have logged in to EPiServer. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public string[] FindUsersByName(string userNameToMatch)
Parameters
Type Name Description
System.String userNameToMatch

The user names to match. Set to null to find all user names.
Returns
Type Description
System.String[]

A string array of user names.

InsertGroup(String)

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public void InsertGroup(string groupName)
Parameters
Type Name Description
System.String groupName

ListGroups(String)

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public string[] ListGroups(string groupExists)
Parameters
Type Name Description
System.String groupExists
Returns
Type Description
System.String[]

ListRoleStatus()

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public IEnumerable<SynchronizedRoleStatus> ListRoleStatus()
Returns
Type Description
System.Collections.Generic.IEnumerable<SynchronizedRoleStatus>

MemberOfGroups(String)

Lists the groups that the user is a member of. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public string[] MemberOfGroups(string userName)
Parameters
Type Name Description
System.String userName

Name of the user.
Returns
Type Description
System.String[]

A string[] with the groups.
Remarks

Note that this routine will only return correct information for a user that has been logged on with the WindowsMembershipProvider. The group list is simply the group list that was current at the time of login, i e it may be out of sync at a later date.

SetVisibilityForRole(Boolean, String)

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public void SetVisibilityForRole(bool show, string role)
Parameters
Type Name Description
System.Boolean show
System.String role

SynchronizeGroups(String, String[])

Synchronizes the group memberships of the user. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public void SynchronizeGroups(string userName, string[] groups)
Parameters
Type Name Description
System.String userName

Name of the user.
System.String[] groups

The groups.
Remarks

Persists the current group membership for the user.

UsersInGroup(String, String)

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public string[] UsersInGroup(string groupName, string userNameToMatch)
Parameters
Type Name Description
System.String groupName
System.String userNameToMatch
Returns
Type Description
System.String[]

Extension Methods