Module: client/apis/AssetDeliveryAPI

Table of contents

Classes

• default

Type aliases

• BaseAsset
• BaseAssetDeliveryOptions
• BaseAssetRaw
• GetAssetByAlias
• GetAssetByAliasOptions
• GetAssetByAssetId
• GetAssetByAssetIdOptions
• GetAssetByAssetVersionId
• GetAssetByAssetVersionIdOptions
• GetAssetByHash
• GetAssetByHashOptions
• GetAssetById
• GetAssetByIdOptions
• GetAssetByMarAssetHash
• GetAssetByMarAssetHashOptions
• GetAssetByUserAssetId
• GetAssetByUserAssetIdOptions
• GetAssetVersionByAssetId
• GetAssetVersionByAssetIdOptions
• GetBatchAssets
• GetBatchAssetsOptions

Type aliases

BaseAsset

Ƭ BaseAsset: object

Type declaration:

Name	Type
errors?	{ code: number ; message: string }[]
isArchived?	boolean
isCopyrightProtected?	boolean
isHashDynamic?	boolean
location?	string
requestId?	string

Defined in: client/apis/AssetDeliveryAPI.ts:17

---

BaseAssetDeliveryOptions

Ƭ BaseAssetDeliveryOptions: object

Type declaration:

Name	Type
accept	string
acceptEncoding	string
assetType	string
clientInsert	number
expectedAssetType	string
modulePlaceId	number
robloxPlaceId	number
scriptInsert	number
serverPlaceId	number
skipSigningScripts	boolean

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

---

BaseAssetRaw

Ƭ BaseAssetRaw: object

Type declaration:

Name	Type
Errors?	{ Code: number ; Message: string }[]
IsArchived?	boolean
IsCopyrightProtected?	boolean
IsHashDynamic?	boolean
Location?	string
RequestId?	string

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

---

GetAssetByAlias

Ƭ GetAssetByAlias: BaseAsset

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

---

GetAssetByAliasOptions

Ƭ GetAssetByAliasOptions: BaseAssetDeliveryOptions & { alias: string }

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

---

GetAssetByAssetId

Ƭ GetAssetByAssetId: unknown

Defined in: client/apis/AssetDeliveryAPI.ts:72

---

GetAssetByAssetIdOptions

Ƭ GetAssetByAssetIdOptions: BaseAssetDeliveryOptions & { assetId: number }

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

---

GetAssetByAssetVersionId

Ƭ GetAssetByAssetVersionId: unknown

Defined in: client/apis/AssetDeliveryAPI.ts:76

---

GetAssetByAssetVersionIdOptions

Ƭ GetAssetByAssetVersionIdOptions: BaseAssetDeliveryOptions & { assetVersionId: number }

Defined in: client/apis/AssetDeliveryAPI.ts:75

---

GetAssetByHash

Ƭ GetAssetByHash: unknown

Defined in: client/apis/AssetDeliveryAPI.ts:70

---

GetAssetByHashOptions

Ƭ GetAssetByHashOptions: BaseAssetDeliveryOptions & { hash: string }

Defined in: client/apis/AssetDeliveryAPI.ts:69

---

GetAssetById

Ƭ GetAssetById: object

Type declaration:

Name	Type
location?	string
request?	unknown

Defined in: client/apis/AssetDeliveryAPI.ts:65

---

GetAssetByIdOptions

Ƭ GetAssetByIdOptions: BaseAssetDeliveryOptions & { id: number }

Defined in: client/apis/AssetDeliveryAPI.ts:64

---

GetAssetByMarAssetHash

Ƭ GetAssetByMarAssetHash: unknown

Defined in: client/apis/AssetDeliveryAPI.ts:78

---

GetAssetByMarAssetHashOptions

Ƭ GetAssetByMarAssetHashOptions: BaseAssetDeliveryOptions & { marAssetHash: string ; marCheckSum: string }

Defined in: client/apis/AssetDeliveryAPI.ts:77

---

GetAssetByUserAssetId

Ƭ GetAssetByUserAssetId: unknown

Defined in: client/apis/AssetDeliveryAPI.ts:80

---

GetAssetByUserAssetIdOptions

Ƭ GetAssetByUserAssetIdOptions: BaseAssetDeliveryOptions & { userAssetId: number }

Defined in: client/apis/AssetDeliveryAPI.ts:79

---

GetAssetVersionByAssetId

Ƭ GetAssetVersionByAssetId: unknown

Defined in: client/apis/AssetDeliveryAPI.ts:74

---

GetAssetVersionByAssetIdOptions

Ƭ GetAssetVersionByAssetIdOptions: BaseAssetDeliveryOptions & { assetId: number ; version: number }

Defined in: client/apis/AssetDeliveryAPI.ts:73

---

GetBatchAssets

Ƭ GetBatchAssets: BaseAsset[]

Defined in: client/apis/AssetDeliveryAPI.ts:99

---

GetBatchAssetsOptions

Ƭ GetBatchAssetsOptions: object

Type declaration:

Name	Type
accept	string
assetId	number
assetName	string
assetType	string
assetVersionId	number
clientInsert	boolean
encoding	string
hash	string
modulePlaceId	number
placeId	number
requestId	string
scriptInsert	boolean
serverPlaceId	number
universeId	number
userAssetId	number
version	number

Defined in: client/apis/AssetDeliveryAPI.ts:81