editor › Globals › RemoteAssetApi

Class: RemoteAssetApi

Offers Assets by querying a remote API endpoint

Hierarchy

• RemoteAssetApi

Implements

• IAssetApi

Index

Constructors

• constructor

Properties

• endpoint
• loadingResourcesPromises

Methods

• _buildAssetFromJson
• _patchMetadata
• deleteAsset
• fillInContainerDetails
• getAllOfType
• getAllThatContain
• getAsset
• getByMetadata
• getName
• getResourceUrl

Constructors

constructor

+ new RemoteAssetApi(endpoint: string): RemoteAssetApi

Defined in src/assets/RemoteAssetApi.ts:15

Parameters:

Name	Type	Default	Description
endpoint	string	"./"	URL of the API endpoint

Returns: RemoteAssetApi

Properties

Private Readonly endpoint

• endpoint: string

Defined in src/assets/RemoteAssetApi.ts:13

---

Private loadingResourcesPromises

• loadingResourcesPromises: Map‹Resource‹›, Promise‹void›› = new Map>()

Defined in src/assets/RemoteAssetApi.ts:15

Methods

Private _buildAssetFromJson

▸ _buildAssetFromJson(json: any): any

Defined in src/assets/RemoteAssetApi.ts:154

Parameters:

Name	Type
json	any

Returns: any

---

Private _patchMetadata

▸ _patchMetadata(metadataKeys: object): object

Defined in src/assets/RemoteAssetApi.ts:143

Modifies the metadata keys to result in a not-so-strict query The difference is: - Directly querying for metadata: {…} expects the metadata to be the same (equal contents) - Query for metadata.key: value, metadata.key2: value2 expects metadata to contain key and equal value but allows for additional, not-queried keys to be present https://docs.mongodb.com/manual/tutorial/query-embedded-documents/#query-on-nested-field

Parameters:

Name	Type	Default
metadataKeys	object	{}

Returns: object

---

deleteAsset

▸ deleteAsset(id: string): Promise‹boolean›

Implementation of IAssetApi

Defined in src/assets/RemoteAssetApi.ts:125

Parameters:

Name	Type
id	string

Returns: Promise‹boolean›

---

fillInContainerDetails

▸ fillInContainerDetails(container: Resource): Promise‹void›

Defined in src/assets/RemoteAssetApi.ts:60

Parameters:

Name	Type
container	Resource

Returns: Promise‹void›

---

getAllOfType

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

Implementation of IAssetApi

Defined in src/assets/RemoteAssetApi.ts:117

Parameters:

Name	Type
assetType	string

Returns: Promise‹any[]›

---

getAllThatContain

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

Implementation of IAssetApi

Defined in src/assets/RemoteAssetApi.ts:121

Parameters:

Name	Type
kindOfResource	string

Returns: Promise‹any[]›

---

getAsset

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

Implementation of IAssetApi

Defined in src/assets/RemoteAssetApi.ts:54

Parameters:

Name	Type
id	string

Returns: Promise‹any›

---

getByMetadata

▸ getByMetadata(metadata: any): Promise‹any›

Defined in src/assets/RemoteAssetApi.ts:30

Parameters:

Name	Type	Default
metadata	any	{}

Returns: Promise‹any›

---

getName

▸ getName(): string

Implementation of IAssetApi

Defined in src/assets/RemoteAssetApi.ts:26

Returns: string

---

getResourceUrl

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

Defined in src/assets/RemoteAssetApi.ts:111

Parameters:

Name	Type
resource	FileContainer
fileInResource	string

Returns: string