SC2Ranks API Library [Obsolete]

SC2Ranks is out of service. This library is no longer useful.

PNG_SC2Ranks
Developers
Last Update
Started
Language
Tools
License
Kevin Gardthausen
2014-10-05
2011-08-12
VB.Net 4.0
Visual Studio 2012
GNU GPL v3

Visual Basic .NET 4.0 implementation of the SC2Ranks API with optional request caching.

Project includes test project. Also works with Mono (v3.3.0+) framework.

What is SC2Ranks?

SC2Ranks is a site aggregating StarCraft II player statistics from around the world.

Support

Open source

Download the source at https://github.com/NuGardt/sc2ranks-api

Subversion (SVN):

Git:

Created in Microsoft Visual Studio 2012 with Visual Basic .NET 4.0.

Download

Usage

Library is thread safe. Original library is signed by NuGardt.

Creating an instance

Creates an instance of the Sc2RanksService. It takes three parameters.
* ApiKey: Your private SC2Ranks API key (http://www.sc2ranks.com/usercp/api)).
* Instance: Reference. Contains the instance if Ex is Nothing.
* CacheStream: Optional. Read/write stream for cache data.
* CacheConfig: Optional. Caching durations for all API calls.
* IgnoreFaultCacheStream: Optional, default False. True: If the cache stream is not readable not error will be returned. False: If the cache stream is not readable an error will be returned and no instance will be created.

Returns System.Exception if unsuccessful.

Calling a method (Sync)

Calls RankService.GetBasePlayerByBattleNetID. Takes multiple parameters depending on method. IgnoreCache and Result are always present.
* IgnoreCache: Optional, default False. If cache data is available then the cached data will be used and SC2Ranks will not be contacted.
* Result: Reference. Contains the result if Ex is Nothing.

Returns System.Exception if unsuccessful.

Calling a method (Async)

Calls RankService.GetCharacterBegin without waiting for the result. When the result is available the callback will be called.
* Key: Can be nothing. Useful it for tracking calls.
* Callback: Will be called when the result is available.a

Version History

  • v2.0.3.0 (SVN r90)
    • NSA-9: Scores can be Null.
    • Updated help file.

License

NuGardt SC2Ranks API
Copyright (C) 2011-2015 NuGardt Software
https://www.nugardt.com

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

Leave a Reply

Your email address will not be published. Required fields are marked *

*

This site uses Akismet to reduce spam. Learn how your comment data is processed.