IUserInfo Interface

Objects containing UserInfo properties.

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 10.0.0

Syntax

public interface IUserInfo : IDataContainer, 
	ISimpleDataContainer

The IUserInfo type exposes the following members.

Properties

	Name	Description
Public property	ColumnNames	Column names. (Inherited from IDataContainer.)
Public property	Email	E-mail address of the user.
Public property	Enabled	Indicates if the user is enabled.
Public property	FirstName	First name of the user.
Public property	FullName	Full name of the user.
Public property	Item	Gets or sets the value of the column. (Inherited from ISimpleDataContainer.)
Public property	LastLogon	Last logon date and time of the user.
Public property	LastName	Last name of the user.
Public property	MiddleName	Middle name of the user.
Public property	PasswordFormat	Format of the user password.
Public property	PreferredCultureCode	Preferred culture code.
Public property	PreferredUICultureCode	Preferred UI culture code.
Public property	ResourceUIElements	Obsolete. Gets UI elements within each module across all sites the user can see.
Public property	SiteCultures	Obsolete. Gets the user's allowed cultures.
Public property	SitesRoles	Gets the HashTable of the user sites and roles.
Public property	UserAuthenticationGUID	Temporary GUID for user identification for automatic sign-in in the CMS Desk.
Public property	UserAvatarID	User avatar ID.
Public property	UserCampaign	User campaign.
Public property	UserCreated	Date and time when was the user created.
Public property	UserDescription	User description.
Public property	UserEnabled	Indicates whether the user is enabled.
Public property	UserGlobalAccessDisabled	Obsolete. Indicates whether user with global admin flag is able to manage global applications and functionality. This property is considered for internal purposes only and should not be used in custom code.
Public property	UserGUID	User GUID.
Public property	UserHasAllowedCultures	Indicates if the user has allowed more than one culture.
Public property	UserID	User ID.
Public property	UserIsDomain	Determines whether user is domain user.
Public property	UserIsExternal	Indicates if the user is external.
Public property	UserIsGlobalAdministrator	Obsolete. True if the user is the global administrator.
Public property	UserIsHidden	Indicates if the user is hidden.
Public property	UserLastModified	Date and time of the user last modification.
Public property	UserMessagingNotificationEmail	Messaging notification email.
Public property	UserName	User name.
Public property	UserNickName	User nick name.
Public property	UserPasswordFormat	Format of the user's password.
Public property	UserPicture	User picture.
Public property	UserSignature	User signature.
Public property	UserStartingAliasPath	Starting alias path of the user.
Public property	UserTimeZoneID	User time zone ID
Public property	UserTokenID	TokenID for multi-factor authentization.
Public property	UserURLReferrer	URL Referrer of user.
Public property	UserVisibility	Contains XML with user's custom form field visibility settings.

Methods

	Name	Description
Public method	ContainsColumn	Returns true if the object contains specified column. (Inherited from IDataContainer.)
Public method	FilterSearchResults	Filters the user search results
Public method	GetValue	Returns value of column. (Inherited from ISimpleDataContainer.)
Public method	CheckPrivilegeLevel	Returns true if user fulfils the required privilege level (the higher level contains all children: GlobalAdmin -> Admin -> Editor -> None)
Public method	IsAuthorizedPerClassName	Checks whether the user is authorized for given class name and permission, returns true if so.
Public method	IsAuthorizedPerResource	Returns true if given user is granted with specified permission.
Public method	IsPublic	Returns true if the user is public user record.
Public method	SetValue	Sets value of column. (Inherited from ISimpleDataContainer.)
Public method	TryGetValue	Returns value of column. (Inherited from IDataContainer.)

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)