Class IPlayerServiceWrapper

Provides additional methods for interacting with Steam Users.

Index

Constructors

Methods

getBadges getCommunityBadgeProgress getOwnedGames getRecentlyPlayedGames getSteamLevel isPlayingSharedGame

Constructors

constructor

new IPlayerServiceWrapper(
apiKey: string,
webApiClient?: WebApiClient,
): IPlayerServiceWrapper
Parameters
- apiKey: string
  Steam Web API key.
- webApiClient: WebApiClient = defaultWebApiClient
  Http client.
Returns IPlayerServiceWrapper
- Defined in wrapper/playerServiceWrapper.ts:162

Methods

getBadges

getBadges(steamid: string): Promise<PlayerBadges>
Gets badges that are owned by a specific user.
Parameters
- steamid: string
  The player we're asking about.
Returns Promise<PlayerBadges>
- Defined in wrapper/playerServiceWrapper.ts:233

getCommunityBadgeProgress

getCommunityBadgeProgress(
steamid: string,
badge?: number,
): Promise<BadgeProgress>
Gets all the quests needed to get the specified badge, and which are completed.
Parameters
- steamid: string
  The player we're asking about.
- Optionalbadge: number
  The badge we're asking about.
Returns Promise<BadgeProgress>
- Defined in wrapper/playerServiceWrapper.ts:248

getOwnedGames

getOwnedGames(
steamid: string,
request?: GetOwnedGamesParams,
): Promise<OwnedGames>
Return a list of games owned by the player.
Parameters
- steamid: string
  The player we're asking about.
- Optionalrequest: GetOwnedGamesParams
  (Optional) Additional request parameters.
Returns Promise<OwnedGames>
- Defined in wrapper/playerServiceWrapper.ts:189

getRecentlyPlayedGames

getRecentlyPlayedGames(
steamid: string,
count?: number,
): Promise<RecentlyPlayedGames>
Gets information about a player's recently played games.
Parameters
- steamid: string
  The player we're asking about.
- Optionalcount: number
  The number of games to return (0/unset: all).
Returns Promise<RecentlyPlayedGames>
- Defined in wrapper/playerServiceWrapper.ts:173

getSteamLevel

getSteamLevel(steamid: string): Promise<SteamLevel>
Returns the Steam Level of a user.
Parameters
- steamid: string
  The player we're asking about.
Returns Promise<SteamLevel>
- Defined in wrapper/playerServiceWrapper.ts:219

isPlayingSharedGame

isPlayingSharedGame(
steamid: string,
appid_playing: number,
): Promise<SharedGameDetails>
Returns valid lender SteamID if game currently played is borrowed.
Parameters
- steamid: string
  The player we're asking about.
- appid_playing: number
  The game player is currently playing.
Returns Promise<SharedGameDetails>
- Defined in wrapper/playerServiceWrapper.ts:265