IPublishedFileService

Methods IPublishedFileService

Cream::IPublishedFileService.queryfiles(key : String, query_type : UInt32, page : UInt32, numperpage : UInt32, creator_appid : UInt32, appid : UInt32, requiredtags : String, excludedtags : String, required_flags : String, omitted_flags : String, search_text : String, filetype : UInt32, child_publishedfileid : UInt64, days : UInt32, cache_max_age_seconds : UInt32, language : Int32)

Parameters

key

Type: string
Optional: false
Description: Access key

query_type

Type: uint32
Optional: false
Description: enumeration EPublishedFileQueryType in clientenums.h

page

Type: uint32
Optional: false
Description: Current page

numperpage

Type: uint32
Optional: true
Description: (Optional) The number of results, per page to return.

creator_appid

Type: uint32
Optional: false
Description: App that created the files

appid

Type: uint32
Optional: false
Description: App that consumes the files

requiredtags

Type: string
Optional: false
Description: Tags to match on. See match_all_tags parameter below

excludedtags

Type: string
Optional: false
Description: (Optional) Tags that must NOT be present on a published file to satisfy the query.

match_all_tags

Type: bool
Optional: true
Description: If true, then items must have all the tags specified, otherwise they must have at least one of the tags.

required_flags

Type: string
Optional: false
Description: Required flags that must be set on any returned items

omitted_flags

Type: string
Optional: false
Description: Flags that must not be set on any returned items

search_text

Type: string
Optional: false
Description: Text to match in the item's title or description

filetype

Type: uint32
Optional: false
Description: EPublishedFileInfoMatchingFileType

child_publishedfileid

Type: uint64
Optional: false
Description: Find all items that reference the given item.

days

Type: uint32
Optional: false
Description: If query_type is k_PublishedFileQueryType_RankedByTrend, then this is the number of days to get votes for [1,7].

include_recent_votes_only

Type: bool
Optional: false
Description: If query_type is k_PublishedFileQueryType_RankedByTrend, then limit result set just to items that have votes within the day range given

cache_max_age_seconds

Type: uint32
Optional: true
Description: Allow stale data to be returned for the specified number of seconds.

language

Type: int32
Optional: true
Description: Language to search in and also what gets returned. Defaults to English.

required_kv_tags

Type: {message}
Optional: false
Description: Required key-value tags to match on.

totalonly

Type: bool
Optional: false
Description: (Optional) If true, only return the total number of files that satisfy this query.

ids_only

Type: bool
Optional: false
Description: (Optional) If true, only return the published file ids of files that satisfy this query.

return_vote_data

Type: bool
Optional: false
Description: Return vote data

return_tags

Type: bool
Optional: false
Description: Return tags in the file details

return_kv_tags

Type: bool
Optional: false
Description: Return key-value tags in the file details

return_previews

Type: bool
Optional: false
Description: Return preview image and video details in the file details

return_children

Type: bool
Optional: false
Description: Return child item ids in the file details

return_short_description

Type: bool
Optional: false
Description: Populate the short_description field instead of file_description

return_for_sale_data

Type: bool
Optional: false
Description: Return pricing information, if applicable

return_metadata

Type: bool
Optional: true
Description: Populate the metadata