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