Class LocalCustomAvatars

Provider for custom mannequins. The methods defined by this interface are used to store the data for the avatar. How you store the data is completely up to you.

Implements

MutableAvatarProvider

Index

Constructors

Methods

deleteById getById getGender getIds getName getThumbnail setGender setName setThumbnail storeById

Constructors

constructor

new LocalCustomAvatars(name): LocalCustomAvatars
Parameters
- name: string
Returns LocalCustomAvatars
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:12

Methods

deleteById

deleteById(id): Promise<void>
Deletes the avatar with the given id
Parameters
- id: ReferenceData
  Unique ID auf the avatar
Returns Promise<void>
Implementation of MutableAvatarProvider.deleteById
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:68

getById

getById(id): Promise<undefined | AssetInfo>
Returns the asset bundle for a specific resource
Parameters
- id: ReferenceData
  Unique ID if the garment as used in your systems
Returns Promise<undefined | AssetInfo>
Implementation of MutableAvatarProvider.getById
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:31

getGender

getGender(id): Promise<undefined | Gender>
Returns the gender of an avatar as enum.
Parameters
- id: ReferenceData
  Unique ID of the avatar
Returns Promise<undefined | Gender>
Implementation of MutableAvatarProvider.getGender
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:60

getIds

getIds(): Promise<ReferenceData[]>
Returns a list of ids for the available resources for this provider.

Returns Promise<ReferenceData[]>
Implementation of MutableAvatarProvider.getIds
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:16

getName

getName(id): Promise<undefined | string>
Returns the display name of the avatar as string. This will be shown in the avatar selection drawer.
Parameters
- id: ReferenceData
  Unique ID of the avatar
Returns Promise<undefined | string>
Implementation of MutableAvatarProvider.getName
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:45

getThumbnail

getThumbnail(id): Promise<undefined | string>
Returns an url to the thumbail image of the avatar. This will be shown in the avater selection drawer. Thumbnails should ideally be square.
Parameters
- id: ReferenceData
  Unique ID of the avatar
Returns Promise<undefined | string>
Implementation of MutableAvatarProvider.getThumbnail
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:52

setGender

setGender(id, gender): Promise<void>
Sets the gender of the avatar with the given ID.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- gender: Gender
  Genderof the avatar
Returns Promise<void>
Implementation of MutableAvatarProvider.setGender
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:88

setName

setName(id, name): Promise<void>
Sets the name for the avatar with the given ID.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- name: string
  Name of the avatar
Returns Promise<void>
Implementation of MutableAvatarProvider.setName
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:80

setThumbnail

setThumbnail(id, thumbnail): Promise<void>
Sets the thumbnail for the avatar encoded as base64 string.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- thumbnail: string
  Thumbnail png in base64 format
Returns Promise<void>
Implementation of MutableAvatarProvider.setThumbnail
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:96

storeById

storeById(id, asset): Promise<void>
Stores the avatar's assets persistently for the given ID. How you actually store them is up to you.
Parameters
- id: ReferenceData
  Unique ID of the avatar
- asset: AssetInfo
  Asset container object
Returns Promise<void>
Implementation of MutableAvatarProvider.storeById
- Defined in packages/public-types/src/adaptors/localCustomAvatars/index.ts:72