| UserInfoProvider Methods |
The UserInfoProvider type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddSiteWhereCondition | Obsolete.
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.) |
 | 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.) |
| 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) |
Deletes specified user.
|
| DeleteUser(String) |
Deletes specified user.
|
| DeleteUser(UserInfo) |
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.
|
| EnsureSitePrefixUserName |
Prepends a site specific prefix to the given user name.
|
| EnsureSitePrefixUserNameInternal |
Prepends a site specific prefix to the given user name.
|
| 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.
|
| 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.
|
| GetFullUsers(String, String) | Obsolete.
Returns dataset with users with their settings according to WHERE condition sorted by ORDER BY expression.
|
| GetFullUsers(String, String, Int32, String) | Obsolete.
Returns dataset with users with their settings according to WHERE condition sorted by ORDER BY expression.
|
| 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.) |
| 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.) |
| GetInfoById |
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.
|
| GetSingleObject | Obsolete.
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.) |
| GetSiteWhereCondition | Obsolete.
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.) |
| GetUserDataClassPermissions |
Returns the DataSet with user permissions for specified class.
|
| GetUserInfo(Int32) |
Returns the UserInfo structure for the specified user.
|
| GetUserInfo(String) |
Returns the UserInfo structure for the specified user.
|
| GetUserInfoByFacebookConnectID |
Returns user with specified Facebook Connect ID.
|
| GetUserInfoByGUID |
Returns object with specified GUID.
|
| GetUserInfoByLinkedInID |
Returns user with specified LinkedIn ID.
|
| GetUserInfoByWindowsLiveID |
Returns UserInfo related to WindowsLive ID.
|
| GetUserInfoForSitePrefix |
Return user info by codename. If Site prefix switched on - test site prefix variant of user name first
|
| GetUserInfoForSitePrefixInternal |
Return user info by codename. If Site prefix switched on - test site prefix variant of user name first
|
| GetUserInfoWithSettings | Obsolete.
Returns user info object with settings according to where condition.
|
| GetUserInfoWithSettingsInternal | Obsolete.
Returns user info object with settings according to where condition.
|
| 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.
|
| GetUserNameSitePrefix |
Returns a site specific prefix.
|
| GetUserNameSitePrefixInternal |
Returns a site specific prefix.
|
| 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 |
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
|
| IsSitePrefixedUser |
Returns true, is user name has site prefix
|
| IsSitePrefixedUserInternal |
Returns true, is user name has site prefix
|
| IsUserInRole |
Returns true if the user is a member of the role in context of the specified site.
|
| IsUserNamePrefixUnique |
Test if there is any site prefix username (f.e. 'site.{GUID}.{Name}' and '{Name}' is not allowed at the same time).
Should be checked if site prefixes are disabled but user names with site prefixes may exist in the system.
|
| 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.) |
| NameIsReserved |
Returns true if specified name is defined in reserved names.
|
| 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
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.) |
| 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.
|
| SetAsDefaultProvider |
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.) |
| 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, does not save the user object.
|
| SetPreferredCultures |
Sets the preferred culture codes from given user object.
|
| SetUserInfo |
Sets (updates or inserts) specified user.
|
| SetUserInfoInternal |
Sets (updates or inserts) specified user.
|
| SortAlphabetically | Obsolete.
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.) |
| TrimSitePrefix |
Trims site prefix from user name (if any prefix found)
|
| TrimSitePrefixInternal |
Trimes site prefix from user name (if any prefix found)
|
| 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.) |
| UpdateUserCounts |
Updates user count with dependence on selected type of activity.
|
| UserNameSitePrefixEnabled |
Returns true, if site prefix for users is enabled
|
| 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.
|
See Also