C# Class CSharpTradeOffers.Community.SteamUserHandler

Handles steam user related tasks.

Show file Open project: FatherFoxxy/CSharpTradeOffers Class Usage Examples

Public Methods

Method	Description
FetchMiniProfile ( SteamId id, bool client = true, int status = 1 ) : string
GetFriendList ( ulong steamId, string relationship = "" ) : List	Retrieves the friends list of the specified steamid64. The profile must be set to public or the owner of the api key must be friends with them. The profile cannot be private or the method will fail and it will return null.
GetPlayerBans ( List playersBansToRequest ) : List	Gets the bans of the specified SteamId64s
GetPlayerSummariesV2 ( List playerSummariesToRequest ) : List	Requests a list of player summaries of the players in the list.
GetUserGroupList ( ulong steamId ) : CSharpTradeOffers.Community.GetUserGroupListResult	Requests the GroupIds of the groups of the specified player.
ResolveVanityUrl ( string vanityUrl, int urlType = 1 ) : ResolveVanityUrlResult	Resolves a vanity url into a SteamId64.
SteamUserHandler ( string apiKey ) : System.Collections.Generic	Initializes a new SteamUserHandler, it is used to GetFriendList and other similiar functions.

Private Methods

Method	Description
CommaDelimit ( List toDelimit ) : string

Method Details

FetchMiniProfile() public method

public FetchMiniProfile ( SteamId id, bool client = true, int status = 1 ) : string
id	SteamId
client	bool
status	int
return	string

GetFriendList() public method

Retrieves the friends list of the specified steamid64. The profile must be set to public or the owner of the api key must be friends with them. The profile cannot be private or the method will fail and it will return null.

public GetFriendList ( ulong steamId, string relationship = "" ) : List
steamId	ulong	SteamId64 to retrieve the friends list from.
relationship	string	All/Friend, there are others but I do not know what.
return	List

GetPlayerBans() public method

Gets the bans of the specified SteamId64s

public GetPlayerBans ( List playersBansToRequest ) : List
playersBansToRequest	List	A List of steamid64s to retrieve ban information about.
return	List

GetPlayerSummariesV2() public method

Requests a list of player summaries of the players in the list.

public GetPlayerSummariesV2 ( List playerSummariesToRequest ) : List
playerSummariesToRequest	List	A list of SteamIds to request their summaries.
return	List

GetUserGroupList() public method

Requests the GroupIds of the groups of the specified player.

public GetUserGroupList ( ulong steamId ) : CSharpTradeOffers.Community.GetUserGroupListResult
steamId	ulong	SteamId64 of the player.
return	CSharpTradeOffers.Community.GetUserGroupListResult

ResolveVanityUrl() public method

Resolves a vanity url into a SteamId64.

public ResolveVanityUrl ( string vanityUrl, int urlType = 1 ) : ResolveVanityUrlResult
vanityUrl	string	The vanity url part of the url (not whole url). ex: fatherfoxxy NOT https://steamcommunity.com/id/FatherFoxxy
urlType	int	/// 1 - (default) Individual profile /// 2 - Group Profile /// 3 - Offical Game Group Profile ///
return	ResolveVanityUrlResult

SteamUserHandler() public method

Initializes a new SteamUserHandler, it is used to GetFriendList and other similiar functions.

public SteamUserHandler ( string apiKey ) : System.Collections.Generic
apiKey	string	Api key to use
return	System.Collections.Generic