Class Visitor

Summary

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

Usage

await new Visitor(topia, id, urlSlug, { attributes: { moveTo: { x: 0, y: 0 } } });

Hierarchy

User
- Visitor

Implements

VisitorInterface

Constructors

constructor

new Visitor(topia: Topia, id: number, urlSlug: string, options?: VisitorOptionalInterface): Visitor
Parameters
- topia: Topia
- id: number
- urlSlug: string
- options: VisitorOptionalInterface = ...
Returns Visitor
Overrides User.constructor
- Defined in controllers/Visitor.ts:34

Properties

credentials

credentials: undefined | InteractiveCredentials

`Optional` dataObject

dataObject?: null | object

`Readonly` id

id: number

`Optional` jwt

jwt?: string

`Optional` profile

profile?: Record<string, any>

`Optional` profileId

profileId?: null | string

requestOptions

requestOptions: object

topia

topia: Topia

urlSlug

urlSlug: string

`Optional` user

user?: User

Accessors

adminWorlds

get adminWorlds(): {
[key: string]: World;
}
Returns {
[key: string]: World;
}
- [key: string]: World
Inherited from User.adminWorlds
- Defined in controllers/User.ts:60

assets

get assets(): {
[key: string]: Asset;
}
Returns {
[key: string]: Asset;
}
- [key: string]: Asset
Inherited from User.assets
- Defined in controllers/User.ts:64

scenes

get scenes(): {
[key: string]: Scene;
}
Returns {
[key: string]: Scene;
}
- [key: string]: Scene
Inherited from User.scenes
- Defined in controllers/User.ts:68

worlds

get worlds(): {
[key: string]: World;
}
Returns {
[key: string]: World;
}
- [key: string]: World
Inherited from User.worlds
- Defined in controllers/User.ts:72

Methods

addAvatar

addAvatar(formData: FormData): Promise<void | ResponseType>

Summary

Add a new avatar

Usage

const animationMeta = {
  "emote": { "loop": false, "x": 0, "y": 0, "hideLoop": true }
}

const spriteSheetJSON = {
  "animations": {
    "emote": [
      "emote/1.png"
    ]
  },
  "frames": {
    "emote/1.png": {
      "frame": {
       "x": 1911,
       "y": 778,
       "w": 58,
       "h": 91
     },
     "rotated": true,
     "trimmed": true,
     "spriteSourceSize": {
       "x": 50,
       "y": 33,
       "w": 58,
       "h": 91
     },
     "sourceSize": {
       "w": 159,
       "h": 159
     }
   }
 },
 "spriteSheetTypeMeta": {
   "nameplate": {
     "x": 0,
     "y": -70
   }
 },
 "meta": {
   "image": "spriteSheets%2FTvHNjgoMkiErDNSrVqHU%2FspriteSheet.png?alt=media",
   "format": "RGBA8888",
   "size": {
     "w": 2006,
     "h": 1099
   },
   "scale": "1"
 }
}

const formData = new FormData();
formData.append('animationMeta', animationMeta);
formData.append('name', "ExampleAvatarName");
formData.append('spriteSheetJSON', spriteSheetJSON);
formData.append('expression_dance', expression_dance);
formData.append('expression_emote', expression_emote);
formData.append('expression_sit', expression_sit);
formData.append('expression_stand', expression_stand);
formData.append('expression_transport', expression_transport);
formData.append('preview', preview);
formData.append('spriteSheet', spriteSheet);
formData.append('unityPackage', unityPackage);
await user.uploadAvatarFiles("exampleAvatarId", formData);

Parameters

formData: FormData

Returns Promise<void | ResponseType>

checkInteractiveCredentials

checkInteractiveCredentials(): Promise<void | ResponseType>
Summary
Verify user has valid interactive credentials

Usage
```
await user.checkInteractiveCredentials();
```
Returns Promise<void | ResponseType>
Inherited from User.checkInteractiveCredentials
- Defined in controllers/User.ts:85

