• Api Documentation
Show / Hide Table of Contents
  • Softadmin.Api
    • AdminMessageException
    • CustomComponent
    • ICookies
    • IEnvironment
    • IForwardState
    • IHttpHeaders
    • IParameters
    • ISessionVariables
    • ISystemSettings
    • Plugin
  • Softadmin.Api.Database
    • IDbRequest
    • IDbRequestFactory
  • Softadmin.Api.Diagnostics
    • ILogger
  • Softadmin.Api.Login
    • IUserState
    • LoginPlugin
    • PostLoginPlugin
    • PreLoginPlugin
    • UserAuthenticationPlugin
  • Softadmin.Api.Logout
    • LogoutPlugin
  • Softadmin.Api.Page
    • ICustomPage
    • PagePlugin
  • Softadmin.Api.Ui
    • IDebugWindow
    • IProgressWindow

Interface IUserState

Controls the logged in user. Setting the logged in user will cause the login page to skip asking the client for username and password and forward the user directly into the system.

Namespace: Softadmin.Api.Login
Assembly: Softadmin.Api.dll
Syntax
public interface IUserState

Properties

UserId

Gets or sets the user id.

Declaration
int? UserId { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

Also updates Username.

Exceptions
Type Condition
System.ArgumentException

No active user exists with the given id.

System.ArgumentNullException

You can't set the UserId to null.

Username

Gets or sets the username.

Declaration
string Username { get; set; }
Property Value
Type Description
System.String
Remarks

Also updates UserId.

Exceptions
Type Condition
System.ArgumentException

No active user exists with the given name.

System.ArgumentNullException

You can't set the Username to null.

Back to top Generated by DocFX