Class User
- Namespace
- Dynamicweb.Security.UserManagement
- Assembly
- Dynamicweb.Core.dll
Represents a user.
[Serializable]
[PermissionEntity("User")]
public class User : IPermissionEntity, IPermissionEntityLookup
- Inheritance
-
User
- Implements
- Inherited Members
- Extension Methods
Constructors
User()
Creates a new instance of a class.
public User()
User(string)
Creates a new instance of a class.
public User(string userName)
Parameters
userName
stringInitial user-name to be assigned to the user.
Fields
ImportedUserID
public static readonly int ImportedUserID
Field Value
ImportedUserName
public static readonly string ImportedUserName
Field Value
NotLoggedInFrontendUserID
public static readonly int NotLoggedInFrontendUserID
Field Value
NotLoggedInFrontendUserName
public static readonly string NotLoggedInFrontendUserName
Field Value
Properties
Active
Gets or sets value indicating whether user is active.
public bool Active { get; set; }
Property Value
- bool
Value indicating whether user is active.
Address
Gets or sets user's primary address.
public string Address { get; set; }
Property Value
- string
User's primary address.
Address2
Gets or sets user's secondary address.
public string Address2 { get; set; }
Property Value
- string
User's secondary address.
AddressCustomFieldValues
Custom fields of the users default address.
public CustomFieldValueCollection AddressCustomFieldValues { get; set; }
Property Value
AddressTitle
Gets or sets user address title.
public string AddressTitle { get; set; }
Property Value
- string
User address title.
AllowBackend
Gets or sets allow backend property value
public bool AllowBackend { get; set; }
Property Value
ApprovalKey
Gets or sets approval key
public string? ApprovalKey { get; set; }
Property Value
City
Gets or sets user's city.
public string City { get; set; }
Property Value
- string
User's city.
Company
Gets or sets user's company name.
public string Company { get; set; }
Property Value
- string
User's company name.
Country
Gets or sets user's country.
public string Country { get; set; }
Property Value
- string
User's country.
CountryCode
Gets or sets user's country code
public string CountryCode { get; set; }
Property Value
CreatedByUser
Gets user who created current user
public string CreatedByUser { get; }
Property Value
- string
String value
CreatedOn
Gets "crated on" date
public DateTime? CreatedOn { get; }
Property Value
- DateTime?
DateTime or null value
Currency
Gets or sets user's currency name.
public string Currency { get; set; }
Property Value
- string
User's currency name.
CustomFieldValues
Gets or sets custom field values
public CustomFieldValueCollection CustomFieldValues { get; set; }
Property Value
CustomerNumber
Gets or sets user's customer number.
public string CustomerNumber { get; set; }
Property Value
- string
User's customer number.
Department
Gets or sets user's department name.
public string Department { get; set; }
Property Value
- string
User's department name.
Gets or sets user's e-mail address.
public string Email { get; set; }
Property Value
- string
User's e-mail address.
EmailAllowed
public bool EmailAllowed { get; set; }
Property Value
EmailPermissionGivenOn
Gets "Email permission given on" date
public DateTime? EmailPermissionGivenOn { get; }
Property Value
- DateTime?
DateTime or null value
EmailPermissionUpdatedOn
Gets "Email permission updated on" date
public DateTime? EmailPermissionUpdatedOn { get; }
Property Value
- DateTime?
DateTime or null value
Exported
Gets or sets user last exported date
public DateTime? Exported { get; set; }
Property Value
ExternalID
Get or sets user's external id.
public string ExternalID { get; set; }
Property Value
- string
external user's id (if any)
Fax
Gets or sets user's fax number
public string Fax { get; set; }
Property Value
- string
User's fax number.
FirstName
Gets or sets user's first name.
public string FirstName { get; set; }
Property Value
- string
User's first name.
FrontendStartPage
Gets or sets the page that the user is redirected to on login
public string FrontendStartPage { get; set; }
Property Value
- string
String value
GeolocationHashCode
Gets or sets geo location hash value
public string? GeolocationHashCode { get; set; }
Property Value
- string
String value
GeolocationIcon
Gets or sets geo location image
public string? GeolocationIcon { get; set; }
Property Value
GeolocationLatitude
Gets geo location latitude
public double GeolocationLatitude { get; set; }
Property Value
- double
Double value
GeolocationLongitude
Gets geo location longitude
public double GeolocationLongitude { get; set; }
Property Value
- double
Double value
HouseNumber
Gets or sets user's house number.
public string HouseNumber { get; set; }
Property Value
- string
User's house number.
ID
Gets the identifier.
public int ID { get; }
Property Value
Image
Gets or sets path to the user's image.
public string Image { get; set; }
Property Value
- string
Path to the user's image.
InformationSentDate
Gets the last date when user information was sent to the user.
public DateTime? InformationSentDate { get; }
Property Value
IsAdmin
Returns true if this user is Admin or Administrator
public bool IsAdmin { get; }
Property Value
IsAngel
Gets or sets value indicating whether current user's type is "Angel".
public bool IsAngel { get; }
Property Value
- bool
Value indicating whether current user's type is "Angel".
IsBuiltInAdmin
Returns true if this user is built-in Admin or Administrator
public bool IsBuiltInAdmin { get; }
Property Value
IsGeolocationCustom
Gets or sets "Geo location is custom" sign
public bool IsGeolocationCustom { get; set; }
Property Value
IsLivePricesDisabled
Gets or sets DisableLivePrices
public bool IsLivePricesDisabled { get; set; }
Property Value
- bool
True or false
IsNew
public bool IsNew { get; }
Property Value
IsValid
Shows if user data is valid
public bool IsValid { get; }
Property Value
- bool
True or false
ItemId
Gets or sets the Id of the associated content item.
public string? ItemId { get; set; }
Property Value
ItemType
Gets or sets the type of the associated item.
public string? ItemType { get; set; }
Property Value
JobTitle
Gets or sets user's job title.
public string JobTitle { get; set; }
Property Value
- string
User's job title.
LastLogOnOn
Gets date of last login
public DateTime? LastLogOnOn { get; }
Property Value
- DateTime?
DateTime or null value
LastName
Gets or sets user's last name.
public string LastName { get; set; }
Property Value
- string
User's last name.
MiddleName
Gets or sets user's middle name.
public string MiddleName { get; set; }
Property Value
- string
User's middle name.
Name
Gets or sets user's name.
public string Name { get; set; }
Property Value
- string
User's name.
Password
Gets or sets user's password.
public string Password { get; set; }
Property Value
- string
User's password.
PasswordDate
Stores and retrieves password date value.
public DateTime PasswordDate { get; set; }
Property Value
- DateTime
Data
PasswordRecoveryToken
Gets or sets the password recovery token.
public string? PasswordRecoveryToken { get; set; }
Property Value
- string
The password recovery token.
PasswordRecoveryTokenExpirationTime
Gets or sets the password recovery token expiration time.
public DateTime PasswordRecoveryTokenExpirationTime { get; set; }
Property Value
- DateTime
The password recovery token expiration time.
Phone
Gets or sets user's phone number.
public string Phone { get; set; }
Property Value
- string
User's phone number.
PhoneBusiness
Gets or sets user's business phone number.
public string PhoneBusiness { get; set; }
Property Value
- string
User's business phone number.
PhoneMobile
Gets or sets user's mobile phone number.
public string PhoneMobile { get; set; }
Property Value
- string
User's mobile phone number.
PhonePrivate
Gets or sets user's private phone number.
public string PhonePrivate { get; set; }
Property Value
- string
User's private phone number.
PointBalance
Gets user's loyalty points balance
public double PointBalance { get; set; }
Property Value
- double
User's loyalty points balance.
ProfileCreated
Shows if profile was created
public bool ProfileCreated { get; }
Property Value
- bool
True or false
ProfileCreatedDate
Gets or sets the profile created date
public DateTime? ProfileCreatedDate { get; set; }
Property Value
- DateTime?
The profile created date
Region
Gets user's region info
public RegionInfo? Region { get; }
Property Value
ReverseChargeForVat
Gets or sets the value indicating whether the prices for this User has reverse charge for VAT.
public bool ReverseChargeForVat { get; set; }
Property Value
ShopID
Gets or sets shop identifier
public string? ShopID { get; set; }
Property Value
- string
String value
State
Gets or sets user's state.
public string State { get; set; }
Property Value
- string
User's state.
StockLocationID
Gets or sets user's stock location id.
public long StockLocationID { get; set; }
Property Value
SystemFieldValues
Gets or sets system field values
public SystemFieldValueCollection SystemFieldValues { get; set; }
Property Value
Title
Gets or sets user's title.
public string Title { get; set; }
Property Value
- string
User's title.
UniqueId
Gets or sets the unique identifier.
public Guid UniqueId { get; set; }
Property Value
UpdatedByUser
Gets user who updated current user
public string UpdatedByUser { get; }
Property Value
- string
String value
UpdatedOn
Gets "updated on" date
public DateTime? UpdatedOn { get; }
Property Value
- DateTime?
DateTime or null value
UserAndGroupTypeSystemName
Gets or sets the SystemName.
public string? UserAndGroupTypeSystemName { get; set; }
Property Value
UserName
Gets or sets user's user-name.
public string UserName { get; set; }
Property Value
- string
User's user-name.
UserType
Gets or sets user's type.
public UserType UserType { get; set; }
Property Value
- UserType
User's type.
ValidFrom
Gets or sets user's validity starting date.
public DateTime ValidFrom { get; set; }
Property Value
- DateTime
User's validity starting date.
ValidTo
Gets or sets user's validity ending date.
public DateTime ValidTo { get; set; }
Property Value
- DateTime
User's validity ending date.
VatRegNumber
A value added tax identification number.
public string VatRegNumber { get; set; }
Property Value
Zip
Gets or sets user's zip code.
public string Zip { get; set; }
Property Value
- string
User's zip code.
Methods
GetAddresses()
public IEnumerable<UserAddress> GetAddresses()
Returns
GetAllowBackendWithInheritance()
public bool GetAllowBackendWithInheritance()
Returns
GetAncestorGroups()
Gets the ancestor groups
public IEnumerable<UserGroup> GetAncestorGroups()
Returns
GetGroups()
Gets the users groups.
public IEnumerable<UserGroup> GetGroups()
Returns
GetRegions()
Returns countries in the ISO format
public static List<RegionInfo> GetRegions()
Returns
GetUserAndGroupType()
Gets the UserAndGroupType.
public UserAndGroupType? GetUserAndGroupType()