Class WorldFactory

Example

const World = new WorldFactory(myTopiaInstance);

Hierarchy (View Summary)

SDKController
- WorldFactory

Index

Constructors

constructor

new WorldFactory(topia: Topia): WorldFactory
Parameters
- topia: Topia
Returns WorldFactory
Overrides SDKController.constructor
- Defined in factories/WorldFactory.ts:12

Properties

credentials

credentials: undefined | InteractiveCredentials

`Optional`jwt

jwt?: string

requestOptions

requestOptions: object

topia

topia: Topia

Methods

create

create(urlSlug: string, options?: WorldOptionalInterface): World
Instantiate a new instance of World class.
Parameters
- urlSlug: string
- Optionaloptions: WorldOptionalInterface
Returns World
Returns a new World object.
Example
```
const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, assetId, urlSlug, visitorId } });
```
- Defined in factories/WorldFactory.ts:26

deleteDroppedAssets

deleteDroppedAssets(
    urlSlug: string,
    droppedAssetIds: string[],
    interactiveSecret: string,
    credentials: {
        apiKey?: string;
        interactiveNonce?: string;
        interactivePublicKey: string;
        visitorId?: number;
    },
): Promise<{ success: boolean }>
Deletes an array of Dropped Assets from within a world and returns success: true
Parameters
- urlSlug: string
- droppedAssetIds: string[]
- interactiveSecret: string
- credentials: {
      apiKey?: string;
      interactiveNonce?: string;
      interactivePublicKey: string;
      visitorId?: number;
  }
Returns Promise<{ success: boolean }>
Returns { success: true } or an error.
Example
```
await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], interactiveSecret, credentials);
```
- Defined in factories/WorldFactory.ts:40

errorHandler

errorHandler(
    __namedParameters: {
        error?: unknown;
        message?: string;
        params?: object;
        sdkMethod?: string;
    },
): {
    data: {};
    message: string;
    method: string;
    params: object;
    sdkMethod: undefined
    | string;
    stack: string;
    stackTrace: Error;
    status: number;
    success: boolean;
    url: string;
}
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;
}
Inherited from SDKController.errorHandler
- Defined in controllers/SDKController.ts:97

topiaPublicApi

topiaPublicApi(): AxiosInstance
Returns AxiosInstance
Inherited from SDKController.topiaPublicApi
- Defined in controllers/SDKController.ts:93

Class WorldFactory

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorldFactory

Properties

credentials

`Optional`jwt

requestOptions

topia

Methods

create

Parameters

Returns World

Example

deleteDroppedAssets

Parameters

Returns Promise<{ success: boolean }>

Example

errorHandler

Parameters

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

topiaPublicApi

Returns AxiosInstance

Settings

On This Page

Class WorldFactory

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorldFactory

Properties

credentials

Optionaljwt

requestOptions

topia

Methods

create

Parameters

Returns World

Example

deleteDroppedAssets

Parameters

Returns Promise<{ success: boolean }>

Example

errorHandler

Parameters

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

topiaPublicApi

Returns AxiosInstance

Settings

On This Page

`Optional`jwt

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