Method HIUGCCheckAssetPlayerBookmark

HIUGCCheckAssetPlayerBookmark(String, String, String, String)

Checks whether the player has favorited a specific asset.

Declaration

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

Parameters

Type	Name	Description
System.String	title	Title for which the asset should be obtained. An example value is "hi".
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 "373f3d27-cb4c-4d7b-b6c9-7757de3c1133" for "Arena:King of the Hill".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<FavoriteAsset,RawResponseContainer>>	If successful, returns an instance of FavoriteAsset containing asset information. Otherwise, returns null.

Examples

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

   {
       "Links": {},
       "Name": "Arena:King of the Hill",
       "Description": "Hold the Hill. Hail to the King.",
       "AssetId": "373f3d27-cb4c-4d7b-b6c9-7757de3c1133",
       "AssetVersionId": "ad7c1591-fe57-4ef7-8b0b-a4ba861fd8d7",
       "CustomData": {},
       "VersionRatings": null,
       "AssetKind": 6
   }