Skip to content

Module: client/apis/ThumbnailsAPI

Table of contents

Classes

Type aliases

Type aliases

GetAssetsThumbnails

Ƭ GetAssetsThumbnails: object

Type declaration:

Name Type
data { imageUrl: string ; state: Error | string ; targetId: number }[]

Defined in: client/apis/ThumbnailsAPI.ts:12

GetAssetsThumbnailsOptions

Ƭ GetAssetsThumbnailsOptions: object

Type declaration:

Name Type
assetIds number[]
format? png | jpg
isCircular? boolean
returnPolicy? PlaceHolder | AutoGenerated | ForceAutoGenerated
size? 42x42 | 50x50 | 75x75 | 110x110 | 140x140 | 150x150 | 160x100 | 160x600 | 250x250 | 256x144 | 300x250 | 304x166 | 384x216 | 396x216 | 420x420 | 480x270 | 512x512 | 576x324 | 700x700 | 728x90 | 768x432

Defined in: client/apis/ThumbnailsAPI.ts:5

GetBadgesIcons

Ƭ GetBadgesIcons: GetAssetsThumbnails

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

GetBadgesIconsOptions

Ƭ GetBadgesIconsOptions: object

Type declaration:

Name Type
badgeIds number[]
format? png | jpg
isCircular? boolean
size? 150x150

Defined in: client/apis/ThumbnailsAPI.ts:19

GetBatchImages

Ƭ GetBatchImages: object

Type declaration:

Name Type
data { errorCode?: number ; errorMessage?: string ; imageUrl: string ; requestId: string ; state: Error | string ; targetId: number }[]

Defined in: client/apis/ThumbnailsAPI.ts:130

GetBatchImagesOptions

Ƭ GetBatchImagesOptions: object

Type declaration:

Name Type
isCircular boolean
requestId string
size string
targetId number
type Avatar | AvatarHeadShot | GameIcon | BadgeIcon | GameThumbnail | GamePass | Asset | BundleThumbnail | Outfit | GroupIcon | DeveloperProduct | AutoGeneratedAsset

Defined in: client/apis/ThumbnailsAPI.ts:123

GetBundlesThumbnails

Ƭ GetBundlesThumbnails: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:32

GetBundlesThumbnailsOptions

Ƭ GetBundlesThumbnailsOptions: object

Type declaration:

Name Type
bundleIds number[]
format? png | jpg
isCircular? boolean
size? 150x150 | 420x420

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

GetDeveloperProductsIcons

Ƭ GetDeveloperProductsIcons: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:39

GetDeveloperProductsIconsOptions

Ƭ GetDeveloperProductsIconsOptions: object

Type declaration:

Name Type
developerProductIds number[]
format? png | jpg
isCircular? boolean
size? 150x150 | 420x420

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

GetGamePassesIcons

Ƭ GetGamePassesIcons: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:46

GetGamePassesIconsOptions

Ƭ GetGamePassesIconsOptions: object

Type declaration:

Name Type
format? png | jpg
gamePassIds number[]
isCircular? boolean
size? 150x150

Defined in: client/apis/ThumbnailsAPI.ts:40

GetGroupsIcons

Ƭ GetGroupsIcons: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:94

GetGroupsIconsOptions

Ƭ GetGroupsIconsOptions: object

Type declaration:

Name Type
format? png | jpg
groupIds number[]
isCircular? boolean
size? 150x150 | 420x420

Defined in: client/apis/ThumbnailsAPI.ts:88

GetUniverseThumbnails

Ƭ GetUniverseThumbnails: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:54

GetUniverseThumbnailsOptions

Ƭ GetUniverseThumbnailsOptions: object

Type declaration:

Name Type
format? png | jpg
isCircular? boolean
size? 768x432 | 576x324 | 480x270 | 384x216 | 256x144
thumbnailIds number[]
universeId number

Defined in: client/apis/ThumbnailsAPI.ts:47

GetUniversesRootPlaceThumbnails

Ƭ GetUniversesRootPlaceThumbnails: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:62

GetUniversesRootPlaceThumbnailsOptions

Ƭ GetUniversesRootPlaceThumbnailsOptions: object

Type declaration:

Name Type
format? png | jpg
isCircular? boolean
returnPolicy? PlaceHolder | AutoGenerated | ForceAutoGenerated
size? 50x50 | 128x128 | 150x150 | 256x256 | 512x512
universeIds number[]

Defined in: client/apis/ThumbnailsAPI.ts:55

GetUniversesThumbnails

Ƭ GetUniversesThumbnails: object

Type declaration:

Name Type
data { error?: { code: number ; field: string ; fieldData: unknown ; message: string ; userFacingMessage: string } ; thumbnails: { imageUrl: string ; state: Error | string ; targetId: number }[] ; universeId: number }[]

Defined in: client/apis/ThumbnailsAPI.ts:71

GetUniversesThumbnailsOptions

Ƭ GetUniversesThumbnailsOptions: object

Type declaration:

Name Type
countPerUniverse? number
defaults? boolean
format? png | jpg
isCircular? boolean
size? 768x432 | 576x324 | 480x270 | 384x216 | 256x144
universeIds number[]

Defined in: client/apis/ThumbnailsAPI.ts:63

GetUsersAvatarBustImages

Ƭ GetUsersAvatarBustImages: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:108

GetUsersAvatarBustImagesOptions

Ƭ GetUsersAvatarBustImagesOptions: object

Type declaration:

Name Type
format? png | jpg
isCircular? boolean
size? 50x50 | 60x60 | 75x75
userIds number[]

Defined in: client/apis/ThumbnailsAPI.ts:102

GetUsersAvatarHeadShotsImages

Ƭ GetUsersAvatarHeadShotsImages: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:115

GetUsersAvatarHeadShotsImagesOptions

Ƭ GetUsersAvatarHeadShotsImagesOptions: object

Type declaration:

Name Type
format? png | jpg
isCircular? boolean
size? 48x48 | 50x50 | 60x60 | 75x75 | 110x110 | 150x150 | 180x180 | 352x352 | 420x420 | 720x720
userIds number[]

Defined in: client/apis/ThumbnailsAPI.ts:109

GetUsersFullBodyAvatarImages

Ƭ GetUsersFullBodyAvatarImages: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:101

GetUsersFullBodyAvatarImagesOptions

Ƭ GetUsersFullBodyAvatarImagesOptions: object

Type declaration:

Name Type
format? png | jpg
isCircular? boolean
size? 30x30 | 48x48 | 60x60 | 75x75 | 100x100 | 140x140 | 150x150 | 150x200 | 180x180 | 250x250 | 352x352 | 420x420 | 720x720
userIds number[]

Defined in: client/apis/ThumbnailsAPI.ts:95

GetUsersOutfitsImages

Ƭ GetUsersOutfitsImages: GetAssetsThumbnails

Defined in: client/apis/ThumbnailsAPI.ts:122

GetUsersOutfitsImagesOptions

Ƭ GetUsersOutfitsImagesOptions: object

Type declaration:

Name Type
format? png | jpg
isCircular? boolean
size? 150x150 | 420x420
userOutfitIds number[]

Defined in: client/apis/ThumbnailsAPI.ts:116