Method HIUGCListPlayerAssets

HIUGCListPlayerAssets(String, String, Int32, Int32, Boolean, String, ResultOrder, List<String>, AssetKind)

Gets information about all authored assets that a player owns.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.AuthoringAssetContainer,Den.Dev.Grunt.Models.RawResponseContainer>> HIUGCListPlayerAssets (string title, string player, int start, int count, bool includeTimes, string sort, Den.Dev.Grunt.Models.HaloInfinite.ResultOrder order, System.Collections.Generic.List<string> keywords, Den.Dev.Grunt.Models.HaloInfinite.AssetKind kind);

Parameters

Type	Name	Description
System.String	title	Title which contains the asset. An example value here is "hi".
System.String	player	The unique player XUID, in the format "xuid(XUID_VALUE)".
System.Int32	start	Number of results from which to start the iteration.
System.Int32	count	Number of assets to return. Maximum is 25. Going beyond 25 will result in only 25 values being returned.
System.Boolean	includeTimes	Include times for asset modification.
System.String	sort	Property by which to sort the results. Example is "PlaysRecent".
ResultOrder	order	Determines whether results are ordered in descending or ascending order.
System.Collections.Generic.List<System.String>	keywords	List of keywords by which to filter.
AssetKind	kind	Type of asset to return.

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<AuthoringAssetContainer,RawResponseContainer>>	If successful, returns an instance of AuthoringAssetContainer containing information about assets a player owns. Otherwise, returns null.

Remarks

The underlying request supports specifying parameters that limit the search, such as ?start=number, however that is not yet implemented in this version of the API wrapper.

Examples

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

   {
       "EstimatedTotal": 3,
       "Start": 0,
       "Count": 13,
       "ResultCount": 3,
       "Results": [
           {
               "Images": [],
               "LatestVersionId": "46e10e8e-38d0-4098-8588-1afc8a5cad14",
               "PublicName": "TestNameValidation",
               "AssetId": "5327af52-98c0-472a-b02f-733c9b43ff93",
               "Kind": 6,
               "OriginalOwner": "xuid(PLAYER_XUID_HERE)",
               "Admin": "xuid(PLAYER_XUID_HERE)",
               "LastModifiedDateUtc": {
                   "ISO8601Date": "2022-07-09T01:08:17.694Z"
               },
               "CreatedDateUtc": {
                   "ISO8601Date": "2022-05-23T23:58:50.532Z"
               },
               "InternalName": "Attrition-Default-UGC",
               "Description": "",
               "HardDeleteTimeUtc": null,
               "Permissions": [
                   {
                       "CanonicalToken": "xuid(PLAYER_XUID_HERE)",
                       "AuthoringRole": 6,
                       "GrantedBy": "the_guardians",
                       "GrantedOnDateUtc": {
                           "ISO8601Date": "2022-05-23T23:58:50.532Z"
                       }
                   }
               ],
               "AssetStats": {
                   "Favorites": 0,
                   "FilmBookmarks": 0,
                   "Likes": 0,
                   "Ratings": {
                       "AverageRating": 0.0,
                       "TotalCount": 0,
                       "Ratings": []
                   },
                   "ParentAssetCount": 0,
                   "LastModifiedDateUtc": {
                       "ISO8601Date": "2022-05-24T00:08:40.58Z"
                   },
                   "IgnoreReports": false
               },
               "AssetHome": 2,
               "IsCurrentlyBeingEdited": false
           },
           {
               "Images": [],
               "LatestVersionId": "2674c887-7aa1-42ab-a6cd-4a2c60611d0e",
               "PublicName": "Arena:Attrition",
               "AssetId": "f96f57e2-9f15-45c5-83ac-5775a48d2ba8",
               "Kind": 6,
               "OriginalOwner": "xuid(PLAYER_XUID_HERE)",
               "Admin": "xuid(PLAYER_XUID_HERE)",
               "LastModifiedDateUtc": {
                   "ISO8601Date": "2022-05-23T23:59:18.306Z"
               },
               "CreatedDateUtc": {
                   "ISO8601Date": "2022-05-23T23:59:02.154Z"
               },
               "InternalName": "Attrition-Default-UGC",
               "Description": "",
               "HardDeleteTimeUtc": null,
               "Permissions": [
                   {
                       "CanonicalToken": "xuid(PLAYER_XUID_HERE)",
                       "AuthoringRole": 6,
                       "GrantedBy": "the_guardians",
                       "GrantedOnDateUtc": {
                           "ISO8601Date": "2022-05-23T23:59:02.154Z"
                       }
                   }
               ],
               "AssetStats": {
                   "Favorites": 0,
                   "FilmBookmarks": 0,
                   "Likes": 0,
                   "Ratings": {
                       "AverageRating": 0.0,
                       "TotalCount": 0,
                       "Ratings": []
                   },
                   "ParentAssetCount": 0,
                   "LastModifiedDateUtc": {
                       "ISO8601Date": ""
                   },
                   "IgnoreReports": false
               },
               "AssetHome": 2,
               "IsCurrentlyBeingEdited": false
           },
           {
               "Images": [],
               "LatestVersionId": "998b36ee-2250-40b9-be61-04316b90610d",
               "PublicName": "Arena:Attrition",
               "AssetId": "cefd4723-7bf2-4784-91bb-7c7c3dc9e324",
               "Kind": 6,
               "OriginalOwner": "xuid(PLAYER_XUID_HERE)",
               "Admin": "xuid(PLAYER_XUID_HERE)",
               "LastModifiedDateUtc": {
                   "ISO8601Date": "2022-04-28T01:06:41.468Z"
               },
               "CreatedDateUtc": {
                   "ISO8601Date": "2022-01-27T19:09:09.877Z"
               },
               "InternalName": "Attrition-Default-UGC",
               "Description": "",
               "HardDeleteTimeUtc": null,
               "Permissions": [
                   {
                       "CanonicalToken": "xuid(PLAYER_XUID_HERE)",
                       "AuthoringRole": 6,
                       "GrantedBy": "the_guardians",
                       "GrantedOnDateUtc": {
                           "ISO8601Date": "2022-01-27T19:09:09.877Z"
                       }
                   }
               ],
               "AssetStats": {
                   "Favorites": 0,
                   "FilmBookmarks": 0,
                   "Likes": 0,
                   "Ratings": {
                       "AverageRating": 0.0,
                       "TotalCount": 0,
                       "Ratings": []
                   },
                   "ParentAssetCount": 0,
                   "LastModifiedDateUtc": {
                       "ISO8601Date": ""
                   },
                   "IgnoreReports": false
               },
               "AssetHome": 2,
               "IsCurrentlyBeingEdited": false
           }
       ],
       "Links": {}
   }