VGMembershipUser Class

Exposes and updates membership user information in the Visual Guard repository.

Inheritance Hierarchy

SystemObject
Novalys.VisualGuard.Security.MembershipVGMembershipUser

Namespace: Novalys.VisualGuard.Security.Membership
Assembly: Novalys.VisualGuard.Security (in Novalys.VisualGuard.Security.dll) Version: 2019.1.831.19 (2019.1.0831.19)

Syntax

Copy

[SerializableAttribute]
public sealed class VGMembershipUser : VGIMembershipObject, 
	VGIDocumentationMembershipObject

<SerializableAttribute>
Public NotInheritable Class VGMembershipUser
	Implements VGIMembershipObject, VGIDocumentationMembershipObject

The VGMembershipUser type exposes the following members.

Properties

	Name	Description
	ApplicationId	Gets the unique identifier of the application for which the user was created
	AuthenticationMode	Gets a value indicating the mode of authentication used by Visual Guard to authenticate the given user.
	Comment	Gets or sets repository-specific information for the membership user.
	CreationDate	Gets the date and time when the user was added to the repository. (Server Time)
	CreationDateLT	Gets the date and time when the user was added to the repository. (Local Time)
	Email	Gets or sets the e-mail address for the membership user.
	EndDate	Gets the end date for the membership user.
	FirstName	Gets or sets the first name of the membership user.
	GraceLoginRemaining	Gets the number of logons that are allowed before the account is locked out.
	Id	Gets a id of the user
	IdentityInformation	Return the information of the user
	IsApproved	Gets or sets whether the membership user can be authenticated.
	IsDirty	Obsolete. Gets a value indicating whether the VGMembershipUser has been modified.
	IsLockedOut	Gets a value indicating whether the membership user is locked out and unable to be validated.
	IsMemberOfAnotherApplication	Returns a boolean value indicating whether the user is a member of an application different from the current application
	IsMemberOfApplication	Returns a boolean value indicating whether the user is a member of the current application.
	IsPasswordExpired	Gets a boolean value that specifies whether the password for the user has expired.
	ItemGuid
	ItemString
	ItemVGGroup, Guid
	ItemVGGroup, String
	LastActivityDate	Gets or sets the date and time when the membership user was last authenticated or accessed the repository
	LastLockoutDate	Gets the most recent date and time that the membership user was locked out.
	LastLoginDate	Gets or sets the date and time when the user was last authenticated.
	LastModification	Gets the date and time when the user was last modified. (Server Time)
	LastModificationDate	Gets the date and time when the user was last modified.
	LastModificationLT	Gets the date and time when the user was last modified. (Local Time)
	LastName	Gets or sets the first name of the membership user.
	LastPasswordChangedDate	Gets the date and time when the membership user's password was last updated.
	MembershipPermission	Gets a value that indicates whether the current user can use Membership API to edit, create, delete or assign role to users for the current application
	MustChangePasswordAtNextLogon	Gets or sets a boolean value indicating when the password must be changed at next logon.
	Name	Gets name of the user
	PasswordExpirationDate	Gets the password expiration date and time.
	PasswordQuestion	Gets the password question for the membership user.
	ProfileValues	Gets User Profile values of the current user.
	RepositoryId	Gets the unique identifier of the information used to store in a repository
	Runtime	Return the current Runtime
	StartDate	Gets start date for the membership user.
	Title	Gets the title of the membership user.
	Type	Gets type of the entity
	UserName	Gets the logon name of the membership user.

Top

Methods

	Name	Description
	ChangePassword(SecureString, SecureString)	Updates the password for the membership user in the Visual Guard repository.
	ChangePassword(String, String)	Updates the password for the membership user in the Visual Guard repository.
	ChangePasswordQuestionAndAnswer(String, String)	Updates the password question and answer for the membership user in the Visual Guard repository
	ChangePasswordQuestionAndAnswer(String, String, String)	Updates the password question and answer for the membership user in the Visual Guard repository
	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.)
	GetAllProfileValues
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(Guid)
	GetValue(String)
	GetValue(VGProfileAttribute)
	GetValue(VGGroup, Guid)	Gets value for particular contextual group's user profile value by property Id.
	GetValue(VGGroup, String)	Gets value for particular contextual group's user profile value by property name.
	GetValueT(Guid)
	GetValueT(String)
	GetValueT(VGProfileAttribute)
	GetValueT(VGGroup, Guid)	Gets value for particular contextual group's user profile value by property Id.
	GetValueT(VGGroup, String)	Gets value for particular contextual group's user profile value by property name.
	GrantMembershipPermission	Grants the permission to use the Membership API to edit, create, delete or assign role to users for the current application
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ResetPassword	Resets a user's password to a new, automatically generated password.
	ResetPassword(String)	Resets a user's password to a new, automatically generated password.
	RevokeMembershipPermission	Revokes the permission to use the Membership API to edit, create, delete or assign role to users for the current application
	SetValue(Guid, Object)
	SetValue(String, Object)
	SetValue(VGGroup, Guid, Object)	Sets user profile value for particular contextual group by propertyId.
	SetValue(VGGroup, String, Object)	Sets user profile value for particular contextual group by propertyname.
	SetValueT(Guid, T)	Sets user profile value by propertyId.
	SetValueT(String, T)	Sets user profile value by propertyname.
	SetValueT(VGGroup, Guid, T)	Sets user profile value for particular contextual group by propertyId.
	SetValueT(VGGroup, String, T)	Sets user profile value for particular contextual group by propertyname.
	ToString	Returns the user name for the membership user. (Overrides ObjectToString.)
	UnlockUser	Clears the locked-out state of the user so that the membership user can be validated.

Top

Fields

	Name	Description
	DefaultInvalidCharsForName	An array of chars containing the list of invalid chars for a name ('\', '/', '?', '*', '%', ';', ''', '"', ':', '\|', '[', ']', '+', '=', ',').

Top

Remarks

The VGMembershipUser object is used to represent a single membership user in the Visual Guard repository. It exposes information about the membership user such as the e-mail address, and provides functionality for the membership user such as the ability to reset his or her password.

A VGMembershipUser object is returned by the GetUser(String) and CreateUser(String, String) methods or as part of a VGMembershipUserCollection returned by the GetAllUsers, FindUsersByName(String), and FindUsersByEmail(String) methods.

A VGMembershipUser object is required by the UpdateUser(VGMembershipUser) method when you want to update the information for an existing membership user.

Reference

Novalys.VisualGuard.Security.Membership Namespace