Skip to content
Peter Shinners edited this page Apr 18, 2021 · 5 revisions
void setAssetAttributes(
    const std::string& assetId, 
    const std::string& scope,
    const StringMap& attrs
)

Optionally set additional metdata for an asset.

An asset reference could theoretically store additional information about an asset like comments, types, users, or timestamps. These values would be exposed through getAssetAttributes.

This differs from getAssetFields which are the values that uniquely define the asset itself. This function is about setting additional metadata and information about the asset.

The scope argument is used to modify which asset entity gets the data set. It can commonly be set to "version" or "name" which has similar meaning to the scope argument in getAssetForScope.

This call is entirely optional for an asset plugin. It is not used by Katana but provided as a general solution. Any attribute values that are unknown or have invalid values can be silently ignored. There is no requirement or expectation that this function will do anything.