uStoreProvider api assets

Functions

getAssets(propertyID) ⇒ Promise.<AssetListItemResponseModelArray>

Gets collection of the graphic assets by dial ID.

getAsset(assetID) ⇒ Promise.<AssetResponseModel>

Gets graphic asset detailed data by asset ID.

deleteAsset(assetID) ⇒ string

Deletes uploaded graphic asset by ID.

uploadAsset(propertyID, data, replaceIfExists) ⇒ AssetListItemResponseModel

Uploads graphic asset.

Typedefs

AssetListItemResponseModelArray : Array.<AssetListItemResponseModel>

Collection of the assets.

GUID : string

globally unique identifier

AssetListItemResponseModel : Object

Provides graphic asset DTO.

AssetResponseModel : Object

Provides graphic asset DTO.

getAssets(propertyID) ⇒ Promise.<AssetListItemResponseModelArray>

Gets collection of the graphic assets by dial ID.

Kind: global function
Returns: Promise.<AssetListItemResponseModelArray> - Returns collection of the assets.

Param	Type	Description
propertyID	GUID	Graphic dial ID

getAsset(assetID) ⇒ Promise.<AssetResponseModel>

Gets graphic asset detailed data by asset ID.

Kind: global function
Returns: Promise.<AssetResponseModel> - Returns graphic assets detailed info.

Param	Type	Description
assetID	string	Graphic asset ID.

deleteAsset(assetID) ⇒ string

Deletes uploaded graphic asset by ID.

Kind: global function
Returns: string - Returns deleted graphic asset ID.

Param	Type	Description
assetID	GUID	Graphic asset ID.

uploadAsset(propertyID, data, replaceIfExists) ⇒ AssetListItemResponseModel

Uploads graphic asset.

Kind: global function
Returns: AssetListItemResponseModel - Returns uploaded asset.

Param	Type	Description
propertyID	GUID	Graphic dial ID
data	File	File to upload
replaceIfExists	boolean	When value 'true' and dial has asset with the same name the asset should be replaced by uploaded file

AssetListItemResponseModelArray : Array.<AssetListItemResponseModel>

Collection of the assets.

Kind: global typedef

GUID : string

globally unique identifier

Kind: global typedef

AssetListItemResponseModel : Object

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.

AssetResponseModel : Object

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.