Click or drag to resize

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.3.169
Syntax
public interface IUser : IEntity<IUserManager>, 
	IEntity, IEntityEvents, IReadonlyUser

The IUser type exposes the following members.

Properties
  NameDescription
Public propertyActivities
Gets the Actities of the user, including its recently visited Pages and its favorite Pages.
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 propertyDisabled
Gets/sets whether the user is disabled Disabled users cannot login until re-enabled
Public propertyDynamicProperties
Public propertyEmailAddress
Gets and sets the email address of this User.
Public propertyIntegratedMembershipProvider
Gets and sets the full name of the Type of the provider object that authenticates this user.
Public propertyIP
Gets the IP Address of the browser's computer.
(Inherited from IReadonlyUser.)
Public propertyIsAdministrator
Gets whether the user is an administrator. Administrators have the privilege of working with any object in the CSAPI.
(Inherited from IReadonlyUser.)
Public propertyLastLogin
Gets the time when this user last logged in.
(Inherited from IReadonlyUser.)
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 propertyPageCount
Returns the number of pages assigned to a user.
Public propertyProfile
Gets user's profile information
Public propertyProfileImage
Gets/sets the user's picture
Public propertyReadLocales
Gets and sets the Languages this user can read.
Public propertyReceiveWorkFlowNotificationMail
Gets and sets whether this user will receive notification emails after a Page advances through is Workflow.
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 propertyTitle
Gets/sets the user's title
Public propertyUserId
Gets the UserId of the user.
(Inherited from IReadonlyUser.)
Public propertyUserRights
Gets the collection of User Rights for this User.
Public propertyWriteLocales
Gets and sets the Languages this user can write.
Top
Methods
  NameDescription
Public methodGroupIds
Public methodGroups
Retrieves in a paginated fashion the Groups this user belongs to.
Public methodGroupsCount
Gets the count of Groups this user belongs to.
Public methodIsMemberOf
Checked whether this user is a member of the specified Group.
Public methodNotifications
Gets the collection Notifications issued to this User.
Public methodUserRightGranted
Checks whether the specified User Right is granted to this User.
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
Remarks

User objects are retrieved directly from Session objects.

C#
IUser currentUser = Session.OperatingUser;
See Also