Method HIUGCFavoriteAnAsset

HIUGCFavoriteAnAsset(String, String, String)

Favorites an asset for the player.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.FavoriteAsset,Den.Dev.Grunt.Models.RawResponseContainer>> HIUGCFavoriteAnAsset (string player, string assetType, string assetId);

Parameters

Type	Name	Description
System.String	player	The unique player XUID, in the format "xuid(XUID_VALUE)".
System.String	assetType	Type of asset to check. Example value is "UgcGameVariants".
System.String	assetId	Unique ID for the asset. Example value is "f96f57e2-9f15-45c5-83ac-5775a48d2ba8" for "Attrition-Default-UGC".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<FavoriteAsset,RawResponseContainer>>	If successful, returns an instance of FavoriteAsset confirming the addition of the asset to favorites. Otherwise, returns null.

Remarks

This method expects a JSON body, but I don't yet know what the underlying data structure is.

Examples

Here is an example response from the API, as snapshotted on 7/18/2022:

   {
       "Links": {},
       "Name": "",
       "Description": "",
       "AssetId": "b5ed517c-ce50-4919-95b2-41197f644ad6",
       "AssetVersionId": null,
       "CustomData": {},
       "VersionRatings": null,
       "AssetKind": 6
   }