SteamEx v0.2.0-alpha SteamEx.ISteamUser View Source

Used to access information and interact with users.

See IPlayerService for additional methods.

For more info on how to use the Steamworks Web API please see the Web API Overview.

Link to this section Summary

Functions

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
relationshipstringrelationship type (ex: friend)
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamidsstringComma-delimited list of SteamIDs
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamidsstringComma-delimited list of SteamIDs (max: 100)
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
vanityurlstringThe vanity URL to get a SteamID for
url_typeint32The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group

Link to this section Functions

Link to this function get_friend_list(access_key, params \\ %{}, headers \\ %{}) View Source
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user
relationshipstringrelationship type (ex: friend)

See other: https://partner.steamgames.com/doc/webapi/ISteamUser#GetFriendList

Link to this function get_player_bans(access_key, params \\ %{}, headers \\ %{}) View Source
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamidsstringComma-delimited list of SteamIDs

See other: https://partner.steamgames.com/doc/webapi/ISteamUser#GetPlayerBans

Link to this function get_player_summaries(access_key, params \\ %{}, headers \\ %{}) View Source
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamidsstringComma-delimited list of SteamIDs (max: 100)

See other: https://partner.steamgames.com/doc/webapi/ISteamUser#GetPlayerSummaries

Link to this function get_user_group_list(access_key, params \\ %{}, headers \\ %{}) View Source
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64SteamID of user

See other: https://partner.steamgames.com/doc/webapi/ISteamUser#GetUserGroupList

Link to this function resolve_vanity_url(access_key, params \\ %{}, headers \\ %{}) View Source
NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
vanityurlstringThe vanity URL to get a SteamID for
url_typeint32The type of vanity URL. 1 (default): Individual profile, 2: Group, 3: Official game group

See other: https://partner.steamgames.com/doc/webapi/ISteamUser#ResolveVanityURL