RTSDK
    Preparing search index...

    Class SDKControllerAbstract

    Abstract base controller that provides common functionality for all SDK controllers.

    This class should NOT be instantiated directly. It serves as the base class for all SDK controllers (World, Visitor, User, etc.) and provides:

    • Authentication and credential management
    • Axios instance configuration for API calls
    • Standardized error handling
    • JWT token generation for interactive credentials

    base, controller, sdk, authentication, api, abstract

    // This class is extended by all controllers
    export class World extends SDKController implements WorldInterface {
      // World-specific implementation
    }

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    credentials jwt? requestOptions topia

    Methods

    errorHandler topiaPublicApi

    Constructors

    Properties

    credentials: undefined | InteractiveCredentials
    jwt?: string
    requestOptions: object
    topia: Topia

    Methods

    • Standardized error handler for all SDK operations.

      Parameters

      • __namedParameters: { error?: unknown; message?: string; params?: object; sdkMethod?: string }

      Returns {
          data: {};
          message: string;
          method: string;
          params: object;
          sdkMethod: undefined | string;
          stack: string;
          stackTrace: Error;
          status: number;
          success: boolean;
          url: string;
      }

      Standardized error object with properties: data, message, method, params, sdkMethod, stack, status, success, url

      This method processes errors from API calls and formats them consistently across the SDK. It extracts relevant error information including:

      • HTTP status codes and response data
      • Error messages from API responses
      • Stack traces for debugging
      • Request details (URL, method, parameters)

      All errors thrown by SDK methods flow through this handler to ensure consistent error format.

      error, exception, handler, debugging, api error, http error

    • Returns the configured Axios instance for making API calls to Topia's Public API.

      Returns AxiosInstance

      The configured Axios client instance with authentication headers.

      All HTTP requests to the Topia API should use this method to ensure proper authentication headers and base URL configuration are applied.

      api, axios, http, request, client, public api

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods