VGMembership Class |
Validates user credentials and manages user settings.
Inheritance HierarchyNamespace: Novalys.VisualGuard.Security.Membership
Assembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)
SyntaxThe VGMembership type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | Count |
Gets the number of users in the repository.
|
| EnablePasswordReset |
Gets a value indicating whether the current membership provider is configured to allow users to reset their passwords.
|
| MaxInvalidPasswordAttempts |
Gets the number of invalid password or password-answer attempts allowed before the membership user is locked out.
|
| MaxUsers |
Gets the maximum number of users allowed in the repository according to the granted license.
|
| MinRequiredNonAlphanumericCharacters |
Gets the minimum number of special characters that must be present in a valid password.
|
| MinRequiredPasswordLength |
Gets the minimum length required for a password.
|
| PasswordAttemptWindow |
Gets the number of minutes in which a maximum number of invalid password or password-answer attempts are allowed before the membership user is locked out.
|
| PasswordStrengthRegularExpression |
Gets the regular expression used to evaluate a password.
|
| RequiresQuestionAndAnswer |
Gets a value indicating whether the repository is configured to require the user to answer a password question for password reset and retrieval.
|
| RequiresUniqueEmail |
Gets a value indicating whether the repository is configured to require a unique e-mail address for each user name.
|
Methods| Name | Description | |
|---|---|---|
 | AddWindowsAccount(NTAccount) |
Adds a new windows account to the Visual Guard repository.
|
| AddWindowsAccount(NTAccount, VGMembershipCreateStatus) |
Adds a new windows account to the Visual Guard repository.
|
| ApproveUser | Approved a user. |
| ChangePassword |
Updates the password for the membership user in the Visual Guard repository.
|
| ChangePasswordQuestionAndAnswer |
Updates the password question and answer for the membership user in the Visual Guard repository
|
| ConvertUsernameToRepositoryId |
Converts the username of a user to a Visual Guard unique repository id for the specified authentication mode
|
| CreateInstance |
Creates a VGMembershipInstance using a specific security runtime
|
| CreateUser(String, String) |
Adds a new user to the Visual Guard repository.
|
| CreateUser(String, String, String) |
Adds a new user to the Visual Guard repository.
|
| CreateUser(String, String, String, String, String, Boolean, String, VGMembershipCreateStatus) |
Adds a new user to the Visual Guard repository.
|
| CreateUser(String, String, String, String, String, Boolean, String, String, String, VGMembershipCreateStatus) |
Adds a new user to the Visual Guard repository.
|
| CreateUser(String, String, String, String, String, Boolean, String, String, String, Boolean, VGMembershipCreateStatus) |
Adds a new user to the Visual Guard repository.
|
| DeleteUser(String) |
Deletes a user from the repository.
|
| DeleteUser(String, Boolean) |
Deletes a user from the repository.
|
| DeleteUserById |
Deletes a user specified by its repository id from the repository.
|
| DeleteWindowsAccount(NTAccount) |
Deletes a windows account from the repository.
|
| DeleteWindowsAccount(NTAccount, Boolean) |
Deletes a windows account from the repository.
|
| DisapproveUser | Disappove a user |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindUsersByAuthenticationMode(VGAuthenticationMode) |
Gets a collection of membership users where the user authentication mode contains the specified user authentication mode to match.
|
| FindUsersByAuthenticationMode(VGAuthenticationMode, Int32, Int32, Int32) |
Gets a collection of membership users where the user authentication mode contains the specified user authentication mode to match.
|
| FindUsersByEmail(String) |
Gets a collection of membership users where the e-mail address contains the specified e-mail address to match.
|
| FindUsersByEmail(String, Int32, Int32, Int32) |
Gets a collection of membership users, in a page of data, where the e-mail address contains the specified e-mail address to match.
|
| FindUsersByLastName(String) |
Gets a collection of membership users where the last name contains the specified user name to match.
|
| FindUsersByLastName(String, Int32, Int32, Int32) |
Gets a collection of membership users where the last name contains the specified name to match.
|
| FindUsersByName(String) |
Gets a collection of membership users where the user name contains the specified user name to match.
|
| FindUsersByName(String, Guid) |
Gets a collection of membership users where the user name contains the specified user name to match.
|
| FindUsersByName(String, Int32, Int32, Int32) |
Gets a collection of membership users where the user name contains the specified user name to match.
|
| FindUsersByName(String, Int32, Int32, Int32, Guid) |
Gets a collection of membership users where the user name contains the specified user name to match.
|
| FindUsersByState(VGMemberShipUserState) |
Gets a collection of membership users where the user state is Locked / Unlocked or Approved / UnApproved.
|
| FindUsersByState(VGMemberShipUserState, Int32, Int32, Int32) |
Gets a collection of membership users where the user state is Locked / Unlocked or Approved / UnApproved.
|
| FindUsersInApplication(Guid) |
Gets a collection of membership users where the application name contains the specified application name to match.
|
| FindUsersInApplication(Guid, Int32, Int32, Int32) |
Gets a collection of membership users where the application name contains the specified application name to match.
|
| FindUsersWithoutApplications |
Gets a collection of membership users without applications.
|
| FindUsersWithoutApplications(Int32, Int32, Int32) |
Gets a collection of membership users without applications.
|
| GetAllUsers |
Gets a collection of all the users in the repository.
|
| GetAllUsers(Int32, Int32, Int32) |
Gets a collection of all the users in the repository in pages of data.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUser |
Gets the information from the repository and updates the last-activity date/time stamp for the current logged-on membership user.
|
| GetUser(String) |
Gets the information from the repository for the specified membership user.
|
| GetUser(String, VGAuthenticationMode) |
Gets the information from the repository for the specified membership user with the specified authenication mode.
|
| GetUserById | Obsolete.
Gets the information from the repository for the user identified by the specified Visual Guard repository id.
|
| GetUserIdByEmail |
Gets the repository id of a user where the e-mail address matches the specified e-mail address.
|
| GetUserNameByEmail |
Gets a user name where the e-mail address for the user matches the specified e-mail address.
|
| GrantMembershipPermission(String) |
Grants the permission to use the Membership API to edit, create, delete or assign role to users for the current application
|
| GrantMembershipPermission(String, Guid) |
Grants the permission to use the Membership API to edit, create, delete or assign role to users for the current application
|
| LockUser | Clears the user's locked-out status so that the membership user can be unvalidated. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RevokeMembershipPermission(String) |
Revokes the permission to use the Membership API to edit, create, delete or assign role to users for the current application
|
| RevokeMembershipPermission(String, Guid) |
Revokes the permission to use the Membership API to edit, create, delete or assign role to users for the current application
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnlockUser | Clears the user's locked-out status so that the membership user can be validated. |
| UpdateUser |
Updates the repository with the information for the specified user.
|
| ValidateUser |
Verifies that the supplied user name and password are valid.
|
Events| Name | Description | |
|---|---|---|
 | ValidatingPassword |
Occurs when a user is created, a password is changed, or a password is reset.
|
RemarksThis class is used by the applications to manage user settings. The Membership class provides the same facilities as the System.Web.Security.Membership class:
Creating new users.
Storing membership information (user names, passwords, e-mail addresses, and supporting data) in a Visual Guard repository.
Managing passwords, which includes creating, changing, retrieving, and resetting them, and so on. You can optionally configure the Visual Guard repository to require a password question and answer to authenticate password reset or retrieval requests for users that have forgotten their password.
See Also