UserInfoProvider Class

Class providing UserInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<UserInfo, UserInfoProvider, ObjectQuery<UserInfo>>
    CMS.DataEngine.AbstractInfoProvider<UserInfo, UserInfoProvider>
      CMS.Membership.UserInfoProvider

Namespace: CMS.Membership
Assembly: CMS.Membership (in CMS.Membership.dll) Version: 13.0.131

Syntax

public class UserInfoProvider : AbstractInfoProvider<UserInfo, UserInfoProvider>, 
	IUserInfoProvider, IInfoProvider<UserInfo>, IInfoByIdProvider<UserInfo>, 
	IInfoByNameProvider<UserInfo>, IInfoByGuidProvider<UserInfo>

The UserInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	UserInfoProvider	Creates new instance of UserInfoProvider.

Fields

	Name	Description
Public field Static member	DEFAULT_ADMIN_USERNAME	Administrator user name
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property Static member	AdministratorUser	Gets the default system administrator user in the listed order of preferences: 1) User defined by settings key CMSDefaultUserID 2) User with username 'administrator' 3) Any other global admin
Public property Static member	AdministratorUserName	Gets the default system administrator user name in the listed order of preferences: 1) User defined by settings key CMSDefaultUserID 2) User with username 'administrator' 3) Any other global admin 4) Defaults to 'administrator' if no global admin is found
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	LogUserCounts	Gets or sets the value that indicates whether user counts settings should be checked.
Public property Static member	NewPasswordFormat	Returns password format to be used while hashing new passwords.
Public property Static member	PasswordSalt	Gets or sets password salt.
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	UserCountsEnabled	Gets the value that indicates whether user counts are enabled.
Public property Static member	UserEnabledWhereCondition	Where condition indicating that user is enabled
Public property Static member	UseSafeRoleName	Indicates whether to use safe or normal role names.
Public property Static member	UseSafeUserName	Indicates whether to use safe or normal user names.

Methods

	Name	Description
