Saxonberg Server API
    Preparing search index...

    Interface IBackend

    Backend interface for Application callbacks.

    interface IBackend {
        handleProviderAuth(
            provider: AuthProvider,
            profile: ProviderProfile,
            done: (
                error: unknown,
                user?: { authProvider: AuthProvider; id: string },
            ) => void,
        ): Promise<void>;
        sendEnvelopeToSocket(socketId: string, envelope: Envelope): void;
        sendMessageToSocket(socketId: string, message: unknown): void;
    }

    Implemented by

    Index

    Methods

    handleProviderAuth sendEnvelopeToSocket sendMessageToSocket

    Methods

    • Handle a successful provider authentication (login). Called by a Passport strategy's verify callback after the provider OAuth succeeds; the find-or-create path is parameterized by provider.

      Parameters

      • provider: AuthProvider

        which login provider authenticated

      • profile: ProviderProfile

        normalized profile (Google) / profile+tokens (Twitch)

      • done: (error: unknown, user?: { authProvider: AuthProvider; id: string }) => void

        Passport callback (principal carries authProvider)

      Returns Promise<void>

    • Send a fully-stamped envelope to a specific WebSocket connection. Parallel to sendMessageToSocket; carries its frameId already (stamped per-Interactive by Application).

      Parameters

      • socketId: string
      • envelope: Envelope

      Returns void

    • Send a message to a specific WebSocket connection.

      Parameters

      • socketId: string

        The socket ID to send to

      • message: unknown

        The message object to send

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods