Method GameCmsGetMultiplayerPlaylistConfiguration

GameCmsGetMultiplayerPlaylistConfiguration(String)

Gets the detailed configuration for a Halo Infinite playlist.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.PlaylistConfiguration,Den.Dev.Grunt.Models.RawResponseContainer>> GameCmsGetMultiplayerPlaylistConfiguration (string playlistFile);

Parameters

Type	Name	Description
System.String	playlistFile	JSON file associated with a playlist. Example is "a446725e-b281-414c-a21e-31b8700e95a1.json".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<PlaylistConfiguration,RawResponseContainer>>	If successful, an instance of PlaylistConfiguration containing playlist configuration. Otherwise, returns null and error details.

Examples

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

   {
       "NameHint": "bot_arena",
       "UgcPlaylistVersion": "ac9b3a8e-e585-40ea-9bd7-b03b2a19b114",
       "PlatformMatchmakingHopperId": "GA-RETAIL_bot_arena",
       "GameStartRulesId": "arenaRules",
       "ThunderheadContentConfiguration": "NonCampaign",
       "ThunderheadVmSize": "Medium",
       "TrueMatchSettings": "singleTeamLoose.json",
       "HasCsr": false,
       "PlaylistExperience": "PveBots",
       "MatchmakingDelaySec": 0
   }