Class WorldFactory

Usage

const World = new WorldFactory(myTopiaInstance);

Hierarchy

Constructors

Properties

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

Methods

  • Summary

    Instantiate a new instance of World class.

    Usage

    const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
    

    Parameters

    Returns World

  • Summary

    Deletes an array of Dropped Assets from within a world and returns success: true

    Usage

    await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], { interactivePublicKey, interactiveSecret });
    

    Parameters

    • urlSlug: string
    • droppedAssetIds: string[]
    • credentials: {
          apiKey?: string;
          interactivePublicKey?: string;
          interactiveSecret?: string;
      }
      • Optional apiKey?: string
      • Optional interactivePublicKey?: string
      • Optional interactiveSecret?: string

    Returns Promise<{
        success: boolean;
    }>

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