SteamEx v0.2.0-alpha SteamEx.IPlayerService View Source

Provides additional methods for interacting with Steam Users.

See ISteamUser for the primary interface.

NOTE: This is a Service interface, methods in this interface should be called with the input_json parameter.

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

Link to this section Summary

Functions

Gets badges that are owned by a specific user

Gets all the quests needed to get the specified badge, and which are completed

Return a list of games owned by the player

Gets information about a player’s recently played games

Returns valid lender SteamID if game currently played is borrowed

Tracks playtime for a user when they are offline

Link to this section Functions

Link to this function get_badges(access_key, params \\ %{}, headers \\ %{}) View Source

Gets badges that are owned by a specific user

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we’re asking about

See other: https://partner.steamgames.com/doc/webapi/IPlayerService#GetBadges

Link to this function get_community_badge_progress(access_key, params \\ %{}, headers \\ %{}) View Source

Gets all the quests needed to get the specified badge, and which are completed

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we’re asking about
badgeidint32The badge we’re asking about

See other: https://partner.steamgames.com/doc/webapi/IPlayerService#GetCommunityBadgeProgress

Link to this function get_owned_games(access_key, params \\ %{}, headers \\ %{}) View Source

Return a list of games owned by the player

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we’re asking about
include_appinfobooltrue if we want additional details (name, icon) about each game
include_played_free_gamesboolFree games are excluded by default. If this is set, free games the user has played will be returned.
appids_filteruint32if set, restricts result set to the passed in apps

See other: https://partner.steamgames.com/doc/webapi/IPlayerService#GetOwnedGames

Link to this function get_recently_played_games(access_key, params \\ %{}, headers \\ %{}) View Source

Gets information about a player’s recently played games

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we’re asking about
countuint32The number of games to return (0/unset: all)

See other: https://partner.steamgames.com/doc/webapi/IPlayerService#GetRecentlyPlayedGames

Link to this function get_steam_level(access_key, params \\ %{}, headers \\ %{}) View Source

Returns the Steam Level of a user

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we’re asking about

See other: https://partner.steamgames.com/doc/webapi/IPlayerService#GetSteamLevel

Link to this function is_playing_shared_game(access_key, params \\ %{}, headers \\ %{}) View Source

Returns valid lender SteamID if game currently played is borrowed

NameTypeRequiredDescription
keystringSteamworks Web API user authentication key.
steamiduint64The player we’re asking about
appid_playinguint32The game player is currently playing

See other: https://partner.steamgames.com/doc/webapi/IPlayerService#IsPlayingSharedGame

Link to this function record_offline_playtime(access_key, params \\ %{}, headers \\ %{}) View Source

Tracks playtime for a user when they are offline

NameTypeRequiredDescription
steamiduint64The player we’re asking about
ticketstringThe users authentication ticket.
play_sessions{message}The recorded play sessions.

See other: https://partner.steamgames.com/doc/webapi/IPlayerService#RecordOfflinePlaytime