LibWowAPI

Updated Release: LibWowAPI 1.0 (Aug 27, 2011)

roncli — Wed, 14 Dec 2011 16:30:00 GMT

LibWowAPI 1.0

This release of the LibWowAPI source code matches the Blizzard WoW API as of version 4.2.0a.

Changes since version 0.5:

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

Released: LibWowAPI 1.0 (Aug 27, 2011)

Wed, 14 Dec 2011 16:30:00 GMT

LibWowAPI 1.0

This release of the LibWowAPI source code matches the Blizzard WoW API as of version 4.2.0a.

Changes since version 0.5:

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

Updated Release: LibWowAPI 1.0 (Aug 27, 2011)

roncli — Wed, 14 Dec 2011 16:29:37 GMT

LibWowAPI 1.0

This release of the LibWowAPI source code matches the Blizzard WoW API as of version 4.2.0a.

Changes since version 0.5:

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

Updated Wiki: Home

roncli — Wed, 14 Dec 2011 16:29:14 GMT

This project is now hosted on Github!

Please visit the Github project at https://github.com/roncli/LibWowAPI. Thank you!

LibWowAPI

LibWowAPI (formerly LibWowArmory) is a library for the .NET framework that interfaces with the Blizzard World of Warcraft API. The Blizzard World of Warcraft API (http://blizzard.github.com/api-wow-docs) is an online API that interfaces with World of Warcraft.

Be sure to check out my other WoW-related projects:
LibWowHeroes

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Usage

See the documentation for more information on how to use LibWowAPI in your .NET application.

Version History

1.0 - 8/27/2011

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Added talents field to the pet class of the character class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0.1

Fixed issue with Gzip'ed error messages.
Caching is now optional for all non-data classes. See the WowAPIData.CacheResults property.
Added the WowAPIData.IsModified property. Use this when using the WowAPIData.IfModifiedSince to determine if the request was modified since the last request.
Better inheritance model for IfModifiedSince and Options properties.

Classes

The following classes are provided:

Auction.AuctionData
Character.CharacterProfile
Data.Battlegroups
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

The source code of LibWowAPI comes with the LibWowAPIDemo application. This console application is designed to provide potential developers with a working example of how to use LibWowAPI in their own applications. It's a great way to learn how to use the library.

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Home

roncli — Sat, 03 Sep 2011 20:30:04 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Usage

See the documentation for more information on how to use LibWowAPI in your .NET application.

Version History

1.0 - 8/27/2011

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Added talents field to the pet class of the character class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0.1

Fixed issue with Gzip'ed error messages.
Caching is now optional for all non-data classes. See the WowAPIData.CacheResults property.
Added the WowAPIData.IsModified property. Use this when using the WowAPIData.IfModifiedSince to determine if the request was modified since the last request.
Better inheritance model for IfModifiedSince and Options properties.

Classes

The following classes are provided:

Auction.AuctionData
Character.CharacterProfile
Data.Battlegroups
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Home

roncli — Fri, 02 Sep 2011 04:32:35 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Usage

See the documentation for more information on how to use LibWowAPI in your .NET application.

Version History

1.0 - 8/27/2011

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Added talents field to the pet class of the character class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0.1

Fixed issue with Gzip'ed error messages.
Caching is now optional for all non-data classes. See the WowAPIData.CacheResults property.
Added the WowAPIData.IsModified property. Use this when using the WowAPIData.IfModifiedSince to determine if the request was modified since the last request.

Classes

The following classes are provided:

Auction.AuctionData
Character.CharacterProfile
Data.Battlegroups
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Home

roncli — Tue, 30 Aug 2011 04:08:38 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Usage

See the documentation for more information on how to use LibWowAPI in your .NET application.

Version History

1.0 - 8/27/2011

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0.1

Fixed issue with Gzip'ed error messages.
Caching is now optional for all non-data classes. See the WowAPIData.CacheResults property.
Added the WowAPIData.IsModified property. Use this when using the WowAPIData.IfModifiedSince to determine if the request was modified since the last request.

Classes

The following classes are provided:

Auction.AuctionData
Character.CharacterProfile
Data.Battlegroups
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Home

roncli — Sat, 27 Aug 2011 23:43:44 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Usage

See the documentation for more information on how to use LibWowAPI in your .NET application.

Version History

1.0 - 8/27/2011

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

No new versions are currently planned.

Classes

The following classes are provided:

Auction.AuctionData
Character.CharacterProfile
Data.Battlegroups
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Created Release: LibWowAPI 1.0 (Aug 27, 2011)

roncli — Sat, 27 Aug 2011 23:39:05 GMT

LibWowAPI 1.0

This release of the LibWowAPI source code matches the Blizzard WoW API as of version 4.2.0a.

Changes since version 0.5:

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

Released: LibWowAPI 1.0 (Aug 27, 2011)

Sat, 27 Aug 2011 23:39:05 GMT

LibWowAPI 1.0

This release of the LibWowAPI source code matches the Blizzard WoW API as of version 4.2.0a.

Changes since version 0.5:

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

Updated Wiki: Home

roncli — Sat, 27 Aug 2011 23:35:58 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Version History

1.0 - 8/27/2011

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Help documentation available.

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

No new versions are currently planned.

Classes

The following classes are provided:

Auction.AuctionData
Character.CharacterProfile
Data.Battlegroups
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Documentation/Usage

roncli — Sat, 27 Aug 2011 23:35:05 GMT

Usage

The following document will describe basic usage of the library. It is recommended that you look at the demo project in the source file for a more detailed look at how LibWowAPI operates. There is also help documentation available which fully documents that API.

Be sure to include a reference to LibWowAPI in your class with the following declaration:

VB.Net:

Imports roncliProductions.LibWowAPI

C#:

using roncliProductions.LibWowAPI;

There are several shared properties that you can set prior to using the library:

VB.Net

' For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL"
WowAPIData.PrivateKey = "MNOPQRSTUVWX"
' Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica
WowAPIData.Language = Internationalization.Language.EnglishUS
' Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application"
WowAPIData.ApplicationURL = "http://www.mywowsite.com"

C#:

// For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL";
WowAPIData.PrivateKey = "MNOPQRSTUVWX";
// Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica;
WowAPIData.Language = Internationalization.Language.EnglishUS;
// Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application";
WowAPIData.ApplicationURL = "http://www.mywowsite.com";

To use the library, first you instantiate an instance of the class you want to use.

VB.Net:

Dim cCharacter As New Character.CharacterProfile()

C#:

Character cCharacter = new Character.CharacterProfile();

Next, you set options you want to use.

VB.Net:

cCharacter.Options.Realm = "Korialstrasz"
cCharacter.Options.Name = "Roncli"
cCharacter.Options.Items = True
cCharacter.Options.Talents = True
cCharacter.Options.Progression = True

C#:

cCharacter.Options.Realm = "Korialstrasz";
cCharacter.Options.Name = "Roncli";
cCharacter.Options.Items = true;
cCharacter.Options.Talents = true;
cCharacter.Options.Progression = true;

Then, you load the data from the API.

VB.Net:

cCharacter.Load()

C#:

cCharacter.Load();

Finally, you retrieve the information from the object.

VB.Net:

Dim intAchievementPoints As Integer = cCharacter.Character.AchievementPoints
Dim iHeadItem as Character.Item = cCharacter.Character.Items.Head

C#:

int intAchievementPoints = cCharacter.Character.AchievementPoints;
Character.Item iHeadItem = cCharacter.Character.Items.Head;

Some properties are made of collections, which allows for using LINQ.

VB.Net:

Dim varSelectedTalents = (From t in cCharacter.Talents Where t.Selected)
Dim varClearedHeroicRaids = (From r in cCharacter.Progression.Raids Where r.Heroic = Progress.Cleared)

C#:

var varSelectedTalents = (from t in cCharacter.Talents where t.Selected select t);
var varClearedHeroicRaids = (from r in cCharacter.Progression.Raids where r.Heroic == Progress.Cleared select r);

Updated Wiki: Documentation

roncli — Sat, 27 Aug 2011 23:33:27 GMT

LibWowAPI

Version 1.0

About the WoW API - Learn about Blizzard's community API for World of Warcraft.
Getting Started - How to setup your Visual Studio 2010 project.
Setting Up Your Application - Properties to set when initializing your application.
The WowAPIData Class - All of the classes you will use to retrieve data are inherited from this class. This will demonstrate the properties that are available to each of these classes.
Usage - Basic library usage.

Source code checked in, #69963

roncli — Sat, 27 Aug 2011 23:23:45 GMT

Tagged as 1.0 release

Source code checked in, #69962

roncli — Sat, 27 Aug 2011 23:22:51 GMT

- Included new LibWowAPIDocs directory - Commit of version 1.0

Updated Wiki: Home

roncli — Thu, 25 Aug 2011 21:47:46 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Version History

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Added battlegroup field to the realm lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Full site documentation.

Usage

Be sure to include a reference to LibWowAPI in your class with the following declaration:

VB.Net:

Imports roncliProductions.LibWowAPI

C#:

using roncliProductions.LibWowAPI;

There are several shared properties that you can set prior to using the library:

VB.Net

' For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL"
WowAPIData.PrivateKey = "MNOPQRSTUVWX"
' Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica
WowAPIData.Language = Internationalization.Language.EnglishUS
' Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application"
WowAPIData.ApplicationURL = "http://www.mywowsite.com"

C#:

// For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL";
WowAPIData.PrivateKey = "MNOPQRSTUVWX";
// Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica;
WowAPIData.Language = Internationalization.Language.EnglishUS;
// Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application";
WowAPIData.ApplicationURL = "http://www.mywowsite.com";

To use the library, first you instantiate an instance of the class you want to use.

VB.Net:

Dim cCharacter As New Character.CharacterProfile()

C#:

Character cCharacter = new Character.CharacterProfile();

Next, you set options you want to use.

VB.Net:

cCharacter.Options.Realm = "Korialstrasz"
cCharacter.Options.Name = "Roncli"
cCharacter.Options.Items = True
cCharacter.Options.Talents = True
cCharacter.Options.Progression = True

C#:

cCharacter.Options.Realm = "Korialstrasz";
cCharacter.Options.Name = "Roncli";
cCharacter.Options.Items = true;
cCharacter.Options.Talents = true;
cCharacter.Options.Progression = true;

Then, you load the data from the API.

VB.Net:

cCharacter.Load()

C#:

cCharacter.Load();

Finally, you retrieve the information from the object.

VB.Net:

Dim intAchievementPoints As Integer = cCharacter.Character.AchievementPoints
Dim iHeadItem as Character.Item = cCharacter.Character.Items.Head

C#:

int intAchievementPoints = cCharacter.Character.AchievementPoints;
Character.Item iHeadItem = cCharacter.Character.Items.Head;

Some properties are made of collections, which allows for using LINQ.

VB.Net:

Dim varSelectedTalents = (From t in cCharacter.Talents Where t.Selected)
Dim varClearedHeroicRaids = (From r in cCharacter.Progression.Raids Where r.Heroic = Progress.Cleared)

C#:

var varSelectedTalents = (from t in cCharacter.Talents where t.Selected select t);
var varClearedHeroicRaids = (from r in cCharacter.Progression.Raids where r.Heroic == Progress.Cleared select r);

Classes

The following classes are provided:

Character.CharacterProfile
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

LibWowAPI comes with the LibWowAPIDemo application. This console application is designed to provide potential developers with a working example of how to use LibWowAPI in their own applications. It's a great way to learn how to use the library.

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Home

roncli — Thu, 25 Aug 2011 14:46:04 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Version History

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowAPI and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Full site documentation.

Usage

Be sure to include a reference to LibWowAPI in your class with the following declaration:

VB.Net:

Imports roncliProductions.LibWowAPI

C#:

using roncliProductions.LibWowAPI;

There are several shared properties that you can set prior to using the library:

VB.Net

' For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL"
WowAPIData.PrivateKey = "MNOPQRSTUVWX"
' Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica
WowAPIData.Language = Internationalization.Language.EnglishUS
' Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application"
WowAPIData.ApplicationURL = "http://www.mywowsite.com"

C#:

// For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL";
WowAPIData.PrivateKey = "MNOPQRSTUVWX";
// Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica;
WowAPIData.Language = Internationalization.Language.EnglishUS;
// Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application";
WowAPIData.ApplicationURL = "http://www.mywowsite.com";

To use the library, first you instantiate an instance of the class you want to use.

VB.Net:

Dim cCharacter As New Character.CharacterProfile()

C#:

Character cCharacter = new Character.CharacterProfile();

Next, you set options you want to use.

VB.Net:

cCharacter.Options.Realm = "Korialstrasz"
cCharacter.Options.Name = "Roncli"
cCharacter.Options.Items = True
cCharacter.Options.Talents = True
cCharacter.Options.Progression = True

C#:

cCharacter.Options.Realm = "Korialstrasz";
cCharacter.Options.Name = "Roncli";
cCharacter.Options.Items = true;
cCharacter.Options.Talents = true;
cCharacter.Options.Progression = true;

Then, you load the data from the API.

VB.Net:

cCharacter.Load()

C#:

cCharacter.Load();

Finally, you retrieve the information from the object.

VB.Net:

Dim intAchievementPoints As Integer = cCharacter.Character.AchievementPoints
Dim iHeadItem as Character.Item = cCharacter.Character.Items.Head

C#:

int intAchievementPoints = cCharacter.Character.AchievementPoints;
Character.Item iHeadItem = cCharacter.Character.Items.Head;

Some properties are made of collections, which allows for using LINQ.

VB.Net:

Dim varSelectedTalents = (From t in cCharacter.Talents Where t.Selected)
Dim varClearedHeroicRaids = (From r in cCharacter.Progression.Raids Where r.Heroic = Progress.Cleared)

C#:

var varSelectedTalents = (from t in cCharacter.Talents where t.Selected select t);
var varClearedHeroicRaids = (from r in cCharacter.Progression.Raids where r.Heroic == Progress.Cleared select r);

Classes

The following classes are provided:

Character.CharacterProfile
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Documentation/WowAPIData

roncli — Thu, 25 Aug 2011 00:47:46 GMT

The WowAPIData Class

In addition to being the class where you setup your application's initialization, the WowAPIData class serves as the base class to all API calls in the library. As such, all of the classes share some functionality.

Load

The Load function is a public function that is implemented by each class that inherits from WowAPIData. This function is responsible for making sure the library calls the API and translating the returned JSON into usable classes. The Load function is automatically called by every constructor overload with one or more arguments. If you call the class's default constructor, you must call the Load function yourself.

C#

void Main() {
    Character.CharacterProfile character = new Character.CharacterProfile();
    character.Options.Realm = "Korialstrasz";
    character.Options.Name = "Roncli";
    character.Load();

    Character.CharacterProfile alt = new Character.CharacterProfile("Korialstrasz", "Albarith");
}

VB.Net

Sub Main()
    Dim character As New Character.CharacterProfile()
    character.Options.Realm = "Korialstrasz"
    character.Options.Name = "Roncli"
    character.Load()

    Dim alt As New Character.CharacterProfile("Korialstrasz", "Albarith")
End Sub

Data

After you load the data, you can see the JSON string that was returned by the API by accessing the Data property.

C#

void Main() {
    Character.CharacterProfile character = new Character.CharacterProfile("Korialstrasz", "Roncli");
    string JSON = character.Data;
}

VB.Net

Sub Main()
    Dim character As New Character.CharacterProfile("Korialstrasz", "Roncli")
    Dim JSON As String = character.Data
End Sub

Caching

Caching is a very important aspect of LibWowAPI. All requests are cached by the library in order to save on unnecessary API calls for commonly called requests.

CacheLength

The default cache length varies depending on the type of data being returned:

Data that changes at most once per major patch is cached for 30 days.
Data that changes on a daily basis is cached once every 24 hours.
Data that is time-sensitive is cached for 15 minutes.

You can change this default by assigning a new TimeSpan to the CacheLength.

C#

void Main() {
    Character.CharacterProfile character = new Character.CharacterProfile();
    character.CacheLength = new TimeSpan(12, 0, 0);
}

VB.Net

Sub Main()
    Dim character As New Character.CharacterProfile()
    character.CacheLength = New TimeSpan(12, 0, 0)
End Sub

CacheHit

To determine if your request was retrieved from the cache instead of from Blizzard, check the CacheHit property.

C#

void Main() {
    CacheHitTest();
    CacheHitTest();
}

private void CacheHitTest() {
    Character.CharacterProfile character = new Character.CharacterProfile();
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue);
    if (character.CacheHit.HasValue) {
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value);
    }
    character.Options.Realm = "Korialstrasz";
    character.Options.Realm = "Roncli";
    character.Load();
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue);
    if (character.CacheHit.HasValue) {
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value);
    }
}

VB.Net

Sub Main()
    CacheHitTest()
    CacheHitTest()
End Sub

Private Sub CacheHitTest()
    Dim character As New Character.CharacterProfile()
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue)
    If character.CacheHit.HasValue Then
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value)
    End If
    character.Options.Realm = "Korialstrasz"
    character.Options.Realm = "Roncli"
    character.Load()
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue)
    If character.CacheHit.HasValue Then
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value)
    End If
End Sub

Output

CacheHit has a value: False
CacheHit has a value: True
Cache hit occurred: False
CacheHit has a value: False
CacheHit has a value: True
Cache hit occurred: True

Clear

To clear the cache, call the Clear function just prior to calling the Load function.

C#

void Main() {
    CacheHitTest();
    CacheHitTest();
}

private void CacheHitTest() {
    Character.CharacterProfile character = new Character.CharacterProfile();
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue);
    if (character.CacheHit.HasValue) {
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value);
    }
    character.Options.Realm = "Korialstrasz";
    character.Options.Realm = "Roncli";
    character.Clear();
    character.Load();
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue);
    if (character.CacheHit.HasValue) {
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value);
    }
}

VB.Net

Sub Main()
    CacheHitTest()
    CacheHitTest()
End Sub

Private Sub CacheHitTest()
    Dim character As New Character.CharacterProfile()
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue)
    If character.CacheHit.HasValue Then
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value)
    End If
    character.Options.Realm = "Korialstrasz"
    character.Options.Realm = "Roncli"
    character.Clear()
    character.Load()
    Console.WriteLine("CacheHit has a value: {0}", character.CacheHit.HasValue)
    If character.CacheHit.HasValue Then
        Console.WriteLine("Cache hit occurred: {0}", character.CacheHit.Value)
    End If
