SessionApi

Reference for the SessionApi module: API endpoints for session management. The module declares its endpoints into the ApiConfig registry at load time, and exposes the current session token.

This page is a pure reference. For how the framework fits together, see the Guide.

Classes

SessionApi - declares the session API endpoints and returns the current session token.

SessionApi

Declares this module's endpoints into the ApiConfig registry, and provides the handler that returns the current session token.

Functions

Endpoints Token

Endpoints

SessionApi::Endpoints(): void

Declare the module's endpoints into the ApiConfig registry: a GET token endpoint under the Session v1 module.

Returns void

Token

SessionApi::Token(): string

The handler for GET /api/Session/v1/Token. Returns the current session token, which is the session id.

Returns string The current session token.