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

constructor

Properties

Methods

Constructors

constructor

new Session(user: null | User, csrfToken: string): Session

- Defined in src/common/Session.ts:29
Parameters
- user: null | User
- csrfToken: string
Returns Session

Properties

csrfToken

csrfToken: string

The CSRF token.

user

user: null | User

The current authenticated user.

Methods

login

login(body: LoginParams, options?: Omit<FlarumRequestOptions<any>, "method" | "body" | "url">): Promise<any>

- Defined in src/common/Session.ts:37
Attempt to log in a user.

Parameters
- body: LoginParams
- options: Omit<FlarumRequestOptions<any>, "method" | "body" | "url"> = {}
Returns Promise<any>

logout

logout(): void

- Defined in src/common/Session.ts:49
Log the user out.

Returns void

Generated using TypeDoc version 0.22.10