C# Class HaloEzAPI.HaloAPIService

Inheritance: IHaloAPIService

Mostrar archivo Open project: glitch100/Halo-API Class Usage Examples

Public Methods

Method	Description
GetArenaPostGameCarnageReport ( System.Guid matchId ) : Task	Get a post game carnage report for a specified match id
GetArenaServiceRecords ( [ players ) : Task	Gets Arena Service Record for specified list of players
GetCampaignMissions ( ) : Task>
GetCampaignPostGameCarnageReport ( System.Guid matchId ) : Task	Get Campaign Post Game Carnage report for a specified match id
GetCampaignServiceRecords ( [ players ) : Task	Get Campaign Service Record for specified list of players
GetCommendations ( ) : Task>
GetCustomGameServiceRecords ( [ players ) : Task	Get Custom Game Service Record for specified list of players
GetCustomPostGameCarnageReport ( System.Guid matchId ) : Task	Get Custom Post Game Carnage report for a specified match id
GetEnemies ( ) : Task>
GetEventsForMatch ( string matchId ) : Task
GetFlexibleStats ( ) : Task>
GetGameBaseVariants ( ) : Task>
GetGameVariant ( string id ) : Task
GetImpulses ( ) : Task>
GetMapVariant ( string id ) : Task
GetMaps ( ) : Task>
GetMatchesForPlayer ( string gamerTag, GameMode gameMode, int start, int count = 25 ) : Task	Get matches for a specific player, for specific gamemodes, and paginated
GetMedals ( ) : Task>
GetPlaylists ( ) : Task>
GetProfileEmblem ( string gamerTag, int size = 256 ) : Task
GetRequisition ( System.Guid id ) : Task
GetRequisitionPack ( System.Guid id ) : Task
GetRequisitionPacks ( ) : Task>
GetSeasons ( ) : Task>
GetSkulls ( ) : Task>
GetSpartanImage ( string gamerTag, int size = 256, CropType cropType = CropType.Full ) : Task
GetSpartanRanks ( ) : Task>
GetTeamColours ( ) : Task>
GetUGCGameVariant ( string gamerTag, string variantId ) : Task	Get a specific UGC Game Variant for a specific player via id
GetUGCGameVariants ( string gamerTag, int start, int count, Sort sort, Order order ) : Task>	Returns a list of UGC Game Variants for a specific player
GetUGCMapVariant ( string gamerTag, string variantId ) : Task	Get a specific UGC Map Variant for a specific player via id
GetUGCMapVariants ( string gamerTag, int start, int count, Sort sort, Order order ) : Task>	Returns a list of UGC Map Variants for a specific player
GetVehicles ( ) : Task>
GetWarzonePostGameCarnageReport ( System.Guid matchId ) : Task	Get Warzone Post Game Carnage report for a specified match id
GetWarzoneServiceRecords ( [ players ) : Task	Get Warzone Service Record for specified list of players
GetWeapons ( ) : Task>
HaloAPIService ( string apiToken, string baseApiUrl = "https://www.haloapi.com" ) : System
PlayerLeaderboard ( string seasonId, string playlistId, int count = 200 ) : Task	Gets the Player leaderboard for a season and playlist

Method Details

GetArenaPostGameCarnageReport() public method

Get a post game carnage report for a specified match id

public GetArenaPostGameCarnageReport ( System.Guid matchId ) : Task
matchId	System.Guid	The Match Id
return	Task

GetArenaServiceRecords() public method

Gets Arena Service Record for specified list of players

public GetArenaServiceRecords ( [ players ) : Task
players	[	Up to 32 Players can be requested
return	Task

GetCampaignMissions() public method

public GetCampaignMissions ( ) : Task>
return	Task>

GetCampaignPostGameCarnageReport() public method

Get Campaign Post Game Carnage report for a specified match id

public GetCampaignPostGameCarnageReport ( System.Guid matchId ) : Task
matchId	System.Guid	The match id
return	Task

GetCampaignServiceRecords() public method

Get Campaign Service Record for specified list of players

public GetCampaignServiceRecords ( [ players ) : Task
players	[	Up to 32 players can be requested>
return	Task

GetCommendations() public method

public GetCommendations ( ) : Task>
return	Task>

GetCustomGameServiceRecords() public method

Get Custom Game Service Record for specified list of players

public GetCustomGameServiceRecords ( [ players ) : Task
players	[	Up to 32 players can be requested>
return	Task

GetCustomPostGameCarnageReport() public method

Get Custom Post Game Carnage report for a specified match id

public GetCustomPostGameCarnageReport ( System.Guid matchId ) : Task
matchId	System.Guid	The match id
return	Task

GetEnemies() public method

public GetEnemies ( ) : Task>
return	Task>

GetEventsForMatch() public method

public GetEventsForMatch ( string matchId ) : Task
matchId	string
return	Task

GetFlexibleStats() public method

public GetFlexibleStats ( ) : Task>
return	Task>

GetGameBaseVariants() public method

public GetGameBaseVariants ( ) : Task>
return	Task>

GetGameVariant() public method

public GetGameVariant ( string id ) : Task
id	string
return	Task

GetImpulses() public method

public GetImpulses ( ) : Task>
return	Task>

GetMapVariant() public method

public GetMapVariant ( string id ) : Task
id	string
return	Task

GetMaps() public method

public GetMaps ( ) : Task>
return	Task>

GetMatchesForPlayer() public method

Get matches for a specific player, for specific gamemodes, and paginated

public GetMatchesForPlayer ( string gamerTag, GameMode gameMode, int start, int count = 25 ) : Task
gamerTag	string	Players gamertag
gameMode	GameMode	Any gamemodes to filter by
start	int	Start of result set
count	int	Count of results at any one time
return	Task

GetMedals() public method

public GetMedals ( ) : Task>
return	Task>

GetPlaylists() public method

public GetPlaylists ( ) : Task>
return	Task>

GetProfileEmblem() public method

public GetProfileEmblem ( string gamerTag, int size = 256 ) : Task
gamerTag	string
size	int
return	Task

GetRequisition() public method

public GetRequisition ( System.Guid id ) : Task
id	System.Guid
return	Task

GetRequisitionPack() public method

public GetRequisitionPack ( System.Guid id ) : Task
id	System.Guid
return	Task

GetRequisitionPacks() public method

public GetRequisitionPacks ( ) : Task>
return	Task>

GetSeasons() public method

public GetSeasons ( ) : Task>
return	Task>

GetSkulls() public method

public GetSkulls ( ) : Task>
return	Task>

GetSpartanImage() public method

public GetSpartanImage ( string gamerTag, int size = 256, CropType cropType = CropType.Full ) : Task
gamerTag	string
size	int
cropType	CropType
return	Task

GetSpartanRanks() public method

public GetSpartanRanks ( ) : Task>
return	Task>

GetTeamColours() public method

public GetTeamColours ( ) : Task>
return	Task>

GetUGCGameVariant() public method

Get a specific UGC Game Variant for a specific player via id

public GetUGCGameVariant ( string gamerTag, string variantId ) : Task
gamerTag	string	Players gamertag
variantId	string	Id of the game variant
return	Task

GetUGCGameVariants() public method

Returns a list of UGC Game Variants for a specific player

public GetUGCGameVariants ( string gamerTag, int start, int count, Sort sort, Order order ) : Task>
gamerTag	string	Players gamertag
start	int
count	int
sort	Sort
order	Order
return	Task>

GetUGCMapVariant() public method

Get a specific UGC Map Variant for a specific player via id

public GetUGCMapVariant ( string gamerTag, string variantId ) : Task
gamerTag	string	Players gamertag
variantId	string	Id of the game variant
return	Task

GetUGCMapVariants() public method

Returns a list of UGC Map Variants for a specific player

public GetUGCMapVariants ( string gamerTag, int start, int count, Sort sort, Order order ) : Task>
gamerTag	string	Players gamertag
start	int
count	int
sort	Sort
order	Order
return	Task>

GetVehicles() public method

public GetVehicles ( ) : Task>
return	Task>

GetWarzonePostGameCarnageReport() public method

Get Warzone Post Game Carnage report for a specified match id

public GetWarzonePostGameCarnageReport ( System.Guid matchId ) : Task
matchId	System.Guid	The match id
return	Task

GetWarzoneServiceRecords() public method

Get Warzone Service Record for specified list of players

public GetWarzoneServiceRecords ( [ players ) : Task
players	[	Up to 32 players can be requested>
return	Task

GetWeapons() public method

public GetWeapons ( ) : Task>
return	Task>

HaloAPIService() public method

public HaloAPIService ( string apiToken, string baseApiUrl = "https://www.haloapi.com" ) : System
apiToken	string
baseApiUrl	string
return	System

PlayerLeaderboard() public method

Gets the Player leaderboard for a season and playlist

public PlayerLeaderboard ( string seasonId, string playlistId, int count = 200 ) : Task
seasonId	string	Season Id
playlistId	string	Playlist Id
count	int	Count of results at any one time, defaults to 200, cannot be 0
return	Task