Class: State

AuthenticationService~State

Represents a state of authentication based on the Webcom Authentication Service model.

Since:
  • 2.11

Members

details :AuthenticationService.AuthenticationDetails

Specifies the authentication details of the user when AuthenticationService.State#state is "some".

Type:

state :string

Specifies the state of authentication among 3 possible values:

  • "none": no user is authenticated,
  • "required": the user has lost her/his authentication before any explicit unauthentication,
  • "some": the user is authenticated, the authentication details are given by the AuthenticationService.State#details property.
Type:
  • string

Methods

isAuthenticated() → {boolean}

Determines whether this instance represents a valid authentication of a user (ie. the AuthenticationService.State#state property equals "some").

Returns:

true if this instance represents the actual authentication of a user.

Type
boolean

isRequired() → {boolean}

Determines whether this instance represents the loss of a previous valid authentication of a user (ie. the AuthenticationService.State#state property equals "required").

Returns:

true if this instance represents the loss of a valid authentication of a user.

Type
boolean

isSameAs(other) → {boolean}

Tests whether this authentication state is the same than another given one.

Parameters:
Name Type Description
other AuthenticationService.State

The other authentication state to compare with.
Returns:

true if and only if other represents the same authentication state than this instance.

Type
boolean

isUnauthenticated() → {boolean}

Determines whether this instance represents no ongoing authentication of a user (ie. AuthenticationService.State#state property equals "none").

Returns:

true if this instance represents the fact that no user is authenticated.

Type
boolean
show
deprecated