Sc2RanksService.GetCharacterTeamList Method

Sc2RanksService GetCharacterTeamList Method

NuGardt

Accepts an array of characters with *region* and *bnet_id*, up to 50 characters at once. If one of the passed characters is invalid (region/bnet id/not found) then the bnet_id/region are returned with the error. Returns all of the teams that match the given team filters for the characters passed. Does not return team characters.

Namespace: NuGardt.SC2Ranks.API
Assembly: NuGardt.SC2Ranks.API (in NuGardt.SC2Ranks.API.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

C++

Copy to Clipboard Print

public Exception GetCharacterTeamList(
	IList<Sc2RanksCharacterSimple> Characters,
	eSc2RanksRankRegion RankRegion,
	eSc2RanksExpansion Expansion,
	eSc2RanksBracket Bracket,
	eSc2RanksLeague League,
	out Sc2RanksGetCharacterTeamListResult Result,
	Nullable<eSc2RanksRace> Race = null,
	bool IgnoreCache = false
)

public Exception GetCharacterTeamList(
	IList<Sc2RanksCharacterSimple> Characters,
	eSc2RanksRankRegion RankRegion,
	eSc2RanksExpansion Expansion,
	eSc2RanksBracket Bracket,
	eSc2RanksLeague League,
	out Sc2RanksGetCharacterTeamListResult Result,
	Nullable<eSc2RanksRace> Race = null,
	bool IgnoreCache = false
)

Public Function GetCharacterTeamList ( 
	Characters As IList(Of Sc2RanksCharacterSimple),
	RankRegion As eSc2RanksRankRegion,
	Expansion As eSc2RanksExpansion,
	Bracket As eSc2RanksBracket,
	League As eSc2RanksLeague,
	<OutAttribute> ByRef Result As Sc2RanksGetCharacterTeamListResult,
	Optional Race As Nullable(Of eSc2RanksRace) = Nothing,
	Optional IgnoreCache As Boolean = false
) As Exception

Public Function GetCharacterTeamList ( 
	Characters As IList(Of Sc2RanksCharacterSimple),
	RankRegion As eSc2RanksRankRegion,
	Expansion As eSc2RanksExpansion,
	Bracket As eSc2RanksBracket,
	League As eSc2RanksLeague,
	<OutAttribute> ByRef Result As Sc2RanksGetCharacterTeamListResult,
	Optional Race As Nullable(Of eSc2RanksRace) = Nothing,
	Optional IgnoreCache As Boolean = false
) As Exception

public:
Exception^ GetCharacterTeamList(
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	eSc2RanksRankRegion RankRegion, 
	eSc2RanksExpansion Expansion, 
	eSc2RanksBracket Bracket, 
	eSc2RanksLeague League, 
	[OutAttribute] Sc2RanksGetCharacterTeamListResult^% Result, 
	Nullable<eSc2RanksRace> Race = nullptr, 
	bool IgnoreCache = false
)

public:
Exception^ GetCharacterTeamList(
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	eSc2RanksRankRegion RankRegion, 
	eSc2RanksExpansion Expansion, 
	eSc2RanksBracket Bracket, 
	eSc2RanksLeague League, 
	[OutAttribute] Sc2RanksGetCharacterTeamListResult^% Result, 
	Nullable<eSc2RanksRace> Race = nullptr, 
	bool IgnoreCache = false
)

Parameters

Characters: Type: System.Collections.Generic IList Sc2RanksCharacterSimple
A list of character information to get more information on.

RankRegion: Type: NuGardt.SC2Ranks.API eSc2RanksRankRegion
The rank region the character plays in.

Expansion: Type: NuGardt.SC2Ranks.API eSc2RanksExpansion
The expansion set of StarCraft II.

Bracket: Type: NuGardt.SC2Ranks.API eSc2RanksBracket
The bracket to filter.

League: Type: NuGardt.SC2Ranks.API eSc2RanksLeague
The league to filter.

Result: Type: NuGardt.SC2Ranks.API.Result Sc2RanksGetCharacterTeamListResult
Contains the result. Is Nothing if no data was received and the query timed out.

Race (Optional): Type: System Nullable eSc2RanksRace
Optional. Default is all races. Race to filter.

IgnoreCache (Optional): Type: System Boolean
Optional. Default is False. Ignores any cached data that might be available when caching is enabled.

Return Value

Type:

Exception
Return an System.Exception if an error occurred otherwise Nothing.

Remarks