NuGardt SoftwareSc2RanksService GetRankingsTopBegin 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

public IAsyncResult GetRankingsTopBegin(
	Object Key,
	eSc2RanksRankRegion RankRegion,
	eSc2RanksExpansion Expansion,
	eSc2RanksBracket Bracket,
	eSc2RanksLeague League,
	int TopCount,
	AsyncCallback Callback,
	Nullable<eSc2RanksRace> Race = null,
	bool IgnoreCache = false
)

Parameters

Key
Type: OnlineSystem Object
Can contain anything. Useful for tracking asynchronous calls. Is returned when the End method is called.
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: OnlineSystem Int32
The top amount of results to return. Cannot exceed MaximumRequestLimit.
Callback
Type: OnlineSystem AsyncCallback
Address of a method to call when a result is available.
Race (Optional)
Type: OnlineSystem Nullable eSc2RanksRace 
Optional. Default is all races. Race to filter.
IgnoreCache (Optional)
Type: OnlineSystem Boolean
Optional. Default is False. Ignores any cached data that might be available when caching is enabled.

Return Value

Type: OnlineIAsyncResult
Return an System.Exception if an error occurred otherwise Nothing.
Remarks

See Also