\Zyberspace\SteamWebApi\InterfacesIPublishedFileService

Summary

Methods
Properties
Constants
__construct()
QueryFilesV1()
No public properties found
No constants found
_call()
$_client
N/A
No private methods found
No private properties found
N/A

Properties

$_client

$_client : 

Type

Methods

QueryFilesV1()

QueryFilesV1(\Zyberspace\SteamWebApi\Interfaces\uint32  $query_type, \Zyberspace\SteamWebApi\Interfaces\uint32  $page, \Zyberspace\SteamWebApi\Interfaces\uint32  $numperpage = null, \Zyberspace\SteamWebApi\Interfaces\uint32  $creator_appid, \Zyberspace\SteamWebApi\Interfaces\uint32  $appid, string  $requiredtags, string  $excludedtags, boolean  $match_all_tags = null, string  $required_flags, string  $omitted_flags, string  $search_text, \Zyberspace\SteamWebApi\Interfaces\uint32  $filetype, \Zyberspace\SteamWebApi\Interfaces\uint64  $child_publishedfileid, \Zyberspace\SteamWebApi\Interfaces\uint32  $days, boolean  $include_recent_votes_only, \Zyberspace\SteamWebApi\Interfaces\uint32  $cache_max_age_seconds = null, \Zyberspace\SteamWebApi\Interfaces\int32  $language = null, \Zyberspace\SteamWebApi\Interfaces\{message}  $required_kv_tags, boolean  $totalonly, boolean  $ids_only, boolean  $return_vote_data, boolean  $return_tags, boolean  $return_kv_tags, boolean  $return_previews, boolean  $return_children, boolean  $return_short_description, boolean  $return_for_sale_data, boolean  $return_metadata = null) 

/IPublishedFileService/QueryFiles/v1/

Parameters

\Zyberspace\SteamWebApi\Interfaces\uint32 $query_type

enumeration EPublishedFileQueryType in clientenums.h

\Zyberspace\SteamWebApi\Interfaces\uint32 $page

Current page

\Zyberspace\SteamWebApi\Interfaces\uint32 $numperpage

(Optional) The number of results, per page to return.

\Zyberspace\SteamWebApi\Interfaces\uint32 $creator_appid

App that created the files

\Zyberspace\SteamWebApi\Interfaces\uint32 $appid

App that consumes the files

string $requiredtags

Tags to match on. See match_all_tags parameter below

string $excludedtags

(Optional) Tags that must NOT be present on a published file to satisfy the query.

boolean $match_all_tags

If true, then items must have all the tags specified, otherwise they must have at least one of the tags.

string $required_flags

Required flags that must be set on any returned items

string $omitted_flags

Flags that must not be set on any returned items

string $search_text

Text to match in the item's title or description

\Zyberspace\SteamWebApi\Interfaces\uint32 $filetype

EPublishedFileInfoMatchingFileType

\Zyberspace\SteamWebApi\Interfaces\uint64 $child_publishedfileid

Find all items that reference the given item.

\Zyberspace\SteamWebApi\Interfaces\uint32 $days

If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].

boolean $include_recent_votes_only

If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given

\Zyberspace\SteamWebApi\Interfaces\uint32 $cache_max_age_seconds

Allow stale data to be returned for the specified number of seconds.

\Zyberspace\SteamWebApi\Interfaces\int32 $language

Language to search in and also what gets returned. Defaults to English.

\Zyberspace\SteamWebApi\Interfaces\{message} $required_kv_tags

Required key-value tags to match on.

boolean $totalonly

(Optional) If true, only return the total number of files that satisfy this query.

boolean $ids_only

(Optional) If true, only return the published file ids of files that satisfy this query.

boolean $return_vote_data

Return vote data

boolean $return_tags

Return tags in the file details

boolean $return_kv_tags

Return key-value tags in the file details

boolean $return_previews

Return preview image and video details in the file details

boolean $return_children

Return child item ids in the file details

boolean $return_short_description

Populate the short_description field instead of file_description

boolean $return_for_sale_data

Return pricing information, if applicable

boolean $return_metadata

Populate the metadata

_call()

_call(  $callee,   $httpMethod,   $parameters) 

Parameters

$callee
$httpMethod
$parameters