Sc2RanksService.GetRankingsTop Method

Sc2RanksService GetRankingsTop Method

NuGardt

Returns the top limit teams given the passed params. Unlike other APIs, this cannot be paginated and is intended to be used for showing mini ranking type of widgets and not for data collection.

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 GetRankingsTop(
	eSc2RanksRankRegion RankRegion,
	eSc2RanksExpansion Expansion,
	eSc2RanksBracket Bracket,
	eSc2RanksLeague League,
	int TopCount,
	out Sc2RanksGetRankingsTopResult Result,
	Nullable<eSc2RanksRace> Race = null,
	bool IgnoreCache = false
)

public Exception GetRankingsTop(
	eSc2RanksRankRegion RankRegion,
	eSc2RanksExpansion Expansion,
	eSc2RanksBracket Bracket,
	eSc2RanksLeague League,
	int TopCount,
	out Sc2RanksGetRankingsTopResult Result,
	Nullable<eSc2RanksRace> Race = null,
	bool IgnoreCache = false
)

Public Function GetRankingsTop ( 
	RankRegion As eSc2RanksRankRegion,
	Expansion As eSc2RanksExpansion,
	Bracket As eSc2RanksBracket,
	League As eSc2RanksLeague,
	TopCount As Integer,
	<OutAttribute> ByRef Result As Sc2RanksGetRankingsTopResult,
	Optional Race As Nullable(Of eSc2RanksRace) = Nothing,
	Optional IgnoreCache As Boolean = false
) As Exception

Public Function GetRankingsTop ( 
	RankRegion As eSc2RanksRankRegion,
	Expansion As eSc2RanksExpansion,
	Bracket As eSc2RanksBracket,
	League As eSc2RanksLeague,
	TopCount As Integer,
	<OutAttribute> ByRef Result As Sc2RanksGetRankingsTopResult,
	Optional Race As Nullable(Of eSc2RanksRace) = Nothing,
	Optional IgnoreCache As Boolean = false
) As Exception

public:
Exception^ GetRankingsTop(
	eSc2RanksRankRegion RankRegion, 
	eSc2RanksExpansion Expansion, 
	eSc2RanksBracket Bracket, 
	eSc2RanksLeague League, 
	int TopCount, 
	[OutAttribute] Sc2RanksGetRankingsTopResult^% Result, 
	Nullable<eSc2RanksRace> Race = nullptr, 
	bool IgnoreCache = false
)

public:
Exception^ GetRankingsTop(
	eSc2RanksRankRegion RankRegion, 
	eSc2RanksExpansion Expansion, 
	eSc2RanksBracket Bracket, 
	eSc2RanksLeague League, 
	int TopCount, 
	[OutAttribute] Sc2RanksGetRankingsTopResult^% Result, 
	Nullable<eSc2RanksRace> Race = nullptr, 
	bool IgnoreCache = false
)

Parameters

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.

TopCount: Type: System Int32
The top amount of results to return. Cannot exceed MaximumRequestLimit.

Result: Type: NuGardt.SC2Ranks.API.Result Sc2RanksGetRankingsTopResult
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