Class: default

client/apis/AvatarAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• createOutfit
• deleteOutfit
• getAvatarMetaData
• getAvatarRules
• getOutfit
• getRecentlyUsed
• getSelfAvatar
• getUserAvatar
• getUserCurrentlyWearing
• getUserOutfits
• redrawThumbnail
• removeAssetFromAvatar
• request
• setSelfAvatarBodyColors
• setSelfAvatarScales
• setSelfAvatarType
• setSelfWearingAssets
• updateOutfit
• wearAssetOnAvatar
• wearOutfit

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/AvatarAPI.ts:219

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

createOutfit

▸ createOutfit(options: Pick<GetOutfit, name | assets | bodyColors | scale | playerAvatarType>): Promise<CreateOutfit>

Parameters:

Name	Type
options	Pick<GetOutfit, name | assets | bodyColors | scale | playerAvatarType>

Returns: Promise<CreateOutfit>

Defined in: client/apis/AvatarAPI.ts:429

---

deleteOutfit

▸ deleteOutfit(options: DeleteOutfitOptions): Promise<DeleteOutfit>

Parameters:

Name	Type
options	DeleteOutfitOptions

Returns: Promise<DeleteOutfit>

Defined in: client/apis/AvatarAPI.ts:392

---

getAvatarMetaData

▸ getAvatarMetaData(): Promise<GetAvatarMetadata>

Returns: Promise<GetAvatarMetadata>

Defined in: client/apis/AvatarAPI.ts:238

---

getAvatarRules

▸ getAvatarRules(): Promise<GetAvatarRules>

Returns: Promise<GetAvatarRules>

Defined in: client/apis/AvatarAPI.ts:249

---

getOutfit

▸ getOutfit(options: GetOutfitOptions): Promise<GetOutfit>

Parameters:

Name	Type
options	GetOutfitOptions

Returns: Promise<GetOutfit>

Defined in: client/apis/AvatarAPI.ts:381

---

getRecentlyUsed

▸ getRecentlyUsed(options: GetRecentItemsOptions): Promise<GetRecentItems>

Parameters:

Name	Type
options	GetRecentItemsOptions

Returns: Promise<GetRecentItems>

Defined in: client/apis/AvatarAPI.ts:442

---

getSelfAvatar

▸ getSelfAvatar(): Promise<UserAvatar>

Returns: Promise<UserAvatar>

Defined in: client/apis/AvatarAPI.ts:227

---

getUserAvatar

▸ getUserAvatar(options: GetUserAvatarOptions): Promise<UserAvatar>

Parameters:

Name	Type
options	GetUserAvatarOptions

Returns: Promise<UserAvatar>

Defined in: client/apis/AvatarAPI.ts:260

---

getUserCurrentlyWearing

▸ getUserCurrentlyWearing(options: GetUserCurrentlyWearingOptions): Promise<GetUserCurrentlyWearing>

Parameters:

Name	Type
options	GetUserCurrentlyWearingOptions

Returns: Promise<GetUserCurrentlyWearing>

Defined in: client/apis/AvatarAPI.ts:271

---

getUserOutfits

▸ getUserOutfits(options: GetUserOutfitsOptions): Promise<GetUserOutfits>

Parameters:

Name	Type
options	GetUserOutfitsOptions

Returns: Promise<GetUserOutfits>

Defined in: client/apis/AvatarAPI.ts:282

---

redrawThumbnail

▸ redrawThumbnail(): Promise<unknown>

Returns: Promise<unknown>

Defined in: client/apis/AvatarAPI.ts:317

---

removeAssetFromAvatar

▸ removeAssetFromAvatar(options: RemoveAssetFromAvatarOptions): Promise<RemoveAssetFromAvatar>

Parameters:

Name	Type
options	RemoveAssetFromAvatarOptions

Returns: Promise<RemoveAssetFromAvatar>

Defined in: client/apis/AvatarAPI.ts:293

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

setSelfAvatarBodyColors

▸ setSelfAvatarBodyColors(options: BodyColors): Promise<SetBodyColors>

Parameters:

Name	Type
options	BodyColors

Returns: Promise<SetBodyColors>

Defined in: client/apis/AvatarAPI.ts:329

---

setSelfAvatarScales

▸ setSelfAvatarScales(options: BodyScales): Promise<SetPlayerAvatarScales>

Parameters:

Name	Type
options	BodyScales

Returns: Promise<SetPlayerAvatarScales>

Defined in: client/apis/AvatarAPI.ts:355

---

setSelfAvatarType

▸ setSelfAvatarType(options: SetPlayerAvatarTypeOptions): Promise<SetPlayerAvatarType>

Parameters:

Name	Type
options	SetPlayerAvatarTypeOptions

Returns: Promise<SetPlayerAvatarType>

Defined in: client/apis/AvatarAPI.ts:342

---

setSelfWearingAssets

▸ setSelfWearingAssets(options: SetPlayerAvatarWearingAssetsOptions): Promise<GetUserCurrentlyWearing>

Parameters:

Name	Type
options	SetPlayerAvatarWearingAssetsOptions

Returns: Promise<GetUserCurrentlyWearing>

Defined in: client/apis/AvatarAPI.ts:368

---

updateOutfit

▸ updateOutfit(options: Pick<GetOutfit, id | name | assets | bodyColors | scale | playerAvatarType>): Promise<UpdateOutfit>

Parameters:

Name	Type
options	Pick<GetOutfit, id | name | assets | bodyColors | scale | playerAvatarType>

Returns: Promise<UpdateOutfit>

Defined in: client/apis/AvatarAPI.ts:404

---

wearAssetOnAvatar

▸ wearAssetOnAvatar(options: WearAssetOnAvatarOptions): Promise<WearAssetOnAvatar>

Parameters:

Name	Type
options	WearAssetOnAvatarOptions

Returns: Promise<WearAssetOnAvatar>

Defined in: client/apis/AvatarAPI.ts:305

---

wearOutfit

▸ wearOutfit(options: WearOutfitOptions): Promise<SetPlayerAvatarWearingAssets>

Parameters:

Name	Type
options	WearOutfitOptions

Returns: Promise<SetPlayerAvatarWearingAssets>

Defined in: client/apis/AvatarAPI.ts:417