Class ISteamUserWrapper

Used to access information and interact with users.

Hierarchy

ISteamUserWrapper

Index

Constructors

Properties

apiKey webApiClient

Methods

getFriendList getPlayerBans getPlayerSummaries getUserGroupList resolveVanityURL

Constructors

constructor

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

Properties

`Private` `Readonly` apiKey

apiKey: string

`Private` `Readonly` webApiClient

webApiClient: WebApiClient

Methods

getFriendList

getFriendList(steamid, relationship): 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:41

getPlayerBans

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

getPlayerSummaries

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

getUserGroupList

getUserGroupList(steamid): 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:84

resolveVanityURL

resolveVanityURL(vanityurl): 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:99

Generated using TypeDoc