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

    • 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;
      }

    • 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 AxiosInstance

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods