Class UserController

Inheritance

object

ServiceLocator<IUserController, UserController>

UserController

Implements

IUserController

Inherited Members

ServiceLocator<IUserController, UserController>.SetTestableInstance(IUserController)

ServiceLocator<IUserController, UserController>.ClearInstance()

ServiceLocator<IUserController, UserController>.GetFactory()

ServiceLocator<IUserController, UserController>.Instance

ServiceLocator<IUserController, UserController>.Factory

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Entities.Users

Assembly: DotNetNuke.dll

Syntax

public class UserController : ServiceLocator<IUserController, UserController>, IUserController

Constructors

UserController()

Declaration

public UserController()

Properties

DisplayFormat

Declaration

public string DisplayFormat { get; set; }

Property Value

Type	Description
string

PortalId

Declaration

public int PortalId { get; set; }

Property Value

Type	Description
int

Methods

AddUserPortal(int, int)

Declaration

public static void AddUserPortal(int portalId, int userId)

Parameters

Type	Name	Description
int	portalId
int	userId

ApproveUser(UserInfo)

Declaration

public static void ApproveUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

ChangePassword(UserInfo, string, string)

Declaration

public static bool ChangePassword(UserInfo user, string oldPassword, string newPassword)

Parameters

Type	Name	Description
UserInfo	user
string	oldPassword
string	newPassword

Returns

Type	Description
bool

ChangePasswordByToken(int, string, string, string)

Declaration

public static bool ChangePasswordByToken(int portalid, string username, string newPassword, string resetToken)

Parameters

Type	Name	Description
int	portalid
string	username
string	newPassword
string	resetToken

Returns

Type	Description
bool

ChangePasswordByToken(int, string, string, string, string, out string)

Declaration

public static bool ChangePasswordByToken(int portalid, string username, string newPassword, string answer, string resetToken, out string errorMessage)

Parameters

Type	Name	Description
int	portalid
string	username
string	newPassword
string	answer
string	resetToken
string	errorMessage

Returns

Type	Description
bool

ChangePasswordByToken(int, string, string, string, out string)

Declaration

[Obsolete("Deprecated in DotNetNuke 7.4.2. Use ChangePasswordByToken(int portalid, string username, string newPassword, string answer, string resetToken, out string errorMessage). Scheduled for removal in v10.0.0.")]
public static bool ChangePasswordByToken(int portalid, string username, string newPassword, string resetToken, out string errorMessage)

Parameters

Type	Name	Description
int	portalid
string	username
string	newPassword
string	resetToken
string	errorMessage

Returns

Type	Description
bool

ChangePasswordQuestionAndAnswer(UserInfo, string, string, string)

Declaration