Public method Static member	AddUserToRole(Int32, Int32)	Adds the specified user to the role of site.
Public method Static member	AddUserToRole(String, String, String)	Adds the specified user to the role of site.
Public method Static member	AddUserToSite	Adds the specified user to the site.
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CheckLicense	Checks the license.
Public method Static member	CheckLicenseLimitation	Checks license limitation for provider UserInfo. Checks limitations for global administrator, editor and site members.
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CheckUserBelongsToSite	Check if user belongs to specified site, considering settings key CMSSiteSharedAccounts.
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	ClearLicenseValues	Clear license values.
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteUser(Int32)	Obsolete. Deletes specified user.
Public method Static member	DeleteUser(String)	Obsolete. Deletes specified user.
Public method Static member	DeleteUser(UserInfo)	Obsolete. Deletes specified user.
Public method Static member	EnsureRolesAndSites	Ensures that roles and sites for the given user are present within the database.
Public method Static member	EnsureRolesAndSitesForWindowsAuthentication	Ensures that roles and sites for the given user are present within the database. Used in case of Windows authentication.
Public method Static member	GenerateNewPassword	Returns new password according to password policy. Generates password with 8 characters (at least one special character) if no password policy is configured.
Protected method	GenerateNewPasswordInternal	Returns new password according to password policy.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetFormattedUserName	Returns formatted username in format: fullname (nickname) if nicname specified otherwise fullname (username). Allows you to customize how the usernames will look like throughout the admin UI.
Public method Static member	GetFullName	Returns user's full name
Public method Static member	GetFullUserInfo(Int32)	Returns the UserInfo structure for the specified user also with UserSettings.
Public method Static member	GetFullUserInfo(String)	Returns the UserInfo structure for the specified user also with UserSettings.
Public method Static member	GetGenericRoles	Gets user generic roles in format "'role1', 'role2'"
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetPasswordHash	Returns the hashed password representation (is hashing on).
Protected method	GetPasswordHashInternal	Returns the hashed password representation (is hashing on).
Public method Static member	GetRequiredResourceUsers(String, String, String)	Gets the DataSet of the required users for the specified resource permission.
Public method Static member	GetRequiredResourceUsers(String, String, String, String, String, Int32, String)	Gets the DataSet of the required users for the specified resource permission.
Protected method	GetRequiredResourceUsersInternal	Gets the DataSet of the required users for the specified resource permission.
Public method Static member	GetRolesForUser	Returns all roles for specified user.
Public method Static member	GetSearchDocuments	Returns top 15 search documents for current scope.
Public method Static member	GetSearchWhereCondition	Returns smart search where condition for indexing.
Public method Static member	GetUserDataClassPermissions	Returns the DataSet with user permissions for specified class.
Public method Static member	GetUserInfo(Int32)	Obsolete. Returns the UserInfo structure for the specified user.
Public method Static member	GetUserInfo(String)	Obsolete. Returns the UserInfo structure for the specified user.
Public method Static member	GetUserInfoByGUID	Obsolete. Returns object with specified GUID.
Public method Static member	GetUserMembershipRoles	Returns the table of the user roles given by membership connection.
Protected method	GetUserMembershipRolesInternal	Returns the table of the user roles given by membership connection.
Public method Static member	GetUserName()	Gets currently logged user name. The user name is safe if the UseSafeUserName is enabled.
Public method Static member	GetUserName(String)	Gets currently logged user name. The user name is safe if the UseSafeUserName is enabled.
Public method Static member	GetUserNameById	Returns the UserName by the specified user ID.
Protected method	GetUserNameByIdInternal	Returns the UserName by the specified user ID.
Protected method	GetUserPermissions	Returns the DataSet of user permissions for permission type specified by ID.
Public method Static member	GetUserResourcePermissions	Returns the DataSet with user permissions for specified resource.
Public method Static member	GetUserRoles(UserInfo)	Returns the table of the user roles.
Public method Static member	GetUserRoles(UserInfo, String, String, Int32, String)	Returns the table of the user roles.
Public method Static member	GetUserRoles(UserInfo, String, String, Int32, String, Boolean, Boolean, Boolean)	Returns the table of the user roles.
Protected method	GetUserRolesInternal	Returns the table of the user roles.
Public method Static member	GetUsers	Obsolete. Returns the query for all users.
Public method Static member	GetUsersDataWithSettings	Returns object query for users with settings data
Public method Static member	GetUserSites	Returns the table of the user sites.
Protected method	GetUserSitesInternal	Returns the table of the user sites.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	InvalidateUser	Invalidates the specified user
Public method Static member	IsAuthorizedPerClass(String, String, String, UserInfo)	Returns true if user is granted with specified permission for particular class (document type).
Public method Static member	IsAuthorizedPerClass(String, String, String, UserInfo, Boolean)	Returns true if user is granted with specified permission for particular class (document type).
Protected method	IsAuthorizedPerClassInternal	Returns true if user is granted with specified permission for particular class.
Public method Static member	IsAuthorizedPerMetaFile	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerObject(String, PermissionsEnum, String, UserInfo)	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerObject(BaseInfo, PermissionsEnum, String, UserInfo)	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerObject(String, PermissionsEnum, String, UserInfo, Boolean)	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerObject(String, Int32, PermissionsEnum, String, UserInfo)	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerObject(BaseInfo, PermissionsEnum, String, UserInfo, Boolean)	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerResource(String, String, String, UserInfo)	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerResource(String, String, String, UserInfo, Boolean)	Returns true if given user is granted with specified permission.
Public method Static member	IsAuthorizedPerUIElement(String, IEnumerable<String>, String, UserInfo)	Indicates if user is authorized to see the specified UI element.
Public method Static member	IsAuthorizedPerUIElement(String, String, String, UserInfo)	Indicates if user is authorized to see the specified UI element.
Public method Static member	IsAuthorizedPerUIElement(String, IEnumerable<String>, String, UserInfo, Boolean)	Indicates if user is authorized to see the specified UI element.
Public method Static member	IsAuthorizedPerUIElement(String, IEnumerable<String>, String, UserInfo, Boolean, Boolean)	Indicates if user is authorized to see the specified UI element.
Public method Static member	IsEmailUnique(String, UserInfo)	Returns true if email doesn't exist in users table. Depends on 'Unique e-mails' and 'Shared user accounts' settings
Public method Static member	IsEmailUnique(String, IEnumerable<String>, Int32)	Returns true if email doesn't exist in users table. Depends on 'Unique e-mails' and 'Shared user accounts' settings
Public method Static member	IsEmailUnique(String, String, Int32)	Returns true if email doesn't exist in users table. Depends on 'Unique e-mails' and 'Shared user accounts' settings
Public method Static member	IsUserInRole	Returns true if the user is a member of the role in context of the specified site.
Public method Static member	IsUserPasswordDifferent	Indicates if user password differs from specified password
Public method Static member	LicenseVersionCheck	License version check.
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ProcessWebFarmTaskInternal(String, String, Byte[]).)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RemoveUserFromRole(Int32, Int32)	Removes specified user from the role.
Public method Static member	RemoveUserFromRole(String, String, String)	Removes specified user from the role.
Public method Static member	RemoveUserFromSite(Int32, Int32)	Removes the user from the specified site.
Public method Static member	RemoveUserFromSite(String, String)	Removes the user from the specified site.
Public method	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetEnabled	Sets the enabled state for the specified user. Toggling a user from enabled state to disabled also generates a new UserSecurityStamp for the user.
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetPassword(String, String)	Sets the password for the specified user. Saves object to database.
Public method Static member	SetPassword(UserInfo, String)	Sets the password for the specified user object, saves the user object.
Public method Static member	SetPassword(String, String, Boolean)	Sets the password for the specified user.
Public method Static member	SetPassword(UserInfo, String, Boolean)	Sets the password for the specified user object.
Public method Static member	SetPreferredCultures	Sets the preferred culture codes from given user object.
Public method Static member	SetUserInfo	Obsolete. Sets (updates or inserts) specified user.
Protected method	SetUserInfoInternal	Obsolete. Sets (updates or inserts) specified user.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the user name. Returns true if the user name is valid and follows rules defined by UsernameRegExp. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ValidateCodeName(TInfo).)
Public method Static member	ValidateUserPassword	Compares hash of given password with user's hash stored in database.
Public method Static member	ValidateUserPasswordHash	Compares hash of given password with provided hash based on user's password format and salt.

Events

	Name	Description
Public event Static member	OnFormattedUserName	Event for formatting user name