Class ISteamUserWrapper

Used to access information and interact with users.

Index

Constructors

Methods

getFriendList getPlayerBans getPlayerSummaries getUserGroupList resolveVanityURL

Constructors

constructor

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

Methods

getFriendList

getFriendList(
steamid: string,
relationship: FriendRelationship,
): Promise<FriendList>
User friend list.
Parameters
- steamid: string
  The 64-bit ID of the user to retrieve a list for.
- relationship: FriendRelationship
  Filter by a given role. Possible options are all (All roles), friend.
Returns Promise<FriendList>
- Defined in wrapper/steamUserWrapper.ts:175

getPlayerBans

getPlayerBans(steamids: string[]): Promise<PlayerBans>
Player ban/probation status.
Parameters
- steamids: string[]
  Comma-delimited list of steam IDs.
Returns Promise<PlayerBans>
- Defined in wrapper/steamUserWrapper.ts:190

getPlayerSummaries

getPlayerSummaries(steamids: string[]): Promise<PlayerSummaries>
User profile data.
Parameters
- steamids: string[]
  Comma-delimited list of steam IDs.
Returns Promise<PlayerSummaries>
- Defined in wrapper/steamUserWrapper.ts:204

getUserGroupList

getUserGroupList(steamid: string): Promise<UserGroups>
Lists Group ID(s) linked with 64-bit ID.
Parameters
- steamid: string
  The 64-bit ID of the user.
Returns Promise<UserGroups>
- Defined in wrapper/steamUserWrapper.ts:218

resolveVanityURL

resolveVanityURL(vanityurl: string): Promise<VanityURLResolved>
Resolve vanity URL parts to a 64-bit ID.
Parameters
- vanityurl: string
  The user's vanity URL that you would like to retrieve a steam ID for, e.g. http://steamcommunity.com/id/gabelogannewell would use "gabelogannewell".
Returns Promise<VanityURLResolved>
- Defined in wrapper/steamUserWrapper.ts:233