uStoreProvider services assets - XMPieLab/uStore-NG GitHub Wiki

Assets

Represent the assets logic in the system

GUID : string

globally unique identifier

AssetListItemResponseModel : Object

Provides graphic asset DTO.

AssetResponseModel : Object

Provides graphic asset DTO.

Represent the assets logic in the system

Kind: global class

• Assets
  • .getAssets(propertyID) ⇒ Array.<AssetListItemResponseModel>
  • .getAsset(assetID) ⇒ AssetResponseModel
  • .deleteAsset(assetID) ⇒ string
  • .uploadAsset(propertyID, data, replaceIfExists) ⇒ AssetListItemResponseModel

Set state.assets with the requested model as AssetListItemResponseModel

Kind: instance method of Assets
Returns: Array.<AssetListItemResponseModel> - Returns collection of the assets.

Param	Type	Description
propertyID	string	Graphic dial ID

Set state.selectedAsset with the requested assets model as AssetResponseModel

Kind: instance method of Assets
Returns: AssetResponseModel - Returns graphic assets detailed info.

Param	Type	Description
assetID	string	Graphic asset ID.

Filters the list of assets, removing the asset with the specified identifier.

Kind: instance method of Assets
Returns: string - Returns deleted graphic asset ID.

Param	Type	Description
assetID	string	Graphic asset ID.

Updates state.assets collection with the new graphic asset model as AssetListItemResponseModel2

Kind: instance method of Assets
Returns: AssetListItemResponseModel - Returns uploaded asset.

Param	Type	Description
propertyID	string	Graphic dial ID
data	File	File to upload
replaceIfExists	boolean	Show if asset should be replaced

globally unique identifier

Kind: global typedef

Provides graphic asset DTO.

Kind: global typedef
Properties

Name	Type	Description
ThumbnailUrl	string	Graphic asset thumbnail URL.
AssetID	string	Graphic asset ID.
DisplayName	string	Graphic asset name.
IsUploaded	boolean	Flag that use to distinguish user uploaded asset from PE asset.
FileName	string	Graphic asset name with extension.
ModificationDate	Date	Graphic asset modification date.

Provides graphic asset DTO.

Kind: global typedef
Properties

Name	Type	Description
AssetID	string	Graphic asset ID.
DisplayName	string	Graphic asset name.
IsUploaded	boolean	Flag that use to distinguish user uploaded asset from PE asset.
FileName	string	Graphic asset name with extension.
Url	string	Graphic asset URL to the original content.
ThumbnailUrl	string	Graphic asset thumbnail URL.
Width	number	Graphic asset width in pixels.
Height	number	Graphic asset height in pixels.
SizeKB	number	Graphic asset size in kilobyte.