editor › Globals › UrlFilesApi

Class: UrlFilesApi

Offers assets that can be reached by calling URLs that represent a file system structure (e.g. kyub.io/resources/swivelCaster/metadata.yml)

Hierarchy

• UrlFilesApi

Implements

• IAssetApi

Index

Constructors

• constructor

Properties

• assetIdToFolderName
• assetListPromise
• rootPath

Methods

• _getAllAssets
• _getAssetFolderName
• _listAllAssets
• _loadAsset
• fillInContainerDetails
• getAllOfType
• getAllThatContain
• getAsset
• getByMetadata
• getName
• getResourceUrl
• setRootPath

Constructors

constructor

+ new UrlFilesApi(rootPath: string): UrlFilesApi

Defined in src/assets/UrlFilesApi.ts:20

Parameters:

Name	Type	Default	Description
rootPath	string	"./assetDb/"	@see UrlFilesApiClient#setRootPath

Returns: UrlFilesApi

Properties

Private assetIdToFolderName

• assetIdToFolderName: Map‹string, string›

Defined in src/assets/UrlFilesApi.ts:19

---

Private assetListPromise

• assetListPromise: Promise‹any›

Defined in src/assets/UrlFilesApi.ts:20

---

Private rootPath

• rootPath: string

Defined in src/assets/UrlFilesApi.ts:18

Methods

_getAllAssets

▸ _getAllAssets(): Promise‹Asset[]›

Defined in src/assets/UrlFilesApi.ts:153

Retrieves a list of all assets, then loads metadata for each asset individually

Returns: Promise‹Asset[]›

---

_getAssetFolderName

▸ _getAssetFolderName(assetId: any): Promise‹string›

Defined in src/assets/UrlFilesApi.ts:140

Parameters:

Name	Type
assetId	any

Returns: Promise‹string›

---

_listAllAssets

▸ _listAllAssets(): Promise‹any›

Defined in src/assets/UrlFilesApi.ts:169

Returns a promisified list of all assets ({folderName, id})

Returns: Promise‹any›

---

_loadAsset

▸ _loadAsset(assetId: string): Promise‹any›

Defined in src/assets/UrlFilesApi.ts:200

Instantiates an asset and loads metadata and resource file list

Parameters:

Name	Type
assetId	string

Returns: Promise‹any›

---

fillInContainerDetails

▸ fillInContainerDetails(fileContainer: any): Promise‹void›

Defined in src/assets/UrlFilesApi.ts:234

Parameters:

Name	Type
fileContainer	any

Returns: Promise‹void›

---

getAllOfType

▸ getAllOfType(assetType: string): Promise‹any[]›

Implementation of IAssetApi

Defined in src/assets/UrlFilesApi.ts:240

Parameters:

Name	Type
assetType	string

Returns: Promise‹any[]›

---

getAllThatContain

▸ getAllThatContain(kindOfResource: string): Promise‹any[]›

Implementation of IAssetApi

Defined in src/assets/UrlFilesApi.ts:50

Parameters:

Name	Type
kindOfResource	string

Returns: Promise‹any[]›

---

getAsset

▸ getAsset(id: string): Promise‹any›

Implementation of IAssetApi

Defined in src/assets/UrlFilesApi.ts:120

Parameters:

Name	Type
id	string

Returns: Promise‹any›

---

getByMetadata

▸ getByMetadata(query: any): Promise‹any[]›

Defined in src/assets/UrlFilesApi.ts:54

Parameters:

Name	Type
query	any

Returns: Promise‹any[]›

---

getName

▸ getName(): string

Implementation of IAssetApi

Defined in src/assets/UrlFilesApi.ts:36

Returns: string

---

getResourceUrl

▸ getResourceUrl(resource: any, fileInResource: any): string

Defined in src/assets/UrlFilesApi.ts:124

Parameters:

Name	Type
resource	any
fileInResource	any

Returns: string

---

setRootPath

▸ setRootPath(rootPath: string): void

Defined in src/assets/UrlFilesApi.ts:43

Parameters:

Name	Type	Description
rootPath	string	the URL root path where assets are stored

Returns: void