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

AI OnAI Off

Class SynchronizeUsersDB

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Database access routines for users/roles synched from for example Windows membership provider/Windows role provider and users authenticated through Single Sign On.

Inheritance
System.Object
SynchronizeUsersDB
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.Internal
Assembly: EPiServer.dll
Version: 10.10.4
Syntax
[ServiceConfiguration(typeof(SynchronizeUsersDB))]
public class SynchronizeUsersDB

Constructors

SynchronizeUsersDB(ServiceAccessor<IAsyncDatabaseExecutor>)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public SynchronizeUsersDB(ServiceAccessor<IAsyncDatabaseExecutor> databaseHandler)
Parameters
Type Name Description
ServiceAccessor<IAsyncDatabaseExecutor> databaseHandler

The IAsyncDatabaseExecutor that will be used for database communication.

Methods

DeleteRole(String, Boolean)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

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

FindMatchingRoles(String)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public IEnumerable<string> FindMatchingRoles(string partOfRoleName)
Parameters
Type Name Description
System.String partOfRoleName
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

FindUsersAsync(String, Int32, Int32)

Declaration
public Task<PagedNotificationUserResult> FindUsersAsync(string partOfUser, int startIndex, int maxCount)
Parameters
Type Name Description
System.String partOfUser
System.Int32 startIndex
System.Int32 maxCount
Returns
Type Description
System.Threading.Tasks.Task<PagedNotificationUserResult>

FindUsersByName(String)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Lists users that have logged in and been sycnhed to site. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public IEnumerable<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.Collections.Generic.IEnumerable<System.String>

A list of user names.

FindUsersInRole(String, String)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

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

InsertRole(String)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public void InsertRole(string roleName)
Parameters
Type Name Description
System.String roleName

ListRolesForUser(String)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Lists the roles 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 IEnumerable<string> ListRolesForUser(string userName)
Parameters
Type Name Description
System.String userName

Name of the user.
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

A list with the roles.
Remarks

Note that this routine will only return correct information for a user that has been logged on and thereby gets it's roles synched. The role list is simply the role list that was current at the time of login, i e it may be out of sync at a later date.

ListRoleStatus()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. 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>

LoadMetadata(String)

Declaration
public NameValueCollection LoadMetadata(string userName)
Parameters
Type Name Description
System.String userName
Returns
Type Description
System.Collections.Specialized.NameValueCollection

SetVisibilityForRole(Boolean, String)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. 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

SynchronizeRoles(String, IEnumerable<String>)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Synchronizes the role memberships for the user. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public void SynchronizeRoles(string userName, IEnumerable<string> roles)
Parameters
Type Name Description
System.String userName
System.Collections.Generic.IEnumerable<System.String> roles

SynchronizeUser(String, String, String, String, NameValueCollection)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Synchronizes the user meta data. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public int SynchronizeUser(string userName, string givenName, string surname, string email, NameValueCollection additionalMetadata)
Parameters
Type Name Description
System.String userName
System.String givenName
System.String surname
System.String email
System.Collections.Specialized.NameValueCollection additionalMetadata
Returns
Type Description
System.Int32

Extension Methods