WoW:API GetAuctionItemLink: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Code example said GetAuctionItemInfo instead of GetAuctionItemLink)
m (Move page script moved page API GetAuctionItemLink to API GetAuctionItemLink without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<center>'''GetAuctionItemLink''' ''-Documentation by ClydeJr-''</center>
{{wowapi}} __NOTOC__


Retrieves a link string about one item in the current retrieved list of items from the Auction House.
Retrieves the [[itemLink]] of one item in the current retrieved list of items from the Auction House.


  link = GetAuctionItemLink("type", index);
  "itemLink" = GetAuctionItemLink("type", index)


----
== Arguments ==
;''Arguments''
:("type", index)
:(String type, Number index)
:;"type" : String - One of the following:
 
:;type : One of the following:
:::;"list" : An item up for auction, the "Browse" tab in the dialog.
:::;"list" : An item up for auction, the "Browse" tab in the dialog.
:::;"bidder" : An item the player has bid on, the "Bids" tab in the dialog.
:::;"bidder" : An item the player has bid on, the "Bids" tab in the dialog.
:::;"owner" : An item the player has up for auction, the "Auctions" tab in the dialog.
:::;"owner" : An item the player has up for auction, the "Auctions" tab in the dialog.
:;index : Number - The index of the item in the list to retrieve info from (normally 1-50, inclusive)


:;index : The index of the item in the list to retrieve info from (normally 1-50, inclusive)
== Returns ==
 
:;"itemLink" : [[itemLink]] - The itemLink for the specified item or
----
:: nil, if type and/or index is invalid.
;''Returns''
 
:;link : The link string for the specified item, or nil if the slot is empty.  
 
----
;''Description''
 
: Retrieves a link string about an item in the current list of auction items.
 
----
{{Template:WoW API}}

Latest revision as of 04:45, 15 August 2023

← WoW API < GetAuctionItemLink

Retrieves the itemLink of one item in the current retrieved list of items from the Auction House. 

"itemLink" = GetAuctionItemLink("type", index)

Arguments[edit]

("type", index)
"type"
String - One of the following:
"list"
An item up for auction, the "Browse" tab in the dialog.
"bidder"
An item the player has bid on, the "Bids" tab in the dialog.
"owner"
An item the player has up for auction, the "Auctions" tab in the dialog.
index
Number - The index of the item in the list to retrieve info from (normally 1-50, inclusive)

Returns[edit]

"itemLink"
itemLink - The itemLink for the specified item or
nil, if type and/or index is invalid.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetAuctionItemLink&oldid=18908"