Global

Members

(constant) ReducerState

Source:
Properties:
Name Type Description
rejected boolean

true if the server has rejected a session-id, user pair.
resuming boolean

true if attempting to resume a session.
session string

The session-id when authenticated; empty string when guest.
user object

An opaque user type when authenticated; null when guest.
username string

The most recently used username from a successful authentication. Will also be used to populate the username field of the LoginForm React component.

ReducerState is the Redux state.

Authenticated

The session is authenticated when the session and user store values are non-empty and non-null respectively.

Guest

The session is in guest mode when the session and user store values are "" and null respectively.

Methods

Reducer(state, action)

Source:
Parameters:
Name Type Description
state Object

The reducer state.
action Object

The reducer action.

Type Definitions

Components

Source:
Properties:
Name Type Description
Authenticated Component

Authenticated component.
LoginForm Component

LoginForm component.
Guest Component

Guest component.
Type:
  • Object

ServerAuthenticateResponse

Source:
Properties:
Name Type Description
success boolean

true if authenticated; false otherwise.
session string

The session-id recognized by the server.
user Object

A non-null object usable by the application; it is opaque to this package.
Type:
  • Object

ServerResultResponse

Source:
Properties:
Name Type Description
success boolean

true if the action succeeded; false otherwise.
Type:
  • Object