closeIframe

closeIframe(droppedAssetId: string): Promise<void | ResponseType>
Summary
Close an iframe for a visitor currently in a world.

Usage
```
await visitor.closeIframe("droppedAssetId");
```
Parameters
- droppedAssetId: string
Returns Promise<void | ResponseType>
- Defined in controllers/Visitor.ts:208

deleteAvatar

deleteAvatar(avatarId: string): Promise<void | ResponseType>
Summary
Update avatar and sprite sheet records and upload files to existing sprite sheet and avatar storage buckets

Usage
```
await user.deleteAvatar("exampleAvatarId");
```
Parameters
- avatarId: string
Returns Promise<void | ResponseType>
Inherited from User.deleteAvatar
- Defined in controllers/User.ts:293

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 User.errorHandler
- Defined in controllers/SDKController.ts:93

fetchAdminWorldsByKey

fetchAdminWorldsByKey(): Promise<void | ResponseType>
Summary
Retrieves all worlds a user with matching API Key is an admin in, creates a new World object for each, and creates new map of Worlds accessible via user.adminWorlds.

Usage
```
await user.fetchAdminWorldsByKey();
const adminWorlds = user.adminWorlds;
```
Returns Promise<void | ResponseType>
Inherited from User.fetchAdminWorldsByKey
- Defined in controllers/User.ts:423

fetchAssets

fetchAssets(): Promise<void | ResponseType>
Summary
Returns all assets owned by User when an email address is provided.

Usage
```
await user.fetchAssets();
const userAssets = user.assets;
```
Returns Promise<void | ResponseType>
Inherited from User.fetchAssets
- Defined in controllers/User.ts:315

fetchAvatars

fetchAvatars(): Promise<void | ResponseType>
Summary
Returns all avatars owned by User

Usage
```
const avatars = await user.fetchAvatars();
```
Returns Promise<void | ResponseType>
Inherited from User.fetchAvatars
- Defined in controllers/User.ts:106

fetchDataObject

fetchDataObject(): Promise<void | ResponseType>
Summary
Retrieves the data object for a visitor.

Usage
```
const dataObject = await visitor.fetchDataObject();
```
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.fetchDataObject

Overrides User.fetchDataObject
- Defined in controllers/Visitor.ts:334

fetchInteractiveWorldsByKey

fetchInteractiveWorldsByKey(interactivePublicKey: string): Promise<object | ResponseType>
Summary
Retrieves ids of all dropped assets in all worlds with a matching interactivePublicKey.

Usage
```
await user.fetchInteractiveWorldsByKey("interactivePublicKeyExample");
const interactiveWorlds = user.interactiveWorlds;
```
Parameters
- interactivePublicKey: string
Returns Promise<object | ResponseType>
Inherited from User.fetchInteractiveWorldsByKey
- Defined in controllers/User.ts:449

fetchPlatformAssets

fetchPlatformAssets(): Promise<object | ResponseType>
Summary
Returns all platform assets.

Usage
```
const assets = await user.fetchPlatformAssets();
```
Returns Promise<object | ResponseType>
Inherited from User.fetchPlatformAssets
- Defined in controllers/User.ts:341

fetchScenes

fetchScenes(): Promise<void | ResponseType>
Summary
Returns all scenes owned by User.

Usage
```
await user.fetchScenes();
const userScenes = user.scenes;
```
Returns Promise<void | ResponseType>
Inherited from User.fetchScenes
- Defined in controllers/User.ts:360

fetchVisitor

fetchVisitor(): Promise<void | ResponseType>
Summary
Get a single visitor from a world

Usage
```
await visitor.fetchVisitor();
```
Result
Returns details for a visitor in a world by id and urlSlug
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.fetchVisitor
- Defined in controllers/Visitor.ts:58

fetchWorldsByKey

