Click or drag to resize

IUserGroup Interface


Represents a collection of Users that share the same Security Permissions.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface IUserGroup : IEntity<IUserManager>, 
	IEntity, IEntityEvents

The IUserGroup type exposes the following members.

Properties
  NameDescription
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyGroupType
Gets/sets the type name of the group. The type of the group is just arbitrary metadata. However, it is useful to identify the purpose of the group.
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Public propertyUserRights
Gets and sets the Security Permissions this group carries.
Top
Methods
  NameDescription
Public methodAddUser
Adds a User to this group.
Public methodDenyUserRight
Denies a specific set of permissions to this group.
Public methodGrantUserRight
Grants a specific set of permissions to this group.
Public methodHasMember
Verifies whether the specified User is a member of this group.
Public methodRemoveUser
Removes a User from this group.
Public methodUserRightGranted
Checks whether a specific set of permissions is granted to this group.
Public methodUsers
Retrieves, in a paginated fashion, the collection of Users that belong to this group.
Public methodUsersCount
Gets the count of Users that belong to this group.
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity.)
Top
Events
  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Top
See Also