Class AssetFactory

Usage

const Asset = new AssetFactory(myTopiaInstance);

Hierarchy

Constructors

constructor

Properties

credentials jwt? requestOptions topia

Methods

create errorHandler topiaPublicApi upload

Constructors

constructor

Properties

credentials

credentials: undefined | InteractiveCredentials

Optional jwt

jwt?: string

requestOptions

requestOptions: object

topia

topia: Topia

Methods

create

  • Summary

    Instantiate a new instance of Asset class.

    Usage

    const assetInstance = await Asset.create(id, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });

    Parameters

    Returns Asset

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

    topiaPublicApi

    • Returns AxiosInstance

    upload

    • Summary

      Upload a new Asset and return a new instance of Asset class.

      Usage

      const assetPayload = {
        assetName: "exampleAssetName"
        bottomLayerURL: "https://example.bottomLayerURL"
        creatorTags: { "decorations": true },
        tagJson: "[{"label":"decorations","value":"decorations"}]",
        isPublic: true,
        topLayerURL: "https://example.topLayerURL"
      }
      const asset = await Asset.upload(assetPayload, apiKey);

      Parameters

      Returns Promise<Asset>

    Settings

    Member Visibility

    Theme