fetchWorldsByKey(): Promise<void | ResponseType>
Summary
Retrieves all worlds owned by user with matching API Key, creates a new World object for each, and creates new map of Worlds accessible via user.worlds.

Usage
```
await user.fetchWorldsByKey();
const userWorlds = user.worlds;
```
Result
```
{ urlSlug: new World({ apiKey, worldArgs, urlSlug }) }
```
Returns Promise<void | ResponseType>
Inherited from User.fetchWorldsByKey
- Defined in controllers/User.ts:394

fireToast

fireToast(__namedParameters: FireToastInterface): Promise<void | ResponseType>
Summary
Display a message via a toast to a visitor currently in a world.

Usage
```
await visitor.fireToast({
 groupId: "custom-message",
 title: "Hello World",
 text: "Thank you for participating!",
});
```
Parameters
- __namedParameters: FireToastInterface
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.fireToast
- Defined in controllers/Visitor.ts:124

getAllParticles

getAllParticles(): Promise<object | ResponseType>
Summary
Get all particles available

Usage
```
await visitor.getAllParticles();
```
Returns Promise<object | ResponseType>
- Defined in controllers/Visitor.ts:278

grantExpression

grantExpression(__namedParameters: {
id?: string;
name?: string;
}): Promise<object | ResponseType>
Summary
Grant expression to a visitor by id or name.

Usage
```
await visitor.grantExpression({ name: "Eyes" });
```
Parameters
- __namedParameters: {
 id?: string;
 name?: string;
 }
 - Optional id?: string
 - Optional name?: string
Returns Promise<object | ResponseType>
- Defined in controllers/Visitor.ts:250

incrementDataObjectValue

incrementDataObjectValue(path: string, amount: number, options?: {
 analytics?: AnalyticType[];
 lock?: {
 lockId: string;
 releaseLock?: boolean;
 };
}): Promise<void | ResponseType>
Summary
Increments a specific value in the data object for a visitor by the amount specified. Must have valid interactive credentials from a visitor in the world.

Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id

Usage
```
await visitor.incrementDataObjectValue("key", 1);
```
Parameters
- path: string
- amount: number
- options: {
 analytics?: AnalyticType[];
 lock?: {
 lockId: string;
 releaseLock?: boolean;
 };
 } = {}
 - Optional analytics?: AnalyticType[]
 - Optional lock?: {
 lockId: string;
 releaseLock?: boolean;
 }
 - lockId: string
 - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.incrementDataObjectValue

Overrides User.incrementDataObjectValue
- Defined in controllers/Visitor.ts:422

moveVisitor

moveVisitor(__namedParameters: MoveVisitorInterface): Promise<void | ResponseType>
Summary
Teleport or walk a visitor currently in a world to a single set of coordinates.

Usage
```
await visitor.moveVisitor({
 shouldTeleportVisitor: true,
 x: 100,
 y: 100,
});
```
Result
Updates each Visitor instance and world.visitors map.
Parameters
- __namedParameters: MoveVisitorInterface
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.moveVisitor
- Defined in controllers/Visitor.ts:93

openIframe

openIframe(__namedParameters: OpenIframeInterface): Promise<void | ResponseType>
Summary
Open an iframe in a drawer or modal for a visitor currently in a world.

Usage
```
await visitor.openIframe({
 droppedAssetId: "droppedAssetId",
 link: "https://topia.io",
 shouldOpenInDrawer: true,
 title: "Hello World",
});
```
Parameters
- __namedParameters: OpenIframeInterface
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.openIframe
- Defined in controllers/Visitor.ts:155

reloadIframe

reloadIframe(droppedAssetId: string): Promise<void | ResponseType>
Summary
Reload an iframe for a visitor currently in a world.

Usage
```
await visitor.reloadIframe("droppedAssetId");
```
Parameters
- droppedAssetId: string
Returns Promise<void | ResponseType>
- Defined in controllers/Visitor.ts:187

sendEmail