public static bool ChangePasswordQuestionAndAnswer(UserInfo user, string password, string passwordQuestion, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user
string	password
string	passwordQuestion
string	passwordAnswer

Returns

Type	Description
bool

ChangeUsername(int, string)

Declaration

public static void ChangeUsername(int userId, string newUsername)

Parameters

Type	Name	Description
int	userId
string	newUsername

CheckInsecurePassword(string, string, ref UserLoginStatus)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.8.1. No alternative method implemented. Scheduled for removal in v11.0.0.")]
public static void CheckInsecurePassword(string username, string password, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
string	username
string	password
UserLoginStatus	loginStatus

CopyUserToPortal(UserInfo, PortalInfo, bool)

Declaration

public static void CopyUserToPortal(UserInfo user, PortalInfo destinationPortal, bool mergeUser)

Parameters

Type	Name	Description
UserInfo	user
PortalInfo	destinationPortal
bool	mergeUser

CreateUser(ref UserInfo)

Declaration

public static UserCreateStatus CreateUser(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
UserCreateStatus

CreateUser(ref UserInfo, bool)

Declaration

public static UserCreateStatus CreateUser(ref UserInfo user, bool sendEmailNotification)

Parameters

Type	Name	Description
UserInfo	user
bool	sendEmailNotification

Returns

Type	Description
UserCreateStatus

DeleteUnauthorizedUsers(int)

Declaration

public static void DeleteUnauthorizedUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

DeleteUser(ref UserInfo, bool, bool)

Declaration

public static bool DeleteUser(ref UserInfo user, bool notify, bool deleteAdmin)

Parameters

Type	Name	Description
UserInfo	user
bool	notify
bool	deleteAdmin

Returns

Type	Description
bool

DeleteUsers(int, bool, bool)

Declaration

public static void DeleteUsers(int portalId, bool notify, bool deleteAdmin)

Parameters

Type	Name	Description
int	portalId
bool	notify
bool	deleteAdmin

GeneratePassword()

Declaration

public static string GeneratePassword()

Returns

Type	Description
string

GeneratePassword(int)

Declaration

public static string GeneratePassword(int length)

Parameters

Type	Name	Description
int	length

Returns

Type	Description
string

GetCachedUser(int, string)

Declaration

public static UserInfo GetCachedUser(int portalId, string username)

Parameters

Type	Name	Description
int	portalId
string	username

Returns

Type	Description
UserInfo

GetDefaultUserSettings()

Declaration

public static Hashtable GetDefaultUserSettings()

Returns

Type	Description
Hashtable

GetDeletedUsers(int)

Declaration

public static ArrayList GetDeletedUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetDuplicateEmailCount()

Declaration

public static int GetDuplicateEmailCount()

Returns

Type	Description
int

GetFactory()

Declaration

protected override Func<IUserController> GetFactory()

Returns

Type	Description
Func<IUserController>

Overrides

ServiceLocator<IUserController, UserController>.GetFactory()

GetOnlineUsers(int)

Declaration

[Obsolete("Deprecated in DotNetNuke 8.0.0. Other solutions exist outside of the DNN Platform. Scheduled for removal in v11.0.0.")]
public static ArrayList GetOnlineUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetPassword(ref UserInfo, string)

Declaration

public static string GetPassword(ref UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user
string	passwordAnswer

Returns

Type	Description
string

GetProfileAvatarAbsoluteUrl(int, UserInfo, int, int, bool)

Declaration

public static string GetProfileAvatarAbsoluteUrl(int portalId, UserInfo user, int width = 64, int height = 64, bool showSuperUsers = true)

Parameters

Type	Name	Description
int	portalId
UserInfo	user
int	width
int	height
bool	showSuperUsers

Returns

Type	Description
string

GetUnAuthorizedUsers(int)

Declaration

public static ArrayList GetUnAuthorizedUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetUnAuthorizedUsers(int, bool, bool)

Declaration

public static ArrayList GetUnAuthorizedUsers(int portalId, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUser(int, int)

Declaration

public UserInfo GetUser(int portalId, int userId)

Parameters

Type	Name	Description
int	portalId
int	userId

Returns

Type	Description
UserInfo

GetUserByDisplayname(int, string)

Declaration

public UserInfo GetUserByDisplayname(int portalId, string displayName)

Parameters

Type	Name	Description
int	portalId
string	displayName

Returns

Type	Description
UserInfo

GetUserByEmail(int, string)

Declaration

public static UserInfo GetUserByEmail(int portalId, string emailToMatch)

Parameters

Type	Name	Description
int	portalId
string	emailToMatch

Returns

Type	Description
UserInfo

GetUserById(int, int)

Declaration

public static UserInfo GetUserById(int portalId, int userId)

Parameters

Type	Name	Description
int	portalId
int	userId

Returns

Type	Description
UserInfo

GetUserByName(int, string)

Declaration

public static UserInfo GetUserByName(int portalId, string username)

Parameters

Type	Name	Description
int	portalId
string	username

Returns

Type	Description
UserInfo

GetUserByName(string)

Declaration

public static UserInfo GetUserByName(string username)

Parameters

Type	Name	Description
string	username

Returns

Type	Description
UserInfo

GetUserByPasswordResetToken(int, string)

Declaration

public static UserInfo GetUserByPasswordResetToken(int portalId, string resetToken)

Parameters

Type	Name	Description
int	portalId
string	resetToken

Returns

Type	Description
UserInfo

GetUserByVanityUrl(int, string)

Declaration

public static UserInfo GetUserByVanityUrl(int portalId, string vanityUrl)

Parameters

Type	Name	Description
int	portalId
string	vanityUrl

Returns

Type	Description
UserInfo

GetUserCountByPortal(int)

Declaration

public static int GetUserCountByPortal(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
int

GetUserCreateStatus(UserCreateStatus)

Declaration

public static string GetUserCreateStatus(UserCreateStatus userRegistrationStatus)

Parameters

Type	Name	Description
UserCreateStatus	userRegistrationStatus

Returns

Type	Description
string

GetUserMembership(UserInfo)

Declaration

public static void GetUserMembership(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

GetUserProfilePictureUrl(int, int, int)

Declaration

public string GetUserProfilePictureUrl(int userId, int width, int height)

Parameters

Type	Name	Description
int	userId
int	width
int	height

Returns

Type	Description
string

GetUserProfilePictureUrl(int, int, int, int)

Declaration

public string GetUserProfilePictureUrl(int portalId, int userId, int width, int height)

Parameters

Type	Name	Description
int	portalId
int	userId
int	width
int	height

Returns

Type	Description
string

GetUserSettings(int)

Declaration

public static Hashtable GetUserSettings(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
Hashtable

GetUsers(bool, bool, int)

Declaration

public static ArrayList GetUsers(bool includeDeleted, bool superUsersOnly, int portalId)

Parameters

Type	Name	Description
bool	includeDeleted
bool	superUsersOnly
int	portalId

Returns

Type	Description
ArrayList

GetUsers(int)

Declaration

public static ArrayList GetUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
ArrayList

GetUsers(int, int, int, ref int)

Declaration

public static ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsers(int, int, int, ref int, bool, bool)

Declaration

public static ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersAdvancedSearch(int, int, int, int, int, bool, int, int, string, bool, string, string)

Declaration

public IList<UserInfo> GetUsersAdvancedSearch(int portalId, int userId, int filterUserId, int filterRoleId, int relationTypeId, bool isAdmin, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyNames, string propertyValues)

Parameters

Type	Name	Description
int	portalId
int	userId
int	filterUserId
int	filterRoleId
int	relationTypeId
bool	isAdmin
int	pageIndex
int	pageSize
string	sortColumn
bool	sortAscending
string	propertyNames
string	propertyValues

Returns

Type	Description
IList<UserInfo>

GetUsersBasicSearch(int, int, int, string, bool, string, string)

Declaration

public IList<UserInfo> GetUsersBasicSearch(int portalId, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyName, string propertyValue)

Parameters

Type	Name	Description
int	portalId
int	pageIndex
int	pageSize
string	sortColumn
bool	sortAscending
string	propertyName
string	propertyValue

Returns

Type	Description
IList<UserInfo>

GetUsersByDisplayName(int, string, int, int, ref int, bool, bool)

Declaration

public static ArrayList GetUsersByDisplayName(int portalId, string nameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	nameToMatch
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersByEmail(int, string, int, int, ref int)

Declaration

public static ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
string	emailToMatch
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsersByEmail(int, string, int, int, ref int, bool, bool)

Declaration

public static ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	emailToMatch
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersByProfileProperty(int, string, string, int, int, ref int)

Declaration

public static ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
string	propertyName
string	propertyValue
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsersByProfileProperty(int, string, string, int, int, ref int, bool, bool)

Declaration

public static ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	propertyName
string	propertyValue
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

GetUsersByUserName(int, string, int, int, ref int)

Declaration

public static ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
int	portalId
string	userNameToMatch
int	pageIndex
int	pageSize
int	totalRecords

Returns

Type	Description
ArrayList

GetUsersByUserName(int, string, int, int, ref int, bool, bool)

Declaration

public static ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
int	portalId
string	userNameToMatch
int	pageIndex
int	pageSize
int	totalRecords
bool	includeDeleted
bool	superUsersOnly

Returns

Type	Description
ArrayList

IsValidUserName(string)

Declaration

public bool IsValidUserName(string userName)

Parameters

Type	Name	Description
string	userName

Returns

Type	Description
bool

MoveUserToPortal(UserInfo, PortalInfo, bool)

Declaration

public static void MoveUserToPortal(UserInfo user, PortalInfo portal, bool mergeUser)

Parameters

Type	Name	Description
UserInfo	user
PortalInfo	portal
bool	mergeUser

RemoveDeletedUsers(int)

Declaration

public static void RemoveDeletedUsers(int portalId)

Parameters

Type	Name	Description
int	portalId

RemoveUser(UserInfo)

Declaration

public static bool RemoveUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

ResetAndChangePassword(UserInfo, string)

Declaration

public static bool ResetAndChangePassword(UserInfo user, string newPassword)

Parameters

Type	Name	Description
UserInfo	user
string	newPassword

Returns

Type	Description
bool

ResetAndChangePassword(UserInfo, string, string)

Declaration

public static bool ResetAndChangePassword(UserInfo user, string oldPassword, string newPassword)

Parameters

Type	Name	Description
UserInfo	user
string	oldPassword
string	newPassword

Returns

Type	Description
bool

ResetPassword(UserInfo, string)

Declaration

public static string ResetPassword(UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user
string	passwordAnswer

Returns

Type	Description
string

ResetPasswordToken(UserInfo)

Declaration

public static void ResetPasswordToken(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

ResetPasswordToken(UserInfo, bool)

Declaration

public static bool ResetPasswordToken(UserInfo user, bool sendEmail)

Parameters

Type	Name	Description
UserInfo	user
bool	sendEmail

Returns

Type	Description
bool

ResetPasswordToken(UserInfo, int)

Declaration

public static void ResetPasswordToken(UserInfo user, int minutesValid)

Parameters

Type	Name	Description
UserInfo	user
int	minutesValid

ResetTermsAgreement(int)

Declaration

public static void ResetTermsAgreement(int portalId)

Parameters

Type	Name	Description
int	portalId

RestoreUser(ref UserInfo)

Declaration

public static bool RestoreUser(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

SettingsKey(int)

Declaration

public static string SettingsKey(int portalId)

Parameters

Type	Name	Description
int	portalId

Returns

Type	Description
string

UnLockUser(UserInfo)

Declaration

public static bool UnLockUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
bool

UpdateDisplayNames()

Declaration

public void UpdateDisplayNames()

UpdateUser(int, UserInfo)

Declaration

public static void UpdateUser(int portalId, UserInfo user)

Parameters

Type	Name	Description
int	portalId
UserInfo	user

UpdateUser(int, UserInfo, bool)

Declaration

public static void UpdateUser(int portalId, UserInfo user, bool loggedAction)

Parameters

Type	Name	Description
int	portalId
UserInfo	user
bool	loggedAction

UpdateUser(int, UserInfo, bool, bool)

Declaration

public static void UpdateUser(int portalId, UserInfo user, bool loggedAction, bool sendNotification)

Parameters

Type	Name	Description
int	portalId
UserInfo	user
bool	loggedAction
bool	sendNotification

UserAgreedToTerms(UserInfo)

Declaration

public static void UserAgreedToTerms(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

UserLogin(int, UserInfo, string, string, bool)

Declaration

public static void UserLogin(int portalId, UserInfo user, string portalName, string ip, bool createPersistentCookie)

Parameters

Type	Name	Description
int	portalId
UserInfo	user
string	portalName
string	ip
bool	createPersistentCookie

UserLogin(int, string, string, string, string, string, ref UserLoginStatus, bool)

Declaration

public static UserInfo UserLogin(int portalId, string username, string password, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus, bool createPersistentCookie)

Parameters

Type	Name	Description
int	portalId
string	username
string	password
string	verificationCode
string	portalName
string	ip
UserLoginStatus	loginStatus
bool	createPersistentCookie

Returns

Type	Description
UserInfo

UserRequestsRemoval(UserInfo, bool)

Declaration

public static void UserRequestsRemoval(UserInfo user, bool remove)

Parameters

Type	Name	Description
UserInfo	user
bool	remove

ValidatePassword(string)

Declaration

public static bool ValidatePassword(string password)

Parameters

Type	Name	Description
string	password

Returns

Type	Description
bool

ValidateUser(UserInfo, int, bool)

Declaration

public static UserValidStatus ValidateUser(UserInfo objUser, int portalId, bool ignoreExpiring)

Parameters

Type	Name	Description
UserInfo	objUser
int	portalId
bool	ignoreExpiring

Returns

Type	Description
UserValidStatus

ValidateUser(int, string, string, string, string, string, ref UserLoginStatus)

Declaration

public static UserInfo ValidateUser(int portalId, string username, string password, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
int	portalId
string	username
string	password
string	verificationCode
string	portalName
string	ip
UserLoginStatus	loginStatus

Returns

Type	Description
UserInfo

ValidateUser(int, string, string, string, string, string, string, ref UserLoginStatus)

Declaration

public static UserInfo ValidateUser(int portalId, string username, string password, string authType, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
int	portalId
string	username
string	password
string	authType
string	verificationCode
string	portalName
string	ip
UserLoginStatus	loginStatus

Returns

Type	Description
UserInfo

VerifyUser(string)

Declaration

public static void VerifyUser(string verificationCode)

Parameters

Type	Name	Description
string	verificationCode

Implements

IUserController

Extension Methods

JsonExtensionsWeb.ToJson(object)