Interface IUserInfo

The UserInfo class provides Business Layer model for Users.

Namespace: DotNetNuke.Abstractions.Users

Assembly: DotNetNuke.Abstractions.dll

Syntax

public interface IUserInfo

Properties

| Improve this Doc View Source

AffiliateID

Gets or sets the AffiliateId for this user.

Declaration

int AffiliateID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

DisplayName

Gets or sets the Display Name.

Declaration

string DisplayName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Email

Gets or sets the Email Address.

Declaration

string Email { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

FirstName

Gets or sets the First Name.

Declaration

string FirstName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HasAgreedToTerms

Gets or sets a value indicating whether the user has agreed to the terms and conditions.

Declaration

bool HasAgreedToTerms { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

HasAgreedToTermsOn

Gets or sets when the user last agreed to the terms and conditions.

Declaration

DateTime HasAgreedToTermsOn { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

IsAdmin

Gets a value indicating whether the user is in the portal's administrators role.

Declaration

bool IsAdmin { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDeleted

Gets or sets a value indicating whether the User is deleted.

Declaration

bool IsDeleted { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsSuperUser

Gets or sets a value indicating whether the User is a SuperUser.

Declaration

bool IsSuperUser { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

LastIPAddress

Gets or sets the Last IP address used by user.

Declaration

string LastIPAddress { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

LastName

Gets or sets the Last Name.

Declaration

string LastName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PasswordResetExpiration

Gets or sets the datetime that the PasswordResetToken is valid.

Declaration

DateTime PasswordResetExpiration { get; set; }

Property Value

Type	Description
DateTime

| Improve this Doc View Source

PasswordResetToken

Gets or sets the token created for resetting passwords.

Declaration

Guid PasswordResetToken { get; set; }

Property Value

Type	Description
Guid

| Improve this Doc View Source

PortalID

Gets or sets the PortalId.

Declaration

int PortalID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

RequestsRemoval

Gets or sets a value indicating whether the user has requested they be removed from the site.

Declaration

bool RequestsRemoval { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Roles

Gets or sets the roles.

Declaration

string[] Roles { get; set; }

Property Value

Type	Description
System.String[]

| Improve this Doc View Source

UserID

Gets or sets the User Id.

Declaration

int UserID { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Username

Gets or sets the User Name.

Declaration

string Username { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

VanityUrl

Gets or sets the vanity url.

Declaration

string VanityUrl { get; set; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

IsInRole(String)

IsInRole determines whether the user is in the role passed.

Declaration

bool IsInRole(string role)

Parameters

Type	Name	Description
System.String	role	The role to check.

Returns

Type	Description
System.Boolean	A Boolean indicating success or failure.

| Improve this Doc View Source

LocalTime()

Gets current time in User's timezone.

Declaration

DateTime LocalTime()

Returns

Type	Description
DateTime	The local time for the user.

| Improve this Doc View Source

LocalTime(DateTime)

Convert utc time in User's timezone.

Declaration

DateTime LocalTime(DateTime utcTime)

Parameters

Type	Name	Description
DateTime	utcTime	Utc time to convert.

Returns

Type	Description
DateTime	The local time for the user.

| Improve this Doc View Source

UpdateDisplayName(String)

UpdateDisplayName updates the displayname to the format provided.

Declaration

void UpdateDisplayName(string format)

Parameters

Type	Name	Description
System.String	format	The format to use.

Extension Methods

JsonExtensionsWeb.ToJson(Object)