Class WorldFactory

Usage

const World = new WorldFactory(myTopiaInstance);

Hierarchy

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
Summary
Instantiate a new instance of World class.

Usage
```
const worldInstance = await World.create(urlSlug, { credentials: { interactiveNonce, interactivePublicKey, visitorId } });
```
Parameters
- urlSlug: string
- Optional options: WorldOptionalInterface
Returns World
- Defined in factories/WorldFactory.ts:25

deleteDroppedAssets

deleteDroppedAssets(urlSlug: string, droppedAssetIds: string[], interactiveSecret: string, credentials: {
    apiKey?: string;
    interactiveNonce?: string;
    interactivePublicKey: string;
    visitorId?: number;
}): Promise<{
    success: boolean;
}>
Summary
Deletes an array of Dropped Assets from within a world and returns success: true

Usage
```
await World.deleteDroppedAssets(urlSlug, ["exampleDroppedAssetId1", "exampleDroppedAssetId2"], interactiveSecret, credentials);
```
Parameters
- urlSlug: string
- droppedAssetIds: string[]
- interactiveSecret: string
- credentials: {
      apiKey?: string;
      interactiveNonce?: string;
      interactivePublicKey: string;
      visitorId?: number;
  }
  - Optional apiKey?: string
  - Optional interactiveNonce?: string
  - interactivePublicKey: string
  - Optional visitorId?: number
Returns Promise<{
success: boolean;
}>
- Defined in factories/WorldFactory.ts:38

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;
  }
  - 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
Inherited from SDKController.errorHandler
- Defined in controllers/SDKController.ts:93

topiaPublicApi

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

Class WorldFactory

Usage

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

topia: Topia

Returns WorldFactory

Properties

credentials

Optional jwt

requestOptions

topia

Methods

create

Summary

Usage

Parameters

urlSlug: string

Optional options: WorldOptionalInterface

Returns World

deleteDroppedAssets

Summary

Usage

Parameters

urlSlug: string

droppedAssetIds: string[]

interactiveSecret: string

credentials: { apiKey?: string; interactiveNonce?: string; interactivePublicKey: string; visitorId?: number; }

Optional apiKey?: string

Optional interactiveNonce?: string

interactivePublicKey: string

Optional visitorId?: number

Returns Promise<{ success: boolean; }>

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

Settings

Member Visibility

Theme

`Optional` jwt

`Optional` options: WorldOptionalInterface

credentials: {
apiKey?: string;
interactiveNonce?: string;
interactivePublicKey: string;
visitorId?: number;
}

`Optional` apiKey?: string

`Optional` interactiveNonce?: string

`Optional` visitorId?: number

Returns Promise<{
success: boolean;
}>

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