Class Session

The Session class defines the current user session. It stores a reference to the current authenticated user, and provides methods to log in/out.

Hierarchy

Session

Index

Constructors

Properties

Methods

Constructors

constructor

new Session(user, csrfToken): Session
Parameters
- user: null | User
- csrfToken: string
Returns Session
- Defined in framework/core/js/src/common/Session.ts:29

Properties

csrfToken

csrfToken: string

The CSRF token.

user

user: null | User

The current authenticated user.

Methods

login

login(body, options?): Promise<any>
Attempt to log in a user.
Parameters
- body: LoginParams
- options: Omit<FlarumRequestOptions<any>, "method" | "body" | "url"> = {}
Returns Promise<any>
- Defined in framework/core/js/src/common/Session.ts:37

logout

logout(): void
Log the user out.

Returns void
- Defined in framework/core/js/src/common/Session.ts:49

Generated using TypeDoc v0.24.8