Class ISteamUserStatsWrapper

Used to access information about users.

Hierarchy

ISteamUserStatsWrapper

Index

Constructors

Properties

apiKey webApiClient

Methods

getGlobalAchievementPercentagesForApp getGlobalStatsForGame getNumberOfCurrentPlayers getPlayerAchievements getSchemaForGame getUserStatsForGame

Constructors

constructor

new ISteamUserStatsWrapper(apiKey, webApiClient?): ISteamUserStatsWrapper
Parameters
- apiKey: string
  
  Steam Web API key.
- webApiClient: WebApiClient = defaultWebApiClient
  
  HTTP client.
Returns ISteamUserStatsWrapper
- Defined in wrapper/steamUserStatsWrapper.ts:31

Properties

`Private` `Readonly` apiKey

apiKey: string

`Private` `Readonly` webApiClient

webApiClient: WebApiClient

Methods

getGlobalAchievementPercentagesForApp

getGlobalAchievementPercentagesForApp(gameid): Promise<AchievementPercentages>
Retrieves the global achievement percentages for the specified app.
Parameters
- gameid: number
  
  GameID to retrieve the achievement percentages for. This can be the ID of any Steamworks game with achievements available.
Returns Promise<AchievementPercentages>
- Defined in wrapper/steamUserStatsWrapper.ts:42

getGlobalStatsForGame

getGlobalStatsForGame(appid, count, stats): Promise<GlobalStatsForGame>
Retrieves the global stats percentages for the specified app.
Parameters
- appid: number
  
  AppID that we're getting global stats for.
- count: number
  
  Number of stats get data for.
- stats: string[]
  
  Names of stat to get data for.
Returns Promise<GlobalStatsForGame>
- Defined in wrapper/steamUserStatsWrapper.ts:121

getNumberOfCurrentPlayers

getNumberOfCurrentPlayers(appid): Promise<CurrentPlayerCount>
Gets the total number of players currently active in the specified app on Steam.
Parameters
- appid: number
  
  AppID that we're getting user count for.
Returns Promise<CurrentPlayerCount>
- Defined in wrapper/steamUserStatsWrapper.ts:55

getPlayerAchievements

getPlayerAchievements(steamid, appid, lang?): Promise<PlayerStats>
Gets the list of achievements the specified user has unlocked in an app.
Parameters
- steamid: string
  
  SteamID of user.
- appid: number
  
  AppID to get achievements for.
- Optional lang: string
  
  Language to return strings for.
Returns Promise<PlayerStats>
- Defined in wrapper/steamUserStatsWrapper.ts:70

getSchemaForGame

getSchemaForGame(appid, lang?): Promise<GameSchema>
Gets the complete list of stats and achievements for the specified game.
Parameters
- appid: number
  
  AppId of the game.
- Optional lang: string
  
  Localized language to return (english, french, etc.).
Returns Promise<GameSchema>
- Defined in wrapper/steamUserStatsWrapper.ts:87

getUserStatsForGame

getUserStatsForGame(steamid, appid): Promise<GameUserStats>
Gets the list of stats that the specified user has set in an app.
Parameters
- steamid: string
  
  SteamId of user.
- appid: number
  
  AppId of game.
Returns Promise<GameUserStats>
- Defined in wrapper/steamUserStatsWrapper.ts:104

Generated using TypeDoc