C# Class SteamWeb.Client

Inheritance: IDisposable
Show file Open project: prom3theu5/iNGEN-Ark-RCON-Desktop Class Usage Examples

Public Properties

Property Type Description
APIKey string

Public Methods

Method Description
Client ( string apikey ) : Newtonsoft.Json
Dispose ( ) : void
GetFriendListAsync ( string steamid ) : Task>>

Returns the friend list of any Steam user, provided his Steam Community profile visibility is set to "Public".

GetOwnedGamesAsync ( string steamid, bool detailedInfo = false, bool includeFreeGames = true ) : Task>

Returns a list of games a player owns along with some playtime information, if the profile is publicly visible.

GetPlayerBansAsync ( ) : Task>>

Returns Community, VAC, and Economy ban statuses for given players.

GetPlayerBansAsync ( IEnumerable steamids ) : Task>>

Returns Community, VAC, and Economy ban statuses for given players.

GetPlayerSummariesAsync ( ) : Task>>

Returns basic profile information for a list of 64-bit Steam IDs. Some data associated with a Steam account may be hidden if the user has their profile visibility set to "Friends Only" or "Private". In that case, only public data will be returned.

GetPlayerSummariesAsync ( IEnumerable steamids ) : Task>>

Returns basic profile information for a list of 64-bit Steam IDs. Some data associated with a Steam account may be hidden if the user has their profile visibility set to "Friends Only" or "Private". In that case, only public data will be returned.

GetPlayerSummariesAsync ( IEnumerable steamids ) : Task>>

Returns basic profile information for a list of 64-bit Steam IDs. Some data associated with a Steam account may be hidden if the user has their profile visibility set to "Friends Only" or "Private". In that case, only public data will be returned.

IsPlayingSharedGameAsync ( string steamid, int appID ) : Task>

Returns the original owner's SteamID if a borrowing account is currently playing this game. If the game is not borrowed or the borrower currently doesn't play this game, the result is null.

Private Methods

Method Description
SendRequestAsync ( SteamRequestBase request ) : Task>

Method Details

Client() public method

public Client ( string apikey ) : Newtonsoft.Json
apikey string
return Newtonsoft.Json

Dispose() public method

public Dispose ( ) : void
return void

GetFriendListAsync() public method

Returns the friend list of any Steam user, provided his Steam Community profile visibility is set to "Public".
public GetFriendListAsync ( string steamid ) : Task>>
steamid string
return Task>>

GetOwnedGamesAsync() public method

Returns a list of games a player owns along with some playtime information, if the profile is publicly visible.
public GetOwnedGamesAsync ( string steamid, bool detailedInfo = false, bool includeFreeGames = true ) : Task>
steamid string The 64 bit ID of the player.
detailedInfo bool Whether or not to include additional details of apps - name and images. Defaults to false.
includeFreeGames bool Whether or not to list free-to-play games in the results. Defaults to false.
return Task>

GetPlayerBansAsync() public method

Returns Community, VAC, and Economy ban statuses for given players.
public GetPlayerBansAsync ( ) : Task>>
return Task>>

GetPlayerBansAsync() public method

Returns Community, VAC, and Economy ban statuses for given players.
public GetPlayerBansAsync ( IEnumerable steamids ) : Task>>
steamids IEnumerable
return Task>>

GetPlayerSummariesAsync() public method

Returns basic profile information for a list of 64-bit Steam IDs. Some data associated with a Steam account may be hidden if the user has their profile visibility set to "Friends Only" or "Private". In that case, only public data will be returned.
public GetPlayerSummariesAsync ( ) : Task>>
return Task>>

GetPlayerSummariesAsync() public method

Returns basic profile information for a list of 64-bit Steam IDs. Some data associated with a Steam account may be hidden if the user has their profile visibility set to "Friends Only" or "Private". In that case, only public data will be returned.
public GetPlayerSummariesAsync ( IEnumerable steamids ) : Task>>
steamids IEnumerable
return Task>>

GetPlayerSummariesAsync() public method

Returns basic profile information for a list of 64-bit Steam IDs. Some data associated with a Steam account may be hidden if the user has their profile visibility set to "Friends Only" or "Private". In that case, only public data will be returned.
public GetPlayerSummariesAsync ( IEnumerable steamids ) : Task>>
steamids IEnumerable
return Task>>

IsPlayingSharedGameAsync() public method

Returns the original owner's SteamID if a borrowing account is currently playing this game. If the game is not borrowed or the borrower currently doesn't play this game, the result is null.
public IsPlayingSharedGameAsync ( string steamid, int appID ) : Task>
steamid string The SteamID of the account playing.
appID int The AppID of the game currently playing
return Task>

Property Details

APIKey public property

public string APIKey
return string