sendEmail(__namedParameters: {
 html: string;
 subject: string;
 to: string;
}): Promise<object | ResponseType>
Summary
Send an email

Usage
```
const html = `Hello World!This email is being sent from via SDK.`
await user.sendEmail({ html, subject: "Example", to: "example@email.io" });
```
Parameters
- __namedParameters: {
 html: string;
 subject: string;
 to: string;
 }
 - html: string
 - subject: string
 - to: string
Returns Promise<object | ResponseType>
Inherited from User.sendEmail
- Defined in controllers/User.ts:471

sendSignalToVisitor

sendSignalToVisitor(signal: any): Promise<void | ResponseType & {
answerSignal: any;
}>
Summary
Setup signal to visitor

Usage
```
await visitor.sendSignalToVisitor(iceServers);
```
Parameters
- signal: any
Returns Promise<void | ResponseType & {
answerSignal: any;
}>
- Defined in controllers/Visitor.ts:475

setDataObject

setDataObject(dataObject: undefined | null | object, options?: {
 analytics?: AnalyticType[];
 lock?: {
 lockId: string;
 releaseLock?: boolean;
 };
}): Promise<void | ResponseType>
Summary
Sets the data object for a visitor.

Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id

Usage
```
await visitor.setDataObject({
 "exampleKey": "exampleValue",
});
```
Parameters
- dataObject: undefined | null | object
- options: {
 analytics?: AnalyticType[];
 lock?: {
 lockId: string;
 releaseLock?: boolean;
 };
 } = {}
 - Optional analytics?: AnalyticType[]
 - Optional lock?: {
 lockId: string;
 releaseLock?: boolean;
 }
 - lockId: string
 - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.setDataObject

Overrides User.setDataObject
- Defined in controllers/Visitor.ts:360

topiaPublicApi

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

triggerParticle

triggerParticle(__namedParameters: {
 duration?: number;
 id?: string;
 name?: string;
}): Promise<string | object | ResponseType>
Summary
Trigger a particle effect on a visitor

Usage
```
await visitor.triggerParticle({ name: "Flame" });
```
Parameters
- __namedParameters: {
 duration?: number;
 id?: string;
 name?: string;
 }
 - Optional duration?: number
 - Optional id?: string
 - Optional name?: string
Returns Promise<string | object | ResponseType>
- Defined in controllers/Visitor.ts:296

turnAVOff

turnAVOff(): Promise<void | ResponseType>
Summary
Mute and turn video off for a visitor currently in a world.

Usage
```
await visitor.turnAVOff();
```
Returns Promise<void | ResponseType>
- Defined in controllers/Visitor.ts:229

updateAvatar

updateAvatar(avatarId: string, formData: FormData): Promise<void | ResponseType>

Summary

Update avatar and sprite sheet records and upload files to existing sprite sheet and avatar storage buckets

Usage

const animationMeta = {
  "emote": { "loop": false, "x": 0, "y": 0, "hideLoop": true }
}

const spriteSheetJSON = {
  "animations": {
    "emote": [
      "emote/1.png"
    ]
  },
  "frames": {
    "emote/1.png": {
      "frame": {
       "x": 1911,
       "y": 778,
       "w": 58,
       "h": 91
     },
     "rotated": true,
     "trimmed": true,
     "spriteSourceSize": {
       "x": 50,
       "y": 33,
       "w": 58,
       "h": 91
     },
     "sourceSize": {
       "w": 159,
       "h": 159
     }
   }
 },
 "spriteSheetTypeMeta": {
   "nameplate": {
     "x": 0,
     "y": -70
   }
 },
 "meta": {
   "image": "spriteSheets%2FTvHNjgoMkiErDNSrVqHU%2FspriteSheet.png?alt=media",
   "format": "RGBA8888",
   "size": {
     "w": 2006,
     "h": 1099
   },
   "scale": "1"
 }
}