End Sub

Output

CacheHit has a value: False
CacheHit has a value: True
Cache hit occurred: False
CacheHit has a value: False
CacheHit has a value: True
Cache hit occurred: False

IfModifiedSince

The IfModifiedSince property can be set prior to send the if-modified-since header to the API. This is ignored if the API call has previously been cached.

C#

void Main() {
    Character.CharacterProfile character = new Character.CharacterProfile();
    character.IfModifiedSince = new Date(2011, 8, 23, 14, 22, 0);
}

VB.Net

Sub Main()
    Dim character As New Character.CharacterProfile()
    character.IfModifiedSince = New Date(2011, 8, 23, 14, 22, 0)
End Sub

Updated Wiki: Home

roncli — Thu, 25 Aug 2011 00:41:59 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Version History

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowArmory and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0

Implemented gzip compression.
Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Full site documentation.

Usage

Be sure to include a reference to LibWowAPI in your class with the following declaration:

VB.Net:

Imports roncliProductions.LibWowAPI

C#:

using roncliProductions.LibWowAPI;

There are several shared properties that you can set prior to using the library:

VB.Net

' For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL"
WowAPIData.PrivateKey = "MNOPQRSTUVWX"
' Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica
WowAPIData.Language = Internationalization.Language.EnglishUS
' Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application"
WowAPIData.ApplicationURL = "http://www.mywowsite.com"

C#:

// For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL";
WowAPIData.PrivateKey = "MNOPQRSTUVWX";
// Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica;
WowAPIData.Language = Internationalization.Language.EnglishUS;
// Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application";
WowAPIData.ApplicationURL = "http://www.mywowsite.com";

To use the library, first you instantiate an instance of the class you want to use.

VB.Net:

Dim cCharacter As New Character.CharacterProfile()

C#:

Character cCharacter = new Character.CharacterProfile();

Next, you set options you want to use.

VB.Net:

cCharacter.Options.Realm = "Korialstrasz"
cCharacter.Options.Name = "Roncli"
cCharacter.Options.Items = True
cCharacter.Options.Talents = True
cCharacter.Options.Progression = True

C#:

cCharacter.Options.Realm = "Korialstrasz";
cCharacter.Options.Name = "Roncli";
cCharacter.Options.Items = true;
cCharacter.Options.Talents = true;
cCharacter.Options.Progression = true;

Then, you load the data from the API.

VB.Net:

cCharacter.Load()

C#:

cCharacter.Load();

Finally, you retrieve the information from the object.

VB.Net:

Dim intAchievementPoints As Integer = cCharacter.Character.AchievementPoints
Dim iHeadItem as Character.Item = cCharacter.Character.Items.Head

C#:

int intAchievementPoints = cCharacter.Character.AchievementPoints;
Character.Item iHeadItem = cCharacter.Character.Items.Head;

Some properties are made of collections, which allows for using LINQ.

VB.Net:

Dim varSelectedTalents = (From t in cCharacter.Talents Where t.Selected)
Dim varClearedHeroicRaids = (From r in cCharacter.Progression.Raids Where r.Heroic = Progress.Cleared)

C#:

var varSelectedTalents = (from t in cCharacter.Talents where t.Selected select t);
var varClearedHeroicRaids = (from r in cCharacter.Progression.Raids where r.Heroic == Progress.Cleared select r);

Classes

The following classes are provided:

Character.CharacterProfile
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

As of version 0.2 beta, LibWowArmory now comes with the LibWowArmoryDemo application. This console application is designed to provide potential users with a working example of how to use LibWowArmory in their own applications. It's a great way to learn how to use the library.

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.

Updated Wiki: Home

roncli — Wed, 24 Aug 2011 18:52:43 GMT

LibWowAPI

Requirements

Json.Net 4.0r2 - A free JSON library for .NET. See the Getting Started guide for more details.

Version History

0.5 beta - 8/18/2011

Project name change from LibWowArmory to LibWowAPI.
Support for BNET authentication.
Added pvp and quests fields to the character profile.
Added character achievements, guild achievements, quests, and arena ladder classes.
Better item lookup support.
Some properties are now shared/static across the library in order to allow for cleaner code. These properties should be set at startup time, or in the application start event for ASP.NET.
Changed LastModified header to IfModifiedSince header.
The library now sends the X-Library and X-LibraryURL headers identifying itself to Blizzard as LibWowArmory and linking to this project. You can optionally send the X-Application and X-ApplicationURL headers - set via the shared/static properties Application and ApplicationURL - to identify your application.
The JSON is now available by using the Data property.
Will start providing binaries in addition to the source code.

0.4.1 beta - 8/13/2011

Added better exception handling using the new BlizzardAPIException class.

0.4 beta - 8/12/2011

Json.NET updated to version 4.0r2
All old Armory classes have been removed, and many new API classes have been added.
Improved caching, along with adjusting the cache time and adding the ability to manually clear the cache.

0.3 beta - 6/14/2010

Solution upgraded to Visual Studio 2010:
- Many properties have been converted to the new shorthand properties
- Many changes recommended by the built-in code analyzer, including a switch from generic Lists to generic Collections
Json.NET updated to version 3.5r7
Many classes have been refactored into different namespaces to make the code tree easier to navigate
Three new classes:
- ItemTooltip - The information contained within an item's tooltip. Thanks to Lukan Schwigtenberg for his contribution!
- AchievementStrings - A class used by CharacterFeed to get the available achievement category names IDs.
- CharacterFeed - Returns a filterable feed of a character's recent achievements, achievement criteria, boss kills, loot received, and talent respecs. Note that Blizzard hasn't implemented respecs just yet.

0.2.3 beta - 2/16/2010

Updated Dungeon class to work with the current Armory, providing more information for the class

0.2.2 beta - 2/15/2010

Updated to work with Json.Net 3.5r6.
Updated all current classes for the wowarmory.com changes made on January 13th.

0.2.1 beta - 9/8/2009

Added the new TranslationFor and FactionRestriction properties to the ItemInfo class to handle new armory information identifying items as being for a single faction.

0.2 beta - 8/30/2009

Fixed various changes to the Armory XML files, especially when it comes to Character Talents.
Added character reputation, character calendar, character achievements, and character statistics functions.

0.1 beta - 12/18/2008

Initial version.

Planned versions

1.0

Added battlegroup listing and auction hall classes.
Completed the item lookup class.
Fixed a bug with URLs that contain pound signs (#) that aren't part of hashes and ampersands (&) that aren't part of querystrings. Yes, this was needed.
Standardized the way the class constructors work so that a constructor with no arguments requires you to call the Load() function while a constructor with arguments does not.
Full site documentation.

Usage

Be sure to include a reference to LibWowAPI in your class with the following declaration:

VB.Net:

Imports roncliProductions.LibWowAPI

C#:

using roncliProductions.LibWowAPI;

There are several shared properties that you can set prior to using the library:

VB.Net

' For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL"
WowAPIData.PrivateKey = "MNOPQRSTUVWX"
' Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica
WowAPIData.Language = Internationalization.Language.EnglishUS
' Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application"
WowAPIData.ApplicationURL = "http://www.mywowsite.com"

C#:

// For Battle.Net API authentication
WowAPIData.PublicKey = "ABCDEFGHIJKL";
WowAPIData.PrivateKey = "MNOPQRSTUVWX";
// Supporting all regions and languages currently supported by the API
WowAPIData.Region = Internationalization.Region.NorthAmerica;
WowAPIData.Language = Internationalization.Language.EnglishUS;
// Identify your application to Blizzard
WowAPIData.Application = "My LibWowAPI Application";
WowAPIData.ApplicationURL = "http://www.mywowsite.com";

To use the library, first you instantiate an instance of the class you want to use.

VB.Net:

Dim cCharacter As New Character.CharacterProfile()

C#:

Character cCharacter = new Character.CharacterProfile();

Next, you set options you want to use.

VB.Net:

cCharacter.Options.Realm = "Korialstrasz"
cCharacter.Options.Name = "Roncli"
cCharacter.Options.Items = True
cCharacter.Options.Talents = True
cCharacter.Options.Progression = True

C#:

cCharacter.Options.Realm = "Korialstrasz";
cCharacter.Options.Name = "Roncli";
cCharacter.Options.Items = true;
cCharacter.Options.Talents = true;
cCharacter.Options.Progression = true;

Then, you load the data from the API.

VB.Net:

cCharacter.Load()

C#:

cCharacter.Load();

Finally, you retrieve the information from the object.

VB.Net:

Dim intAchievementPoints As Integer = cCharacter.Character.AchievementPoints
Dim iHeadItem as Character.Item = cCharacter.Character.Items.Head

C#:

int intAchievementPoints = cCharacter.Character.AchievementPoints;
Character.Item iHeadItem = cCharacter.Character.Items.Head;

Some properties are made of collections, which allows for using LINQ.

VB.Net:

Dim varSelectedTalents = (From t in cCharacter.Talents Where t.Selected)
Dim varClearedHeroicRaids = (From r in cCharacter.Progression.Raids Where r.Heroic = Progress.Cleared)

C#:

var varSelectedTalents = (from t in cCharacter.Talents where t.Selected select t);
var varClearedHeroicRaids = (from r in cCharacter.Progression.Raids where r.Heroic == Progress.Cleared select r);

Classes

The following classes are provided:

Character.CharacterProfile
Data.CharacterAchievements
Data.CharacterClasses
Data.CharacterRaces
Data.GuildAchievements
Data.GuildPerks
Data.GuildRewards
Data.ItemClasses
Guild.GuildProfile
Item.ItemLookup
PvP.ArenaLadder
PvP.ArenaTeam
Quest.QuestLookup
Realms.RealmStatus

Demo

Special Thanks

Lukan Schwigtenberg contributed the first working copy of the now-removed ItemTooltip class.