Class WMUserDTO

Data Transfer Object that implements the persistent data storage interface for the WMUser class.

Inheritance
object
DataTransferObject<WMUser>
WMUserDTO
Implements
Inherited Members
Namespace: Quantellia.WMServer.Auth.Model.UserAccess
Assembly: WMServer.dll
Syntax
public class WMUserDTO : DataTransferObject<WMUser>, IDbEntity, IWMEntity, IWMResource

Constructors

WMUserDTO()

Declaration
public WMUserDTO()

WMUserDTO(WMUser)

Declaration
public WMUserDTO(WMUser modelObj)
Parameters
Type Name Description
WMUser modelObj

WMUserDTO(string)

Constructor that initializes the ID.

Declaration
public WMUserDTO(string id)
Parameters
Type Name Description
string id

Properties

CreatedBy

ID of the user that created this entity.

Declaration
public string CreatedBy { get; set; }
Property Value
Type Description
string

CreatedDate

Date and time at which this entity was last updated.

Declaration
public DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime

Email

Primary email address for the user.

Declaration
public string? Email { get; set; }
Property Value
Type Description
string

IsSysAdmin

Whether this user is a system admin for this instance of WMServer

Declaration
public int IsSysAdmin { get; set; }
Property Value
Type Description
int

LastUpdatedBy

ID of the user that last updated this entity.

Declaration
public string LastUpdatedBy { get; set; }
Property Value
Type Description
string

LastUpdatedDate

Date and time at which this entity was last updated.

Declaration
public DateTime LastUpdatedDate { get; set; }
Property Value
Type Description
DateTime

LoginName

Name for login.

Declaration
public string LoginName { get; set; }
Property Value
Type Description
string
Remarks

The pair LoginName, WMOrganization must be unique.

Name

The actual name of the user

Declaration
public string? Name { get; set; }
Property Value
Type Description
string

Password

Password used for authentication

Declaration
public string Password { get; set; }
Property Value
Type Description
string

Salt

Salt for hashing the password.

Declaration
public string Salt { get; set; }
Property Value
Type Description
string

UserStatus

Declaration
public PrincipalStatus UserStatus { get; set; }
Property Value
Type Description
PrincipalStatus

Methods

FromModel()

Write data from the associated ModelObject. If this is null, does nothing.

Declaration
public override void FromModel()
Overrides
Exceptions
Type Condition
NotImplementedException

Get(string, AuthDbContext?)

Declaration
public static Task<WMUserDTO> Get(string id, AuthDbContext? context = null)
Parameters
Type Name Description
string id
AuthDbContext context
Returns
Type Description
Task<WMUserDTO>

ResourceDefinition()

The resource operation definition for this asset.

Declaration
public static WMResourceOperationsDefinition ResourceDefinition()
Returns
Type Description
WMResourceOperationsDefinition

UpdateModel(WMPrincipal, DbContext, object[]?)

Read data from this DTO and write it to the Model Object.

Declaration
public override Task<WMUser> UpdateModel(WMPrincipal principal, DbContext context, object[]? data)
Parameters
Type Name Description
WMPrincipal principal
DbContext context
object[] data
Returns
Type Description
Task<WMUser>
Overrides
Exceptions
Type Condition
NotImplementedException

UpdateUser(WMPrincipal, string, WMUserArgs, AuthDbContext)

Updates the given user if the principal possesses the authority.

Declaration
public static Task UpdateUser(WMPrincipal principal, string userID, UserController.WMUserArgs user, AuthDbContext context)
Parameters
Type Name Description
WMPrincipal principal
string userID
UserController.WMUserArgs user
AuthDbContext context
Returns
Type Description
Task

Implements