Returns the top limit divisions 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.APIAssembly: NuGardt.SC2Ranks.API (in NuGardt.SC2Ranks.API.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
Parameters
- Key
- Type:
System 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:
System Int32
The top amount of results to return. Cannot exceed MaximumRequestLimit.
- Callback
- Type:
System AsyncCallback
Address of a method to call when a result is available.
- 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:Returns the status of the asynchronous operation.
Remarks
See Also