Documentation

Class

Relay

Relay(api, options)

A class that manages session checks, dispatches events based on session status, and uses broadcast channels for inter-tab communication.
Constructor

# new Relay(api, options)

Parameters:
Name Type Description
api string The API endpoint URL.
options InternalOptions The internal configuration options of the SDK.

View Source lib/events/Relay.ts, line 19

Extends

Classes

Relay

Methods

# dispatchSessionCreatedEvent(detail)

Dispatches a "hanko-session-created" event to the document with the specified detail.
Parameters:
Name Type Description
detail SessionDetail The event detail.
Overrides:

View Source lib/events/Dispatcher.ts, line 26

# dispatchSessionExpiredEvent()

Dispatches a "hanko-session-expired" event to the document.
Overrides:

View Source lib/events/Dispatcher.ts, line 32

# dispatchUserDeletedEvent()

Dispatches a "hanko-user-deleted" event to the document.
Overrides:

View Source lib/events/Dispatcher.ts, line 44

# dispatchUserLoggedOutEvent()

Dispatches a "hanko-user-logged-out" event to the document.
Overrides:

View Source lib/events/Dispatcher.ts, line 38