const formData = new FormData();
formData.append('animationMeta', animationMeta);
formData.append('name', "ExampleAvatarName");
formData.append('spriteSheetJSON', spriteSheetJSON);
formData.append('expression_dance', expression_dance);
formData.append('expression_emote', expression_emote);
formData.append('expression_sit', expression_sit);
formData.append('expression_stand', expression_stand);
formData.append('expression_transport', expression_transport);
formData.append('preview', preview);
formData.append('spriteSheet', spriteSheet);
formData.append('unityPackage', unityPackage);
await user.uploadAvatarFiles("exampleAvatarId", formData);

Parameters

avatarId: string
formData: FormData

Returns Promise<void | ResponseType>

updateDataObject

updateDataObject(dataObject: object, options?: {
 analytics?: AnalyticType[];
 lock?: {
 lockId: string;
 releaseLock?: boolean;
 };
}): Promise<void | ResponseType>
Summary
Updates the data object for a visitor.

Optionally, a lock can be provided with this request to ensure only one update happens at a time between all updates that share the same lock id

Usage
```
await visitor.updateDataObject({
 "exampleKey": "exampleValue",
});
```
Parameters
- dataObject: object
- options: {
 analytics?: AnalyticType[];
 lock?: {
 lockId: string;
 releaseLock?: boolean;
 };
 } = {}
 - Optional analytics?: AnalyticType[]
 - Optional lock?: {
 lockId: string;
 releaseLock?: boolean;
 }
 - lockId: string
 - Optional releaseLock?: boolean
Returns Promise<void | ResponseType>
Implementation of VisitorInterface.updateDataObject

Overrides User.updateDataObject
- Defined in controllers/Visitor.ts:392

updatePublicKeyAnalytics

updatePublicKeyAnalytics(analytics?: AnalyticType[]): Promise<void | ResponseType>
Summary
Update analytics for a given public key. Must have valid interactive credentials from a visitor in the world.

Usage
```
await visitor.updatePublicKeyAnalytics([{ analyticName: "joins", profileId, uniqueKey: profileId, urlSlug }]);
```
Parameters
- Optional analytics: AnalyticType[]
Returns Promise<void | ResponseType>
- Defined in controllers/Visitor.ts:454

Class Visitor

Summary

Usage

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

topia: Topia

id: number

urlSlug: string

options: VisitorOptionalInterface = ...

Returns Visitor

Properties

credentials

Optional dataObject

Readonly id

Optional jwt

Optional profile

Optional profileId

requestOptions

topia

urlSlug

Optional user

Accessors

adminWorlds

Returns { [key: string]: World; }

[key: string]: World

assets

Returns { [key: string]: Asset; }

[key: string]: Asset

scenes

Returns { [key: string]: Scene; }

[key: string]: Scene

worlds

Returns { [key: string]: World; }

[key: string]: World

Methods

addAvatar

Summary

Usage

Parameters

formData: FormData

Returns Promise<void | ResponseType>

checkInteractiveCredentials

Summary

Usage

Returns Promise<void | ResponseType>

closeIframe

Summary

Usage

Parameters

droppedAssetId: string

Returns Promise<void | ResponseType>

deleteAvatar

Summary

Usage

Parameters

avatarId: string

Returns Promise<void | ResponseType>

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

`Optional` dataObject

`Readonly` id

`Optional` jwt

`Optional` profile

`Optional` profileId

`Optional` user

Returns {
[key: string]: World;
}

Returns {
[key: string]: Asset;
}

Returns {
[key: string]: Scene;
}

Returns {
[key: string]: World;
}

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

__namedParameters: {
id?: string;
name?: string;
}

`Optional` id?: string

`Optional` name?: string

options: {
analytics?: AnalyticType[];
lock?: {
lockId: string;
releaseLock?: boolean;
};
} = {}

`Optional` analytics?: AnalyticType[]

`Optional` lock?: {
lockId: string;
releaseLock?: boolean;
}