VGRole Class

Exposes and updates role information in the Visual Guard repository.

Inheritance Hierarchy

SystemObject
Novalys.VisualGuard.Security.MembershipVGRole

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 VGRole : VGIMembershipObject, 
	VGIDocumentationMembershipObject, VGIAuditInformation, VGIMatrixSupported

<SerializableAttribute>
Public NotInheritable Class VGRole
	Implements VGIMembershipObject, VGIDocumentationMembershipObject, VGIAuditInformation, VGIMatrixSupported

The VGRole type exposes the following members.

Properties

	Name	Description
	ApplicationId	Gets the unique identifier of the application of the role
	CanBeGrantedToGroup	Gets or sets whether this role can be granted to group or not.
	CanBeGrantedToUser	Gets or sets whether this role can be granted to user or not.
	Comment	Gets or sets a short description of the role.
	GrantedPermissions	Gets Granted permissions to role.
	Id	Return the ID of role
	IsAnonymous	Gets a boolean value indicating whether the role is an anonymous role
	IsBuiltIn	Gets a boolean value indicating whether the role is a built-in role and cannot be modified or deleted
	IsDefault	Gets a boolean value indicating whether the role is an default role for a current application
	IsMembershipManagerRole	Return true if this role is Membership Role
	IsSharedRole	Gets a boolean value indicating whether the role is a shared role
	ItemGuid	Gets or sets profileAttribute Value by attribute's Id.
	ItemString	Gets or sets profileAttribute Value by attribute's propertyName.
	LastModification	Return the last modification date (Server Time)
	LastModificationDate	Gets or sets the date and time when the role was last modified.
	LastModificationLT	Return the last modification date (Lcoal Time)
	Name	Gets or sets the name of the role.
	PermissionSet	Obsolete. Gets or sets the permission set granted to the role.
	PermissionSets	Gets permission set list granted to the role.
	RepositoryId	Gets the unique identifier from the repository for the role.
	RoleId	Gets a VGRoleIdof role
	Type	Gets entityType

Top

Methods

	Name	Description
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(Guid)	Gets profileattribute Value by attributeId
	GetValue(String)	Gets profileAttribute Value by propertyName
	GetValueT(Guid)	Gets profileattribute Value by attributeId
	GetValueT(String)	Gets profileAttribute Value by propertyName
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetValue(Guid, Object)	Sets profileattribute Value by attributeId
	SetValue(String, Object)	Sets profileattribute Value by propertyname
	SetValueT(Guid, T)	Sets profileattribute Value by attributeId
	SetValueT(String, T)	Sets profileattribute Value by propertyname
	ToString	Returns the name of the role. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	Equality	VGRole check if both VGrole are equals
	Inequality	VGRole check if both VGrole are NOT equals

Top

Remarks

The VGRole object is used to represent a role in the Visual Guard repository. It exposes information about the role such as the id, name, description and permission sets, and provides functionality for the role such as change the list of members.

A VGRole object is returned by the GetRole(String) and CreateRole(String, String, Guid) methods or as part of a VGRoleCollection returned by the GetAllRoles, GetRolesForUser(String) methods.

A VGRole object is required by the UpdateRole(VGRole) method when you want to update the information for an existing role.

Reference

Novalys.VisualGuard.Security.Membership Namespace