The Sc2RanksService type exposes the following members.
Back to Top
Back to Top
Methods
| Name | Description | |
|---|---|---|
 | ClearCache |
Create the cache.
|
 | CreateInstance |
Create an instance of the SC2Ranks Service.
|
| CustomDivisionAdd |
Adds characters to the custom division, up to 200 at once. Returns the status of each ID passed, whether invalid, added or already added.
|
| CustomDivisionAddBegin |
Adds characters to the custom division, up to 200 at once. Returns the status of each ID passed, whether invalid, added or already added.
|
| CustomDivisionAddEnd |
End method to call when the callback was invoked.
|
| CustomDivisionRemove |
Removes characters from the custom division, up to 200 at once. Returns the status of each ID passed, whether invalid, removed, not added or unknown.
|
| CustomDivisionRemoveBegin |
Removes characters from the custom division, up to 200 at once. Returns the status of each ID passed, whether invalid, removed, not added or unknown.
|
| CustomDivisionRemoveEnd |
End method to call when the callback was invoked.
|
| Dispose | Releases all resources used by the Sc2RanksService |
|  Equals | (Inherited from Object.) |
| GetBaseData |
Returns base information about the API. Such as the value leagues, brackets, regions or rank regions that can be used.
|
| GetBaseDataBegin |
Returns base information about the API. Such as the value leagues, brackets, regions or rank regions that can be used.
|
| GetBaseDataEnd |
End method to call when the callback was invoked.
|
| GetCharacter |
Returns a single character.
|
| GetCharacterBegin |
Returns a single character.
|
| GetCharacterEnd |
End method to call when the callback was invoked.
|
| GetCharacterList |
Accepts an array of characters with region and bnet_id, up to 200 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.
|
| GetCharacterListBegin |
Accepts an array of characters with region and bnet_id, up to 200 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.
|
| GetCharacterListEnd |
End method to call when the callback was invoked.
|
| GetCharacterTeamList |
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.
|
| GetCharacterTeamListBegin |
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.
|
| GetCharacterTeamListEnd |
End method to call when the callback was invoked.
|
| GetCharacterTeamsList |
Returns all of the teams the character is on, as well as the characters info. Does not return other characters on the team.
|
| GetCharacterTeamsListBegin |
Returns all of the teams the character is on, as well as the characters info. Does not return other characters on the team.
|
| GetCharacterTeamsListEnd |
End method to call when the callback was invoked.
|
| GetClan |
Returns base clan data with the Clans scores based on the bracket.
|
| GetClanBegin |
Returns base clan data with the Clans scores based on the bracket.
|
| GetClanCharacterList |
Returns the characters who are part of the clan, up to 50 per request or less if limit is passed.
|
| GetClanCharacterListBegin |
Returns the characters who are part of the clan, up to 50 per request or less if limit is passed.
|
| GetClanCharacterListEnd |
End method to call when the callback was invoked.
|
| GetClanEnd |
End method to call when the callback was invoked.
|
| GetClanTeamList |
Returns the teams who are part of the clan, up to 50 per request or less if limit is passed.
|
| GetClanTeamListBegin |
Returns the teams who are part of the clan, up to 50 per request or less if limit is passed.
|
| GetClanTeamListEnd |
End method to call when the callback was invoked.
|
| GetCustomDivision |
Returns base information of the custom division by the given id.
|
| GetCustomDivisionBegin |
Returns base information of the custom division by the given id.
|
| GetCustomDivisionCharacterList |
Returns the characters in the custom division without any team data, filtered by the passed params.
|
| GetCustomDivisionCharacterListBegin |
Returns the characters in the custom division without any team data, filtered by the passed params.
|
| GetCustomDivisionCharacterListEnd |
End method to call when the callback was invoked.
|
| GetCustomDivisionEnd |
End method to call when the callback was invoked.
|
| GetCustomDivisions |
Returns all of the custom divisions attached to the user account of the API Key.
|
| GetCustomDivisionsBegin |
Returns all of the custom divisions attached to the user account of the API Key.
|
| GetCustomDivisionsEnd |
End method to call when the callback was invoked.
|
| GetCustomDivisionTeamList |
Returns the teams in the custom division filtered by the passed params.
|
| GetCustomDivisionTeamListBegin |
Returns the teams in the custom division filtered by the passed params.
|
| GetCustomDivisionTeamListEnd |
End method to call when the callback was invoked.
|
| GetDivision |
Returns base information about the division.
|
| GetDivisionBegin |
Returns base information about the division.
|
| GetDivisionEnd |
End method to call when the callback was invoked.
|
| GetDivisionsTop |
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.
|
| GetDivisionsTopBegin |
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.
|
| GetDivisionsTopEnd |
End method to call when the callback was invoked.
|
| GetDivisionTeamsTop |
Returns the top limit teams in the division. This cannot be paginated and is intended to be used for showing mini ranking type of widgets and not data collection.
|
| GetDivisionTeamsTopBegin |
Returns the top limit teams in the division. This cannot be paginated and is intended to be used for showing mini ranking type of widgets and not data collection.
|
| GetDivisionTeamsTopEnd |
End method to call when the callback was invoked.
|
| GetHashCode | (Inherited from Object.) |
| GetRankingsTop |
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.
|
| GetRankingsTopBegin |
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.
|
| GetRankingsTopEnd |
End method to call when the callback was invoked.
|
| GetType | (Inherited from Object.) |
| SearchCharacterTeamList |
Returns all the teams with a team member whos name matches the search.
|
| SearchCharacterTeamListBegin |
Returns all the teams with a team member whos name matches the search.
|
| SearchCharacterTeamListEnd |
End method to call when the callback was invoked.
|
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | MaxRequestLimit |
Maximum request limit.
|
See Also