IUser Interface |
Represents a user in the Content Store. The Ingeniux CMS CSAPI is an protected environment that requires a user account to create any kind of reading or writing sessions.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe IUser type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Activities | |
| Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity.) |
| AssetCount |
Returns the number of assets assigned to a user.
|
| AssignmentCount |
Returns the number of content items assigned to a user.
|
| Created |
Gets the entity's creation date.
(Inherited from IEntity.) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity.) |
| Disabled |
Gets/sets whether the user is disabled
Disabled users cannot login until re-enabled
|
| DynamicProperties | |
| EmailAddress |
Gets and sets the email address of this User.
|
| IntegratedMembershipProvider |
Gets and sets the full name of the Type of the provider object that authenticates this user.
|
| IP |
Gets the IP Address of the browser's computer.
(Inherited from IReadonlyUser.) |
| IsAdministrator |
Gets whether the user is an administrator. Administrators have the privilege of working with any object in the CSAPI.
|
| IsTaskUser |
Gets/set whether this user will be a task user.
Task users are only allowed for task execution. They cannot log in to CMS client
(Inherited from IReadonlyUser.) |
| LastLogin |
Gets the time when this user last logged in.
(Inherited from IReadonlyUser.) |
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity.) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.) |
| PageCount |
Returns the number of pages assigned to a user.
|
| Profile |
Gets user's profile information
|
| ProfileImage |
Gets/sets the user's picture
|
| ReadLocales |
Gets and sets the Languages this user can read.
|
| ReceiveWorkFlowNotificationMail | |
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.) |
| Theme | |
| Title |
Gets/sets the user's title
|
| UserId |
Gets the UserId of the user.
(Inherited from IReadonlyUser.) |
| UserRights |
Gets the collection of User Rights for this User.
|
| WriteLocales |
Gets and sets the Languages this user can write.
|
Methods| Name | Description | |
|---|---|---|
 | GroupIds | |
| Groups |
Retrieves in a paginated fashion the Groups this user belongs to.
|
| GroupsCount |
Gets the count of Groups this user belongs to.
|
| IsMemberOf |
Checked whether this user is a member of the specified Group.
|
| Notifications |
Gets the collection Notifications issued to this User.
|
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.) |
| UserRightGranted |
Checks whether the specified User Right is granted to this User.
|
| ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity.) |
Events| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.) |
RemarksUser objects are retrieved directly from Session objects.
C#
IUser currentUser = Session.OperatingUser;
See Also