AP&C API Reference
Public Member Functions | Static Public Member Functions | Properties | List of all members
Apac.Auth.User Class Reference

Wraps a UserAuth in a type that has extensions related to our security model. More...

Inheritance diagram for Apac.Auth.User:

Public Member Functions

 User ()
 Initializes a new instance of the User class. More...
 
 User (UserAuth user)
 Initializes a new instance of the User class. More...
 
void UpdateFrom (User user)
 Updates the user using data provided by user . More...
 

Static Public Member Functions

static User TranslateFromSession (IAuthSession session)
 Translates from session. More...
 

Properties

List< NotificationGroupNotificationGroups [get, set]
 Gets or sets the notification groups. More...
 
bool IsNew [get, set]
 Gets or sets a value indicating whether this instance is new. More...
 
bool IsDeleted [get, set]
 Gets or sets a value indicating whether this instance is deleted. More...
 

Detailed Description

Wraps a UserAuth in a type that has extensions related to our security model.

Constructor & Destructor Documentation

◆ User() [1/2]

Apac.Auth.User.User ( )
inline

Initializes a new instance of the User class.

◆ User() [2/2]

Apac.Auth.User.User ( UserAuth  user)
inline

Initializes a new instance of the User class.

Parameters
userThe user.

Member Function Documentation

◆ TranslateFromSession()

static User Apac.Auth.User.TranslateFromSession ( IAuthSession  session)
inlinestatic

Translates from session.

Parameters
sessionThe session.
Returns
Returns a User with data from the session.

◆ UpdateFrom()

void Apac.Auth.User.UpdateFrom ( User  user)
inline

Updates the user using data provided by user .

Parameters
userThe user.

This routine does not alter the Id value, but it does alter UserName and all of the security infor, so it can provide a way to replicate a user account.

Property Documentation

◆ IsDeleted

bool Apac.Auth.User.IsDeleted
getset

Gets or sets a value indicating whether this instance is deleted.

true if this instance is deleted; otherwise, false.

◆ IsNew

bool Apac.Auth.User.IsNew
getset

Gets or sets a value indicating whether this instance is new.

true if this instance is new; otherwise, false.

◆ NotificationGroups

List<NotificationGroup> Apac.Auth.User.NotificationGroups
getset

Gets or sets the notification groups.

The notification groups.


The documentation for this class was generated from the following file: