12.07.2015 Views

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

SHOW MORE
SHOW LESS
  • No tags were found...

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Chapter 27 ■ API <strong>Reference</strong> 895Search queries are throttled, preventing abuse <strong>of</strong> the server by clients sendingtoo many queries in short succession. Normal queries can be sent once everyfew seconds; mass queries return all results in the auction house instead <strong>of</strong> one‘‘page’’ at a time, <strong>and</strong> can only be sent once every several minutes.Query results are not returned immediately: the AUCTION_ITEM_LIST_UPDATEevent fires once data is available; listing in<strong>for</strong>mation can then be retrievedusing GetAuctionItemInfo() or other Auction APIs.Arguments:name (optional)—Full or partial item name to limit search results;will match any item whose name contains this string (string)minLevel (optional)—Maximum required character level <strong>of</strong> items to limitsearch results (number)maxLevel (optional)—Maximum required character level <strong>of</strong> items to limitsearch results (number)invTypeIndex (optional)—Index <strong>of</strong> an item inventory type to limit searchresults (note that GetAuctionInvTypes(classIndex, subClassIndex)returns a list <strong>of</strong> token, display pairs <strong>for</strong> each inventory type; thus, to converta token index from that list <strong>for</strong> use here, divide by 2 <strong>and</strong> round up) (number)classIndex (optional)—Index <strong>of</strong> an item class to limit search results(in the list returned by GetAuctionItemClasses()) (number)subClassIndex (optional)—Index <strong>of</strong> an item subclass to limit search results (inthe list returned by GetAuctionItemSubClasses(classIndex))(number)page (optional)—Which ‘‘page’’ <strong>of</strong> search results to list, if more thanNUM_AUCTION_ITEMS_PER_PAGE (50) auctions are available; nil to query thefirst (or only) page (number)isUsable (optional)—True to limit search results to only items which can beused or equipped by the player character; otherwise false (boolean)minQuality (optional)—Minimum quality (rarity) level <strong>of</strong> items to limit searchresults (itemQuality)getAll (optional)—True to per<strong>for</strong>m a mass query (returning all listings atonce); false to per<strong>for</strong>m a normal query (returning a large number <strong>of</strong> listingsin ‘‘pages’’ <strong>of</strong> NUM_AUCTION_ITEMS_PER_PAGE [50] at a time) (boolean)QueryGuildBankLogRequests the item transaction log <strong>for</strong> a guild bank tab from the server.QueryGuildBankLog(tab)Fires the GUILDBANKLOG_UPDATE event when transaction log in<strong>for</strong>mationbecomes available.Arguments:tab—Index <strong>of</strong> a guild bank tab (between 1 <strong>and</strong> GetNumGuildBankTabs())(number)QueryGuildBankTabRequests in<strong>for</strong>mation about the contents <strong>of</strong> a guild bank tab from the server.QueryGuildBankTab(tab)

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!