steam-web

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>steam - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="steam.html">steam</a><ul class='methods'><li data-type='method'><a href="steam.html#getAppList">getAppList</a></li><li data-type='method'><a href="steam.html#getAssetClassInfo">getAssetClassInfo</a></li><li data-type='method'><a href="steam.html#getAssetPrices">getAssetPrices</a></li><li data-type='method'><a href="steam.html#getBadges">getBadges</a></li><li data-type='method'><a href="steam.html#getCommunityBadgeProgress">getCommunityBadgeProgress</a></li><li data-type='method'><a href="steam.html#getFriendList">getFriendList</a></li><li data-type='method'><a href="steam.html#getGlobalAchievementPercentagesForApp">getGlobalAchievementPercentagesForApp</a></li><li data-type='method'><a href="steam.html#getGlobalStatsForGame">getGlobalStatsForGame</a></li><li data-type='method'><a href="steam.html#getNewsForApp">getNewsForApp</a></li><li data-type='method'><a href="steam.html#getNumberOfCurrentPlayers">getNumberOfCurrentPlayers</a></li><li data-type='method'><a href="steam.html#getOwnedGames">getOwnedGames</a></li><li data-type='method'><a href="steam.html#getPlayerAchievements">getPlayerAchievements</a></li><li data-type='method'><a href="steam.html#getPlayerBans">getPlayerBans</a></li><li data-type='method'><a href="steam.html#getPlayerItems">getPlayerItems</a></li><li data-type='method'><a href="steam.html#getPlayerSummaries">getPlayerSummaries</a></li><li data-type='method'><a href="steam.html#getRecentlyPlayedGames">getRecentlyPlayedGames</a></li><li data-type='method'><a href="steam.html#getSchema">getSchema</a></li><li data-type='method'><a href="steam.html#getSchemaForGame">getSchemaForGame</a></li><li data-type='method'><a href="steam.html#getSchemaURL">getSchemaURL</a></li><li data-type='method'><a href="steam.html#getServerInfo">getServerInfo</a></li><li data-type='method'><a href="steam.html#getServersAtAddress">getServersAtAddress</a></li><li data-type='method'><a href="steam.html#getSteamLevel">getSteamLevel</a></li><li data-type='method'><a href="steam.html#getStoreMetadata">getStoreMetadata</a></li><li data-type='method'><a href="steam.html#getStoreStatus">getStoreStatus</a></li><li data-type='method'><a href="steam.html#getSupportedAPIList">getSupportedAPIList</a></li><li data-type='method'><a href="steam.html#getUserGroupList">getUserGroupList</a></li><li data-type='method'><a href="steam.html#getUserStatsForGame">getUserStatsForGame</a></li><li data-type='method'><a href="steam.html#isPlayingSharedGame">isPlayingSharedGame</a></li><li data-type='method'><a href="steam.html#resolveVanityURL">resolveVanityURL</a></li><li data-type='method'><a href="steam.html#upToDateCheck">upToDateCheck</a></li></ul></li></ul> </nav> <div id="main"> <h1 class="page-title">steam</h1> <section> <header> <h2> steam </h2> </header> <article> <div class="container-overview"> <h4 class="name" id="steam"><span class="type-signature"></span>new steam<span class="signature">(settings)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line11">line 11</a> </li></ul></dd> </dl> <div class="description"> Creates a new Steam Web instance </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>settings</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>apiKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last">The steam web API key, obtained from: http://steamcommunity.com/dev/apikey</td> </tr> <tr> <td class="name"><code>format</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> <code>json</code> </td> <td class="description last">The format for the response [json, xml, vdf] - default: json</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="getAppList"><span class="type-signature"></span>getAppList<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line285">line 285</a> </li></ul></dd> </dl> <div class="description"> Gets a list of apps and their appid </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getAssetClassInfo"><span class="type-signature"></span>getAssetClassInfo<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line159">line 159</a> </li></ul></dd> </dl> <div class="description"> Gets class info for a specific game asset </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getAssetPrices"><span class="type-signature"></span>getAssetPrices<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line145">line 145</a> </li></ul></dd> </dl> <div class="description"> Gets the prices for items in a game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getBadges"><span class="type-signature"></span>getBadges<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line375">line 375</a> </li></ul></dd> </dl> <div class="description"> Gets a user's badges </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getCommunityBadgeProgress"><span class="type-signature"></span>getCommunityBadgeProgress<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line388">line 388</a> </li></ul></dd> </dl> <div class="description"> Gets a user's progress towards a specific badge </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getFriendList"><span class="type-signature"></span>getFriendList<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line87">line 87</a> </li></ul></dd> </dl> <div class="description"> Gets a user's friend list </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getGlobalAchievementPercentagesForApp"><span class="type-signature"></span>getGlobalAchievementPercentagesForApp<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line56">line 56</a> </li></ul></dd> </dl> <div class="description"> Gets the global achievement percentages for a specific app </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getGlobalStatsForGame"><span class="type-signature"></span>getGlobalStatsForGame<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line222">line 222</a> </li></ul></dd> </dl> <div class="description"> Gets the global stats for a specific game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getNewsForApp"><span class="type-signature"></span>getNewsForApp<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line43">line 43</a> </li></ul></dd> </dl> <div class="description"> Gets the news for a specific app </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getNumberOfCurrentPlayers"><span class="type-signature"></span>getNumberOfCurrentPlayers<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line349">line 349</a> </li></ul></dd> </dl> <div class="description"> Gets the number of current players for a specific game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getOwnedGames"><span class="type-signature"></span>getOwnedGames<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line100">line 100</a> </li></ul></dd> </dl> <div class="description"> Gets a user's owned games list </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getPlayerAchievements"><span class="type-signature"></span>getPlayerAchievements<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line182">line 182</a> </li></ul></dd> </dl> <div class="description"> Gets a user's achievements for a specific game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getPlayerBans"><span class="type-signature"></span>getPlayerBans<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line269">line 269</a> </li></ul></dd> </dl> <div class="description"> Gets a list of bans for a specific user </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getPlayerItems"><span class="type-signature"></span>getPlayerItems<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line131">line 131</a> </li></ul></dd> </dl> <div class="description"> Gets a player's items for a specific game <br /> <br /> This will work with TF2 and some other games but it no longer works with Counterstrike, valve has disabled the API See https://www.reddit.com/r/SteamBot/comments/5ztiv6/psa_api_method_shutdown_ieconitems/ </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getPlayerSummaries"><span class="type-signature"></span>getPlayerSummaries<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line70">line 70</a> </li></ul></dd> </dl> <div class="description"> Gets the player summaries for a list of users </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getRecentlyPlayedGames"><span class="type-signature"></span>getRecentlyPlayedGames<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line196">line 196</a> </li></ul></dd> </dl> <div class="description"> Gets a user's recently played games </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getSchema"><span class="type-signature"></span>getSchema<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line113">line 113</a> </li></ul></dd> </dl> <div class="description"> Gets the item schema for a specific game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getSchemaForGame"><span class="type-signature"></span>getSchemaForGame<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line255">line 255</a> </li></ul></dd> </dl> <div class="description"> Gets a game's statistics schema </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getSchemaURL"><span class="type-signature"></span>getSchemaURL<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line421">line 421</a> </li></ul></dd> </dl> <div class="description"> Gets the schema URL for a specific game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getServerInfo"><span class="type-signature"></span>getServerInfo<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line401">line 401</a> </li></ul></dd> </dl> <div class="description"> Gets info on a specific server </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getServersAtAddress"><span class="type-signature"></span>getServersAtAddress<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line295">line 295</a> </li></ul></dd> </dl> <div class="description"> Gets a list of servers at a specific address </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getSteamLevel"><span class="type-signature"></span>getSteamLevel<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line362">line 362</a> </li></ul></dd> </dl> <div class="description"> Gets a user's Steam level </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getStoreMetadata"><span class="type-signature"></span>getStoreMetadata<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line435">line 435</a> </li></ul></dd> </dl> <div class="description"> Gets the store metadata for a specific game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getStoreStatus"><span class="type-signature"></span>getStoreStatus<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line449">line 449</a> </li></ul></dd> </dl> <div class="description"> Gets the store status for a specific game (only TF2 currently supported) </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getSupportedAPIList"><span class="type-signature"></span>getSupportedAPIList<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line411">line 411</a> </li></ul></dd> </dl> <div class="description"> Gets a list of supported API endpoints </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getUserGroupList"><span class="type-signature"></span>getUserGroupList<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line323">line 323</a> </li></ul></dd> </dl> <div class="description"> Gets a user's group memberships </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="getUserStatsForGame"><span class="type-signature"></span>getUserStatsForGame<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line209">line 209</a> </li></ul></dd> </dl> <div class="description"> Gets a user's stats for a specific game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="isPlayingSharedGame"><span class="type-signature"></span>isPlayingSharedGame<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line242">line 242</a> </li></ul></dd> </dl> <div class="description"> Check if a user is playing a shared game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="resolveVanityURL"><span class="type-signature"></span>resolveVanityURL<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line336">line 336</a> </li></ul></dd> </dl> <div class="description"> Resolves a specific vanity URL (seems to no longer work) </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="upToDateCheck"><span class="type-signature"></span>upToDateCheck<span class="signature">(obj)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="steam.js.html">steam.js</a>, <a href="steam.js.html#line308">line 308</a> </li></ul></dd> </dl> <div class="description"> Check if a specific version is the latest version of that game </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>obj</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last"></td> </tr> </tbody> </table> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Feb 03 2018 17:19:29 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>