RTSDK
    Preparing search index...

    Class Scene

    Create an instance of Scene class with a given scene id and optional attributes and session credentials.

    import { Scene } from "utils/topiaInit.ts";

    const scene = await Scene.get(exampleSceneId, {
      attributes: { name: "My Scene" },
      credentials: { interactivePublicKey: "examplePublicKey", interactiveNonce: "exampleNonce", assetId: "exampleDroppedAssetId", visitorId: 1, urlSlug: "exampleUrlSlug" }
    });

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    credentials id jwt? requestOptions topia

    Methods

    errorHandler fetchSceneById topiaPublicApi

    Constructors

    Properties

    credentials: undefined | InteractiveCredentials
    id: string
    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

    • Retrieves scene details and assigns response data to the instance.

      Returns Promise<void | ResponseType>

      get, fetch, retrieve, load, details, info, information, scene

      await scene.fetchSceneById();
      const { name } = scene;

    • 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