Class Asset

Summary

Create an instance of Asset class with a given asset id and optional attributes and session credentials.

Usage

await new Asset(topia, "assetId", {
  attributes: { assetName: "My Asset", isPublic: false },
  credentials: { apiKey: "exampleKey", interactiveNonce: "exampleNonce", urlSlug: "exampleWorld", visitorId: 1 }
});

Hierarchy

Implements

Constructors

constructor

Properties

credentials id? jwt? requestOptions topia

Methods

errorHandler fetchAssetById topiaPublicApi updateAsset

Constructors

constructor

Properties

credentials

credentials: undefined | InteractiveCredentials

Optional Readonly id

id?: string

Optional jwt

jwt?: string

requestOptions

requestOptions: object

topia

topia: Topia

Methods

errorHandler

  • Parameters

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

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

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

    fetchAssetById

    • Summary

      Retrieves platform asset details.

      Usage

      await asset.fetchAssetById();
      const { assetName } = asset;

      Returns Promise<object | ResponseType>

    topiaPublicApi

    • Returns AxiosInstance

    updateAsset

    • Summary

      Updates platform asset details.

      Usage

      await asset.updateAsset({
        assetName: "exampleAsset",
        bottomLayerURL: null,
        creatorTags: { "decorations": true },
        isPublic: true,
        shouldUploadImages: true,
        tagJson: "[{"label":"decorations","value":"decorations"}]",
        topLayerURL: "https://example.topLayerURL"
       });
      const { assetName } = asset;

      Parameters

      • __namedParameters: {
            assetName: string;
            bottomLayerURL?: string;
            creatorTags: object;
            isPublic: boolean;
            shouldUploadImages?: boolean;
            tagJson: string;
            topLayerURL?: string;
        }
        • assetName: string
        • Optional bottomLayerURL?: string
        • creatorTags: object
        • isPublic: boolean
        • Optional shouldUploadImages?: boolean
        • tagJson: string
        • Optional topLayerURL?: string

      Returns Promise<void | ResponseType>

    Settings

    Member Visibility

    Theme