Class: Steam::RemoteStorage

Inherits:

Object

• Object
• Steam::RemoteStorage

Defined in:

lib/steam-api/steam/remote_storage.rb

Overview

A Ruby DSL for communicating with the Steam Web API.

See Also:

• https://developer.valvesoftware.com/wiki/Steam_Web_API

Since:

• 1.0.0

Class Method Summary

• .client ⇒ Object
• .published_file(params: {}) ⇒ Hash

  Get Published File Details.

• .ugc_file(params: {}) ⇒ Hash

  Get UGC File Details.

Class Method Details

.client ⇒ Object

Since:

• 1.0.0

# File 'lib/steam-api/steam/remote_storage.rb', line 31

def self.client
  build_client 'ISteamRemoteStorage'
end

.published_file(params: {}) ⇒ Hash

Get Published File Details

Parameters:

• params (Hash) (defaults to: {}) —

  Parameters to pass to the API

Options Hash (params:):

• :itemcount (Fixnum) —

  Number of items being requested

• :publishedfileids (Fixnum) —

  Published file id to look up

Returns:

• (Hash) —

  A hash containing the API response

See Also:

• http://wiki.teamfortress.com/wiki/WebAPI/GetPublishedFileDetails

Since:

• 1.0.0

# File 'lib/steam-api/steam/remote_storage.rb', line 12

def self.published_file(params: {})
  response = client.get 'GetPublishedFileDetails/v1', params: params
  response
end

.ugc_file(params: {}) ⇒ Hash

Get UGC File Details

Parameters:

• params (Hash) (defaults to: {}) —

  Parameters to pass to the API

Options Hash (params:):

• :key (String) —

  Steam Api Key

• :steamid (Fixnum) —

  If specified, only returns details if the file is owned by the SteamID specified

• :ugcid (Fixnum) —

  ID of UGC file to get info for

• :appid (Fixnum) —

  appID of product

Returns:

• (Hash) —

  A hash containing the API response

See Also:

• http://wiki.teamfortress.com/wiki/WebAPI/GetUGCFileDetails

Since:

• 1.0.0

# File 'lib/steam-api/steam/remote_storage.rb', line 26

def self.ugc_file(params: {})
  response = client.get 'GetUGCFileDetails/v1', params: params
  response
end