Class AuthenticationState
Authentication state of the current
Namespace: SuperOffice.Security.Principal
Assembly: SoCore.dll
Syntax
public sealed class AuthenticationState : EnumRemarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.
Fields
Authenticated
The session is authenticated
Declaration
public const AuthenticationState AuthenticatedField Value
| Type | Description |
|---|---|
| AuthenticationState |
Remarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.
Authenticating
The session is currently being authenticating
Declaration
public const AuthenticationState AuthenticatingField Value
| Type | Description |
|---|---|
| AuthenticationState |
Remarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.
AuthenticationFailed
The authentication has failed.
Declaration
public const AuthenticationState AuthenticationFailedField Value
| Type | Description |
|---|---|
| AuthenticationState |
Remarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.
Closed
The session has closed
Declaration
public const AuthenticationState ClosedField Value
| Type | Description |
|---|---|
| AuthenticationState |
Remarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.
Suspended
The session has been suspended.
Declaration
public const AuthenticationState SuspendedField Value
| Type | Description |
|---|---|
| AuthenticationState |
Remarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.
Unauthenticated
The process of authentication has not been carried out.
Declaration
public const AuthenticationState UnauthenticatedField Value
| Type | Description |
|---|---|
| AuthenticationState |
Remarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.
value__
Authentication state of the current
Declaration
public int value__Field Value
| Type | Description |
|---|---|
| Int32 |
Remarks
The initial state of
When the authentication starts, the state is set to Authenticating. The state is set to
Authenticated if the authentication succeeded and AuthenticationFailed if the authentication failed.
The authentication state is set to Disconnected or Closed if such operations are performed on SoSession.
A value greater than Unauthenticated means that the process of authentication is either being carried out or has actually been successfull. CurrentPrincipal is available when the athentication are in these states.
A value less than Unauthenticated means that we don't have a valid session.